مقدمه

به داکیومنت API تبدیل خوش آمدید.

برای استفاده از API میتوانید از ماژول پایتونی زیر استفاده نمایید:

امنیت

مکانیزم های امنیتی

نوع مکانیزم	ملزومات
TRADE	`api-key` و `signature`
NONE	-

برای API هایی که مکانیزم امنیتی آنها از نوع TRADE باشد نیاز است تا Header یی با نام X-MBX-APIKEY ارسال شود که مقدار آن API Key دریافت شده از سایت میباشد , همچنین لازم است تا پارامترهای ارسالی با کلید api-secret دریافت شده از سایت, رمز شده و تحت عنوان signature در پارامترها ارسال شود.
برای API هایی که مکانیزم امنیتی آنها از نوع NONE باشد نیاز به ارسال هیچ پارامتر اضافه تری نیست.

احراز هویت

در API هایی که دارای مکانیزم امنیتی TRADE باشند , برای احراز هویت لازم است تا api-key و api-secret از سایت دریافت شده و به صورتی که در زیر توضیح داده میشود ارسال شود.

از طریق این آدرس اقدام به دریافت API Key کنید.

سپس لازم هست تا api-key دریافت شده را به عنوان header درخواست خود به صورت زیر قرار دهید:

X-MBX-APIKEY: your_api_key

شما باید api-key خود را به جای your_api_key بگذارید.

در ادامه لازم است تا پارامترهای ارسالی را با api-secret رمز کنید. برای این کار باید زمان ارسال درخواست را در فرمت timestamp به انتهای پارامترهای ارسالی اضافه کنید و کل این مجموعه را به ساختار Query String در آورده و آن را با کلید api-secret و با الگوریتم SHA256 و با مکانیزم HMAC رمز کنید. خروجی رشته ی رمز شده ی بالا را تحت عنوان signature به انتهای پارامترهای ارسالی اضافه کرده و درخواست خود را ارسال کنید.

منظور از Query String ساختاری شبیه به ساختار زیر است:
param_1=test_1&param_2=test_2&...&timestamp=1507725176595

توضیحات

وضعیت سفارشات

وضعیت سفارش	توضیحات
`New`	سفارش ایجاد شده است
`PARTIALLY_FILLED`	بخشی از سفارش انجام شده است
`FILLED`	سفارش به طور کامل انجام شده است
`CANCELED`	سفارش لغو شده است
`REJECTED`	سفارش رد شده است

نوع سفارشات

LIMIT
MARKET
STOP_LOSS_LIMIT

جهت سفارشات

BUY
SELL

وضعیت سفارش OCO

وضعیت سفارش	توضیحات
`EXECUTING`	سفارش ایجاد شده یا یکی از سفارشات زیرمجموعه در حال اجراست
`ALL_DONE`	سفارش تکمیل شده و سفارشات زیرمجموعه پایان یافته اند
`REJECT`	سفارش رد و یا لغو شده است

وضعیت سفارشات زیرمجموعه OCO

وضعیت سفارش	توضیحات
`RESPONSE`	یکی از سفارشات زیر مجموعه لغو و یا رد شده است
`EXEC_STARTED`	سفارشات زیرمجموعه فعال شده اند و یا وضعیتشان تغییر کرده است
`ALL_DONE`	سفارشات زیرمجموعه تکمیل شده و پایان یافته اند

معامله

ارسال سفارش

POST https://api1.tabdeal.org/api/v1/order [TRADE]

ارسال درخواست با کتابخانه پایتونی:

from tabdeal.spot import Spot
from tabdeal.enums import OrderSides, OrderTypes

client = Spot(api_key, api_secret)

order = client.new_order(
    symbol='BTCIRT',
    side=OrderSides.SELL,
    type=OrderTypes.MARKET,
    quantity=0.001
)

نمونه خروجی:

{
    "symbol": "BTCIRT",
    "tabdealSymbol": "BTC_IRT",
    "orderId": 139,
    "orderListId": -1,
    "clientOrderId": null,
    "transactTime": 1650126344421,
    "price": "0.00000000",
    "origQty": "0.00100000",
    "executedQty": "0.00100000",
    "cummulativeQuoteQty": "99999.99900000",
    "cumulativeQuoteQty": "99999.99900000",
    "status": "FILLED",
    "type": "MARKET",
    "side": "SELL",
    "stopPrice": "0.00000000",
    "updateTime": 1650126344546,
    "isWorking": false,
    "isStopOrderTriggered": false,
    "fills": [
        {
            "price": "99999999.00000000",
            "qty": "0.00100000",
            "commission": "399.99999600",
            "commissionAsset": "IRT",
            "tradeId": 4
        }
    ]
}

