General Info
General API Information
- The base endpoint is: https://api.superex.com
Market Data Endpoints
24hr Ticker Price Change Statistics
request method: /spot/public/v3/summary
request method: GET
consumes
produces ["*/*"]
Interface description
Parameters
Name | Description | Request Type | Mandatory | Type | schema |
---|---|---|---|---|---|
No Data |
Response Status:
Status | Description | schema |
---|---|---|
200 | OK | ReturnResult«List«SummaryResponse»» |
401 | Unauthorized | |
403 | Forbidden | |
404 | Not Found |
Response Parameter:
Name | Description | Type | schema |
---|---|---|---|
code | integer(int32) | integer(int32) | |
data | array | SummaryResponse | |
base_currency | string | ||
base_volume | string | ||
highest_bid | string | ||
highest_price_24h | string | ||
last_price | string | ||
lowest_ask | string | ||
lowest_price_24h | string | ||
price_change_percent_24h | string | ||
quote_currency | string | ||
quote_volume | string | ||
trading_pairs | string | ||
msg | string |
Assets
interface address: /spot/public/v3/assets
request method: GET
consumes
produces ["*/*"]
Interface description
Parameters
Name | Description | Request Type | Mandatory | Type | schema |
---|---|---|---|---|---|
No Data |
Response Status:
Status | Description | schema |
---|---|---|
200 | OK | ReturnResult«JSONObject» |
401 | Unauthorized | |
403 | Forbidden | |
404 | Not Found |
Response Parameter:
Name | Description | Type | schema |
---|---|---|---|
code | integer(int32) | integer(int32) | |
data | object | ||
msg | string |
Ticker
request method: /spot/public/v3/ticker
request method: GET
consumes
produces ["*/*"]
Interface description
request parameters
Name | Description | Request Type | Mandatory | Type | schema |
---|---|---|---|---|---|
No Data |
Response Status:
Status | Description | schema |
---|---|---|
200 | OK | ReturnResult«JSONObject» |
401 | Unauthorized | |
403 | Forbidden | |
404 | Not Found |
Response Parameter:
Name | Description | Type | schema |
---|---|---|---|
code | integer(int32) | integer(int32) | |
data | object | ||
msg | string |
Order Book
request method: /spot/public/v3/orderbook
request method: GET
consumes
produces ["*/*"]
Interface description
Parameters
Name | Description | Request Type | Mandatory | Type | schema |
---|---|---|---|---|---|
market_pair | BTC_ETH | query | true | string | |
depth | depth | query | false | integer | |
level | level | query | false | integer |
Response Status:
Status | Description | schema |
---|---|---|
200 | OK | ReturnResult«OrderBookResponse» |
401 | Unauthorized | |
403 | Forbidden | |
404 | Not Found |
Response Parameter:
Name | Description | Type | schema |
---|---|---|---|
code | integer(int32) | integer(int32) | |
data | OrderBookResponse | OrderBookResponse | |
asks | array | array | |
bids | array | array | |
ticker_id | string | ||
timestamp | string | ||
msg | string |
Trades
request method: /spot/public/v3/trades
request method: GET
consumes
produces ["*/*"]
Interface description
Parameters
Name | Description | Request Type | Mandatory | Type | schema |
---|---|---|---|---|---|
market_pair | BTC_ETH | query | true | string |
Response Status:
Status | Description | schema |
---|---|---|
200 | OK | ReturnResult«OrderBookResponse» |
401 | Unauthorized | |
403 | Forbidden | |
404 | Not Found |
Response Parameter:
Name | Description | Type | schema |
---|---|---|---|
code | integer(int32) | integer(int32) | |
data | array | TradesResponse | |
base_volume | string | ||
price | string | ||
quote_volume | string | ||
timestamp | string | ||
trade_id | string | ||
type | string | ||
msg | string |