openAPI-StarEx

# Spot Market Data

# K-Line Data

GET /v1/spot/market/klines

Module Type Resource Isolation Rate Limit
Spot Market(SPOT_MARKET) Query(QUERY) 5

# Parameters

Name Type Required Description
symbol String Yes Trading pair,eg.BTC/USDT
period String Yes Time granularity of returned data, which corresponds to the time interval of each candlestick, available options: [1min,5min,15min,30min,60min,4hour,1day,1mon,1week]
limit Int No Number of K-line data to be returned, available values: [1,1000],默认150

# Response Parameters

Name Type Description
id Long Timestamp in UTC, in seconds, used as the id for this candlestick
symbol String Trading pair
period String Time granularity
high Decimal Highest price in this period
open Decimal Opening price in this period
low Decimal Lowest price in this period
close Decimal Closing price in this period
amount Decimal Trading volume measured in the base currency
vol Decimal Trading volume measured in the quote currency
count Int Number of trades

# Request Example

GET /v1/spot/market/klines?limit=150&period=1min&symbol=BTC/USDT

# Response Example

{
  "code": "200",
  "message": "OK",
  "timestamp": "1687264134584",
  "data": [
    {
      "symbol": "BTC/USDT",
      "period": "1min",
      "id": "1687264080",
      "high": "26908.99",
      "open": "26901.4",
      "low": "26851.89",
      "close": "26862.72",
      "amount": "68.58573",
      "vol": "1844070.146055",
      "count": "191"
    },
    {
      "symbol": "BTC/USDT",
      "period": "1min",
      "id": "1687264020",
      "high": "26944.96",
      "open": "26937.17",
      "low": "26894.59",
      "close": "26901.4",
      "amount": "61.98514",
      "vol": "1668826.217133",
      "count": "121"
    }
  ]
}

# Recent Market Trades

GET /v1/spot/market/trade

Module Type Resource Isolation Rate Limit
Spot Market(SPOT_MARKET) Query(QUERY) 5

# Parameters

Name Type Required Description
symbol String Yes Trading pair,eg.BTC/USDT

# Response Parameters

Name Type Description
trades Array Trade records
| amount Decimal Trade volume
| price Decimal Trade price
| direction Trading initiator's direction (taker's order direction) BUY、SELL
| timestamp Long Trade timestamp
| tradeId Long Trade order ID
| symbol String Trading pair
| vol Decimal Order turnover

# Request Example

GET /v1/spot/market/trade?symbol=BTC/USDT

# Response Example

{
  "code": "200",
  "message": "OK",
  "timestamp": "1687264383325",
  "data": {
    "trades": [
      {
        "amount": "1.07729",
        "price": "26836.99",
        "direction": "SELL",
        "timestamp": "1687264380148",
        "tradeId": "596645628754759680",
        "symbol": "BTC/USDT",
        "vol": "28911.2209571"
      }
    ]
  }
}

# Market Depth Data

GET /v1/spot/market/depth

Module Type Resource Isolation Rate Limit
Spot Market(SPOT_MARKET) Query(QUERY) 5

# Parameters

Name Type Required Description
symbol String Yes Trading pair,eg.BTC/USDT
limit Int No Number of depth levels to be returned, available values:[5, 10, 20, 50, 100, 500],default100

# Response Parameters

Name Type Description
asks array All current sell orders [price, size]
bids array All current buy orders [price, size]

# Request Example

GET /v1/spot/market/depth?limit=5&symbol=BTC/USDT

# Response Example

{
  "code": "200",
  "message": "OK",
  "timestamp": "1687264098931",
  "data": {
    "bids": [
      [
        "26880.85",
        "1.80307"
      ],
      [
        "26877.08",
        "1.0218"
      ],
      [
        "26876.45",
        "1.17699"
      ],
      [
        "26876.37",
        "1.25906"
      ],
      [
        "26876.04",
        "1.93795"
      ]
    ],
    "asks": [
      [
        "26934.68",
        "1.31659"
      ],
      [
        "26935.62",
        "1.92772"
      ],
      [
        "26941.93",
        "1.11408"
      ],
      [
        "26971.91",
        "1.62224"
      ],
      [
        "26972.03",
        "1.20742"
      ]
    ]
  }
}

# Aggregated Market Data

GET /v1/spot/market/ticker

Module Type Resource Isolation Rate Limit
Spot Market(SPOT_MARKET) Query(QUERY) 5

# Parameters

Name Type Required Description
symbol String Yes Trading pair,eg.BTC/USDT

# Response Parameters

Name Type Description
id Int Query start time, unit：s
symbol String Trading pair
high Decimal Highest price in this period (rolling 24 hours)
open Decimal Opening price in this period (rolling 24 hours)
low Decimal Lowest price in this period (rolling 24 hours)）
close Decimal Latest price in this period (rolling 24 hours)
amount Decimal rading volume measured in the base currency (rolling 24 hours)
vol Decimal Trading volume measured in the quote currency (rolling 24 hours)
count Int Number of trades (rolling 24 hours)
priceChangePercent Decimal Percentage change in price
bid Array Current highest bid price [price, amount]
ask Array Current lowest ask price [price, amount]

# Request Example

GET /v1/spot/market/ticker?symbol=BTC/USDT

# Response Example

{
  "code": "200",
  "message": "OK",
  "timestamp": "1687264449117",
  "data": {
    "symbol": "BTC/USDT",
    "id": "1687264449104",
    "high": "26974.41",
    "open": "25591.31",
    "low": "25576.42",
    "close": "26849.06",
    "amount": "54965.37335",
    "vol": "1421314041.6349009",
    "count": "36667",
    "priceChangePercent": "0.049147542661",
    "bid": [
      "26826.11",
      "1.4072"
    ],
    "ask": [
      "26879.84",
      "1.81495"
    ]
  }
}

# Fetching Recent Trade Records

GET /v1/spot/market/trade/history

Module Type Resource Isolation Rate Limit
Spot Market(SPOT_MARKET) Query(QUERY) 5

# Parameters

Name Type Required Description
symbol String Yes Trading pair,eg.BTC/USDT
limit Int No Number of returned trade records, available values: [1, 2000], default1

# Response Parameters

Name Type Description
trades Array Trade records
| amount Decimal Trade volume
| price Decimal Trade price
| direction String Trading initiator's direction (taker's order direction) BUY, SELL
| timestamp Long Trade timestamp
| tradeId Long Trade order ID
| symbol String Trading pair
| vol Decimal Order turnover

# Request Example

GET  v1/spot/market/trade/history?limit=1&symbol=BTC/USDT

# Response Example

{
  "code": "200",
  "message": "OK",
  "timestamp": "1687264491542",
  "data": {
    "trades": [
      {
        "amount": "1.56101",
        "price": "26857.25",
        "direction": "BUY",
        "timestamp": "1687264490152",
        "tradeId": "596790985111343104",
        "symbol": "BTC/USDT",
        "vol": "41924.4358225"
      }
    ]
  }
}

# Recent 24-Hour Market Data

GET /v1/spot/market/ticker24h

Module Type Resource Isolation Rate Limit
Spot Market(SPOT_MARKET) Query(QUERY) 5

# Parameters

Name Type Required Description
symbol String Yes Trading pair,eg.BTC/USDT

# Response Parameters

Name Type Description
id Int Query start time, unit: s
symbol String Trading pair
high Decimal Highest price in this period (rolling 24 hours)
open Decimal Opening price in this period (rolling 24 hours)
low Decimal Lowest price in this period (rolling 24 hours)
close Decimal Latest price in this period (rolling 24 hours)
amount Decimal Trading volume measured in the base currency (rolling 24 hours)
vol Decimal Trading volume measured in the quote currency (rolling 24 hours)
count Int Number of trades (rolling 24 hours)
priceChangePercent Decimal Percentage change in price

# Request Example

GET /v1/spot/market/ticker24h?symbol=BTC/USDT

# Response Example

{
  "code": "200",
  "message": "OK",
  "timestamp": "1687264529031",
  "data": {
    "symbol": "BTC/USDT",
    "id": "1687264529026",
    "high": "26974.41",
    "open": "25582.15",
    "low": "25576.42",
    "close": "26857.27",
    "amount": "54991.02497",
    "vol": "1422073144.0360743",
    "count": "36682",
    "priceChangePercent": "0.049844129598"
  }
}

# Full 24-Hour Market Data

GET /v1/spot/market/fullTicker24h

Module Type Resource Isolation Rate Limit
Spot Market(SPOT_MARKET) Query(QUERY) 50

# Parameters

NONE

# Response Parameters

Name Type Description
id Int Query start time, unit: s
symbol String Trading pair
high Decimal Highest price in this period (rolling 24 hours)
open Decimal Opening price in this period (rolling 24 hours)
low Decimal Lowest price in this period (rolling 24 hours)
close Decimal Latest price in this period (rolling 24 hours)
amount Decimal Trading volume measured in the base currency (rolling 24 hours)
vol Decimal Trading volume measured in the quote currency (rolling 24 hours)
count Int Number of trades (rolling 24 hours)
priceChangePercent Decimal Percentage change in price

# Request Example

GET /v1/spot/market/fullTicker24h

# Response Example

{
  "code": "200",
  "message": "OK",
  "timestamp": "1687264529055",
  "data": [
    {
      "symbol": "BTC/USDT",
      "id": "1687264529041",
      "high": "68036.96",
      "open": "67757.88",
      "low": "67591.61",
      "close": "67765.12",
      "amount": "37.17293",
      "vol": "2522864.9923825",
      "count": "10614",
      "priceChangePercent": "0.000106851041"
    },
    {
      "symbol": "TRX/USDT",
      "id": "1687264529045",
      "high": "0.11212",
      "open": "0.111789",
      "low": "0.111009",
      "close": "0.11192",
      "amount": "2612328.05",
      "vol": "291183.50239715",
      "count": "26256",
      "priceChangePercent": "0.00117185054"
    }
  ]
}

← Spot Orders →