Query API Overview

Authentication and common patterns for the Finance API query endpoints.

Authentication

All query endpoints require an API key via the F-API-KEY header.

F-API-KEY: fk-xxxxx

Obtain an API key from the dashboard.

Requests are subject to per-key rate limits based on the quotas configured for your key.

Every query endpoint supports the following parameters:

Parameter	Type	Default	Description
`limit`	integer	`100`	Max rows per page (max `1000`)
`offset`	integer	`0`	Number of rows to skip
`sort`	string	endpoint-specific	Field to sort by
`order`	`asc` \| `desc`	endpoint-specific	Sort direction

Exact match filters vary by endpoint. Pass the field name and value as query parameters:

GET /api/v1/etf/basic?code=510300&exchange=SH

Like (fuzzy) filters support partial matches using SQL LIKE %value%:

GET /api/v1/etf/basic?name=沪深300

Date range filters use date_from and date_to on endpoints that support time-series data:

GET /api/v1/etf/nav?code=510300&date_from=2024-01-01&date_to=2024-01-31

All query endpoints return a unified JSON structure:

{
  "code": 0,
  "message": "ok",
  "data": [...],
  "meta": {
    "total": 1250,
    "limit": 100,
    "offset": 0,
    "has_more": true
  }
}

Field	Description
`code`	`0` means success; non-zero indicates an error
`message`	Human-readable status message
`data`	Array of result rows
`meta.total`	Total matching rows (ignoring pagination)
`meta.limit`	Rows returned in this request
`meta.offset`	Current offset
`meta.has_more`	Whether more results exist

ETF — ETF basic info, NAV, price, size, flow, holdings, PCF, dividends, kline
A-Share — Stock spot data, financials, industry classification
Index — Index constituents, price, metadata
Macro & Market — Macro indicators, margin trading, HK Stock Connect flows
US Stocks — US companies, SEC filings, financial facts, insider trades, 13F holdings