پارامتر ها:

پارامتر	الزامی	توضیحات
symbol	خیر	نام بازار
tabdealSymbol	خیر	نام بازار با `_`
side	بله	`SELL` یا `BUY`
type	بله	`MARKET` یا `LIMIT` یا `STOP_LOSS_LIMIT`
quantity	بله	تعداد خرید یا فروش
newClientOrderId	خیر	`id` سفارش که توسط کاربر تولید شده
price	خیر	قیمت خرید یا فروش
stopPrice	خیر	قیمت فعال شدن سفارش
timestamp	بله	زمان ارسال درخواست
signature	بله	رشته ی رمز شده

با تغییر type مربوط سفارش ملزومات سفارش تغییر میکند و ممکن است پارامترهای price یا stopPrice الزامی شوند.

ارسال symbol یا tabdealSymbol الزامی است. تفاوت این دو در علامت _ بین علامت ارزهاست.
در صورتی که type سفارش LIMIT باشد, ارسال price الزامی است.
در صورتی که type سفارش STOP_LOSS_LIMIT باشد, ارسال stopPrice الزامی است.
پارامتر newClientOrderId شناسه یکتا برای سفارش است و توسط کاربر تولید میشود که برای هر کاربر باید یکتا باشد.

جستجوی سفارش

GET https://api1.tabdeal.org/r/api/v1/order [TRADE]

ارسال درخواست با کتابخانه پایتونی:

from tabdeal.spot import Spot

client = Spot(api_key, api_secret)

order = client.get_order(
    symbol='BTC_IRT',
    order_id=140
)

نمونه خروجی:

{
    "symbol": "BTCIRT",
    "tabdealSymbol": "BTC_IRT",
    "orderId": 140,
    "orderListId": -1,
    "clientOrderId": null,
    "transactTime": 1650126546994,
    "price": "99999999.00000000",
    "origQty": "0.00200000",
    "executedQty": "0.00100000",
    "cummulativeQuoteQty": "99999.99900000",
    "cumulativeQuoteQty": "99999.99900000",
    "status": "PARTIALLY_FILLED",
    "type": "LIMIT",
    "side": "BUY",
    "stopPrice": "0.00000000",
    "updateTime": 1650126680079,
    "isWorking": true,
    "isStopOrderTriggered": false
}

پارامتر ها:

پارامتر	الزامی	توضیحات
symbol	خیر	نام بازار
tabdealSymbol	خیر	نام بازار با `_`
orderId	خیر	`id` سفارش
origClientOrderId	خیر	`id` سفارش که توسط کاربر تولید شده
timestamp	بله	زمان ارسال درخواست
signature	بله	رشته ی رمز شده

ارسال symbol یا tabdealSymbol الزامی است. تفاوت این دو در علامت _ بین علامت ارزهاست.
ارسال یکی از پارامترهای orderId یا origClientOrderId الزامی است.

سفارشات باز

GET https://api1.tabdeal.org/r/api/v1/openOrders [TRADE]

ارسال درخواست با کتابخانه پایتونی:

from tabdeal.spot import Spot

client = Spot(api_key, api_secret)

orders = client.get_open_orders(
    symbol='BTCIRT'
)

نمونه خروجی:

[
    {
        "symbol": "BTCIRT",
        "tabdealSymbol": "BTC_IRT",
        "orderId": 140,
        "orderListId": -1,
        "clientOrderId": null,
        "transactTime": 1650126546994,
        "price": "99999999.00000000",
        "origQty": "0.00200000",
        "executedQty": "0.00100000",
        "cummulativeQuoteQty": "0.00000000",
        "cumulativeQuoteQty": "0.00000000",
        "status": "PARTIALLY_FILLED",
        "type": "LIMIT",
        "side": "BUY",
        "stopPrice": "0.00000000",
        "updateTime": 1650126680079,
        "isWorking": true,
        "isStopOrderTriggered": false
    }
]

پارامتر ها:

پارامتر	الزامی	توضیحات
symbol	خیر	نام بازار
tabdealSymbol	خیر	نام بازار با `_`
timestamp	بله	زمان ارسال درخواست
signature	بله	رشته ی رمز شده

در صورتی که symbol یا tabdealSymbol را ارسال نکنید سفارشات باز تمام بازار ها را برمیگرداند.

لغو سفارش

DELETE https://api1.tabdeal.org/api/v1/order [TRADE]

ارسال درخواست با کتابخانه پایتونی:

from tabdeal.spot import Spot

client = Spot(api_key, api_secret)

order = client.cancel_order(
    symbol='BTC_IRT',
    order_id=143
)

نمونه خروجی:

{
    "symbol": "BTCIRT",
    "tabdealSymbol": "BTC_IRT",
    "orderId": 143,
    "orderListId": -1,
    "clientOrderId": null,
    "transactTime": 1650126665341,
    "price": "99999999.00000000",
    "origQty": "0.00300000",
    "executedQty": "0.00000000",
    "cummulativeQuoteQty": "0.00000000",
    "cumulativeQuoteQty": "0.00000000",
    "status": "CANCELED",
    "type": "LIMIT",
    "side": "BUY",
    "stopPrice": "0.00000000",
    "updateTime": 1650126730359,
    "isWorking": false,
    "isStopOrderTriggered": false
}

پارامتر ها:

پارامتر	الزامی	توضیحات
symbol	خیر	نام بازار
tabdealSymbol	خیر	نام بازار با `_`
orderId	خیر	`id` سفارش
origClientOrderId	خیر	`id` سفارش که توسط کاربر تولید شده
timestamp	بله	زمان ارسال درخواست
signature	بله	رشته ی رمز شده

ارسال symbol یا tabdealSymbol الزامی است. تفاوت این دو در علامت _ بین علامت ارزهاست.
ارسال یکی از پارامترهای orderId یا origClientOrderId الزامی است.

تمام سفارشات

GET https://api1.tabdeal.org/r/api/v1/allOrders [TRADE]

ارسال درخواست با کتابخانه پایتونی:

from tabdeal.spot import Spot

client = Spot(api_key, api_secret)

orders = client.get_orders(
    symbol='BTCIRT',
    start_time=1650126305575,
    end_time=1650126665350
)

نمونه خروجی:

[
    {
        "symbol": "BTCIRT",
        "tabdealSymbol": "BTC_IRT",
        "orderId": 143,
        "orderListId": -1,
        "clientOrderId": null,
        "transactTime": 1650126665341,
        "price": "99999999.00000000",
        "origQty": "0.00300000",
        "executedQty": "0.00000000",
        "cummulativeQuoteQty": "0.00000000",
        "cumulativeQuoteQty": "0.00000000",
        "status": "CANCELED",
        "type": "LIMIT",
        "side": "BUY",
        "stopPrice": "0.00000000",
        "updateTime": 1650126730359,
        "isWorking": false,
        "isStopOrderTriggered": false
    },
    {
        "symbol": "BTCIRT",
        "tabdealSymbol": "BTC_IRT",
        "orderId": 138,
        "orderListId": -1,
        "clientOrderId": null,
        "transactTime": 1650126305575,
        "price": "99999999.00000000",
        "origQty": "0.00100000",
        "executedQty": "0.00100000",
        "cummulativeQuoteQty": "99999.99900000",
        "cumulativeQuoteQty": "99999.99900000",
        "status": "FILLED",
        "type": "LIMIT",
        "side": "BUY",
        "stopPrice": "0.00000000",
        "updateTime": 1650126569260,
        "isWorking": false,
        "isStopOrderTriggered": false
    }
]

پارامتر ها:

پارامتر	الزامی	توضیحات
symbol	خیر	نام بازار
tabdealSymbol	خیر	نام بازار با `_`
startTime	خیر	سفارشاتی که بعد از این زمان ایجاد شده باشند به عنوان خروجی بازگردانده میشوند
endTime	خیر	سفارشاتی که قبل از این زمان ایجاد شده باشند به عنوان خروجی بازگردانده میشوند
limit	خیر	خروجی تنها به این تعداد بازگردانده میشود
timestamp	بله	زمان ارسال درخواست
signature	بله	رشته ی رمز شده

ارسال symbol یا tabdealSymbol الزامی است. تفاوت این دو در علامت _ بین علامت ارزهاست.
پارامتر limit حداکثر 1000 میتواند باشد.

