راه‌اندازی کلید API

برخی اندپوینت‌ها به کلید API نیاز دارند. برای ساخت کلید به این صفحه مراجعه کنید.
کلید API یا کلید محرمانه خود را هرگز با هیچ‌کس به اشتراک نگذارید.

محدودیت‌های کلید API

نوع امنیت	توضیحات
NONE	دسترسی به اندپوینت آزاد است.
TRADE	اندپوینت به API-Key معتبر و امضا نیاز دارد.

فعال‌سازی حساب‌ها

کیف پول اصلی

یک Main کیف پول پیش‌فرض شماست و با آن می‌توانید واریز، برداشت و معامله کنید.

کیف پول معاملاتی

در این بخش می‌توانید برای تفکیک بهتر حساب‌ها، دارایی خود را انتقال دهید.

کالکشن‌های Postman

یک کالکشن Postman شامل اندپوینت‌های API برای استفاده سریع و آسان در دسترس است.

این کالکشن برای کاربران جدیدی که می‌خواهند سریع کار با API را شروع کنند پیشنهاد می‌شود.

برای اطلاعات بیشتر به این صفحه مراجعه کنید: Efex API Postman

تماس با ما

گروه تلگرام API افکس
- برای پرسش درباره افت ناگهانی عملکرد API یا WebSocketها.
- برای پرسش‌های عمومی API که در مستندات پاسخ داده نشده‌اند.
توسعه‌دهندگان افکس
- برای پرسش درباره پیاده‌سازی کد با API یا WebSocketها.
پشتیبانی مشتریان افکس
- برای مواردی مانند کسری موجودی، راهنمایی احراز هویت دومرحله‌ای و موارد مشابه.

اطلاعات عمومی

اطلاعات عمومی API

اندپوینت پایه: https://api.efex.pro
همه اندپوینت‌ها یک شیء یا آرایه JSON برمی‌گردانند.
داده‌ها با ترتیب صعودی برگردانده می‌شوند؛ قدیمی‌ترین ابتدا و جدیدترین در انتها قرار می‌گیرد.
همه فیلدهای مربوط به زمان و timestamp بر حسب میلی‌ثانیه.

کدهای پاسخ HTTP

HTTP 4XX برای درخواست‌های نامعتبر استفاده می‌شوند؛ مشکل از سمت ارسال‌کننده است.
HTTP 403 وقتی محدودیت WAF (فایروال برنامه وب) نقض شده باشد استفاده می‌شود.
HTTP 429 وقتی محدودیت نرخ درخواست نقض شده باشد استفاده می‌شود.
HTTP 418 وقتی یک IP پس از دریافت کد 429 به ارسال درخواست ادامه دهد و به‌صورت خودکار مسدود شود، استفاده می‌شود.
HTTP 5XX برای خطاهای داخلی استفاده می‌شوند؛ مشکل از سمت افکس است.

کدها و پیام‌های خطا

در صورت بروز خطا، API پیام خطایی شامل علت را برمی‌گرداند.

{
    "message": "Invalid symbol."
}

اطلاعات عمومی اندپوینت‌ها

برای GET ، پارامترها باید به‌صورت query string.
برای POST, PUTو DELETE ، پارامترها را می‌توان در request body با نوع محتواapplication/form-data.
پارامترها را می‌توان با هر ترتیبی ارسال کرد.

امنیت اندپوینت‌های SIGNED (TRADE، USER_DATA و MARGIN)

SIGNED به یک پارامتر اضافی با نام signatureنیاز دارند که باید در request body.
اندپوینت‌ها از امضای HMAC SHA256 استفاده می‌کنند. امضای HMAC SHA256 signature یک عملیات کلیددار HMAC SHA256 است. از secretKey به‌عنوان کلید و totalParams به‌عنوان مقدار عملیات HMAC استفاده کنید.
مقدار signature به حروف بزرگ و کوچک حساس نیست.
totalParams به‌صورت query string متصل به request body.

امنیت زمانی

یک SIGNED همچنین به پارامتری با نام timestampنیاز دارد که باید timestamp میلی‌ثانیه‌ای دریافت‌شده از API زمان سرور باشد.
پارامتر اختیاری receive_windowرا می‌توان برای تعیین تعداد میلی‌ثانیه‌هایی ارسال کرد که پس از timestamp درخواست معتبر باقی می‌ماند.

if ((serverTime - timestamp) < recvWindow){
    // process request
} else {
    // reject request
}

زمان‌بندی در معاملات حرفه‌ای اهمیت زیادی دارد. شبکه‌ها ممکن است ناپایدار باشند و رسیدن درخواست‌ها به سرور زمان متفاوتی ببرد. با receive_windowمی‌توانید مشخص کنید درخواست باید در چند میلی‌ثانیه پردازش شود؛ در غیر این صورت سرور آن را رد می‌کند.

اطلاعات بازار اسپات

API زمان سرور

GET/get-timestamp

{
    "timestamp": 1630133102  
}

API معامله خرید و فروش

POST/v1/trade-bot

ثبت سفارش خرید یا فروش

هدرها:

کلید	مقدار
Accept	application/json
api-key	کلید API شما

پارامترها:

نام	نوع	الزامی	توضیحات
symbol	STRING	YES	نماد جفت‌ارز مانند BTC_USDT.
order_type	INT	YES	1-LIMIT,2-MARKET,3-STOP-LIMIT,4-OCO
order_by	INT	NO	وقتی order_by برابر 2 است ارسال شود. مقدار 1 برای مرتب‌سازی بر اساس تعداد و مقدار 2 برای مرتب‌سازی بر اساس مبلغ است
price	FLOAT	YES	قیمت برای سفارش‌های LIMIT، STOP-LIMIT و OCO الزامی است
side	INT	YES	1-BUY,2-SELL
qty	FLOAT	YES	برای سفارش MARKET بر اساس مبلغ، qty لازم نیست؛ در سایر حالت‌ها الزامی است
amount	FLOAT	YES	amount فقط برای سفارش MARKET بر اساس مبلغ الزامی است
trigger_price	FLOAT	NO	قیمت فعال‌سازی برای سفارش‌های STOP-LIMIT و OCO الزامی است
limit_price	FLOAT	NO	قیمت محدود برای سفارش OCO الزامی است
is_hidden	INT	NO	اگر نمی‌خواهید سفارش در دفتر سفارش‌ها نمایش داده شود مقدار 1 و در غیر این صورت مقدار 0 را وارد کنید. (فقط سفارش‌های LIMIT)
timestamp	MILLISECOND	YES	مقداری که از API دریافت زمان سرور گرفته‌اید
receive_window	INT	Yes	حداکثر 20000.
signature	STRING	YES	will be in this sequence IF ORDER_TYPE == 1 "symbol:order_type:price:qty:side:timestamp:receive_window" IF ORDER_TYPE == 2 AND ORDER_BY == 1 "symbol:order_type:order_by:qty:side:timestamp:receive_window" IF ORDER_TYPE == 2 AND ORDER_BY == 2 "symbol:order_type:order_by:amount:side:timestamp:receive_window" IF ORDER_TYPE == 3 "symbol:order_type:price:qty:trigger_price:side:timestamp:receive_window" IF ORDER_TYPE == 4 "symbol:order_type:price:qty:limit_price:trigger_price:side:timestamp:receive_window"

