Query Ticker Information and Statistics
Endpoint Information
Endpoint: GET /api/v1/tickers/{symbol}/stats?exchange={exchange}
Description: Get statistics for a specific stock, including basic information and trading statistics
Authentication: Accessible anonymously
Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| symbol | string | Yes | Route parameter, stock symbol |
| exchange | int | Yes | URL parameter, exchange code. See Exchange enum type description |
| chain_id | int | No | URL parameter, blockchain network ID. If not provided, queries and aggregates statistics from all chains |
Response Parameters
| Field | Type | Description |
|---|---|---|
| ticker | string | Stock symbol |
| name | string | Stock name |
| chain_id | int | Blockchain network ID (only returned when chain_id is specified in query) |
| address | string | Token address (only returned when chain_id is specified in query) |
| exchange | int | Exchange code. See Exchange enum type description |
| orders | int | Order count |
| volume | string | Volume (sum of price × quantity) |
Request Example
Query Using Default Chain ID (Query All Chains)
bash
curl -X GET "/api/v1/tickers/AAPLs/stats?exchange=0" \
-H "Content-Type: application/json"Query Specifying Chain ID
bash
curl -X GET "/api/v1/tickers/AAPLs/stats?exchange=0&chain_id=56" \
-H "Content-Type: application/json"Response Example
Query Statistics for Specific Chain
json
{
"code": 0,
"data": {
"ticker": "AAPLs",
"name": "Apple Inc.",
"chain_id": 11155111,
"address": "0x1234567890abcdef...",
"exchange": 0,
"orders": 150,
"volume": "50000"
}
}Query Aggregated Statistics for All Chains
json
{
"code": 0,
"data": {
"ticker": "AAPLs",
"name": "Apple Inc.",
"exchange": 0,
"orders": 320,
"volume": "125000"
}
}Note: When querying all chains, the response does not include chain_id and address fields.
Implementation Notes
- Supports querying statistics on specific blockchain networks via the
chain_idparameter - If
chain_idis not provided, the system queries data from all chains and aggregates statistics - When querying specific chain:
- Response includes
chain_idandaddressfields addressis the token contract address for the stock on the specified chain
- Response includes
- When querying all chains:
- Response does not include
chain_idandaddressfields (as it may span multiple chains) ordersandvolumeare aggregated data from all chains
- Response does not include
ordersfield represents the total number of orders for the stockvolumefield represents trading volume (sum of price × quantity)- Only statistics for active tickers (
is_active = true) are counted