> ## 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
````