{
    "message": "Sell Order Place Successfully"  
}

API فهرست همه معاملات خرید و فروش فعال

GET/v1/get-open-buy-sell-order

دریافت همه معاملات خرید و فروش فعال

هدرها:

کلید	مقدار
Accept	application/json
api-key	کلید API شما

پارامترها:

کلید	مقدار	توضیحات
symbol	BTC_USDT	نماد جفت‌ارز را مانند نمونه بالا ارسال کنید
type	0	0-All,1-Buy,2-Sell
page	1	ارسال page الزامی است؛ از 1 شروع می‌شود و حداکثر مقدار آن 10 است.
per_page	1	ارسال per_page الزامی است؛ از 1 شروع می‌شود و حداکثر مقدار آن 100 است.
timestamp	MILLISECOND	مقداری که از API دریافت زمان سرور گرفته‌اید
receive_window	INT	حداکثر 20000.
signature	STRING	ترتیب مقادیر باید به این صورت باشد: "Symbol:type"

{
    "trades": {
        "sell": [
            {
                "price": 46705.6958,
                "qty": "3.02968500",
                "total": "141503.54597982"
            }
        ],
        "buy": [
            {
                "price": 46034.6299,
                "qty": "0.19120000",
                "total": "8801.82123688"
            }
        ]
    }
}

API فهرست همه معاملات خرید و فروش فعال کاربر

GET/v1/get-user-open-order

دریافت همه معاملات خرید و فروش فعال کاربر

هدرها:

کلید	مقدار
Accept	application/json
api-key	کلید API شما

پارامترها:

کلید	مقدار	توضیحات
symbol	BTC_USDT	نماد جفت‌ارز را مانند نمونه بالا ارسال کنید
type	0	0-All,1-Buy,2-Sell
timestamp	MILLISECOND	مقداری که از API دریافت زمان سرور گرفته‌اید
receive_window	INT	حداکثر 20000.
signature	STRING	ترتیب مقادیر باید به این صورت باشد: "Symbol:type"

{
    "trades": [
        {
            "id": 716880,
            "time": "11:36:03", //time is in utc
            "date": "16/03/2023", //date is in utc  
            "symbol": "BNB/USDT", //pair code
            "order_type": 1,
            "type": 1, //Buy Order
            "price": "360.90000000",
            "amount": "1.00000000", // qty
            "total": "360.90000000",
            "limit": "-",
            "confirm_qty": "0.00000000",
            "table": 1
        },
	]
}

API لغو معامله خرید یا فروش باز

GET/v1/cancel-user-trade

لغو معامله خرید یا فروش فعال کاربر

هدرها:

کلید	مقدار
Accept	application/json
api-key	کلید API شما

پارامترها:

کلید	مقدار	توضیحات
id	شناسه معامله	شناسه معامله بازی را که می‌خواهید لغو کنید ارسال کنید
timestamp	MILLISECOND	مقداری که از API دریافت زمان سرور گرفته‌اید
receive_window	INT	حداکثر 20000.
signature	STRING	ترتیب مقادیر باید به این صورت باشد: "id"

{
    "message": "Order Cancel Successfully"  
}

API لغو گروهی معاملات خرید و فروش باز

GET/v1/cancel-bulk-order

لغو گروهی معاملات خرید و فروش فعال کاربر

هدرها:

کلید	مقدار
Accept	application/json
api-key	کلید API شما

پارامترها:

کلید	مقدار	توضیحات
type	نوع سفارش	0-all, 1-Limit, 2-Market, 3-Stop Limit
timestamp	MILLISECOND	مقداری که از API دریافت زمان سرور گرفته‌اید
receive_window	INT	حداکثر 20000.
signature	STRING	ترتیب مقادیر باید به این صورت باشد: "Type"

{
    "message": "Order Cancel Successfully"  
}

موجودی یک ارز

GET/v1/check-user-balance

بررسی موجودی کاربر برای یک ارز مشخص

هدرها:

کلید	مقدار
Accept	application/json
api-key	کلید API شما

پارامترها:

کلید	مقدار	توضیحات
symbol	USDT	برای دریافت موجودی یک ارز، کد آن ارز را ارسال کنید؛ برای همه ارزها مقدار ALL را بفرستید
timestamp	MILLISECOND	مقداری که از API دریافت زمان سرور گرفته‌اید
receive_window	INT	حداکثر 20000.
signature	STRING	ترتیب مقادیر باید به این صورت باشد: "symbol"

{
    "balance": "xxxxx.xxxxxxxx" //user balance of that coin is display  
}

دریافت قیمت بازار

GET/v1/get-market-price

دریافت قیمت بازار برای یک یا همه جفت‌ارزها

هدرها:

کلید	مقدار
Accept	application/json
api-key	کلید API شما

پارامترها:

کلید	مقدار	توضیحات
symbol	DOGE_USDT	اختیاری است؛ در صورت ارسال فقط قیمت همان جفت‌ارز برگردانده می‌شود
timestamp	MILLISECOND	مقداری که از API دریافت زمان سرور گرفته‌اید
receive_window	INT	حداکثر 20000.

[
    {
        "currency_pair": "ETH/BTC",
        "last_trade_price": "0.07408300"
    },
    {
        "currency_pair": "BNB/USDT",
        "last_trade_price": "360.70000000"
    },
    {
        "currency_pair": "BTC/USDT",
        "last_trade_price": "16978.63460900"
    },
    {
        "currency_pair": "DOGE/USDT",
        "last_trade_price": "0.10085000"
    },
]

تاریخچه سفارش‌های اسپات

GET/v1/get-user-all-order

دریافت همه سفارش‌های اسپات کاربر

هدرها:

کلید	مقدار
Accept	application/json
api-key	کلید API شما

پارامترها:

کلید	مقدار	توضیحات
symbol	USDT_IRR	اختیاری است. برای دریافت سفارش‌های یک جفت‌ارز مشخص، نام آن جفت‌ارز را ارسال کنید
page	1	ارسال page الزامی است؛ از 1 شروع می‌شود و حداکثر مقدار آن 10 است.
per_page	1	ارسال per_page الزامی است؛ از 1 شروع می‌شود و حداکثر مقدار آن 100 است.
type	0	0-All,1-Buy,2-Sell
from_timestamp	TIMESTAMP	برای دریافت تراکنش‌ها از زمان مشخص تا تاریخ فعلی، timestamp را ارسال کنید.
to_timestamp	TIMESTAMP	برای دریافت تراکنش‌ها تا زمان مشخص، timestamp را ارسال کنید.
tradeId	INT	برای دریافت یک سفارش مشخص، tradeId را ارسال کنید.
timestamp	MILLISECOND	مقداری که از API دریافت زمان سرور گرفته‌اید
receive_window	INT	حداکثر 20000.
signature	STRING	ترتیب مقادیر باید به این صورت باشد: "from_timestamp:to_timestamp:page:per_page"

{
    "trades": []
}

دریافت سفارش‌های اخیر

GET/v1/get-recent-order

دریافت سفارش‌های اخیر یک جفت‌ارز

هدرها:

کلید	مقدار
Accept	application/json
api-key	کلید API شما

پارامترها:

کلید	مقدار	توضیحات
symbol	DOGE_USDT	نماد جفت‌ارز را مانند نمونه بالا ارسال کنید
timestamp	MILLISECOND	مقداری که از API دریافت زمان سرور گرفته‌اید
receive_window	INT	حداکثر 20000.
page	INT	اختیاری است؛ در هر صفحه حداکثر 20 رکورد به ترتیب نزولی برگردانده می‌شود.

[
    {
        "price": 602.3923,
        "qty": 0.174474,
        "datetime": "2024-08-15T05:33:28.2501302",
        "isGreen": true
    },
    {
        "price": 584.7289,
        "qty": 0.112505,
        "datetime": "2024-08-15T05:30:27.2423365",
        "isGreen": false
    },
    {
        "price": 603.1283,
        "qty": 0.155497,
        "datetime": "2024-08-15T05:27:28.6631559",
        "isGreen": true
    }
]

واریز و برداشت

کد وضعیت تراکنش واریز و برداشت رمزارز

کدها و نام وضعیت‌های تراکنش واریز و برداشت رمزارز در جدول زیر آمده است

کد وضعیت:

کد	نام
0	در انتظار
1	تکمیل‌شده
2	در انتظار تأیید مدیر
3	لغوشده توسط مدیر
4	در حال پردازش
5	لغوشده توسط کاربر

دریافت فهرست ارزهای موجود

GET/v1/get-available-currency

دریافت فهرست ارزهای موجود

هدرها:

کلید	مقدار
Accept	application/json
api-key	کلید API شما

پارامترها:

کلید	مقدار	توضیحات
timestamp	MILLISECOND	مقداری که از API دریافت زمان سرور گرفته‌اید
receive_window	INT	حداکثر 20000.

{
    "message": "Available Currency List receive successfully",
    "currency_list": [
        {
            "code": "BTC",
            "name": "Bitcoin",
            "deposite_status": 1,
            "withdraw_status": 1,
            "withdraw_fees": 10,
            "min_withdraw_amount": 0.001,
            "max_withdraw_amount": 0.31635748,
            "decimal_point": 8,
            "currency_type": "Crypto Currency",
            "network_list": [
                {
                    "network": "Bitcoin",
                    "protocol": "Bitcoin",
                    "symbol": "BTC",
                    "avg_time": 10,
                    "withdraw_fees": 0.0002,
                    "withdraw_type": 0,
                    "address_regex": 0
                },
                {
                    "network": "Binance Smart Chain",
                    "protocol": "BEP20",
                    "symbol": "BTC_BSC",
                    "avg_time": 2,
                    "withdraw_fees": 0.0002,
                    "withdraw_type": 0,
                    "address_regex": 0
                },
                {
                    "network": "Ethereum",
                    "protocol": "ERC20",
                    "symbol": "BTC_ERC",
                    "avg_time": 2,
                    "withdraw_fees": 0.0007,
                    "withdraw_type": 0,
                    "address_regex": 0
                }
            ]
        },
        {
            "code": "IRR",
            "name": "Iran's Rial",
            "deposite_status": 1,
            "withdraw_status": 1,
            "withdraw_fees": 0,
            "min_withdraw_amount": 10,
            "max_withdraw_amount": 100,
            "decimal_point": 0,
            "currency_type": "Fiat Currency"
        },
    ]
}

دریافت فهرست واریزهای رمزارزی

POST/v1/get-deposit-transaction-list

دریافت فهرست 500 تراکنش واریز رمزارزی اخیر

هدرها:

کلید	مقدار
Accept	application/json
api-key	کلید API شما

پارامترها:

کلید	مقدار	توضیحات
page	INT	در هر صفحه حداکثر 10 رکورد به ترتیب نزولی برگردانده می‌شود
currency_code	STRING	اختیاری است. اگر نمی‌خواهید فهرست تراکنش‌ها بر اساس دارایی مشخصی فیلتر شود، آن را ارسال نکنید.
destination_address	STRING	اختیاری است. اگر نمی‌خواهید فهرست تراکنش‌ها بر اساس آدرس مقصد مشخصی فیلتر شود، آن را ارسال نکنید.
from_timestamp	TIMESTAMP	اختیاری است. برای دریافت تراکنش‌ها از زمان مشخص تا تاریخ فعلی، timestamp را ارسال کنید.
to_timestamp	TIMESTAMP	اختیاری است. برای دریافت تراکنش‌ها تا زمان مشخص، timestamp را ارسال کنید.
timestamp	MILLISECOND	مقداری که از API دریافت زمان سرور گرفته‌اید
receive_window	INT	حداکثر 20000.

{
    "message": "Transaction List receive successfully",
    "total_transaction_count": 19,
    "transaction_list": [
        {
            "currency_code": "USDT",
            "amount": "10.00000000",
            "address_from": "TNGozGijqxTyTip6gaasd9cuV4PJouBo1u",
            "address_to": "TF32u9nxn4CyZEQxtgHgmPmgtdAFq3g3rE",
            "unique_id": "2109251129268",
            "tx_id": "df21ee17241504ba56138a57a0d79aad2bd6b467768af4270ff80601b7757095",  
            "confirmation": 1,
            "error_reason": null,
            "status": 1,
            "created_at": "2021-09-25T16:59:40.000000Z"
        },
    ]
}

دریافت فهرست برداشت‌های رمزارزی

POST/v1/get-withdraw-transaction-list

دریافت فهرست 500 تراکنش برداشت رمزارزی اخیر

هدرها:

کلید	مقدار
Accept	application/json
api-key	کلید API شما

