Exchange API Documentation

This documentation describes the public API endpoints for accessing exchange market data. All endpoints return JSON responses.

Base URL:

Authentication

These endpoints are public and do not require authentication.

Rate Limits

The API has a rate limit of 60 requests per minute per IP address. Excessive requests may result in temporary restrictions.

Endpoint 1: Order Book Depth

Description

Retrieves the current order book (bids and asks) for a specified market pair.

Endpoint

GET /api/v2/orderbook/

Parameters

Parameter	Required	Type	Description
ticker_id	Yes	String	Market pair identifier in BASE_QUOTE format (e.g., "BTC_USDT")
depth	No	Integer	Number of orders to return for each side (default: 100, max: 1000)

Response Format

{
    "ticker_id": "BTC_USDT",
    "timestamp": 1634567890,
    "bids": [
        ["50000.00000000", "1.25000000"],
        ["49950.00000000", "2.10000000"]
    ],
    "asks": [
        ["50100.00000000", "0.75000000"],
        ["50150.00000000", "3.20000000"]
    ]
}

Response Fields

ticker_id: The market pair identifier
timestamp: Current UNIX timestamp
bids: Array of bid orders [price, volume], sorted highest price first
asks: Array of ask orders [price, volume], sorted lowest price first

Test Order Book API

Response will appear here...

Endpoint 2: Ticker Data

Description

Retrieves 24-hour market statistics for all available trading pairs.

Endpoint

GET /api/v2/tickers/

Parameters

None

Response Format

[
    {
        "ticker_id": "BTC_USDT",
        "base_currency": "BTC",
        "target_currency": "USDT",
        "last_price": "50123.45000000",
        "base_volume": "125.50000000",
        "target_volume": "6300000.00000000",
        "bid": "50100.00000000",
        "ask": "50150.00000000",
        "high": "50500.00000000",
        "low": "49800.00000000",
        "change_24h": "+2.45"
    }
]

Response Fields (per market)

ticker_id: Market pair identifier
base_currency: Base currency symbol
target_currency: Quote currency symbol
last_price: Last traded price
base_volume: 24-hour trading volume in base currency
target_volume: 24-hour trading volume in quote currency
bid: Current best bid price
ask: Current best ask price
high: Highest price in last 24 hours
low: Lowest price in last 24 hours
change_24h: Percentage price change with sign

Test Ticker API

Response will appear here...

Error Responses

All endpoints return errors in the following format:

{
    "error": "Error message describing the issue"
}

Common Error Codes

400 Bad Request: Invalid parameters or missing required parameters
404 Not Found: Requested resource not found
500 Internal Server Error: Server-side error

Futures API

Public API endpoints for futures/perpetual contract market data.

Base URL:

Endpoint 3: Futures Tickers

Description

Retrieves 24-hour market statistics for all enabled futures/perpetual contracts.

Endpoint

GET /api/v2/futures/tickers/

Parameters

None

Response Format

[
    {
        "ticker_id": "BTC_USD_PERP",
        "contract_id": "btcusd-perp",
        "base_currency": "BTC",
        "target_currency": "USD",
        "contract_type": "perpetual",
        "last_price": "50123.45",
        "index_price": "50100.00",
        "mark_price": "50115.50",
        "base_volume": "125.50",
        "target_volume": "6300000.00",
        "bid": "50100.00",
        "ask": "50150.00",
        "high": "50500.00",
        "low": "49800.00",
        "change_24h": "+2.45",
        "funding_rate": "0.0100",
        "next_funding_at": "2025-01-01 08:00:00",
        "open_interest": "1500.50"
    }
]

Response Fields (per contract)

ticker_id: Contract ticker identifier (BASE_QUOTE_PERP)
contract_id: Internal contract identifier
base_currency: Base currency symbol
target_currency: Quote currency symbol
contract_type: Contract type (perpetual, quarterly, etc.)
last_price: Last traded price
index_price: Underlying asset index price
mark_price: Mark price used for liquidations
base_volume: 24-hour trading volume in base currency
target_volume: 24-hour trading volume in quote currency
bid: Current best bid price
ask: Current best ask price
high: Highest price in last 24 hours
low: Lowest price in last 24 hours
change_24h: Percentage price change with sign
funding_rate: Current funding rate
next_funding_at: Next funding payment timestamp
open_interest: Total open interest

Test Futures Tickers API

Response will appear here...

Endpoint 4: Futures Order Book

Description

Retrieves the current order book (bids and asks) for a specified futures contract.

Endpoint

GET /api/v2/futures/orderbook/

Parameters

Parameter	Required	Type	Description
contract_id	Yes	String	Futures contract identifier (e.g., "btcusd-perp")
depth	No	Integer	Number of orders per side (default: 50, max: 100)

Response Format

{
    "contract_id": "btcusd-perp",
    "symbol": "BTCUSD-PERP",
    "timestamp": 1634567890,
    "bids": [
        ["50000.00000000", "1.25000000"],
        ["49950.00000000", "2.10000000"]
    ],
    "asks": [
        ["50100.00000000", "0.75000000"],
        ["50150.00000000", "3.20000000"]
    ]
}

Response Fields

contract_id: The futures contract identifier
symbol: The contract symbol
timestamp: Current UNIX timestamp
bids: Array of bid orders [price, volume], sorted highest price first
asks: Array of ask orders [price, volume], sorted lowest price first

Test Futures Order Book API

Response will appear here...

General Error Responses

All endpoints return errors in the following format:

{
    "error": "Error message describing the issue"
}

Common Error Codes

400 Bad Request: Invalid parameters or missing required parameters
404 Not Found: Requested resource not found
500 Internal Server Error: Server-side error