> ## 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.
# 产品查询
> 查询 TickDB 支持的产品，覆盖外汇、指数、美股、港股、A股、中国期货、加密货币等市场，产品列表持续增加中。
## 注意事项
* 市场代码不区分大小写
* 产品命名规则请参阅数据规范文档
* 仅返回状态为活跃且已确认可用的产品
* 使用 `market=CN&type=futures` 查询可用的中国期货
* 除 API 查询外，您也可以登录 [TickDB 官网](https://tickdb.ai) 用户中心，在产品管理页面直接浏览和搜索所有支持的产品
## 市场与产品类型
通过 `market` 和 `type` 参数可以灵活过滤产品，两者可单独或组合使用。
| market | type | 说明 | 产品量级 |
| ------ | ------- | --------- | ------- |
| GLOBAL | forex | 外汇货币对、贵金属 | 1,200+ |
| GLOBAL | indices | 市场指数 | 12,900+ |
| GLOBAL | crypto | 加密货币交易对 | 800+ |
| US | stock | 美国股票 | 12,400+ |
| HK | stock | 香港股票 | 4,300+ |
| CN | stock | A股 | 6,000+ |
| CN | futures | 中国期货 | 持续更新 |
* `market` 按具体市场过滤，如 `market=CN` 返回A股和中国期货
* `type` 按产品大类过滤，如 `type=stock` 返回 US + HK + CN 全部股票
* 组合使用：`market=HK&type=stock` 仅返回港股
## 请求参数
| 参数名 | 是否必须 | 描述 |
| ------ | ---- | ------------------------------------------------- |
| type | 否 | 产品类型过滤，可选值：stock, crypto, forex, indices, futures |
| market | 否 | 市场过滤，可选值：GLOBAL, US, HK, CN |
| limit | 否 | 每页返回数量，默认100，最大1000 |
| offset | 否 | 分页偏移量，默认0 |
## 返回字段说明
| 字段名 | 描述 |
| ------------------ | ---------------------------------------- |
| products | 产品数组 |
| └─ symbol | 产品代码 |
| └─ name | 产品名称 |
| └─ market | 市场代码 |
| └─ type | 产品类型（stock/crypto/forex/indices/futures） |
| └─ currency | 交易币种（CNY/USD/HKD/USDT） |
| └─ is\_active | 是否活跃 |
| └─ updated\_at | 更新时间 |
| summary | 汇总信息 |
| └─ total\_products | 产品总数 |
| └─ by\_market | 按市场统计数量 |
| └─ by\_type | 按类型统计数量 |
| └─ last\_updated | 最后更新时间 |
| pagination | 分页信息 |
| └─ limit | 每页数量 |
| └─ offset | 偏移量 |
| └─ total | 总数 |
| └─ count | 当前页返回数量 |
## 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
````