لغو تمام سفارشات باز

DELETE https://api1.tabdeal.org/api/v1/openOrders [TRADE]

ارسال درخواست با کتابخانه پایتونی:

from tabdeal.spot import Spot

client = Spot(api_key, api_secret)

orders = client.cancel_open_orders(
    symbol='BTC_IRT'
)

نمونه خروجی:

[
    {
        "symbol": "BTCIRT",
        "tabdealSymbol": "BTC_IRT",
        "orderId": 145,
        "orderListId": -1,
        "clientOrderId": null,
        "transactTime": 1650126930817,
        "price": "99999999.00000000",
        "origQty": "0.00300000",
        "executedQty": "0.00100000",
        "cummulativeQuoteQty": "99999.99900000",
        "cumulativeQuoteQty": "99999.99900000",
        "status": "FILLED",
        "type": "LIMIT",
        "side": "BUY",
        "stopPrice": "0.00000000",
        "updateTime": 1650126954582,
        "isWorking": false,
        "isStopOrderTriggered": false
    }
]

پارامتر ها:

پارامتر	الزامی	توضیحات
symbol	خیر	نام بازار
tabdealSymbol	خیر	نام بازار با `_`
timestamp	بله	زمان ارسال درخواست
signature	بله	رشته ی رمز شده

ارسال symbol یا tabdealSymbol الزامی است. تفاوت این دو در علامت _ بین علامت ارزهاست.

ارسال سفارش OCO

POST https://api1.tabdeal.org/api/v1/order/oco [TRADE]

ارسال درخواست با کتابخانه پایتونی:

from tabdeal.spot import Spot
from tabdeal.enums import OrderSides

client = Spot(api_key, api_secret)

oco = client.new_oco_order(
    symbol='BTC_IRT',
    side=OrderSides.SELL,
    quantity=0.005,
    price=100100000,
    stop_price=99899999,
    stop_limit_price=99890000,
    list_client_order_id="oco_6",
    limit_client_order_id="limit_6",
    stop_client_order_id="stop_6"
)

نمونه خروجی:

{
    "orderListId": 20,
    "contingencyType": "OCO",
    "listStatusType": "EXEC_STARTED",
    "listOrderStatus": "EXECUTING",
    "listClientOrderId": "oco_6",
    "transactionTime": 1652161449338,
    "symbol": "BTCIRT",
    "tabdealSymbol": "BTC_IRT",
    "orders": [
        {
            "symbol": "BTCIRT",
            "tabdealSymbol": "BTC_IRT",
            "orderId": 159,
            "clientOrderId": "limit_6"
        },
        {
            "symbol": "BTCIRT",
            "tabdealSymbol": "BTC_IRT",
            "orderId": 226,
            "clientOrderId": "stop_6"
        }
    ],
    "orderReports": [
        {
            "symbol": "BTCIRT",
            "tabdealSymbol": "BTC_IRT",
            "orderId": 159,
            "orderListId": 20,
            "clientOrderId": "limit_6",
            "transactTime": 1652161449593,
            "price": "100100000.00000000",
            "origQty": "0.00500000",
            "executedQty": "0.00000000",
            "cummulativeQuoteQty": "0.00000000",
            "cumulativeQuoteQty": "0.00000000",
            "status": "NEW",
            "type": "LIMIT",
            "side": "SELL",
            "stopPrice": "0.00000000",
            "updateTime": 1652161449905,
            "isWorking": true,
            "isStopOrderTriggered": false
        },
        {
            "symbol": "BTCIRT",
            "tabdealSymbol": "BTC_IRT",
            "orderId": 226,
            "orderListId": 20,
            "clientOrderId": "stop_6",
            "transactTime": 1652161450753,
            "price": "99890000.00000000",
            "origQty": "0.00500000",
            "executedQty": "0.00000000",
            "cummulativeQuoteQty": "0.00000000",
            "cumulativeQuoteQty": "0.00000000",
            "status": "NEW",
            "type": "STOP_LOSS_LIMIT",
            "side": "SELL",
            "stopPrice": "99899999.00000000",
            "updateTime": 1652161450753,
            "isWorking": true,
            "isStopOrderTriggered": false
        }
    ]
}

پارامتر ها:

پارامتر	الزامی	توضیحات
symbol	خیر	نام بازار
tabdealSymbol	خیر	نام بازار با `_`
side	بله	`SELL` یا `BUY`
quantity	بله	تعداد خرید یا فروش
price	بله	قیمت سفارش limit
stopPrice	بله	قیمت فعالسازی سفارش stop
stopLimitPrice	بله	قیمت سفارش stop
listClientOrderId	خیر	`id` سفارش oco که توسط کاربر تولید شده
limitClientOrderId	خیر	`id` سفارش limit که توسط کاربر تولید شده
stopClientOrderId	خیر	`id` سفارش stop که توسط کاربر تولید شده
timestamp	بله	زمان ارسال درخواست
signature	بله	رشته ی رمز شده

ارسال symbol یا tabdealSymbol الزامی است. تفاوت این دو در علامت _ بین علامت ارزهاست.
پارامترهای listClientOrderId و limitClientOrderId و stopClientOrderId شناسه های یکتا برای سفارشات هستند و توسط کاربر تولید میشوند که برای هر کاربر باید یکتا باشند.

جستجوی سفارش OCO

GET https://api1.tabdeal.org/r/api/v1/orderList [TRADE]

ارسال درخواست با کتابخانه پایتونی:

from tabdeal.spot import Spot

client = Spot(api_key, api_secret)

oco = client.get_oco_order(
    oco_id=19
)

نمونه خروجی:

{
    "orderListId": 19,
    "contingencyType": "OCO",
    "listStatusType": "EXEC_STARTED",
    "listOrderStatus": "EXECUTING",
    "listClientOrderId": null,
    "transactionTime": 1651489273803,
    "symbol": "BTCIRT",
    "orders": [
        {
            "symbol": "BTCIRT",
            "tabdealSymbol": "BTC_IRT",
            "orderId": 142,
            "clientOrderId": null
        },
        {
            "symbol": "BTCIRT",
            "tabdealSymbol": "BTC_IRT",
            "orderId": 225,
            "clientOrderId": null
        }
    ]
}

پارامتر ها:

پارامتر	الزامی	توضیحات
orderListId	خیر	`id` سفارش
origClientOrderId	خیر	`id` سفارش که توسط کاربر تولید شده
timestamp	بله	زمان ارسال درخواست
signature	بله	رشته ی رمز شده

ارسال یکی از پارامترهای orderListId یا origClientOrderId الزامی است.

سفارشات باز OCO

GET https://api1.tabdeal.org/r/api/v1/openOrderList [TRADE]

ارسال درخواست با کتابخانه پایتونی:

from tabdeal.spot import Spot

client = Spot(api_key, api_secret)

open_oco = client.get_oco_open_orders()

نمونه خروجی:

[
    {
        "orderListId": 19,
        "contingencyType": "OCO",
        "listStatusType": "EXEC_STARTED",
        "listOrderStatus": "EXECUTING",
        "listClientOrderId": null,
        "transactionTime": 1651489273803,
        "symbol": "BTCIRT",
        "orders": [
            {
                "symbol": "BTCIRT",
                "tabdealSymbol": "BTC_IRT",
                "orderId": 142,
                "clientOrderId": null
            },
            {
                "symbol": "BTCIRT",
                "tabdealSymbol": "BTC_IRT",
                "orderId": 225,
                "clientOrderId": null
            }
        ]
    },
    {
        "orderListId": 22,
        "contingencyType": "OCO",
        "listStatusType": "EXEC_STARTED",
        "listOrderStatus": "EXECUTING",
        "listClientOrderId": null,
        "transactionTime": 1652162579757,
        "symbol": "BTCIRT",
        "orders": [
            {
                "symbol": "BTCIRT",
                "tabdealSymbol": "BTC_IRT",
                "orderId": 161,
                "clientOrderId": null
            },
            {
                "symbol": "BTCIRT",
                "tabdealSymbol": "BTC_IRT",
                "orderId": 228,
                "clientOrderId": null
            }
        ]
    }
]

پارامتر ها:

پارامتر	الزامی	توضیحات
timestamp	بله	زمان ارسال درخواست
signature	بله	رشته ی رمز شده

لغو سفارش OCO

DELETE https://api1.tabdeal.org/api/v1/orderList [TRADE]

ارسال درخواست با کتابخانه پایتونی:

from tabdeal.spot import Spot

client = Spot(api_key, api_secret)

