> ## Documentation Index
> Fetch the complete documentation index at: https://docs.tickdb.ai/llms.txt
> Use this file to discover all available pages before exploring further.
# Symbol Query
> Query products supported by TickDB, covering forex, indices, US stocks, HK stocks, A-shares, China futures, and crypto markets, with the product list continuously growing.
## Notes
* Market codes are case-insensitive
* Refer to Data Specification for product naming conventions
* Only active products with confirmed availability are returned
* Use `market=CN&type=futures` to query available China futures
* You can also browse and search all supported products in the [TickDB Dashboard](https://tickdb.ai) product management page
## Markets & Product Types
Use `market` and `type` parameters to filter products flexibly. They can be used individually or combined.
| market | type | Description | Volume |
| ------ | ------- | ----------------------------- | -------------------- |
| GLOBAL | forex | Forex pairs & precious metals | 1,200+ |
| GLOBAL | indices | Market indices | 12,900+ |
| GLOBAL | crypto | Cryptocurrency pairs | 800+ |
| US | stock | US stocks | 12,400+ |
| HK | stock | Hong Kong stocks | 4,300+ |
| CN | stock | A-shares | 6,000+ |
| CN | futures | China futures | Continuously updated |
* `market` filters by specific market, e.g. `market=CN` returns A-shares and China futures
* `type` filters by product category, e.g. `type=stock` returns all stocks across US + HK + CN
* Combined: `market=HK&type=stock` returns only HK stocks
## Request Parameters
| Parameter | Required | Description |
| --------- | -------- | ----------------------------------------------------------- |
| type | No | Product type filter: stock, crypto, forex, indices, futures |
| market | No | Market filter: GLOBAL, US, HK, CN |
| limit | No | Number of results per page, default 100, max 1000 |
| offset | No | Pagination offset, default 0 |
## Response Fields
| Field | Description |
| ------------------ | ------------------------------------------------- |
| products | Array of products |
| └─ symbol | Product symbol code |
| └─ name | Product name |
| └─ market | Market code |
| └─ type | Product type (stock/crypto/forex/indices/futures) |
| └─ currency | Trading currency (CNY/USD/HKD/USDT) |
| └─ is\_active | Whether the symbol is active |
| └─ updated\_at | Last updated time |
| summary | Summary information |
| └─ total\_products | Total number of products |
| └─ by\_market | Count by market |
| └─ by\_type | Count by type |
| └─ last\_updated | Last updated time |
| pagination | Pagination information |
| └─ limit | Page size |
| └─ offset | Offset |
| └─ total | Total count |
| └─ count | Number of items returned in current page |
## OpenAPI
````yaml GET /v1/symbols/available
openapi: 3.0.0
info:
title: TickDB API
description: >-
Unified real-time market data API — one connection for Forex, indices, US
stocks, HK stocks, A-shares, China futures, and Crypto via REST and
WebSocket.
version: 1.0.2
contact:
email: support@tickdb.ai
servers:
- url: https://api.tickdb.ai
description: Production server
security:
- ApiKeyAuth: []
paths:
/v1/symbols/available:
get:
summary: Available Symbols
description: List tradable instruments and supported markets
parameters:
- name: type
in: query
required: false
description: Product type filter
schema:
type: string
enum:
- stock
- crypto
- forex
- indices
- futures
example: stock
- name: market
in: query
required: false
description: Market filter
schema:
type: string
enum:
- GLOBAL
- US
- HK
- CN
example: CN
- name: limit
in: query
required: false
description: Number of symbols per page (default 100, max 1000)
schema:
type: integer
minimum: 1
maximum: 1000
default: 100
example: 50
- name: offset
in: query
required: false
description: Offset for pagination (default 0)
schema:
type: integer
minimum: 0
default: 0
example: 0
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: object
properties:
code:
type: integer
example: 0
message:
type: string
example: success
data:
type: object
properties:
products:
type: array
items:
type: object
properties:
symbol:
type: string
example: 000001.SZ
name:
type: string
example: 平安银行
market:
type: string
example: CN
type:
type: string
example: stock
currency:
type: string
example: CNY
is_active:
type: boolean
example: true
updated_at:
type: string
format: date-time
example: '2026-03-15T20:27:58Z'
summary:
type: object
properties:
total_products:
type: integer
example: 32492
by_market:
type: object
additionalProperties:
type: integer
example:
CN: 6643
GLOBAL: 14833
HK: 2909
US: 8107
by_type:
type: object
additionalProperties:
type: integer
example:
crypto: 877
stock: 17658
forex: 1207
indices: 12750
last_updated:
type: string
format: date-time
example: '2026-03-27T11:09:44+08:00'
pagination:
type: object
properties:
limit:
type: integer
example: 10
offset:
type: integer
example: 0
total:
type: integer
example: 6642
count:
type: integer
example: 10
components:
securitySchemes:
ApiKeyAuth:
type: apiKey
in: header
name: X-API-Key
````