- Streams, endpoints, parameters, payloads, etc. described in the documents in this repository are considered official and supported.
- The use of any other streams, endpoints, parameters, or payloads, etc. is not supported; use them at your own risk and with no guarantees.
| Name | Description |
|---|---|
| rest-api.md | Details on the Rest API (/api) |
| errors.md | Descriptions of possible error messages from the Rest API |
| web-socket-streams.md | Details on available streams and payloads |
| API | Description |
|---|---|
| GET /api/v1/ping | Test server connectivity PING |
| GET /api/v1/time | Get server time |
| GET /api/v1/exchangeInfo | Get restriction info and trading pair info |
| GET /api/v1/optionInfo | Get trading pair information of options transaction |
| GET /api/v1/contractInfo | Get trading pair information of contract transaction |
| GET /api/v1/account (HMAC SHA256) | Asset information of the account |
| POST /api/v1/userDataStream | Create user data stream |
| PUT /api/v1/userDataStream | Extend the period of validity of user data stream |
| DELETE /api/v1/userDataStream | Close user data stream |
| GET /wapi/v1/assetDetail | Details of user assets |
| GET /wapi/v1/depositAddress | User's deposit address |
| GET /wapi/v1/depositHistory | Deposit history |
| GET /wapi/v1/tradeFee | Transaction fee |
| GET /wapi/v1/withdrawHistory | Withdraw History |
| API | Description |
|---|---|
| GET /api/v1/spot/depth | Depth |
| GET /api/v1/spot/trades | Recent trades |
| GET /api/v1/spot/historicalTrades | Historical trades |
| GET /api/v1/spot/klines | K-line |
| GET /api/v1/spot/avgPrice | Average price now |
| GET /api/v1/spot/ticker/24hr | Price change in 24 hours |
| GET /api/v1/spot/ticker/price | Latest price |
| GET /api/v1/spot/ticker/bookTicker | Optimal entry order |
| POST /api/v1/spot/order/test (HMAC SHA256) | Test placing order |
| POST /api/v1/spot/order (HMAC SHA256) | Place order |
| GET /api/v1/spot/order (HMAC SHA256) | Check orders |
| DELETE /api/v1/spot/order (HMAC SHA256) | Cancel order |
| GET /api/v1/spot/openOrders (HMAC SHA256) | Check entry orders |
| GET /api/v1/spot/historyOrders (HMAC SHA256) | Historical entry orders |
| Stream | Description |
|---|---|
| <symbol>@<tradeType> | Recent trades |
| <symbol>@<klineType>_<interval> | K-line |
| <symbol>@<miniTickerType> | Simplified Ticker |
| <symbol>@<tradeType> | Complete Ticker |
| <symbol>@<depthType><levels> | Depth information |
| <symbol>@<depthType> | Depth information stream |
| Stream | Description |
|---|---|
| accountSpotInfo | Change of spot assets |
| accountOptionInfo | Change of options assets |
| accountContractInfo | Change of contract assets |
| execSpotReport | Update spot orders/ trades |
| execOptionReport | Update options orders/ trades |
| execContractReport | Update contract orders/ trades |
| contractPositions | Positions of contract |
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent