Dashboard
Overview of your API usage and account status.
Quick Start
Use your API Key in the Authorization header:
API Keys
Manage your API credentials. Secret is shown only once after creation.
API Documentation
Reference for all available endpoints.
API Request Format / API 请求格式
All REST market-data requests use HMAC headers. Sign only the path part, not the query string.
Path Parameters / 路径参数
| Name | Required | Example | Description |
|---|---|---|---|
venue | Yes | BINANCE | Exchange venue. Current production support is BINANCE. |
symbol | Yes | BTCUSDT | Raw market symbol. |
data_type | Yes | depth | One of: depth, trade, kline, funding, oi, ls_ratio, liquidation, mark_index, options_mark, options_oi, spot, stablecoin, chain_data. |
REST Endpoints / REST 接口
Available data_type values:
| data_type | Meaning | Main fields |
|---|---|---|
depth | Order book depth snapshots | ts, bids, asks, last_update_id |
trade | Aggregated trades | ts, price, qty, side, trade_id |
kline | Realtime 5m exchange K-line stream | open, high, low, close, volume, closed |
funding | Funding rate and premium index | rate, next_funding_ts, mark_price, index_price |
oi | Open interest | oi |
ls_ratio | Long/short account ratio | long_ratio, short_ratio, ls_ratio |
liquidation | Force liquidation events | side, price, qty, notional |
mark_index | Mark/index price | mark_price, index_price, pred_funding |
options_mark | Options mark price and Greeks | mark_price, bid_iv, ask_iv, delta, gamma, theta, vega |
options_oi | Options open interest | open_interest, sum_open_interest |
spot | Spot ticker price | spot_price, source |
stablecoin | USDT/USDC liquidity | usdt_mcap, usdc_mcap, source |
chain_data | BTC on-chain context | mempool_size_mb, whale_tx_count_1h |
Response Format / 响应格式
Latest Snapshot Format / 最新快照格式
/latest returns the latest depth snapshot plus the realtime exchange K-line cache.
curl Example / curl 示例
Common Query Parameters
All endpoints share the same query parameters.
| Param | Type | Default | Description |
|---|---|---|---|
start | string | today | Start date/time YYYY-MM-DD or YYYY-MM-DDThh:mm:ss |
end | string | today | End date/time YYYY-MM-DD or YYYY-MM-DDThh:mm:ss |
limit | int | 100 | Rows per page (1-1000) |
offset | int | 0 | Row offset |
after_ts | int | - | ts >= after_ts (ms) |
before_ts | int | - | ts < before_ts (ms) |
Pagination: increment offset += limit until has_more == false. Or use next_cursor as before_ts.
WebSocket Request Format
Real-time trades, depth, kline, funding, OI, and long/short ratio via WebSocket. WebSocket access requires enterprise tier.
WebSocket Message Format
HMAC-SHA256 Signature
All authenticated REST requests require three headers:
Authentication Headers
Signature Payload
Node.js Example
Timestamp must be within 30 seconds of server time.
Billing & License
Current plan and available upgrades. Payment via USDT.
Current Plan
Upgrade Plan
License History
Upgrade Plan
Complete the payment and submit your transaction hash to activate.
Order Summary
How to Upgrade
Copy the USDT Address
Copy the TRC-20 address above. Supports USDT on TRON network only.
Transfer USDT
Send the exact amount from your wallet (Binance, OKX, etc.). TRC-20 transfers usually confirm within 1-2 minutes.
Paste the TxID
After sending, copy the transaction hash (TxID) from your wallet and paste it above.
Wait for Activation
Admin will verify the payment and activate your license. Usually within a few hours.
Profile
Account information.