order = client.cancel_oco_order(
    symbol='BTC_IRT',
    oco_id=19
)

نمونه خروجی:

{
    "orderListId": 19,
    "contingencyType": "OCO",
    "listStatusType": "ALL_DONE",
    "listOrderStatus": "ALL_DONE",
    "listClientOrderId": null,
    "transactionTime": 1651489273803,
    "symbol": "BTCIRT",
    "tabdealSymbol": "BTC_IRT",
    "orders": [
        {
            "symbol": "BTCIRT",
            "tabdealSymbol": "BTC_IRT",
            "orderId": 142,
            "clientOrderId": null
        },
        {
            "symbol": "BTCIRT",
            "tabdealSymbol": "BTC_IRT",
            "orderId": 225,
            "clientOrderId": null
        }
    ],
    "orderReports": [
        {
            "symbol": "BTCIRT",
            "tabdealSymbol": "BTC_IRT",
            "orderId": 142,
            "orderListId": 19,
            "clientOrderId": null,
            "transactTime": 1651489273833,
            "price": "100100000.00000000",
            "origQty": "0.00500000",
            "executedQty": "0.00000000",
            "cummulativeQuoteQty": "0.00000000",
            "cumulativeQuoteQty": "0.00000000",
            "status": "CANCELED",
            "type": "LIMIT",
            "side": "SELL",
            "stopPrice": "0.00000000",
            "updateTime": 1652162973131,
            "isWorking": false,
            "isStopOrderTriggered": false
        },
        {
            "symbol": "BTCIRT",
            "tabdealSymbol": "BTC_IRT",
            "orderId": 225,
            "orderListId": 19,
            "clientOrderId": null,
            "transactTime": 1651489275437,
            "price": "99890000.00000000",
            "origQty": "0.00500000",
            "executedQty": "0.00000000",
            "cummulativeQuoteQty": "0.00000000",
            "cumulativeQuoteQty": "0.00000000",
            "status": "CANCELED",
            "type": "STOP_LOSS_LIMIT",
            "side": "SELL",
            "stopPrice": "99899999.00000000",
            "updateTime": 1652162973140,
            "isWorking": false,
            "isStopOrderTriggered": false
        }
    ]
}

پارامتر ها:

پارامتر	الزامی	توضیحات
symbol	خیر	نام بازار
tabdealSymbol	خیر	نام بازار با `_`
orderListId	خیر	`id` سفارش
listClientOrderId	خیر	`id` سفارش که توسط کاربر تولید شده
timestamp	بله	زمان ارسال درخواست
signature	بله	رشته ی رمز شده

ارسال symbol یا tabdealSymbol الزامی است. تفاوت این دو در علامت _ بین علامت ارزهاست.
ارسال یکی از پارامترهای orderListId یا listClientOrderId الزامی است.

تمام سفارشات OCO

GET https://api1.tabdeal.org/r/api/v1/allOrderList [TRADE]

ارسال درخواست با کتابخانه پایتونی:

from tabdeal.spot import Spot

client = Spot(api_key, api_secret)

all_oco = client.get_oco_orders(
    start_time=1650962658352,
    end_time=1652161449338,
    limit=2
)

نمونه خروجی:

[
    {
        "orderListId": 19,
        "contingencyType": "OCO",
        "listStatusType": "EXEC_STARTED",
        "listOrderStatus": "EXECUTING",
        "listClientOrderId": null,
        "transactionTime": 1651489273803,
        "symbol": "BTCIRT",
        "orders": [
            {
                "symbol": "BTCIRT",
                "tabdealSymbol": "BTC_IRT",
                "orderId": 142,
                "clientOrderId": null
            },
            {
                "symbol": "BTCIRT",
                "tabdealSymbol": "BTC_IRT",
                "orderId": 225,
                "clientOrderId": null
            }
        ]
    },
    {
        "orderListId": 18,
        "contingencyType": "OCO",
        "listStatusType": "ALL_DONE",
        "listOrderStatus": "ALL_DONE",
        "listClientOrderId": "oco_5",
        "transactionTime": 1650963634241,
        "symbol": "BTCIRT",
        "orders": [
            {
                "symbol": "BTCIRT",
                "tabdealSymbol": "BTC_IRT",
                "orderId": 141,
                "clientOrderId": null
            },
            {
                "symbol": "BTCIRT",
                "tabdealSymbol": "BTC_IRT",
                "orderId": 224,
                "clientOrderId": null
            }
        ]
    }
]

