Public
Quick Start¶
Restful API¶
Public Interface¶
User Interface¶
Order Interface¶
WebSocket API¶
WebSocket Introduction¶
Public Interface¶
User Interface¶
Order Interface¶
1. Get latest price¶
HTTP Requeset
GET: /api/spot/v1/market/last_price
Parameters
| Name | Type | Required | Notes |
|---|---|---|---|
| symbol | string | Y | Pair |
Returned Data
| Name | Type | Required | Notes |
|---|---|---|---|
| code | number | Y | Error code |
| msg | string | Y | Description |
| data | string | N | Last price |
2. Get depth data¶
HTTP Request
GET: /api/spot/v1/market/depth
Parameters
| Name | Type | Required | Notes |
|---|---|---|---|
| symbol | string | Y | Trading pair |
| precision | number | Y | token precision |
Returned Data
| Name | Type | Required | Notes |
|---|---|---|---|
| code | number | Y | Error code |
| msg | string | Y | Description |
| data | object | N | Depth data |
data
| Name | Type | Required | Notes |
|---|---|---|---|
| asks | object[] | N | asks order depth |
| bids | object[] | N | bids order depth |
| ts | string | N | timestamp |
asks/bids
| Name | Type | Required | Notes |
|---|---|---|---|
| price | string | N | Price |
| volume | string | N | Size |
3. Get K-Line data¶
HTTP Request
GET: /api/spot/v1/market/kline
Parameters
| Name | Type | Required | Notes |
|---|---|---|---|
| symbol | string | Y | Trading Pair |
| interval | string | Y | kline interval，Default is 1min(1,3,5,15,30,60,120,240,360,720,D,M,W) |
Returned Data
| Name | Type | Required | Notes |
|---|---|---|---|
| code | number | Y | Error code |
| msg | string | Y | Description |
| data | object | N | K-Line data |
data
| Name | Type | Required | Notes |
|---|---|---|---|
| symbol | string | N | Trading pair |
| open | string | N | Open price |
| high | string | N | Highest price |
| low | string | N | Lowest price |
| close | string | N | Last price |
| ts | string | N | kline Starting timeISO8601 |
4. Get K-Line history data¶
HTTP Request
GET: /api/spot/v1/market/kline/history
Parameters
| Name | Type | Required | Notes |
|---|---|---|---|
| symbol | string | Y | Trading Pair |
| interval | string | N | kline interval，Default is 1min(1,3,5,15,30,60,120,240,360,720,D,M,W) |
| endTime | string | N | End timestamp (seconds), open interval, such as 1696507201. If not transmitted, it defaults to the current time and does not include the latest data |
| limit | string | N | Number of K-Line data, 1-500，Default is 200 |
Returned Data
| Name | Type | Required | Notes |
|---|---|---|---|
| code | number | Y | Error code |
| msg | string | Y | Description |
| data | object | N | K-Line data |
data
| Name | Type | Required | Notes |
|---|---|---|---|
| symbol | string | N | Trading pair |
| open | string | N | Open price |
| high | string | N | Highest price |
| low | string | N | Lowest price |
| close | string | N | Last price |
| ts | string | N | kline Starting timeISO8601 |
5. Query trading pair data¶
HTTP Request
GET: /api/spot/v1/common/coin_pair/list
Parameters
| Name | Type | Required | Notes |
|---|---|---|---|
| Null |
Returned Data
| Name | Type | Required | Notes |
|---|---|---|---|
| code | number | Y | Error code |
| msg | string | Y | Description |
| data | object[] | N | Trading pair Data |
data
| Name | Type | Required | Notes |
|---|---|---|---|
| id | string | N | id |
| base | string | N | Base token |
| quote | string | N | Quote token |
| basePrecision | string | N | Base token precision |
| quotePrecision | string | N | Quote token precision |
| minPrice | string | N | Minimun trading amount |
| minVolume | string | N | Minimum trading volume |
| isOpen | string | N | Whether the pair is open or not |
| isHot | string | N | Whether the pair is trending or not |
| isRecommend | string | N | Whether the pair is recommended or not |
| isShow | string | N | Whether the pair is found or not |
| tradeArea | string | N | Trading categories |
| sort | string | N | Sorting order |
| openTime | string | N | Trading pair open time |
| precisions | string[] | N | Precesion of the trading pair |
6. Query rate data¶
HTTP Request
GET: /api/spot/v1/common/rate/list
Parameters
| Name | Type | Required | Notes |
|---|---|---|---|
| Null |
Returned Data
| Name | Type | Required | Notes |
|---|---|---|---|
| code | number | Y | Error code |
| msg | string | Y | Description |
| data | object[] | N | Rate data |
data
| Name | Type | Required | Notes |
|---|---|---|---|
| baseSymbol | string | N | Base token |
| quoteSymbol | string | N | Quote token |
| rate | string | N | Rate |
7. Query token data¶
HTTP Request
GET: /api/spot/v1/common/coin/coin_network/list
Parameters
| Name | Type | Required | Notes |
|---|---|---|---|
| Null |
Returned Data
| Name | Type | Required | Notes |
|---|---|---|---|
| code | number | Y | Error code |
| msg | string | Y | Description |
| data | object[] | N | Token data |
data
| Name | Type | Required | Notes |
|---|---|---|---|
| name | string | N | Token |
| fullName | string | N | Token full name |
| logo | string | N | Token icon |
| track | string | N | Categories |
| quotePrecision | string | N | Quote token precision |
| minPrice | string | N | Minumim order price |
| isOpen | string | N | Available for trading |
| isHot | string | N | Whether the token is trending |
| depositOpen | string | N | If deposit is open，0 means not，1 means deposit open； |
| isShow | string | N | Whether the token can be found |
| withdrawOpen | string | N | If withdrawal is open，0 means not, 1 means withdrawal open； |
| withdrawMin | string | N | Minimum withdrawal amount |
| withdrawMax | string | N | Maximum withdrawal amount |
| networks | object[] | N | Data of the the network of the token |
networks
| Name | Type | Required | Notes |
|---|---|---|---|
| contractPrecision | string | N | Token precision |
| contractAddress | string | N | Contract Address of the token |
| requireMemo | string | N | If memo is needed.0:No,1:Optional,2:Required |
| chain | string | N | Chain of the token |
| depositConfirm | string | N | How many blocks are needed for confirmation |
| addressRegular | string | N | Address regular verification |
| network | string | N | Name of Network |
| isOpen | string | N | Whether the network is open; 0:Close, 1:Open |
| depositOpen | string | N | If deposit is open，0 means not，1 means deposit open； |
| isShow | string | N | Whether the token can be found |
| withdrawOpen | string | N | If withdrawal is open，0 means not, 1 means withdrawal open； |
| withdrawMin | string | N | Minimum withdrawal amount |
| withdrawMax | string | N | Maximum withdrawal amount |
| depositMin | string | N | Minumum deposit amount |