GET /api/v1/index/meta

Returns metadata for market indices including name, compilation rule, and publish date.

Request

GET /api/v1/index/meta

Headers

Header	Value
F-API-KEY	Your API key

Query Parameters

Parameter	Type	Required	Filter	Description
index_code	string	No	exact	Index code
name	string	No	like	Index name (fuzzy match)
limit	integer	No	—	Max rows per page (default 100, max 1000)
offset	integer	No	—	Rows to skip (default 0)
sort	string	No	—	Sort field (default index_code)
order	asc | desc	No	—	Sort direction (default asc)

Example

curl -H "F-API-KEY: fk-xxxxx" \
  "https://finance-api.xp-java.workers.dev/api/v1/index/meta?index_code=000001"

Response

{
  "code": 0,
  "message": "ok",
  "data": [
    {
      "index_code": "000001",
      "name": "上证指数",
      "compile_rule": "市值加权",
      "publish_date": "1991-07-15",
      "source": "exchange",
      "updated_at": "2024-12-31T00:00:00Z"
    }
  ],
  "meta": {
    "total": 1,
    "limit": 100,
    "offset": 0,
    "has_more": false
  }
}