پارامترها:

کلید	مقدار	توضیحات
page	1	در هر صفحه حداکثر 10 رکورد به ترتیب نزولی برگردانده می‌شود
currency_code	STRING	اختیاری است. اگر نمی‌خواهید فهرست تراکنش‌ها بر اساس دارایی مشخصی فیلتر شود، آن را ارسال نکنید.
destination_address	STRING	اختیاری است. اگر نمی‌خواهید فهرست تراکنش‌ها بر اساس آدرس مقصد مشخصی فیلتر شود، آن را ارسال نکنید.
from_timestamp	TIMESTAMP	اختیاری است. برای دریافت تراکنش‌ها از زمان مشخص تا تاریخ فعلی، timestamp را ارسال کنید.
to_timestamp	TIMESTAMP	اختیاری است. برای دریافت تراکنش‌ها تا زمان مشخص، timestamp را ارسال کنید.
timestamp	MILLISECOND	مقداری که از API دریافت زمان سرور گرفته‌اید
receive_window	INT	حداکثر 20000.

{
    "message": "Transaction List receive successfully",
    "total_transaction_count": 5,
    "transaction_list": [
        {
            "currency_code": "XRP",
            "amount": "2.00000000",
            "address_from": "rL7XrqvegsepuSs9FL35vpShr8yhubDDUc",
            "address_to": "rUzWJkXyEtT8ekSSxkBYPqCvHpngcy6Fks",
            "unique_id": "2109241155752",
            "tx_id": "456F7E536D48E71110E70412F8EACEF414DD7ED8F23A31B6DF565DE5D15D6544",
            "error_reason": null,
            "status": 1,
            "created_at": "2021-09-24T17:25:56.000000Z"
        },
    ]
}

ایجاد تراکنش برداشت رمزارز

POST/v1/create-withdraw-transaction

ایجاد تراکنش برداشت رمزارز

هدرها:

کلید	مقدار
Accept	application/json
api-key	کلید API شما

پارامترها:

کلید	مقدار	توضیحات
currency_code	DOGE	کد ارزی که می‌خواهید برداشت کنید
fromAddress	آدرس مبدأ دارایی	اختیاری است. آدرسی را که می‌خواهید دارایی از آن ارسال شود وارد کنید. توجه کنید مبلغ از کیف پول سیستم کسر می‌شود، نه از آدرس واردشده.
fromMemo	Memo مبدأ دارایی	اختیاری است؛ اگر Memo وجود ندارد مقدار NULL را ارسال کنید
toAddress	آدرس مقصد دارایی	آدرسی را که باید دارایی را دریافت کند ارسال کنید
memo	Memo مقصد دارایی	اختیاری است؛ اگر Memo وجود ندارد مقدار NULL را ارسال کنید
network	DOGE	نماد شبکه‌ای را که برای شبکه موردنظر از API فهرست ارزها دریافت کرده‌اید وارد کنید
amount	10	مقدار دارایی برای برداشت.
timestamp	MILLISECOND	مقداری که از API دریافت زمان سرور گرفته‌اید
receive_window	INT	حداکثر 20000.
signature	STRING	ترتیب مقادیر باید به این صورت باشد: "fromAddress:from_memo:toAddress:memo:currency_code:network:amount:receive_window"

{
    "message": "Withdrawal Request Sent Successfully",
    "unique_transaction_id": "99580491-9fb3-4625-b66f-770a492504fb"  
}

ساخت آدرس کیف پول واریز

POST/v1/generate-deposit-wallet-address

ساخت آدرس کیف پول واریز

هدرها:

کلید	مقدار
Accept	application/json
api-key	کلید API شما

پارامترها:

کلید	مقدار	توضیحات
currency	DOGE	کد ارزی که می‌خواهید برای آن آدرس بسازید
network	NULL	برای ساخت آدرس در شبکه‌ای مشخص، نماد شبکه دریافت‌شده از API فهرست ارزها را ارسال کنید؛ در غیر این صورت برای ساخت آدرس همه شبکه‌های موجود مقدار را خالی بگذارید
generate_new_address	TRUE	الزامی است. مقدار باید TRUE یا FALSE باشد؛ برای ساخت آدرس جدید True و در غیر این صورت False را ارسال کنید
timestamp	MILLISECOND	مقداری که از API دریافت زمان سرور گرفته‌اید
receive_window	INT	حداکثر 20000.
signature	STRING	اگر network خالی نیست ترتیب مقادیر "currency:network" و در غیر این صورت "currency" است

{
    "message": "Address Generated Successfully",
    "address_data": [
        {
            "address": "0xfa9efdde29c50f2e660e13d50d9c99131bcc469c",
            "symbol": "USDT",
            "destination_tag": "",
            "memo": "",
            "message": "",
            "protocol": "ERC20"
        },
        {
            "address": "TKPj8LsVYAbsHmApfnxGZfeRcEiUVSNM4p",
            "symbol": "USDT_TRON",
            "destination_tag": "",
            "memo": "",
            "message": "",
            "protocol": "TRC20"
        }
    ]
}

دریافت اطلاعات حساب شبا

POST/v1/get-iban-account-details

دریافت اطلاعات حساب شبا

هدرها:

کلید	مقدار
Accept	application/json
api-key	کلید API شما

پارامترها:

کلید	مقدار	توضیحات
account_no	شماره حساب	شماره حسابی را که می‌خواهید اطلاعات آن را دریافت کنید وارد کنید.
timestamp	MILLISECOND	مقداری که از API دریافت زمان سرور گرفته‌اید
receive_window	INT	حداکثر 20000.
signature	STRING	ترتیب مقادیر باید به این صورت باشد: "account_no"

{
    "message": "Get IBAN account no details",  
    "data": {
        "bank_name": "بانک صادرات ایران",
        "IBAN": "IR840191110000111643351114",
        "deposit": "1111643351114",
        "deposit_description": "حساب فعال است",
        "account_name": "سیامک سیفی",
        "first_name": "سیامک",
        "last_name": "سیفی"
    }
}

دریافت فهرست برداشت‌های فیات

POST/v1/withdraw/get-fiat-transaction-list

دریافت فهرست 500 تراکنش برداشت فیات اخیر

هدرها:

کلید	مقدار
Accept	application/json
api-key	کلید API شما

پارامترها:

کلید	مقدار	توضیحات
page	1	در هر صفحه حداکثر 10 رکورد به ترتیب نزولی برگردانده می‌شود
account_no	STRING	اختیاری است. اگر نمی‌خواهید فهرست تراکنش‌ها بر اساس شماره حساب مشخصی فیلتر شود، آن را ارسال نکنید.
from_timestamp	TIMESTAMP	اختیاری است. برای دریافت تراکنش‌ها از زمان مشخص تا تاریخ فعلی، timestamp را ارسال کنید.
to_timestamp	TIMESTAMP	اختیاری است. برای دریافت تراکنش‌ها تا زمان مشخص، timestamp را ارسال کنید.
timestamp	MILLISECOND	مقداری که از API دریافت زمان سرور گرفته‌اید
receive_window	INT	حداکثر 20000.

{
    "message": "Fiat Withdraw Transaction List receive successfully",
    "total_transaction_count": 10,
    "transaction_list": [
        {
            "unique_id": "2309010432437",
            "unique_transaction_id": "9a06dd65-41df-4727-ba9f-0a076e54e4a1",
            "currency_code": "IRR",
            "amount": "100",
            "account_no": "123456789123456789123456",
            "payment_id": "12121212",
            "transaction_id": "313113133113313",
            "status": "Completed",
            "error_reason": null,
            "created_at": "2023-09-01T04:32:28.000000Z"
        },
    ]
}

ایجاد تراکنش برداشت فیات

POST/v1/withdraw/create-fiat-transaction

ایجاد تراکنش برداشت فیات

هدرها:

کلید	مقدار
Accept	application/json
api-key	کلید API شما

پارامترها:

کلید	مقدار	توضیحات
account_no	شماره حساب دارایی	شماره حسابی را که می‌خواهید دارایی را دریافت کند وارد کنید. توجه کنید مبلغ از کیف پول سیستم کسر می‌شود.
payment_id	شناسه پرداخت دارایی	اختیاری است؛ اگر شناسه پرداخت وجود ندارد مقدار NULL را ارسال کنید
amount	10	مقدار دارایی برای برداشت.
timestamp	MILLISECOND	مقداری که از API دریافت زمان سرور گرفته‌اید
receive_window	INT	حداکثر 20000.
signature	STRING	will be in this sequence "account_no:payment_id:amount" If there is no payment ID, the sequence will be "account_no:amount"

{
    "message": "Withdrawal Request Sent Successfully",
    "unique_transaction_id": "99580491-9fb3-4625-b66f-770a492504fb"  
}

دریافت فهرست تراکنش‌های ارز الکترونیک

POST/v1/ecurrency/get-transaction-list

دریافت فهرست 500 تراکنش ارز الکترونیک اخیر

هدرها:

کلید	مقدار
Accept	application/json
api-key	کلید API شما

پارامترها:

کلید	مقدار	توضیحات
page	1	در هر صفحه حداکثر 10 رکورد به ترتیب نزولی برگردانده می‌شود
currency	PMV	اختیاری است. اگر نمی‌خواهید فهرست تراکنش‌ها بر اساس ارز مشخصی فیلتر شود، آن را ارسال نکنید. (WMZ، PMD، PMV، PSV)
type	STRING	اختیاری است. اگر نمی‌خواهید فهرست تراکنش‌ها بر اساس نوع مشخصی فیلتر شود، آن را ارسال نکنید.
from_timestamp	TIMESTAMP	اختیاری است. برای دریافت تراکنش‌ها از زمان مشخص تا تاریخ فعلی، timestamp را ارسال کنید.
to_timestamp	TIMESTAMP	اختیاری است. برای دریافت تراکنش‌ها تا زمان مشخص، timestamp را ارسال کنید.
timestamp	MILISECOUND	مقداری که از API دریافت زمان سرور گرفته‌اید
receive_window	INT	حداکثر 20000.

{
    "message": "Ecurrency Transaction List receive successfully",
    "total_transaction_count": 10,
    "transaction_list": [
        {
            "unique_id": "2309010432437",
            "type": "Withdraw",
            "unique_transaction_id": "9a06dd65-41df-4727-ba9f-0a076e54e4a1",
            "currency_code": "PMD",
            "amount": "100",
            "account_no": "123456789123456789123456",
            "voucher_code": "",
            "voucher_secret": "",
            "transaction_id": "313113133113313",
            "status": "Completed",
            "error_reason": null,
            "created_at": "2023-09-01T04:32:28.000000Z"
        },
    ]
}

ایجاد تراکنش واریز ارز الکترونیک

POST/v1/ecurrency/create-deposit-transaction

ایجاد تراکنش واریز ارز الکترونیک

هدرها:

کلید	مقدار
Accept	application/json
api-key	کلید API شما

پارامترها:

کلید	مقدار	توضیحات
currency	PMV	کد ارزی که می‌خواهید واریز کنید (PMV، PSV)
voucher_number	123456789	اختیاری است؛ اگر currency_code برابر PSV است مقدار NULL را ارسال کنید
voucher_code	123456789	کد ووچری را که می‌خواهید بازخرید کنید ارسال کنید
amount	10	مقدار دارایی برای برداشت.
timestamp	MILISECOUND	مقداری که از API دریافت زمان سرور گرفته‌اید
receive_window	INT	حداکثر 20000.
signature	STRING	If PMV will be in this sequence "currency:voucher_number:voucher_code:amount:receive_window" If PSV is no voucher_number, the sequence will be "currency:voucher_code:amount:receive_window"

{
    "message": "Deposit Request Sent Successfully",
    "unique_transaction_id": "99580491-9fb3-4625-b66f-770a492504fb"  
}

ایجاد تراکنش برداشت ارز الکترونیک

POST/v1/ecurrency/create-withdraw-transaction

ایجاد تراکنش برداشت ارز الکترونیک

هدرها:

کلید	مقدار
Accept	application/json
api-key	کلید API شما

پارامترها:

کلید	مقدار	توضیحات
currency	PMD	کد ارز موردنظر (WMZ، PMD، PMV، PSV)
account_no	شماره حساب دارایی	اختیاری است. شماره حسابی را که می‌خواهید دارایی را دریافت کند وارد کنید.
amount	10	مقدار دارایی برای برداشت.
timestamp	MILISECOUND	مقداری که از API دریافت زمان سرور گرفته‌اید
receive_window	INT	حداکثر 20000.
signature	STRING	Will be in this sequence "currency:account_no:amount:receive_window" If PMV, PSV is no account_no, the sequence will be "currency:amount:receive_window"

{
    "message": "Withdrawal Request Sent Successfully",
    "unique_transaction_id": "99580491-9fb3-4625-b66f-770a492504fb"  
}

API تبدیل سریع

دریافت نرخ رزرو

POST/v1/rapid/get-reserve

دریافت نرخ رزرو

هدرها:

کلید	مقدار
Accept	application/json
api-key	کلید API شما

پارامترها:

کلید	مقدار	توضیحات
type	STRING	مقدار باید BUY یا SELL باشد
amountFrom	FLOAT	مقداری را که می‌خواهید پرداخت کنید ارسال کنید.
pair	STRING	نام جفت‌ارز را مانند BTC/USDT وارد کنید.
timestamp	MILLISECOND	مقداری که از API دریافت زمان سرور گرفته‌اید
receive_window	INT	حداکثر 20000.
signature	STRING	ترتیب مقادیر باید به این صورت باشد: "type:amountFrom:pair:receive_window"

{
    "status": 1,
    "rate": 49325.345193959  
}

ایجاد معامله تبدیل سریع

POST/v1/rapid/create-trade

دریافت نرخ رزرو

هدرها:

کلید	مقدار
Accept	application/json
api-key	کلید API شما

پارامترها:

کلید	مقدار	توضیحات
type	STRING	مقدار باید BUY یا SELL باشد
amountFrom	FLOAT	مقداری را که می‌خواهید پرداخت کنید ارسال کنید.
pair	STRING	نام جفت‌ارز را مانند BTC/USDT وارد کنید.
send_type	INT	برای داخلی مقدار 1 و برای خارجی مقدار 2 را ارسال کنید
receive_type	INT	برای داخلی مقدار 1 و برای خارجی مقدار 2 را ارسال کنید
address	STRING	اگر receive_type برابر 2 است، آدرس دریافت دارایی را ارسال کنید
memo	STRING	اگر receive_type برابر 2 است و دارایی Memo دارد، آن را در این متغیر ارسال کنید
send_network	STRING	اگر send_type برابر 2 و ارز رمزارز است، این متغیر را ارسال کنید.
receiver_network	STRING	اگر receive_type برابر 2 و ارز رمزارز است، این متغیر را ارسال کنید.
account_no	STRING	اگر receive_type برابر 2 و ارز الکترونیک است، این متغیر را ارسال کنید.
voucher_number	STRING	اگر send_type برابر 2 و ارز ووچر الکترونیک است، این متغیر را ارسال کنید.
voucher_code	STRING	اگر send_type برابر 2 و ارز ووچر الکترونیک است، این متغیر را ارسال کنید.
timestamp	MILLISECOND	مقداری که از API دریافت زمان سرور گرفته‌اید
receive_window	INT	حداکثر 20000.
signature	STRING	`will be in this sequence string = "type:amountFrom:pair:send_type:receive_type:receive_window" if send_type == 2: //crypto currency string += send_network if receive_type == 2: //crypto currency string += address if not empty(memo): string += memo if not empty(receiver_network): string += receiver_network`

{
    "from_currency_id": 1,
    "to_currency_id": 3,
    "send_currency_network" => 'BTC,
    "receive_currency_network" => 'USDT',  
    "send_amount": "0.10000000",
    "receive_amount": "4883.20917000",
    "withdraw_fee": "0.00000000",
    "commission_fee": "49.32534519",
    "deposit_address": null,
    "deposite_destination_tag": null,
    "deposite_memo": null,
    "receive_address": "",
    "receiver_memo": "",
    "transaction_id": "2306061056608",
    "rate": "49325.34519000",
    "payment_status": "Confirmed",
    "receive_status": "Pending",
    "payment_mode": "Internal Wallet",
    "receive_mode": "Internal Wallet"
}

دریافت جزئیات تراکنش تبدیل سریع

GET/v1/rapid/transaction-detail/transaction_id

دریافت نرخ رزرو

هدرها:

کلید	مقدار
Accept	application/json
api-key	کلید API شما

پارامترها:

کلید	مقدار	توضیحات
timestamp	MILLISECOND	مقداری که از API دریافت زمان سرور گرفته‌اید
receive_window	INT	حداکثر 20000.

{
    "from_currency_id": 1,
    "to_currency_id": 3,
    "send_currency_network" => 'BTC,
    "receive_currency_network" => 'USDT',  
    "send_amount": "0.10000000",
    "receive_amount": "4883.20917000",
    "withdraw_fee": "0.00000000",
    "commission_fee": "49.32534519",
    "deposit_address": null,
    "deposite_destination_tag": null,
    "deposite_memo": null,
    "receive_address": "",
    "receiver_memo": "",
    "transaction_id": "2306061056608",
    "rate": "49325.34519000",
    "payment_status": "Confirmed",
    "receive_status": "Pending",
    "payment_mode": "Internal Wallet",
    "receive_mode": "Internal Wallet"
}

دریافت فهرست ارزهای تبدیل سریع

GET/v1/rapid/get-currency

دریافت نرخ رزرو

هدرها:

کلید	مقدار
Accept	application/json
api-key	کلید API شما

پارامترها:

کلید	مقدار	توضیحات
timestamp	MILLISECOND	مقداری که از API دریافت زمان سرور گرفته‌اید
receive_window	INT	حداکثر 20000.

[
    {
        "currency_code": "BTC",
        "min_amount_internal": "0.00010000",
        "max_amount_internal": "12.00000000",
        "min_amount_external": "0.0001000000",
        "max_amount_external": "1.0000000000",
        "commission_type": "Fixed",
        "commission_value": "0.00000000",
        "network": [
            {
                "network": "bitcoin",
                "protocol": "btc",
                "symbol": "BTC",
                "address_regex": "bc1[qQp][a-zA-HJ-NP-Z0-9]{14,72}",  
                "withdraw_type": "Percentage",
                "withdraw_fees": "1.00000000"
            }
        ]
    },
    {
        "currency_code": "USDT",
        "min_amount_internal": "2.00000000",
        "max_amount_internal": "200000.00000000",
        "min_amount_external": "3.0000000000",
        "max_amount_external": "100000.0000000000",
        "commission_type": "Percentage",
        "commission_value": "2.00000000",
        "network": [
            {
                "network": "tron",
                "protocol": "TRC20",
                "symbol": "USDT_TRON",
                "address_regex": "T[a-zA-Z1-9]{33}",
                "withdraw_type": "Percentage",
                "withdraw_fees": "1.00000000"
            },
            {
                "network": "ethereum",
                "protocol": "ERC20",
                "symbol": "USDT",
                "address_regex": "^0x[a-fA-F0-9]{40}$",
                "withdraw_type": "Percentage",
                "withdraw_fees": "1.00000000"
            },
            {
                "network": "Polygon",
                "protocol": "ERC20",
                "symbol": "USDT_MATIC",
                "address_regex": "^0x[a-fA-F0-9]{40}$",
                "withdraw_type": "Percentage",
                "withdraw_fees": "2.00000000"
            }
        ]
    },
]

دریافت کارمزد هر ارز

GET/v1/rapid/get-fees

دریافت نرخ رزرو

هدرها:

کلید	مقدار
Accept	application/json
api-key	کلید API شما

پارامترها:

کلید	مقدار	توضیحات
timestamp	MILLISECOND	مقداری که از API دریافت زمان سرور گرفته‌اید
receive_window	INT	حداکثر 20000.

{
    "spot": [
        {
            "pair": "ETH/BTC",
            "maker_fee": 0.1,
            "taker_fee": 0.1
        },
        {
            "pair": "BTC/USDT",
            "maker_fee": 0.1,
            "taker_fee": 0.1
        },
    ],
    "Rapid": [
        {
            "currency_code": "BTC",
            "commission": "0.10000000 %"   
        },
        {
            "currency_code": "ETH",
            "commission": "0.10000000 %"
        },
        {
            "currency_code": "USDT",
            "commission": "0.10000000 %"
        },
        {
            "currency_code": "IRR",
            "commission": "0.10000000 %"
        },
    ]
}

دریافت نرخ میانگین وزنی

POST/v1/rapid/get-rapid-currency-rate

دریافت نرخ رزرو جفت‌ارز

هدرها:

کلید	مقدار
Accept	application/json
api-key	کلید API شما

پارامترها:

کلید	مقدار	توضیحات
timestamp	MILLISECOND	مقداری که از API دریافت زمان سرور گرفته‌اید
receive_window	INT	حداکثر 20000.
type	STRING	مقدار باید BUY یا SELL باشد.
pair	STRING	نام جفت‌ارز را با قالب BTC/USDT وارد کنید.
amount	INT	مقدار ارزی که می‌خواهید بخرید یا بفروشید.
signature	STRING	"type:amount:pair"

{
    "rate": 42956.0407708915
}

دریافت فهرست همه تراکنش‌های تبدیل سریع

POST/v1/rapid/get-transaction-list

دریافت همه تراکنش‌های تبدیل سریع

هدرها:

کلید	مقدار
Accept	application/json
api-key	کلید API شما

پارامترها:

کلید	مقدار	توضیحات
timestamp	MILLISECOND	مقداری که از API دریافت زمان سرور گرفته‌اید
receive_window	INT	حداکثر 20000.
page	INT	حداکثر 10.

{
    "message": "Transaction List receive successfully",
    "total_transaction_count": 1,
    "transaction_list": [
        {
            "from_currency_id": 2,
            "to_currency_id": 3,
            "send_currency_network": null,
            "receive_currency_network": null,
            "send_amount": "0.01000000",
            "receive_amount": "39.16742000",
            "withdraw_fee": "1.00000000",
            "commission_fee": "0.39563049",
            "deposit_address": null,
            "deposite_destination_tag": null,
            "deposite_memo": null,
            "receive_address": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
            "receiver_memo": "",
            "transaction_id": "xxxxxxxxxxxxxxx",
            "rate": "4056.30492000",
            "payment_status": "Pending",
            "receive_status": "Pending",
            "payment_mode": "External Wallet",
            "receive_mode": "External Wallet"
        }
    ]
}

API کیف پول معاملاتی

دریافت موجودی کیف پول معاملاتی

GET/v1/check-user-trade-balance

دریافت نرخ رزرو

هدرها:

کلید	مقدار
Accept	application/json
api-key	کلید API شما

پارامترها:

کلید	مقدار	توضیحات
symbol	STRING	کد ارز مانند BTC
timestamp	MILLISECOND	مقداری که از API دریافت زمان سرور گرفته‌اید
receive_window	INT	حداکثر 20000.
signature	STRING	ترتیب مقادیر باید به این صورت باشد: "symbol"

{
    "balance": xxx
}

انتقال موجودی کیف پول

POST/v1/transfer-wallet-main-trade

انتقال موجودی میان کیف پول اصلی و کیف پول معاملاتی

هدرها:

کلید	مقدار
Accept	application/json
api-key	کلید API شما

پارامترها:

کلید	مقدار	توضیحات
currency_code	STRING	کد ارز مانند BTC
from	STRING	مقدار باید spot یا trade باشد
to	STRING	مقدار باید spot یا trade باشد
amount	Float	مقدار قابل انتقال میان کیف پول‌ها
timestamp	MILLISECOND	مقداری که از API دریافت زمان سرور گرفته‌اید
receive_window	INT	حداکثر 20000.
signature	STRING	ترتیب مقادیر باید به این صورت باشد: "currency_code:from:to:amount"

{
    "message": "Amount transfer from main wallet to trade wallet"
}

مدیریت آدرس‌ها

دریافت فهرست آدرس‌های ذخیره‌شده

GET/v1/address-managment/list-address

دریافت همه آدرس‌های ذخیره‌شده

هدرها:

کلید	مقدار
Accept	application/json
api-key	کلید API شما

پارامترها:

کلید	مقدار	توضیحات
timestamp	MILLISECOND	مقداری که از API دریافت زمان سرور گرفته‌اید
receive_window	INT	حداکثر 20000.

[
    {
        "currency_code": "USDT",
        "label": "save address 1",  
        "address": "address1",
        "network": "TRC20",
        "memo": null
    },
    {
        "currency_code": "BTC",
        "label": "save address 2",
        "address": "address2",
        "network": null,
        "memo": null
    },
]

افزودن آدرس

POST/v1/address-managment/add-address

افزودن آدرس به بخش مدیریت آدرس‌ها

هدرها:

کلید	مقدار
Accept	application/json
api-key	کلید API شما

پارامترها:

کلید	مقدار	توضیحات
currency_code	STRING	کد ارز مانند BTC
label	STRING	شناسه یکتایی که می‌خواهید به آدرس اختصاص دهید
address	STRING	آدرسی که می‌خواهید ذخیره کنید
network	STRING	مانند ERC20 یا TRC20
memo	STRING	اگر آدرس Memo دارد آن را وارد کنید؛ در غیر این صورت مقدار NULL را بفرستید
timestamp	MILLISECOND	مقداری که از API دریافت زمان سرور گرفته‌اید
receive_window	INT	حداکثر 20000.
signature	STRING	`will be in this sequence "currency_code:label:address". if network present then "currency_code:label:address:network". if memo present then "currency_code:label:address:memo". if network and memo both present then "currency_code:label:address:network:memo"`

{
    ""message": "The address has already been taken."  
}

اعتبارسنجی آدرس

POST/v1/address-managment/validate-address

اعتبارسنجی آدرس

هدرها:

کلید	مقدار
Accept	application/json
api-key	کلید API شما

پارامترها:

کلید	مقدار	توضیحات
currency_code	STRING	کد ارز مانند BTC
address	STRING	آدرسی که می‌خواهید اعتبارسنجی کنید
network	STRING	مانند ERC20 یا TRC20
timestamp	MILLISECOND	مقداری که از API دریافت زمان سرور گرفته‌اید
receive_window	INT	حداکثر 20000.
signature	STRING	`will be in this sequence "currency_code:address". if network present then "currency_code:address:network".`

{
    "is_farhad_deposit_address":true,  
    "message": "Address is valid",
    "status": 1
}

تاریخچه تغییرات

تغییرات نسخه

2024-08-15

اندپوینت‌های جدید بازار اسپات:
- GET /v1/get-recent-order برای دریافت فهرست سفارش‌های اخیر

2024-04-01

اندپوینت‌های جدید ارز الکترونیک:
- POST /v1/ecurrency/get-transaction-list برای دریافت فهرست تراکنش‌های ارز الکترونیک
- POST /v1/ecurrency/create-deposit-transactionبرای ایجاد تراکنش واریز ارز الکترونیک
- POST /v1/ecurrency/create-withdraw-transactionبرای ایجاد تراکنش برداشت ارز الکترونیک

2024-02-29

اندپوینت‌های جدید اسپات:
- GET /v1/get-user-all-order برای دریافت همه سفارش‌های اسپات کاربر

2024-01-05

اندپوینت‌های جدید تبدیل سریع:
- POST /v1/rapid/get-rapid-currency-rate برای دریافت نرخ جفت‌ارز در تبدیل سریع
- POST /v1/rapid/get-transaction-list دریافت فهرست همه تراکنش‌های تبدیل سریع

2023-09-01

اندپوینت‌های جدید برداشت:
- POST /v1/withdraw/create-fiat-transaction برای ایجاد تراکنش برداشت فیات
- POST /v1/withdraw/get-fiat-transaction-list برای دریافت فهرست تراکنش‌های برداشت فیات
- GET /v1/get-available-currency برای دریافت فهرست ارزهای موجود
- POST /v1/get-iban-account-details برای دریافت اطلاعات حساب شبا

2023-08-29

اندپوینت‌های جدید مدیریت آدرس:
- POST /v1/address-managment/add-address برای افزودن آدرس جدید
- GET /v1/address-managment/list-address برای دریافت همه آدرس‌های ذخیره‌شده
- POST /v1/address-managment/validate-address برای اعتبارسنجی آدرس

2023-08-02

اندپوینت‌های جدید کیف پول معاملاتی:
- GET /v1/check-user-trade-balance برای دریافت موجودی معاملاتی کاربر
- POST /v1/transfer-wallet-main-trade برای انتقال موجودی میان کیف پول اصلی و کیف پول معاملاتی

2023-06-06

اندپوینت‌های جدید واریز، برداشت و تبدیل سریع:
- POST /v1/generate-deposit-wallet-address برای ساخت آدرس کیف پول واریز
- POST /v1/get-deposit-transaction-list برای دریافت فهرست تراکنش‌های واریز
- POST /v1/get-withdraw-transaction-list برای دریافت فهرست تراکنش‌های برداشت
- POST /v1/create-withdraw-transaction برای ایجاد تراکنش برداشت
- POST /v1/rapid/get-reserve برای دریافت نرخ رزرو
- POST /v1/rapid/create-trade برای ایجاد تراکنش تبدیل سریع
- GET /v1/rapid/transaction-detail/transaction_id برای دریافت تراکنش تبدیل سریع
- GET /v1/rapid/get-currency برای دریافت فهرست ارزهای تبدیل سریع
- GET /v1/rapid/get-fees برای دریافت کارمزد هر ارز

2021-08-20

اندپوینت‌های جدید معاملات اسپات:
- GET /get-timestamp برای دریافت زمان سرور
- POST /v1/trade-bot برای ثبت سفارش خرید و فروش اسپات
- GET /v1/get-open-buy-sell-order دریافت همه معاملات خرید و فروش فعال
- GET /v1/get-user-open-order دریافت همه معاملات خرید و فروش فعال کاربر
- GET /v1/cancel-user-trade لغو معامله خرید یا فروش فعال کاربر
- GET /v1/cancel-bulk-order لغو گروهی معاملات خرید و فروش فعال کاربر
- GET /v1/check-user-balance بررسی موجودی کاربر برای یک ارز مشخص
- GET /v1/get-market-price دریافت قیمت بازار برای یک یا همه جفت‌ارزها

مقدمه

راه‌اندازی کلید API

محدودیت‌های کلید API

فعال‌سازی حساب‌ها

کالکشن‌های Postman

تماس با ما

اطلاعات عمومی

اطلاعات عمومی API

کدهای پاسخ HTTP

کدها و پیام‌های خطا

اطلاعات عمومی اندپوینت‌ها

امنیت اندپوینت‌های SIGNED (TRADE، USER_DATA و MARGIN)

امنیت زمانی

اطلاعات بازار اسپات

API زمان سرور

API معامله خرید و فروش

API فهرست همه معاملات خرید و فروش فعال

API فهرست همه معاملات خرید و فروش فعال کاربر

API لغو معامله خرید یا فروش باز

API لغو گروهی معاملات خرید و فروش باز

موجودی یک ارز

دریافت قیمت بازار

تاریخچه سفارش‌های اسپات

دریافت سفارش‌های اخیر

واریز و برداشت

کد وضعیت تراکنش واریز و برداشت رمزارز

دریافت فهرست ارزهای موجود

دریافت فهرست واریزهای رمزارزی

دریافت فهرست برداشت‌های رمزارزی

ایجاد تراکنش برداشت رمزارز

ساخت آدرس کیف پول واریز

دریافت اطلاعات حساب شبا

دریافت فهرست برداشت‌های فیات

ایجاد تراکنش برداشت فیات

دریافت فهرست تراکنش‌های ارز الکترونیک

ایجاد تراکنش واریز ارز الکترونیک

ایجاد تراکنش برداشت ارز الکترونیک

API تبدیل سریع

دریافت نرخ رزرو

ایجاد معامله تبدیل سریع

دریافت جزئیات تراکنش تبدیل سریع

دریافت فهرست ارزهای تبدیل سریع

دریافت کارمزد هر ارز

دریافت نرخ میانگین وزنی

دریافت فهرست همه تراکنش‌های تبدیل سریع

API کیف پول معاملاتی

دریافت موجودی کیف پول معاملاتی

انتقال موجودی کیف پول

مدیریت آدرس‌ها

دریافت فهرست آدرس‌های ذخیره‌شده

افزودن آدرس

اعتبارسنجی آدرس

تاریخچه تغییرات

تغییرات نسخه

2024-08-15

2024-04-01

2024-02-29

2024-01-05

2023-09-01

2023-08-29

2023-08-02

2023-06-06

2021-08-20