Comment on page
Contract
Endpoints under Public section can be accessed freely without requiring any API-key or signatures
get
https://futuresopenapi.tokex.pro/fapi/v1/ping
Test Connectivity
get
https://futuresopenapi.tokex.pro/fapi/v1/time
Check Server Time
Response
name | type | example | description |
serverTime | long | 1607702400000 | server timestamp |
timezone | string | China standard time | server time zone |
get
https://futuresopenapi.tokex.pro/fapi/v1/contracts
symbol | number | E-BTC-USDT | Contract Name |
status | string | 1 | status（0：cannot trade，1：can trade |
type | number | S | contract type, E: perpetual contract, S: test contract, others are mixed contract |
side | number | 1 | Contract direction(backwards：0，1：forward) |
multiplier | string | 0.5 | Contract face value |
multiplierCoin | number | BTC | Contract face value unit |
pricePrecision | number | 4 | Precision of the price |
minOrderMoney | number | 10 | Minimum order volume |
minOrderVolume | number | 10 | Minimum order value |
maxMarketVolume | number | 100000 | Market price order maximum volume |
maxMarketMoney | number | 100000 | Market price order maximum value |
macLimitVolume | number | 100000 | Limit price order maximum volume |
maxValidOrder | number | 100000 | Maximum valid order quantity |
Market section can be accessed freely without requiring any API-key or signatures.
get
https://futuresopenapi.tokex.pro/fapi/v1/depth
Depth
name | type | example | description |
time | long | 1595563624731 | Current Timestamp (ms) |
bids | list | Look below | Order book purchase info |
asks | list | Look below | Order book selling info |
The fields bids and asks are lists of order book price level entries, sorted from best to worst.
name | type | example | description |
' ' | float | 131.1 | price level |
' ' | float | 2.3 | Total order quantity for this price level |
get
https://futuresopenapi.tokex.pro/fapi/v1/ticker
24 hrs ticker
Response
name | type | example | description |
time | long | 1595563624731 | Open time |
high | float | 9900 | Higher price |
low | float | 8800.34 | Lower price |
last | float | 8900 | Newest price |
vol | float | 4999 | Trade volume |
rose | string | +0.5 | Price variation |
get
https://futuresopenapi.tokex.pro/fapi/v1/index
Get index//marked price
get
https://futuresopenapi.tokex.pro/fapi/v1/klines
name | type | example | description |
idx | long | 1538728740000 | Start timestamp (ms） |
open | float | 36.00000 | Open price |
close | float | 33.00000 | Closing price |
high | float | 36.00000 | Max price |
low | float | 30.00000 | Min price |
vol | float | 2456.111 | Trade volume |
All interfaces under the transaction require signature and API-key verification
post
https://futuresopenapi.tokex.pro/fapi/v1/order
Order creation
Response:
name | type | example | description |
orderId | String | 256609229205684228 | Order ID |
post
https://futuresopenapi.tokex.pro/fapi/v1/conditionOrder
Condition order creation
post
https://openapi.tokex.pro/sapi/v1/cancel
Cancel order
get
https://futuresopenapi.tokex.pro/fapi/v1/order
Order details
name | type | example | description |
orderId | long | 150695552109032492 | Order ID（system generated |
contractName | string | E-BTC-USDT | Contract name |
price | float | 10.5 | Order price |
origQty | float | 10.5 | Order quantity |
executedQty | float | 20 | Order quantity |
avgPrice | float | 10.5 | Average transaction price |
symbol | string | BHTUSDT | Coin pair name |
status | string | NEW | Order status. Possible values are： NEW(new order，not filled)、PARTIALLY_FILLED（partially filled）、FILLED（fully filled）、CANCELLED（already cancelled）andREJECTED（order rejected） |
side | string | NEW | Order direction. Possible values can only be：BUY（buy long）and SELL（sell short） |
action | string | OPEN | OPEN / CLOSE |
transactTime | long | 1607702400000 | Order creation time |
| | | |
get
https://futuresopenapi.tokex.pro/fapi/v1/openOrders
name | type | example | description |
orderId | long | 150695552109032492 | Order ID（system generated） |
contractName | string | E-BTC-USDT | Contract name |
price | float | 4765.29 | Order price |
origQty | float | 1.01 | Order quantity |
executedQty | float | 1.01 | Filled orders quantity |
avgPrice | float | 4754.24 | Filled orders average price |
type | string | LIMIT | Order type. Possible values can only be: LIMIT(limit price) andMARKET（market price） |
side | string | BUY | Order direction. Possible values can only be： BUY（buy long）and SELL（sell short） |
status | string | NEW | Order status. Possible values are： NEW(new order，not filled)、PARTIALLY_FILLED（partially filled）、FILLED（fully filled）、CANCELLED（already cancelled）andREJECTED（order rejected） |
action | string | OPEN | OPEN / CLOSE |
transactTime | long | 1607702400000 | Order creation time, |
post
https://futuresopenapi.tokex.pro/fapi/v1/orderHistorical
order history
post
https://futuresopenapi.tokex.pro/fapi/v1/profitHistorical
get
https://futuresopenapi.tokex.pro/fapi/v1/myTrades
order record
name | type | example | description |
symbol | string | ETHBTC | Coin name(trade pair) |
tradeId | number | 28457 | Trade ID |
bidid | long | 150695552109032492 | Buyer order ID |
askId | long | 150695552109032493 | Seller order ID |
bidUserId | integer | 10024 | Buyer user ID |
askUserId | integer | 10025 | Seller user ID |
price | float | 4.01 | Filled price |
qty | float | 12 | Trade quantity |
amount | float | 5.38 | Filled amount |
time | number | 1499865549590 | Trade time stamp |
fee | number | 0.001 | Trading fees |
side | string | buy | Current order direction BUY purchase, SELL selling |
contractName | string | E-BTC-USDT | Contract name |
isMaker | boolean | true | is it maker? |
isBuyer | boolean | true | is it buyer? |
All interfaces under the account require signature and API-key verification
get
https://futuresopenapi.tokex.pro/fapi/v1/account
Account info
name | type | description |
account | [] | Balance collection |
account field:
name | type | example | description |
marginCoin | string | USDT | Margin coin |
accountNormal | float | 10.05 | Balance account |
accountLock | float | 10.07 | Margin frozen account |
partPositionNormal | float | 10.07 | Restricted position margin balance |
totalPositionNormal | float | 10.07 | Full position initial margin |
achievedAmount | float | 10.07 | Profit and losses occurred |
unrealizedAmount | float | 10.05 | Unfilled profit and losses |
totalMarginRate | float | 10.05 | Full position margin rate |
totalEquity | float | 10.07 | Full position equity |
partEquity | float | 10.07 | Restricted position equity |
totalCost | float | 10.07 | Full position costs |
sumMarginRate | float | 10.07 | All accounts margin rate |
positionVos | [] | | Position contract record |
positionVos field:name | type | example | description |
contractId | integer | 2 | Contract id |
contractName | string | E-BTC-USDT | Contract name |
contractSymbol | string | BTC-USDT | Contract coin pair |
positions | [] | | Position details |
positions field:name | type | example | description |
id | integer | 2 | Position id |
uid | integer | 10023 | User ID |
positionType | integer | 1 | Hold position type(1 full，2 restrictive) |
side | string | SELL | Hold position direction SELL sell long, BUY buy short |
volume | float | 1.05 | Hold quantity |
openPrice | float | 1.05 | Open position price |
avgPrice | float | 1.05 | Hold average price |
closePrice | float | 1.05 | Balancing average price |
leverageLevel | float | 1.05 | Leverage multiple |
holdAmount | float | 1.05 | Hold position margin |
closeVolume | float | 1.05 | Balanced quantity |
pendingCloseVolume | float | 1.05 | The number of pending closing orders |
realizedAmount | float | 1.05 | Profit and losses occurred |
historyRealizedAmount | float | 1.05 | Historic accumulated profit and losses |
tradeFee | float | 1.05 | Trading fees |
capitalFee | float | 1.05 | Capital costs |
closeProfit | float | 1.05 | Balancing profit and loss |
shareAmount | float | 1.05 | Amount to share |
freezeLock | integer | 0 | Position freeze status: 0 normal, 1 liquidation freeze, 2 delivery freeze |
status | integer | 0 | Position effectiveness，0 ineffective 1 effective |
ctime | time | | Creation time |
mtime | time | | Update time |
brokerid | integer | 1023 | Client id |
lockTime | time | | liquidation lock time |
marginRate | float | 1.05 | Margin rate |
reducePrice | float | 1.05 | Price reduction |
returnRate | float | 1.05 | Return rate (profit rate) |
unRealizedAmount | float | 1.05 | Unfilled profit and losses |
openRealizedAmount | float | 1.05 | Open position unfilled profit and losses |
positionBalance | float | 1.05 | Position value |
indexPrice | float | 1.05 | Newest marked price |
keepRate | float | 1.05 | Scaled minimum kept margin rate |
maxFeeRate | float | 1.05 | Balancing maximum fees rate |
| | | |
Last modified 11mo ago