API document
API Documentation for Aster Finance
https://github.com/asterdex/api-docs/blob/master/README.md
General API Information
Some endpoints will require an API Key. Please refer to this page
The base endpoint is: https://fapi.asterdex.com
All endpoints return either a JSON object or array.
Data is returned in ascending order. Oldest first, newest last.
All time and timestamp related fields are in milliseconds.
All data types adopt definition in JAVA.
HTTP Return Codes
HTTP
4XXreturn codes are used for for malformed requests; the issue is on the sender's side.HTTP
403return code is used when the WAF Limit (Web Application Firewall) has been violated.HTTP
429return code is used when breaking a request rate limit.HTTP
418return code is used when an IP has been auto-banned for continuing to send requests after receiving429codes.HTTP
5XXreturn codes are used for internal errors; the issue is on Aster's side.HTTP
503return code is used when the API successfully sent the message but not get a response within the timeout period. It is important to NOT treat this as a failure operation; the execution status is UNKNOWN and could have been a success.
Error Codes and Messages
Any endpoint can return an ERROR
The error payload is as follows:
Specific error codes and messages defined in Error Codes.
General Information on Endpoints
For
GETendpoints, parameters must be sent as aquery string.For
POST,PUT, andDELETEendpoints, the parameters may be sent as aquery stringor in therequest bodywith content typeapplication/x-www-form-urlencoded. You may mix parameters between both thequery stringandrequest bodyif you wish to do so.Parameters may be sent in any order.
If a parameter sent in both the
query stringandrequest body, thequery stringparameter will be used.
LIMITS
The
/fapi/v1/exchangeInforateLimitsarray contains objects related to the exchange'sRAW_REQUEST,REQUEST_WEIGHT, andORDERrate limits. These are further defined in theENUM definitionssection underRate limiters (rateLimitType).A
429will be returned when either rate limit is violated.
Aster Finance has the right to further tighten the rate limits on users with intent to attack.
IP Limits
Every request will contain
X-MBX-USED-WEIGHT-(intervalNum)(intervalLetter)in the response headers which has the current used weight for the IP for all request rate limiters defined.Each route has a
weightwhich determines for the number of requests each endpoint counts for. Heavier endpoints and endpoints that do operations on multiple symbols will have a heavierweight.When a 429 is received, it's your obligation as an API to back off and not spam the API.
Repeatedly violating rate limits and/or failing to back off after receiving 429s will result in an automated IP ban (HTTP status 418).
IP bans are tracked and scale in duration for repeat offenders, from 2 minutes to 3 days.
The limits on the API are based on the IPs, not the API keys.
It is strongly recommended to use websocket stream for getting data as much as possible, which can not only ensure the timeliness of the message, but also reduce the access restriction pressure caused by the request.
Order Rate Limits
Every order response will contain a
X-MBX-ORDER-COUNT-(intervalNum)(intervalLetter)header which has the current order count for the account for all order rate limiters defined.Rejected/unsuccessful orders are not guaranteed to have
X-MBX-ORDER-COUNT-**headers in the response.The order rate limit is counted against each account.
Endpoint Security Type
Each endpoint has a security type that determines the how you will interact with it.
API-keys are passed into the Rest API via the
X-MBX-APIKEYheader.API-keys and secret-keys are case sensitive.
API-keys can be configured to only access certain types of secure endpoints. For example, one API-key could be used for TRADE only, while another API-key can access everything except for TRADE routes.
By default, API-keys can access all secure routes.
NONE
Endpoint can be accessed freely.
TRADE
Endpoint requires sending a valid API-Key and signature.
USER_DATA
Endpoint requires sending a valid API-Key and signature.
USER_STREAM
Endpoint requires sending a valid API-Key.
MARKET_DATA
Endpoint requires sending a valid API-Key.
TRADEandUSER_DATAendpoints areSIGNEDendpoints.
SIGNED (TRADE and USER_DATA) Endpoint Security
SIGNEDendpoints require an additional parameter,signature, to be sent in thequery stringorrequest body.Endpoints use
HMAC SHA256signatures. TheHMAC SHA256 signatureis a keyedHMAC SHA256operation. Use yoursecretKeyas the key andtotalParamsas the value for the HMAC operation.The
signatureis not case sensitive.Please make sure the
signatureis the end part of yourquery stringorrequest body.totalParamsis defined as thequery stringconcatenated with therequest body.
Timing Security
A
SIGNEDendpoint also requires a parameter,timestamp, to be sent which should be the millisecond timestamp of when the request was created and sent.An additional parameter,
recvWindow, may be sent to specify the number of milliseconds aftertimestampthe request is valid for. IfrecvWindowis not sent, it defaults to 5000.
The logic is as follows:
Serious trading is about timing. Networks can be unstable and unreliable, which can lead to requests taking varying amounts of time to reach the servers. With recvWindow, you can specify that the request must be processed within a certain number of milliseconds or be rejected by the server.
It is recommended to use a small recvWindow of 5000 or less!
SIGNED Endpoint Examples for POST /fapi/v1/order
Here is a step-by-step example of how to send a vaild signed payload from the Linux command line using echo, openssl, and curl.
apiKey
dbefbc809e3e83c283a984c3a1459732ea7db1360ca80c5c2c8867408d28cc83
secretKey
2b5eb11e18796d12d88f13dc27dbbd02c2cc51ff7059765ed9821957d82bb4d9
symbol
BTCUSDT
side
BUY
type
LIMIT
timeInForce
GTC
quantity
1
price
9000
recvWindow
5000
timestamp
1591702613943
Example 1: As a query string
Example 1
HMAC SHA256 signature:
curl command:
queryString:
symbol=BTCUSDT &side=BUY &type=LIMIT &timeInForce=GTC &quantity=1 &price=9000 &recvWindow=5000 ×tamp=1591702613943
Example 2: As a request body
Example 2
HMAC SHA256 signature:
curl command:
requestBody:
symbol=BTCUSDT &side=BUY &type=LIMIT &timeInForce=GTC &quantity=1 &price=9000 &recvWindow=5000 ×tamp=1591702613943
Example 3: Mixed query string and request body
Example 3
HMAC SHA256 signature:
curl command:
queryString: symbol=BTCUSDT&side=BUY&type=LIMIT&timeInForce=GTC
requestBody: quantity=1&price=9000&recvWindow=5000×tamp= 1591702613943
Note that the signature is different in example 3. There is no & between "GTC" and "quantity=1".
Public Endpoints Info
Terminology
base assetrefers to the asset that is thequantityof a symbol.quote assetrefers to the asset that is thepriceof a symbol.
ENUM definitions
Symbol type:
FUTURE
Contract type (contractType):
PERPETUAL
Contract status(contractStatus，status):
PENDING_TRADING
TRADING
PRE_SETTLE
SETTLING
CLOSE
Order status (status):
NEW
PARTIALLY_FILLED
FILLED
CANCELED
REJECTED
EXPIRED
Order types (orderTypes, type):
LIMIT
MARKET
STOP
STOP_MARKET
TAKE_PROFIT
TAKE_PROFIT_MARKET
TRAILING_STOP_MARKET
Order side (side):
BUY
SELL
Position side (positionSide):
BOTH
LONG
SHORT
Time in force (timeInForce):
GTC - Good Till Cancel
IOC - Immediate or Cancel
FOK - Fill or Kill
GTX - Good Till Crossing (Post Only)
Working Type (workingType)
MARK_PRICE
CONTRACT_PRICE
Response Type (newOrderRespType)
ACK
RESULT
Kline/Candlestick chart intervals:
m -> minutes; h -> hours; d -> days; w -> weeks; M -> months
1m
3m
5m
15m
30m
1h
2h
4h
6h
8h
12h
1d
3d
1w
1M
Rate limiters (rateLimitType)
REQUEST_WEIGHT
ORDERS
REQUEST_WEIGHT
ORDERS
Rate limit intervals (interval)
MINUTE
Filters
Filters define trading rules on a symbol or an exchange.
Symbol filters
PRICE_FILTER
/exchangeInfo format:
The PRICE_FILTER defines the price rules for a symbol. There are 3 parts:
minPricedefines the minimumprice/stopPriceallowed; disabled onminPrice== 0.maxPricedefines the maximumprice/stopPriceallowed; disabled onmaxPrice== 0.tickSizedefines the intervals that aprice/stopPricecan be increased/decreased by; disabled ontickSize== 0.
Any of the above variables can be set to 0, which disables that rule in the price filter. In order to pass the price filter, the following must be true for price/stopPrice of the enabled rules:
price>=minPriceprice<=maxPrice(
price-minPrice) %tickSize== 0
LOT_SIZE
/exchangeInfo format:
The LOT_SIZE filter defines the quantity (aka "lots" in auction terms) rules for a symbol. There are 3 parts:
minQtydefines the minimumquantityallowed.maxQtydefines the maximumquantityallowed.stepSizedefines the intervals that aquantitycan be increased/decreased by.
In order to pass the lot size, the following must be true for quantity:
quantity>=minQtyquantity<=maxQty(
quantity-minQty) %stepSize== 0
MARKET_LOT_SIZE
/exchangeInfo format:
The MARKET_LOT_SIZE filter defines the quantity (aka "lots" in auction terms) rules for MARKET orders on a symbol. There are 3 parts:
minQtydefines the minimumquantityallowed.maxQtydefines the maximumquantityallowed.stepSizedefines the intervals that aquantitycan be increased/decreased by.
In order to pass the market lot size, the following must be true for quantity:
quantity>=minQtyquantity<=maxQty(
quantity-minQty) %stepSize== 0
MAX_NUM_ORDERS
/exchangeInfo format:
The MAX_NUM_ORDERS filter defines the maximum number of orders an account is allowed to have open on a symbol.
Note that both "algo" orders and normal orders are counted for this filter.
MAX_NUM_ALGO_ORDERS
/exchangeInfo format:
The MAX_NUM_ALGO_ORDERS filter defines the maximum number of all kinds of algo orders an account is allowed to have open on a symbol.
The algo orders include STOP, STOP_MARKET, TAKE_PROFIT, TAKE_PROFIT_MARKET, and TRAILING_STOP_MARKET orders.
PERCENT_PRICE
/exchangeInfo format:
The PERCENT_PRICE filter defines valid range for a price based on the mark price.
In order to pass the percent price, the following must be true for price:
BUY:
price<=markPrice*multiplierUpSELL:
price>=markPrice*multiplierDown
MIN_NOTIONAL
/exchangeInfo format:
The MIN_NOTIONAL filter defines the minimum notional value allowed for an order on a symbol. An order's notional value is the price * quantity. Since MARKET orders have no price, the mark price is used.
Market Data Endpoints
Test Connectivity
Response:
GET /fapi/v1/ping
Test connectivity to the Rest API.
Weight: 1
Parameters: NONE
Check Server Time
Response:
GET /fapi/v1/time
Test connectivity to the Rest API and get the current server time.
Weight: 1
Parameters: NONE
Exchange Information
Response:
GET /fapi/v1/exchangeInfo
Current exchange trading rules and symbol information
Weight: 1
Parameters: NONE
Order Book
Response:
GET /fapi/v1/depth
Weight:
Adjusted based on the limit:
5, 10, 20, 50
2
100
5
500
10
1000
20
Parameters:
symbol
STRING
YES
limit
INT
NO
Default 500; Valid limits:[5, 10, 20, 50, 100, 500, 1000]
Recent Trades List
Response:
GET /fapi/v1/trades
Get recent market trades
Weight: 1
Parameters:
symbol
STRING
YES
limit
INT
NO
Default 500; max 1000.
Market trades means trades filled in the order book. Only market trades will be returned, which means the insurance fund trades and ADL trades won't be returned.
Old Trades Lookup (MARKET_DATA)
Response:
GET /fapi/v1/historicalTrades
Get older market historical trades.
Weight: 20
Parameters:
symbol
STRING
YES
limit
INT
NO
Default 500; max 1000.
fromId
LONG
NO
TradeId to fetch from. Default gets most recent trades.
Market trades means trades filled in the order book. Only market trades will be returned, which means the insurance fund trades and ADL trades won't be returned.
Compressed/Aggregate Trades List
Response:
GET /fapi/v1/aggTrades
Get compressed, aggregate market trades. Market trades that fill at the time, from the same order, with the same price will have the quantity aggregated.
Weight: 20
Parameters:
symbol
STRING
YES
fromId
LONG
NO
ID to get aggregate trades from INCLUSIVE.
startTime
LONG
NO
Timestamp in ms to get aggregate trades from INCLUSIVE.
endTime
LONG
NO
Timestamp in ms to get aggregate trades until INCLUSIVE.
limit
INT
NO
Default 500; max 1000.
If both startTime and endTime are sent, time between startTime and endTime must be less than 1 hour.
If fromId, startTime, and endTime are not sent, the most recent aggregate trades will be returned.
Only market trades will be aggregated and returned, which means the insurance fund trades and ADL trades won't be aggregated.
Kline/Candlestick Data
Response:
GET /fapi/v1/klines
Kline/candlestick bars for a symbol. Klines are uniquely identified by their open time.
Weight: based on parameter LIMIT
[1,100)
1
[100, 500)
2
[500, 1000]
5
1000 | 10
Parameters:
symbol
STRING
YES
interval
ENUM
YES
startTime
LONG
NO
endTime
LONG
NO
limit
INT
NO
Default 500; max 1500.
If startTime and endTime are not sent, the most recent klines are returned.
Index Price Kline/Candlestick Data
Response:
GET /fapi/v1/indexPriceKlines
Kline/candlestick bars for the index price of a pair.
Klines are uniquely identified by their open time.
Weight: based on parameter LIMIT
[1,100)
1
[100, 500)
2
[500, 1000]
5
1000 | 10
Parameters:
pair
STRING
YES
interval
ENUM
YES
startTime
LONG
NO
endTime
LONG
NO
limit
INT
NO
Default 500; max 1500.
If startTime and endTime are not sent, the most recent klines are returned.
Mark Price Kline/Candlestick Data
Response:
GET /fapi/v1/markPriceKlines
Kline/candlestick bars for the mark price of a symbol.
Klines are uniquely identified by their open time.
Weight: based on parameter LIMIT
[1,100)
1
[100, 500)
2
[500, 1000]
5
1000 | 10
Parameters:
symbol
STRING
YES
interval
ENUM
YES
startTime
LONG
NO
endTime
LONG
NO
limit
INT
NO
Default 500; max 1500.
If startTime and endTime are not sent, the most recent klines are returned.
Mark Price
Response:
OR (when symbol not sent)
GET /fapi/v1/premiumIndex
Mark Price and Funding Rate
Weight: 1
Parameters:
symbol
STRING
NO
Get Funding Rate History
Response:
GET /fapi/v1/fundingRate
Weight: 1
Parameters:
symbol
STRING
NO
startTime
LONG
NO
Timestamp in ms to get funding rate from INCLUSIVE.
endTime
LONG
NO
Timestamp in ms to get funding rate until INCLUSIVE.
limit
INT
NO
Default 100; max 1000
If
startTimeandendTimeare not sent, the most recentlimitdatas are returned.If the number of data between
startTimeandendTimeis larger thanlimit, return asstartTime+limit.In ascending order.
24hr Ticker Price Change Statistics
Response:
OR
GET /fapi/v1/ticker/24hr
24 hour rolling window price change statistics. Careful when accessing this with no symbol.
Weight: 1 for a single symbol; 40 when the symbol parameter is omitted
Parameters:
symbol
STRING
NO
If the symbol is not sent, tickers for all symbols will be returned in an array.
Symbol Price Ticker
Response:
OR
GET /fapi/v1/ticker/price
Latest price for a symbol or symbols.
Weight: 1 for a single symbol; 2 when the symbol parameter is omitted
Parameters:
symbol
STRING
NO
If the symbol is not sent, prices for all symbols will be returned in an array.
Symbol Order Book Ticker
Response:
OR
GET /fapi/v1/ticker/bookTicker
Best price/qty on the order book for a symbol or symbols.
Weight: 1 for a single symbol; 2 when the symbol parameter is omitted
Parameters:
symbol
STRING
NO
If the symbol is not sent, bookTickers for all symbols will be returned in an array.
Websocket Market Streams
The baseurl for websocket is wss://fstream.asterdex.com
Streams can be access either in a single raw stream or a combined stream
Raw streams are accessed at /ws/<streamName>
Combined streams are accessed at /stream?streams=<streamName1>/<streamName2>/<streamName3>
Combined stream events are wrapped as follows: {"stream":"<streamName>","data":<rawPayload>}
All symbols for streams are lowercase
A single connection is only valid for 24 hours; expect to be disconnected at the 24 hour mark
The websocket server will send a
ping frameevery 5 minutes. If the websocket server does not receive apong frameback from the connection within a 15 minute period, the connection will be disconnected. Unsolicitedpong framesare allowed.WebSocket connections have a limit of 10 incoming messages per second.
A connection that goes beyond the limit will be disconnected; IPs that are repeatedly disconnected may be banned.
A single connection can listen to a maximum of 200 streams.
Considering the possible data latency from RESTful endpoints during an extremely volatile market, it is highly recommended to get the order status, position, etc from the Websocket user data stream.
Live Subscribing/Unsubscribing to streams
The following data can be sent through the websocket instance in order to subscribe/unsubscribe from streams. Examples can be seen below.
The
idused in the JSON payloads is an unsigned INT used as an identifier to uniquely identify the messages going back and forth.
Subscribe to a stream
Response
Request
{ "method": "SUBSCRIBE", "params": [ "btcusdt@aggTrade", "btcusdt@depth" ], "id": 1 }
Unsubscribe to a stream
Response
Request
{ "method": "UNSUBSCRIBE", "params": [ "btcusdt@depth" ], "id": 312 }
Listing Subscriptions
Response
Request
{ "method": "LIST_SUBSCRIPTIONS", "id": 3 }
Setting Properties
Currently, the only property can be set is to set whether combined stream payloads are enabled are not. The combined property is set to false when connecting using /ws/ ("raw streams") and true when connecting using /stream/.
Response
Request
{ "method": "SET_PROPERTY", "params": [ "combined", true ], "id": 5 }
Retrieving Properties
Response
Request
{ "method": "GET_PROPERTY", "params": [ "combined" ], "id": 2 }
Error Messages
{"code": 0, "msg": "Unknown property"}
Parameter used in the SET_PROPERTY or GET_PROPERTY was invalid
{"code": 1, "msg": "Invalid value type: expected Boolean"}
Value should only be true or false
{"code": 2, "msg": "Invalid request: property name must be a string"}
Property name provided was invalid
{"code": 2, "msg": "Invalid request: request ID must be an unsigned integer"}
Parameter id had to be provided or the value provided in the id parameter is an unsupported type
{"code": 2, "msg": "Invalid request: unknown variant %s, expected one of SUBSCRIBE, UNSUBSCRIBE, LIST_SUBSCRIPTIONS, SET_PROPERTY, GET_PROPERTY at line 1 column 28"}
Possible typo in the provided method or provided method was neither of the expected values
{"code": 2, "msg": "Invalid request: too many parameters"}
Unnecessary parameters provided in the data
{"code": 2, "msg": "Invalid request: property name must be a string"}
Property name was not provided
{"code": 2, "msg": "Invalid request: missing field method at line 1 column 73"}
method was not provided in the data
{"code":3,"msg":"Invalid JSON: expected value at line %s column %s"}
JSON data sent has incorrect syntax.
Aggregate Trade Streams
Payload:
The Aggregate Trade Streams push market trade information that is aggregated for a single taker order every 100 milliseconds.
Stream Name:
<symbol>@aggTrade
Update Speed: 100ms
Only market trades will be aggregated, which means the insurance fund trades and ADL trades won't be aggregated.
Mark Price Stream
Payload:
Mark price and funding rate for a single symbol pushed every 3 seconds or every second.
Stream Name:
<symbol>@markPrice or <symbol>@markPrice@1s
Update Speed: 3000ms or 1000ms
Mark Price Stream for All market
Payload:
Mark price and funding rate for all symbols pushed every 3 seconds or every second.
Stream Name:
!markPrice@arr or !markPrice@arr@1s
Update Speed: 3000ms or 1000ms
Kline/Candlestick Streams
Payload:
The Kline/Candlestick Stream push updates to the current klines/candlestick every 250 milliseconds (if existing).
Kline/Candlestick chart intervals:
m -> minutes; h -> hours; d -> days; w -> weeks; M -> months
1m
3m
5m
15m
30m
1h
2h
4h
6h
8h
12h
1d
3d
1w
1M
Stream Name:
<symbol>@kline_<interval>
Update Speed: 250ms
Individual Symbol Mini Ticker Stream
Payload:
24hr rolling window mini-ticker statistics for a single symbol. These are NOT the statistics of the UTC day, but a 24hr rolling window from requestTime to 24hrs before.
Stream Name:
<symbol>@miniTicker
Update Speed: 500ms
All Market Mini Tickers Stream
Payload:
24hr rolling window mini-ticker statistics for all symbols. These are NOT the statistics of the UTC day, but a 24hr rolling window from requestTime to 24hrs before. Note that only tickers that have changed will be present in the array.
Stream Name:
!miniTicker@arr
Update Speed: 1000ms
Individual Symbol Ticker Streams
Payload:
24hr rollwing window ticker statistics for a single symbol. These are NOT the statistics of the UTC day, but a 24hr rolling window from requestTime to 24hrs before.
Stream Name:
<symbol>@ticker
Update Speed: 500ms
All Market Tickers Streams
Payload:
24hr rollwing window ticker statistics for all symbols. These are NOT the statistics of the UTC day, but a 24hr rolling window from requestTime to 24hrs before. Note that only tickers that have changed will be present in the array.
Stream Name:
!ticker@arr
Update Speed: 1000ms
Individual Symbol Book Ticker Streams
Payload:
Pushes any update to the best bid or ask's price or quantity in real-time for a specified symbol.
Stream Name: <symbol>@bookTicker
Update Speed: Real-time
All Book Tickers Stream
Payload:
Pushes any update to the best bid or ask's price or quantity in real-time for all symbols.
Stream Name: !bookTicker
Update Speed: Real-time
Liquidation Order Streams
Payload:
The Liquidation Order Snapshot Streams push force liquidation order information for specific symbol.
For each symbol，only the latest one liquidation order within 1000ms will be pushed as the snapshot. If no liquidation happens in the interval of 1000ms, no stream will be pushed.
Stream Name: <symbol>@forceOrder
Update Speed: 1000ms
All Market Liquidation Order Streams
Payload:
The All Liquidation Order Snapshot Streams push force liquidation order information for all symbols in the market.
For each symbol，only the latest one liquidation order within 1000ms will be pushed as the snapshot. If no liquidation happens in the interval of 1000ms, no stream will be pushed.
Stream Name: !forceOrder@arr
Update Speed: 1000ms
Partial Book Depth Streams
Payload:
Top <levels> bids and asks, Valid <levels> are 5, 10, or 20.
Stream Names: <symbol>@depth<levels> OR <symbol>@depth<levels>@500ms OR <symbol>@depth<levels>@100ms.
Update Speed: 250ms, 500ms or 100ms
Diff. Book Depth Streams
Payload:
Bids and asks, pushed every 250 milliseconds, 500 milliseconds, 100 milliseconds (if existing)
Stream Name:
<symbol>@depth OR <symbol>@depth@500ms OR <symbol>@depth@100ms
Update Speed: 250ms, 500ms, 100ms
How to manage a local order book correctly
Open a stream to wss://fstream.asterdex.com/stream?streams=btcusdt@depth.
Buffer the events you receive from the stream. For same price, latest received update covers the previous one.
Get a depth snapshot from https://fapi.asterdex.com/fapi/v1/depth?symbol=BTCUSDT&limit=1000 .
Drop any event where
uis <lastUpdateIdin the snapshot.The first processed event should have
U<=lastUpdateIdANDu>=lastUpdateIdWhile listening to the stream, each new event's
pushould be equal to the previous event'su, otherwise initialize the process from step 3.The data in each event is the absolute quantity for a price level.
If the quantity is 0, remove the price level.
Receiving an event that removes a price level that is not in your local order book can happen and is normal.
Account/Trades Endpoints
Considering the possible data latency from RESTful endpoints during an extremely volatile market, it is highly recommended to get the order status, position, etc from the Websocket user data stream.
Change Position Mode(TRADE)
Response:
POST /fapi/v1/positionSide/dual (HMAC SHA256)
Change user's position mode (Hedge Mode or One-way Mode ) on EVERY symbol
Weight: 1
Parameters:
dualSidePosition
STRING
YES
"true": Hedge Mode; "false": One-way Mode
recvWindow
LONG
NO
timestamp
LONG
YES
Get Current Position Mode(USER_DATA)
Response:
GET /fapi/v1/positionSide/dual (HMAC SHA256)
Get user's position mode (Hedge Mode or One-way Mode ) on EVERY symbol
Weight: 30
Parameters:
recvWindow
LONG
NO
timestamp
LONG
YES
Change Multi-Assets Mode (TRADE)
Response:
POST /fapi/v1/multiAssetsMargin (HMAC SHA256)
Change user's Multi-Assets mode (Multi-Assets Mode or Single-Asset Mode) on Every symbol
Weight: 1
Parameters:
multiAssetsMargin
STRING
YES
"true": Multi-Assets Mode; "false": Single-Asset Mode
recvWindow
LONG
NO
timestamp
LONG
YES
Get Current Multi-Assets Mode (USER_DATA)
Response:
GET /fapi/v1/multiAssetsMargin (HMAC SHA256)
Get user's Multi-Assets mode (Multi-Assets Mode or Single-Asset Mode) on Every symbol
Weight: 30
Parameters:
recvWindow
LONG
NO
timestamp
LONG
YES
New Order (TRADE)
Response:
POST /fapi/v1/order (HMAC SHA256)
Send in a new order.
Weight: 1
Parameters:
symbol
STRING
YES
side
ENUM
YES
positionSide
ENUM
NO
Default BOTH for One-way Mode ; LONG or SHORT for Hedge Mode. It must be sent in Hedge Mode.
type
ENUM
YES
timeInForce
ENUM
NO
quantity
DECIMAL
NO
Cannot be sent with closePosition=true(Close-All)
reduceOnly
STRING
NO
"true" or "false". default "false". Cannot be sent in Hedge Mode; cannot be sent with closePosition=true
price
DECIMAL
NO
newClientOrderId
STRING
NO
A unique id among open orders. Automatically generated if not sent. Can only be string following the rule: ^[\.A-Z\:/a-z0-9_-]{1,36}$
stopPrice
DECIMAL
NO
Used with STOP/STOP_MARKET or TAKE_PROFIT/TAKE_PROFIT_MARKET orders.
closePosition
STRING
NO
true, false；Close-All，used with STOP_MARKET or TAKE_PROFIT_MARKET.
activationPrice
DECIMAL
NO
Used with TRAILING_STOP_MARKET orders, default as the latest price(supporting different workingType)
callbackRate
DECIMAL
NO
Used with TRAILING_STOP_MARKET orders, min 0.1, max 5 where 1 for 1%
workingType
ENUM
NO
stopPrice triggered by: "MARK_PRICE", "CONTRACT_PRICE". Default "CONTRACT_PRICE"
priceProtect
STRING
NO
"TRUE" or "FALSE", default "FALSE". Used with STOP/STOP_MARKET or TAKE_PROFIT/TAKE_PROFIT_MARKET orders.
newOrderRespType
ENUM
NO
"ACK", "RESULT", default "ACK"
recvWindow
LONG
NO
timestamp
LONG
YES
Additional mandatory parameters based on type:
LIMIT
timeInForce, quantity, price
MARKET
quantity
STOP/TAKE_PROFIT
quantity, price, stopPrice
STOP_MARKET/TAKE_PROFIT_MARKET
stopPrice
TRAILING_STOP_MARKET
callbackRate
Order with type
STOP, parametertimeInForcecan be sent ( defaultGTC).Order with type
TAKE_PROFIT, parametertimeInForcecan be sent ( defaultGTC).Condition orders will be triggered when:
If parameter
priceProtectis sent as true:when price reaches the
stopPrice，the difference rate between "MARK_PRICE" and "CONTRACT_PRICE" cannot be larger than the "triggerProtect" of the symbol"triggerProtect" of a symbol can be got from
GET /fapi/v1/exchangeInfo
STOP,STOP_MARKET:BUY: latest price ("MARK_PRICE" or "CONTRACT_PRICE") >=
stopPriceSELL: latest price ("MARK_PRICE" or "CONTRACT_PRICE") <=
stopPrice
TAKE_PROFIT,TAKE_PROFIT_MARKET:BUY: latest price ("MARK_PRICE" or "CONTRACT_PRICE") <=
stopPriceSELL: latest price ("MARK_PRICE" or "CONTRACT_PRICE") >=
stopPrice
TRAILING_STOP_MARKET:BUY: the lowest price after order placed <=
activationPrice, and the latest price >= the lowest price * (1 +callbackRate)SELL: the highest price after order placed >=
activationPrice, and the latest price <= the highest price * (1 -callbackRate)
For
TRAILING_STOP_MARKET, if you got such error code.{"code": -2021, "msg": "Order would immediately trigger."}means that the parameters you send do not meet the following requirements:BUY:
activationPriceshould be smaller than latest price.SELL:
activationPriceshould be larger than latest price.
If
newOrderRespTypeis sent asRESULT:MARKETorder: the final FILLED result of the order will be return directly.LIMITorder with specialtimeInForce: the final status result of the order(FILLED or EXPIRED) will be returned directly.
STOP_MARKET,TAKE_PROFIT_MARKETwithclosePosition=true:Follow the same rules for condition orders.
If triggered，close all current long position( if
SELL) or current short position( ifBUY).Cannot be used with
quantityparemeterCannot be used with
reduceOnlyparameterIn Hedge Mode,cannot be used with
BUYorders inLONGposition side. and cannot be used withSELLorders inSHORTposition side
Place Multiple Orders (TRADE)
Response:
POST /fapi/v1/batchOrders (HMAC SHA256)
Weight: 5
Parameters:
batchOrders
LIST
YES
order list. Max 5 orders
recvWindow
LONG
NO
timestamp
LONG
YES
Where batchOrders is the list of order parameters in JSON
symbol
STRING
YES
side
ENUM
YES
positionSide
ENUM
NO
Default BOTH for One-way Mode ; LONG or SHORT for Hedge Mode. It must be sent with Hedge Mode.
type
ENUM
YES
timeInForce
ENUM
NO
quantity
DECIMAL
YES
reduceOnly
STRING
NO
"true" or "false". default "false".
price
DECIMAL
NO
newClientOrderId
STRING
NO
A unique id among open orders. Automatically generated if not sent. Can only be string following the rule: ^[\.A-Z\:/a-z0-9_-]{1,36}$
stopPrice
DECIMAL
NO
Used with STOP/STOP_MARKET or TAKE_PROFIT/TAKE_PROFIT_MARKET orders.
activationPrice
DECIMAL
NO
Used with TRAILING_STOP_MARKET orders, default as the latest price(supporting different workingType)
callbackRate
DECIMAL
NO
Used with TRAILING_STOP_MARKET orders, min 0.1, max 4 where 1 for 1%
workingType
ENUM
NO
stopPrice triggered by: "MARK_PRICE", "CONTRACT_PRICE". Default "CONTRACT_PRICE"
priceProtect
STRING
NO
"TRUE" or "FALSE", default "FALSE". Used with STOP/STOP_MARKET or TAKE_PROFIT/TAKE_PROFIT_MARKET orders.
newOrderRespType
ENUM
NO
"ACK", "RESULT", default "ACK"
Paremeter rules are same with
New OrderBatch orders are processed concurrently, and the order of matching is not guaranteed.
The order of returned contents for batch orders is the same as the order of the order list.
Query Order (USER_DATA)
Response:
GET /fapi/v1/order (HMAC SHA256)
Check an order's status.
Weight: 1
These orders will not be found:
order status is
CANCELEDorEXPIRED, ANDorder has NO filled trade, AND
created time + 7 days < current time
Parameters:
symbol
STRING
YES
orderId
LONG
NO
origClientOrderId
STRING
NO
recvWindow
LONG
NO
timestamp
LONG
YES
Notes:
Either
orderIdororigClientOrderIdmust be sent.
Cancel Order (TRADE)
Response:
DELETE /fapi/v1/order (HMAC SHA256)
Cancel an active order.
Weight: 1
Parameters:
symbol
STRING
YES
orderId
LONG
NO
origClientOrderId
STRING
NO
recvWindow
LONG
NO
timestamp
LONG
YES
Either orderId or origClientOrderId must be sent.
Cancel All Open Orders (TRADE)
Response:
DELETE /fapi/v1/allOpenOrders (HMAC SHA256)
Weight: 1
Parameters:
symbol
STRING
YES
recvWindow
LONG
NO
timestamp
LONG
YES
Cancel Multiple Orders (TRADE)
Response:
DELETE /fapi/v1/batchOrders (HMAC SHA256)
Weight: 1
Parameters:
symbol
STRING
YES
orderIdList
LIST<LONG>
NO
max length 10 e.g. [1234567,2345678]
origClientOrderIdList
LIST<STRING>
NO
max length 10 e.g. ["my_id_1","my_id_2"], encode the double quotes. No space after comma.
recvWindow
LONG
NO
timestamp
LONG
YES
Either orderIdList or origClientOrderIdList must be sent.
Auto-Cancel All Open Orders (TRADE)
Response:
Cancel all open orders of the specified symbol at the end of the specified countdown.
POST /fapi/v1/countdownCancelAll (HMAC SHA256)
Weight: 10
Parameters:
symbol
STRING
YES
countdownTime
LONG
YES
countdown time, 1000 for 1 second. 0 to cancel the timer
recvWindow
LONG
NO
timestamp
LONG
YES
The endpoint should be called repeatedly as heartbeats so that the existing countdown time can be canceled and replaced by a new one.
Example usage: Call this endpoint at 30s intervals with an countdownTime of 120000 (120s). If this endpoint is not called within 120 seconds, all your orders of the specified symbol will be automatically canceled. If this endpoint is called with an countdownTime of 0, the countdown timer will be stopped.
The system will check all countdowns approximately every 10 milliseconds, so please note that sufficient redundancy should be considered when using this function. We do not recommend setting the countdown time to be too precise or too small.
Query Current Open Order (USER_DATA)
Response:
GET /fapi/v1/openOrder (HMAC SHA256)
Weight: 1
Parameters:
symbol
STRING
YES
orderId
LONG
NO
origClientOrderId
STRING
NO
recvWindow
LONG
NO
timestamp
LONG
YES
Either
orderIdororigClientOrderIdmust be sentIf the queried order has been filled or cancelled, the error message "Order does not exist" will be returned.
Current All Open Orders (USER_DATA)
Response:
GET /fapi/v1/openOrders (HMAC SHA256)
Get all open orders on a symbol. Careful when accessing this with no symbol.
Weight: 1 for a single symbol; 40 when the symbol parameter is omitted
Parameters:
symbol
STRING
NO
recvWindow
LONG
NO
timestamp
LONG
YES
If the symbol is not sent, orders for all symbols will be returned in an array.
All Orders (USER_DATA)
Response:
GET /fapi/v1/allOrders (HMAC SHA256)
Get all account orders; active, canceled, or filled.
These orders will not be found:
order status is
CANCELEDorEXPIRED, ANDorder has NO filled trade, AND
created time + 7 days < current time
Weight: 5
Parameters:
symbol
STRING
YES
orderId
LONG
NO
startTime
LONG
NO
endTime
LONG
NO
limit
INT
NO
Default 500; max 1000.
recvWindow
LONG
NO
timestamp
LONG
YES
Notes:
If
orderIdis set, it will get orders >= thatorderId. Otherwise most recent orders are returned.The query time period must be less then 7 days( default as the recent 7 days).
Futures Account Balance V2 (USER_DATA)
Response:
GET /fapi/v2/balance (HMAC SHA256)
Weight: 5
Parameters:
recvWindow
LONG
NO
timestamp
LONG
YES
Account Information V2 (USER_DATA)
Response:
GET /fapi/v2/account (HMAC SHA256)
Get current account information.
Weight: 5
Parameters:
recvWindow
LONG
NO
timestamp
LONG
YES
Change Initial Leverage (TRADE)
Response:
POST /fapi/v1/leverage (HMAC SHA256)
Change user's initial leverage of specific symbol market.
Weight: 1
Parameters:
symbol
STRING
YES
leverage
INT
YES
target initial leverage: int from 1 to 125
recvWindow
LONG
NO
timestamp
LONG
YES
Change Margin Type (TRADE)
Response:
POST /fapi/v1/marginType (HMAC SHA256)
Weight: 1
Parameters:
symbol
STRING
YES
marginType
ENUM
YES
ISOLATED, CROSSED
recvWindow
LONG
NO
timestamp
LONG
YES
Modify Isolated Position Margin (TRADE)
Response:
POST /fapi/v1/positionMargin (HMAC SHA256)
Weight: 1
Parameters:
symbol
STRING
YES
positionSide
ENUM
NO
Default BOTH for One-way Mode ; LONG or SHORT for Hedge Mode. It must be sent with Hedge Mode.
amount
DECIMAL
YES
type
INT
YES
1: Add position margin，2: Reduce position margin
recvWindow
LONG
NO
timestamp
LONG
YES
Only for isolated symbol
Get Position Margin Change History (TRADE)
Response:
GET /fapi/v1/positionMargin/history (HMAC SHA256)
Weight: 1
Parameters:
symbol
STRING
YES
type
INT
NO
1: Add position margin，2: Reduce position margin
startTime
LONG
NO
endTime
LONG
NO
limit
INT
NO
Default: 500
recvWindow
LONG
NO
timestamp
LONG
YES
Position Information V2 (USER_DATA)
Response:
For One-way position mode:
For Hedge position mode:
GET /fapi/v2/positionRisk (HMAC SHA256)
Get current position information.
Weight: 5
Parameters:
symbol
STRING
NO
recvWindow
LONG
NO
timestamp
LONG
YES
Note
Please use with user data stream ACCOUNT_UPDATE to meet your timeliness and accuracy needs.
Account Trade List (USER_DATA)
Response:
GET /fapi/v1/userTrades (HMAC SHA256)
Get trades for a specific account and symbol.
Weight: 5
Parameters:
symbol
STRING
YES
startTime
LONG
NO
endTime
LONG
NO
fromId
LONG
NO
Trade id to fetch from. Default gets most recent trades.
limit
INT
NO
Default 500; max 1000.
recvWindow
LONG
NO
timestamp
LONG
YES
If
startTimeandendTimeare both not sent, then the last 7 days' data will be returned.The time between
startTimeandendTimecannot be longer than 7 days.The parameter
fromIdcannot be sent withstartTimeorendTime.
Get Income History(USER_DATA)
Response:
GET /fapi/v1/income (HMAC SHA256)
Weight: 30
Parameters:
symbol
STRING
NO
incomeType
STRING
NO
"TRANSFER"，"WELCOME_BONUS", "REALIZED_PNL"，"FUNDING_FEE", "COMMISSION", "INSURANCE_CLEAR", and "MARKET_MERCHANT_RETURN_REWARD"
startTime
LONG
NO
Timestamp in ms to get funding from INCLUSIVE.
endTime
LONG
NO
Timestamp in ms to get funding until INCLUSIVE.
limit
INT
NO
Default 100; max 1000
recvWindow
LONG
NO
timestamp
LONG
YES
If neither
startTimenorendTimeis sent, the recent 7-day data will be returned.If
incomeTypeis not sent, all kinds of flow will be returned"trandId" is unique in the same incomeType for a user
Notional and Leverage Brackets (USER_DATA)
Response:
OR (if symbol sent)
GET /fapi/v1/leverageBracket
Weight: 1
Parameters:
symbol
STRING
NO
recvWindow
LONG
NO
timestamp
LONG
YES
Position ADL Quantile Estimation (USER_DATA)
Response:
GET /fapi/v1/adlQuantile
Weight: 5
Parameters:
symbol
STRING
NO
recvWindow
LONG
NO
timestamp
LONG
YES
Values update every 30s.
Values 0, 1, 2, 3, 4 shows the queue position and possibility of ADL from low to high.
For positions of the symbol are in One-way Mode or isolated margined in Hedge Mode, "LONG", "SHORT", and "BOTH" will be returned to show the positions' adl quantiles of different position sides.
If the positions of the symbol are crossed margined in Hedge Mode:
"HEDGE" as a sign will be returned instead of "BOTH";
A same value caculated on unrealized pnls on long and short sides' positions will be shown for "LONG" and "SHORT" when there are positions in both of long and short sides.
User's Force Orders (USER_DATA)
Response:
GET /fapi/v1/forceOrders
Weight: 20 with symbol, 50 without symbol
Parameters:
symbol
STRING
NO
autoCloseType
ENUM
NO
"LIQUIDATION" for liquidation orders, "ADL" for ADL orders.
startTime
LONG
NO
endTime
LONG
NO
limit
INT
NO
Default 50; max 100.
recvWindow
LONG
NO
timestamp
LONG
YES
If "autoCloseType" is not sent, orders with both of the types will be returned
If "startTime" is not sent, data within 7 days before "endTime" can be queried
User Commission Rate (USER_DATA)
Response:
GET /fapi/v1/commissionRate (HMAC SHA256)
Weight: 20
Parameters:
symbol
STRING
YES
recvWindow
LONG
NO
timestamp
LONG
YES
User Data Streams
The base API endpoint is: https://fapi.asterdex.com
A User Data Stream
listenKeyis valid for 60 minutes after creation.Doing a
PUTon alistenKeywill extend its validity for 60 minutes.Doing a
DELETEon alistenKeywill close the stream and invalidate thelistenKey.Doing a
POSTon an account with an activelistenKeywill return the currently activelistenKeyand extend its validity for 60 minutes.The baseurl for websocket is wss://fstream.asterdex.com
User Data Streams are accessed at /ws/<listenKey>
User data stream payloads are not guaranteed to be in order during heavy periods; make sure to order your updates using E
A single connection to fstream.asterdex.com is only valid for 24 hours; expect to be disconnected at the 24 hour mark
Start User Data Stream (USER_STREAM)
Response:
POST /fapi/v1/listenKey
Start a new user data stream. The stream will close after 60 minutes unless a keepalive is sent. If the account has an active listenKey, that listenKey will be returned and its validity will be extended for 60 minutes.
Weight: 1
Parameters:
None
Keepalive User Data Stream (USER_STREAM)
Response:
PUT /fapi/v1/listenKey
Keepalive a user data stream to prevent a time out. User data streams will close after 60 minutes. It's recommended to send a ping about every 60 minutes.
Weight: 1
Parameters:
None
Close User Data Stream (USER_STREAM)
Response:
DELETE /fapi/v1/listenKey
Close out a user data stream.
Weight: 1
Parameters:
None
Event: User Data Stream Expired
Payload:
When the listenKey used for the user data stream turns expired, this event will be pushed.
Notice:
This event is not related to the websocket disconnection.
This event will be received only when a valid
listenKeyin connection got expired.No more user data event will be updated after this event received until a new valid
listenKeyused.
Event: Margin Call
Payload:
When the user's position risk ratio is too high, this stream will be pushed.
This message is only used as risk guidance information and is not recommended for investment strategies.
In the case of a highly volatile market, there may be the possibility that the user's position has been liquidated at the same time when this stream is pushed out.
Event: Balance and Position Update
Payload:
Event type is ACCOUNT_UPDATE.
When balance or position get updated, this event will be pushed.
ACCOUNT_UPDATEwill be pushed only when update happens on user's account, including changes on balances, positions, or margin type.Unfilled orders or cancelled orders will not make the event
ACCOUNT_UPDATEpushed, since there's no change on positions.Only positions of symbols with non-zero isolatd wallet or non-zero position amount will be pushed in the "position" part of the event
ACCOUNT_UPDATEwhen any position changes.
When "FUNDING FEE" changes to the user's balance, the event will be pushed with the brief message:
When "FUNDING FEE" occurs in a crossed position,
ACCOUNT_UPDATEwill be pushed with only the balanceB(including the "FUNDING FEE" asset only), without any positionPmessage.When "FUNDING FEE" occurs in an isolated position,
ACCOUNT_UPDATEwill be pushed with only the balanceB(including the "FUNDING FEE" asset only) and the relative position messageP( including the isolated position on which the "FUNDING FEE" occurs only, without any other position message).
The field "m" represents the reason type for the event and may shows the following possible types:
DEPOSIT
WITHDRAW
ORDER
FUNDING_FEE
WITHDRAW_REJECT
ADJUSTMENT
INSURANCE_CLEAR
ADMIN_DEPOSIT
ADMIN_WITHDRAW
MARGIN_TRANSFER
MARGIN_TYPE_CHANGE
ASSET_TRANSFER
OPTIONS_PREMIUM_FEE
OPTIONS_SETTLE_PROFIT
AUTO_EXCHANGE
The field "bc" represents the balance change except for PnL and commission.
Event: Order Update
Payload:
When new order created, order status changed will push such event. event type is ORDER_TRADE_UPDATE.
Side
BUY
SELL
Order Type
MARKET
LIMIT
STOP
TAKE_PROFIT
LIQUIDATION
Execution Type
NEW
CANCELED
CALCULATED - Liquidation Execution
EXPIRED
TRADE
Order Status
NEW
PARTIALLY_FILLED
FILLED
CANCELED
EXPIRED
NEW_INSURANCE - Liquidation with Insurance Fund
NEW_ADL - Counterparty Liquidation`
Time in force
GTC
IOC
FOK
GTX
Working Type
MARK_PRICE
CONTRACT_PRICE
Event: Account Configuration Update previous Leverage Update
Payload:
Or
When the account configuration is changed, the event type will be pushed as ACCOUNT_CONFIG_UPDATE
When the leverage of a trade pair changes, the payload will contain the object ac to represent the account configuration of the trade pair, where s represents the specific trade pair and l represents the leverage
When the user Multi-Assets margin mode changes the payload will contain the object ai representing the user account configuration, where j represents the user Multi-Assets margin mode
Error Codes
Here is the error JSON payload:
Errors consist of two parts: an error code and a message. Codes are universal,but messages can vary.
10xx - General Server or Network issues
-1000 UNKNOWN
An unknown error occured while processing the request.
-1001 DISCONNECTED
Internal error; unable to process your request. Please try again.
-1002 UNAUTHORIZED
You are not authorized to execute this request.
-1003 TOO_MANY_REQUESTS
Too many requests queued.
Too many requests; please use the websocket for live updates.
Too many requests; current limit is %s requests per minute. Please use the websocket for live updates to avoid polling the API.
Way too many requests; IP banned until %s. Please use the websocket for live updates to avoid bans.
-1004 DUPLICATE_IP
This IP is already on the white list
-1005 NO_SUCH_IP
No such IP has been white listed
-1006 UNEXPECTED_RESP
An unexpected response was received from the message bus. Execution status unknown.
-1007 TIMEOUT
Timeout waiting for response from backend server. Send status unknown; execution status unknown.
-1010 ERROR_MSG_RECEIVED
ERROR_MSG_RECEIVED.
-1011 NON_WHITE_LIST
This IP cannot access this route.
-1013 INVALID_MESSAGE
INVALID_MESSAGE.
-1014 UNKNOWN_ORDER_COMPOSITION
Unsupported order combination.
-1015 TOO_MANY_ORDERS
Too many new orders.
Too many new orders; current limit is %s orders per %s.
-1016 SERVICE_SHUTTING_DOWN
This service is no longer available.
-1020 UNSUPPORTED_OPERATION
This operation is not supported.
-1021 INVALID_TIMESTAMP
Timestamp for this request is outside of the recvWindow.
Timestamp for this request was 1000ms ahead of the server's time.
-1022 INVALID_SIGNATURE
Signature for this request is not valid.
-1023 START_TIME_GREATER_THAN_END_TIME
Start time is greater than end time.
11xx - Request issues
-1100 ILLEGAL_CHARS
Illegal characters found in a parameter.
Illegal characters found in parameter '%s'; legal range is '%s'.
-1101 TOO_MANY_PARAMETERS
Too many parameters sent for this endpoint.
Too many parameters; expected '%s' and received '%s'.
Duplicate values for a parameter detected.
-1102 MANDATORY_PARAM_EMPTY_OR_MALFORMED
A mandatory parameter was not sent, was empty/null, or malformed.
Mandatory parameter '%s' was not sent, was empty/null, or malformed.
Param '%s' or '%s' must be sent, but both were empty/null!
-1103 UNKNOWN_PARAM
An unknown parameter was sent.
-1104 UNREAD_PARAMETERS
Not all sent parameters were read.
Not all sent parameters were read; read '%s' parameter(s) but was sent '%s'.
-1105 PARAM_EMPTY
A parameter was empty.
Parameter '%s' was empty.
-1106 PARAM_NOT_REQUIRED
A parameter was sent when not required.
Parameter '%s' sent when not required.
-1108 BAD_ASSET
Invalid asset.
-1109 BAD_ACCOUNT
Invalid account.
-1110 BAD_INSTRUMENT_TYPE
Invalid symbolType.
-1111 BAD_PRECISION
Precision is over the maximum defined for this asset.
-1112 NO_DEPTH
No orders on book for symbol.
-1113 WITHDRAW_NOT_NEGATIVE
Withdrawal amount must be negative.
-1114 TIF_NOT_REQUIRED
TimeInForce parameter sent when not required.
-1115 INVALID_TIF
Invalid timeInForce.
-1116 INVALID_ORDER_TYPE
Invalid orderType.
-1117 INVALID_SIDE
Invalid side.
-1118 EMPTY_NEW_CL_ORD_ID
New client order ID was empty.
-1119 EMPTY_ORG_CL_ORD_ID
Original client order ID was empty.
-1120 BAD_INTERVAL
Invalid interval.
-1121 BAD_SYMBOL
Invalid symbol.
-1125 INVALID_LISTEN_KEY
This listenKey does not exist.
-1127 MORE_THAN_XX_HOURS
Lookup interval is too big.
More than %s hours between startTime and endTime.
-1128 OPTIONAL_PARAMS_BAD_COMBO
Combination of optional parameters invalid.
-1130 INVALID_PARAMETER
Invalid data sent for a parameter.
Data sent for parameter '%s' is not valid.
-1136 INVALID_NEW_ORDER_RESP_TYPE
Invalid newOrderRespType.
20xx - Processing Issues
-2010 NEW_ORDER_REJECTED
NEW_ORDER_REJECTED
-2011 CANCEL_REJECTED
CANCEL_REJECTED
-2013 NO_SUCH_ORDER
Order does not exist.
-2014 BAD_API_KEY_FMT
API-key format invalid.
-2015 REJECTED_MBX_KEY
Invalid API-key, IP, or permissions for action.
-2016 NO_TRADING_WINDOW
No trading window could be found for the symbol. Try ticker/24hrs instead.
-2018 BALANCE_NOT_SUFFICIENT
Balance is insufficient.
-2019 MARGIN_NOT_SUFFICIEN
Margin is insufficient.
-2020 UNABLE_TO_FILL
Unable to fill.
-2021 ORDER_WOULD_IMMEDIATELY_TRIGGER
Order would immediately trigger.
-2022 REDUCE_ONLY_REJECT
ReduceOnly Order is rejected.
-2023 USER_IN_LIQUIDATION
User in liquidation mode now.
-2024 POSITION_NOT_SUFFICIENT
Position is not sufficient.
-2025 MAX_OPEN_ORDER_EXCEEDED
Reach max open order limit.
-2026 REDUCE_ONLY_ORDER_TYPE_NOT_SUPPORTED
This OrderType is not supported when reduceOnly.
-2027 MAX_LEVERAGE_RATIO
Exceeded the maximum allowable position at current leverage.
-2028 MIN_LEVERAGE_RATIO
Leverage is smaller than permitted: insufficient margin balance.
40xx - Filters and other Issues
-4000 INVALID_ORDER_STATUS
Invalid order status.
-4001 PRICE_LESS_THAN_ZERO
Price less than 0.
-4002 PRICE_GREATER_THAN_MAX_PRICE
Price greater than max price.
-4003 QTY_LESS_THAN_ZERO
Quantity less than zero.
-4004 QTY_LESS_THAN_MIN_QTY
Quantity less than min quantity.
-4005 QTY_GREATER_THAN_MAX_QTY
Quantity greater than max quantity.
-4006 STOP_PRICE_LESS_THAN_ZERO
Stop price less than zero.
-4007 STOP_PRICE_GREATER_THAN_MAX_PRICE
Stop price greater than max price.
-4008 TICK_SIZE_LESS_THAN_ZERO
Tick size less than zero.
-4009 MAX_PRICE_LESS_THAN_MIN_PRICE
Max price less than min price.
-4010 MAX_QTY_LESS_THAN_MIN_QTY
Max qty less than min qty.
-4011 STEP_SIZE_LESS_THAN_ZERO
Step size less than zero.
-4012 MAX_NUM_ORDERS_LESS_THAN_ZERO
Max mum orders less than zero.
-4013 PRICE_LESS_THAN_MIN_PRICE
Price less than min price.
-4014 PRICE_NOT_INCREASED_BY_TICK_SIZE
Price not increased by tick size.
-4015 INVALID_CL_ORD_ID_LEN
Client order id is not valid.
Client order id length should not be more than 36 chars
-4016 PRICE_HIGHTER_THAN_MULTIPLIER_UP
Price is higher than mark price multiplier cap.
-4017 MULTIPLIER_UP_LESS_THAN_ZERO
Multiplier up less than zero.
-4018 MULTIPLIER_DOWN_LESS_THAN_ZERO
Multiplier down less than zero.
-4019 COMPOSITE_SCALE_OVERFLOW
Composite scale too large.
-4020 TARGET_STRATEGY_INVALID
Target strategy invalid for orderType '%s',reduceOnly '%b'.
-4021 INVALID_DEPTH_LIMIT
Invalid depth limit.
'%s' is not valid depth limit.
-4022 WRONG_MARKET_STATUS
market status sent is not valid.
-4023 QTY_NOT_INCREASED_BY_STEP_SIZE
Qty not increased by step size.
-4024 PRICE_LOWER_THAN_MULTIPLIER_DOWN
Price is lower than mark price multiplier floor.
-4025 MULTIPLIER_DECIMAL_LESS_THAN_ZERO
Multiplier decimal less than zero.
-4026 COMMISSION_INVALID
Commission invalid.
%sless than zero.%sabsolute value greater than%s
-4027 INVALID_ACCOUNT_TYPE
Invalid account type.
-4028 INVALID_LEVERAGE
Invalid leverage
Leverage
%sis not validLeverage
%salready exist with%s
-4029 INVALID_TICK_SIZE_PRECISION
Tick size precision is invalid.
-4030 INVALID_STEP_SIZE_PRECISION
Step size precision is invalid.
-4031 INVALID_WORKING_TYPE
Invalid parameter working type
Invalid parameter working type:
%s
-4032 EXCEED_MAX_CANCEL_ORDER_SIZE
Exceed maximum cancel order size.
Invalid parameter working type:
%s
-4033 INSURANCE_ACCOUNT_NOT_FOUND
Insurance account not found.
-4044 INVALID_BALANCE_TYPE
Balance Type is invalid.
-4045 MAX_STOP_ORDER_EXCEEDED
Reach max stop order limit.
-4046 NO_NEED_TO_CHANGE_MARGIN_TYPE
No need to change margin type.
-4047 THERE_EXISTS_OPEN_ORDERS
Margin type cannot be changed if there exists open orders.
-4048 THERE_EXISTS_QUANTITY
Margin type cannot be changed if there exists position.
-4049 ADD_ISOLATED_MARGIN_REJECT
Add margin only support for isolated position.
-4050 CROSS_BALANCE_INSUFFICIENT
Cross balance insufficient.
-4051 ISOLATED_BALANCE_INSUFFICIENT
Isolated balance insufficient.
-4052 NO_NEED_TO_CHANGE_AUTO_ADD_MARGIN
No need to change auto add margin.
-4053 AUTO_ADD_CROSSED_MARGIN_REJECT
Auto add margin only support for isolated position.
-4054 ADD_ISOLATED_MARGIN_NO_POSITION_REJECT
Cannot add position margin: position is 0.
-4055 AMOUNT_MUST_BE_POSITIVE
Amount must be positive.
-4056 INVALID_API_KEY_TYPE
Invalid api key type.
-4057 INVALID_RSA_PUBLIC_KEY
Invalid api public key
-4058 MAX_PRICE_TOO_LARGE
maxPrice and priceDecimal too large,please check.
-4059 NO_NEED_TO_CHANGE_POSITION_SIDE
No need to change position side.
-4060 INVALID_POSITION_SIDE
Invalid position side.
-4061 POSITION_SIDE_NOT_MATCH
Order's position side does not match user's setting.
-4062 REDUCE_ONLY_CONFLICT
Invalid or improper reduceOnly value.
-4063 INVALID_OPTIONS_REQUEST_TYPE
Invalid options request type
-4064 INVALID_OPTIONS_TIME_FRAME
Invalid options time frame
-4065 INVALID_OPTIONS_AMOUNT
Invalid options amount
-4066 INVALID_OPTIONS_EVENT_TYPE
Invalid options event type
-4067 POSITION_SIDE_CHANGE_EXISTS_OPEN_ORDERS
Position side cannot be changed if there exists open orders.
-4068 POSITION_SIDE_CHANGE_EXISTS_QUANTITY
Position side cannot be changed if there exists position.
-4069 INVALID_OPTIONS_PREMIUM_FEE
Invalid options premium fee
-4070 INVALID_CL_OPTIONS_ID_LEN
Client options id is not valid.
Client options id length should be less than 32 chars
-4071 INVALID_OPTIONS_DIRECTION
Invalid options direction
-4072 OPTIONS_PREMIUM_NOT_UPDATE
premium fee is not updated, reject order
-4073 OPTIONS_PREMIUM_INPUT_LESS_THAN_ZERO
input premium fee is less than 0, reject order
-4074 OPTIONS_AMOUNT_BIGGER_THAN_UPPER
Order amount is bigger than upper boundary or less than 0, reject order
-4075 OPTIONS_PREMIUM_OUTPUT_ZERO
output premium fee is less than 0, reject order
-4076 OPTIONS_PREMIUM_TOO_DIFF
original fee is too much higher than last fee
-4077 OPTIONS_PREMIUM_REACH_LIMIT
place order amount has reached to limit, reject order
-4078 OPTIONS_COMMON_ERROR
options internal error
-4079 INVALID_OPTIONS_ID
invalid options id
invalid options id: %s
duplicate options id %d for user %d
-4080 OPTIONS_USER_NOT_FOUND
user not found
user not found with id: %s
-4081 OPTIONS_NOT_FOUND
options not found
options not found with id: %s
-4082 INVALID_BATCH_PLACE_ORDER_SIZE
Invalid number of batch place orders.
Invalid number of batch place orders: %s
-4083 PLACE_BATCH_ORDERS_FAIL
Fail to place batch orders.
-4084 UPCOMING_METHOD
Method is not allowed currently. Upcoming soon.
-4085 INVALID_NOTIONAL_LIMIT_COEF
Invalid notional limit coefficient
-4086 INVALID_PRICE_SPREAD_THRESHOLD
Invalid price spread threshold
-4087 REDUCE_ONLY_ORDER_PERMISSION
User can only place reduce only order
-4088 NO_PLACE_ORDER_PERMISSION
User can not place order currently
-4104 INVALID_CONTRACT_TYPE
Invalid contract type
-4114 INVALID_CLIENT_TRAN_ID_LEN
clientTranId is not valid
Client tran id length should be less than 64 chars
-4115 DUPLICATED_CLIENT_TRAN_ID
clientTranId is duplicated
Client tran id should be unique within 7 days
-4118 REDUCE_ONLY_MARGIN_CHECK_FAILED
ReduceOnly Order Failed. Please check your existing position and open orders
-4131 MARKET_ORDER_REJECT
The counterparty's best price does not meet the PERCENT_PRICE filter limit
-4135 INVALID_ACTIVATION_PRICE
Invalid activation price
-4137 QUANTITY_EXISTS_WITH_CLOSE_POSITION
Quantity must be zero with closePosition equals true
-4138 REDUCE_ONLY_MUST_BE_TRUE
Reduce only must be true with closePosition equals true
-4139 ORDER_TYPE_CANNOT_BE_MKT
Order type can not be market if it's unable to cancel
-4140 INVALID_OPENING_POSITION_STATUS
Invalid symbol status for opening position
-4141 SYMBOL_ALREADY_CLOSED
Symbol is closed
-4142 STRATEGY_INVALID_TRIGGER_PRICE
REJECT: take profit or stop order will be triggered immediately
-4144 INVALID_PAIR
Invalid pair
-4161 ISOLATED_LEVERAGE_REJECT_WITH_POSITION
Leverage reduction is not supported in Isolated Margin Mode with open positions
-4164 MIN_NOTIONAL
Order's notional must be no smaller than 5.0 (unless you choose reduce only)
Order's notional must be no smaller than %s (unless you choose reduce only)
-4165 INVALID_TIME_INTERVAL
Invalid time interval
Maximum time interval is %s days
-4183 PRICE_HIGHTER_THAN_STOP_MULTIPLIER_UP
Price is higher than stop price multiplier cap.
Limit price can't be higher than %s.
-4184 PRICE_LOWER_THAN_STOP_MULTIPLIER_DOWN
Price is lower than stop price multiplier floor.
Limit price can't be lower than %s.
Last updated