پارامتر ها:

پارامتر	الزامی	توضیحات
startTime	خیر	سفارشاتی که بعد از این زمان ایجاد شده باشند به عنوان خروجی بازگردانده میشوند
endTime	خیر	سفارشاتی که قبل از این زمان ایجاد شده باشند به عنوان خروجی بازگردانده میشوند
limit	خیر	خروجی تنها به این تعداد بازگردانده میشود
timestamp	بله	زمان ارسال درخواست
signature	بله	رشته ی رمز شده

پارامتر limit حداکثر 1000 میتواند باشد.

معاملات من

GET https://api1.tabdeal.org/r/api/v1/myTrades [TRADE]

ارسال درخواست با کتابخانه پایتونی:

from tabdeal.spot import Spot

client = Spot(api_key, api_secret)

trades = client.my_trades(
    symbol='BTC_IRT',
    start_time=1653210673316, 
    end_time=1653222331419,
    limit=2
)

نمونه خروجی:

[
    {
        "symbol": "BTCIRT",
        "tabdealSymbol": "BTC_IRT",
        "id": 36,
        "orderId": 1140,
        "price": "99900500.00000000",
        "qty": "0.00500000",
        "quoteQty": "0.00498000",
        "commission": "1998.01000000",
        "commissionAsset": "IRT",
        "time": 1653211038472,
        "isBuyer": false,
        "isMaker": true
    },
    {
        "symbol": "BTCIRT",
        "tabdealSymbol": "BTC_IRT",
        "id": 35,
        "orderId": 1137,
        "price": "99900500.00000000",
        "qty": "0.00500000",
        "quoteQty": "0.00498000",
        "commission": "1998.01000000",
        "commissionAsset": "IRT",
        "time": 1653210886838,
        "isBuyer": false,
        "isMaker": true
    }
]

پارامتر ها:

پارامتر	الزامی	توضیحات
symbol	خیر	نام بازار
tabdealSymbol	خیر	نام بازار با `_`
startTime	خیر	معاملاتی که بعد از این زمان ایجاد شده باشند به عنوان خروجی بازگردانده میشوند
endTime	خیر	معاملاتی که قبل از این زمان ایجاد شده باشند به عنوان خروجی بازگردانده میشوند
limit	خیر	خروجی تنها به این تعداد بازگردانده میشود
timestamp	بله	زمان ارسال درخواست
signature	بله	رشته ی رمز شده

ارسال symbol یا tabdealSymbol الزامی است. تفاوت این دو در علامت _ بین علامت ارزهاست.
پارامتر limit حداکثر 1000 میتواند باشد.

بازار

لیست سفارشات

GET https://api1.tabdeal.org/r/api/v1/depth [NONE]

ارسال درخواست با کتابخانه پایتونی:

from tabdeal.spot import Spot

client = Spot(api_key, api_secret)

order_book = client.depth(
    symbol='BTCUSDT',
    limit=1
)

نمونه خروجی:

{
  "bids": [
    [
      "39792.23000000",     // PRICE
      "8.27169000"          // QUANTITY
    ],
    [
      "39792.18000000",     // PRICE
      "0.33006000"          // QUANTITY
    ]
  ],
  "asks": [
    [
      "39792.24000000",     // PRICE
      "1.27040000"          // QUANTITY
    ],
    [
      "39792.27000000",     // PRICE
      "0.00850000"          // QUANTITY
    ]
  ]
}

پارامتر ها:

پارامتر	الزامی	توضیحات
symbol	خیر	نام بازار
tabdealSymbol	خیر	نام بازار با `_`
limit	خیر	خروجی تنها به این تعداد بازگردانده میشود

ارسال symbol یا tabdealSymbol الزامی است. تفاوت این دو در علامت _ بین علامت ارزهاست.
پارامتر limit حداکثر 5000 میتواند باشد.

لیست معاملات

GET https://api1.tabdeal.org/r/api/v1/trades [NONE]

ارسال درخواست با کتابخانه پایتونی:

from tabdeal.spot import Spot

client = Spot(api_key, api_secret)

trades = client.trades(
    symbol='BTC_IRT',
    limit=2
)

نمونه خروجی:

[
    {
        "id": 18,
        "price": "100000000.00000000",
        "qty": "0.02500000",
        "quoteQty": "0.02490000",
        "time": 1648990888735,
        "isBuyerMaker": false
    },
    {
        "id": 17,
        "price": "99999999.00000000",
        "qty": "0.02500000",
        "quoteQty": "2489999.97510000",
        "time": 1648990780492,
        "isBuyerMaker": true
    }
]

پارامتر ها:

پارامتر	الزامی	توضیحات
symbol	خیر	نام بازار
tabdealSymbol	خیر	نام بازار با `_`
limit	خیر	خروجی تنها به این تعداد بازگردانده میشود

ارسال symbol یا tabdealSymbol الزامی است. تفاوت این دو در علامت _ بین علامت ارزهاست.
پارامتر limit حداکثر 1000 میتواند باشد.

لیست بازارها

GET https://api1.tabdeal.org/r/api/v1/exchangeInfo [NONE]

ارسال درخواست با کتابخانه پایتونی:

from tabdeal.spot import Spot

client = Spot(api_key, api_secret)

market = client.exchange_info(
    symbol='BTC_IRT',
    limit=2
)

market = client.exchange_info(
    symbol='MANAUSDT',
    limit=2
)

markets = client.exchange_info(
    symbols=['BTCIRT', 'MANAUSDT'],
    limit=2
)

نمونه خروجی:

[
    {
        "symbol": "BTCIRT",
        "tabdealSymbol": "BTC_IRT",
        "status": "TRADING",
        "baseAsset": "BTC",
        "baseAssetPrecision": "8",
        "quoteAsset": "IRT",
        "quoteAssetPrecision": "8",
        "baseCommissionPrecision": "8",
        "quoteCommissionPrecision": "8",
        "orderTypes": [
            "LIMIT",
            "STOP_LOSS_LIMIT",
            "MARKET"
        ],
        "icebergAllowed": false,
        "ocoAllowed": true,
        "quoteOrderQtyMarketAllowed": false,
        "allowTrailingStop": false,
        "isSpotTradingAllowed": true,
        "isMarginTradingAllowed": false,
        "filters": [
            {
                "filterType": "PRICE_FILTER",
                "minPrice": "300.00000000",
                "maxPrice": "30000000000.00000000",
                "tickSize": "1.00000000"
            },
            {
                "filterType": "PERCENT_PRICE",
                "multiplierUp": 5.0,
                "multiplierDown": 0.2,
                "avgPriceMins": 5
            },
            {
                "filterType": "LOT_SIZE",
                "minQty": "0.00005000",
                "stepSize": "0.00000001"
            },
            {
                "filterType": "MIN_NOTIONAL",
                "minNotional": "99000.00000000",
                "applyToMarket": false,
                "avgPriceMins": 5
            },
            {
                "filterType": "MARKET_LOT_SIZE",
                "minQty": "0.00005000",
                "maxQty": "0.99250018",
                "stepSize": "0.00000001"
            }
        ],
        "permissions": [
            "SPOT"
        ]
    }
]

پارامتر ها:

پارامتر	الزامی	توضیحات
symbol	خیر	نام بازار
symbols	خیر	نام بازارها
tabdealSymbol	خیر	نام بازار با `_`
tabdealSymbols	خیر	نام بازارها با `_`
limit	خیر	خروجی تنها به این تعداد بازگردانده میشود

پارامتر limit حداکثر 1000 میتواند باشد.
در صورتی که هیچکدام از فیلدهای symbol یا symbols یا tabdealSymbol یا tabdealSymbols ارسال نشود. تمامی بازارها بازگردانده میشود.

کیف پول

لیست دارایی ها

GET https://api1.tabdeal.org/r/api/v1/asset/get-funding-asset [TRADE]

ارسال درخواست با کتابخانه پایتونی:

from tabdeal.spot import Spot

client = Spot(api_key, api_secret)

order = client.funding_wallet(
    asset='BTC',
)

نمونه خروجی:

{
    "asset": "BTC",
    "free": "1.97427700",
    "freeze": "0.00634300"
}

پارامتر ها:

پارامتر	الزامی	توضیحات
asset	خیر	نماد مربوط به دارایی مورد نظر
timestamp	بله	زمان ارسال درخواست
signature	بله	رشته ی رمز شده

در صورتی که پارامتر asset ارسال نشود لیست تمام دارایی ها بازگردانده میشود.