EN

API 文档

快速开始

先理解 Axiora 的数据边界、鉴权方式和首个请求,再进入各个数据域文档。

打开 llm.txt

Axiora 提供面向 A 股市场的统一数据 API。文档站不只是把 OpenAPI 渲染出来,而是按接入者真正会经历的流程组织:先理解平台,再确认鉴权、请求约定、返回结构,最后进入具体数据域。

概览

  • 所有公开数据接口都位于 /api/v1
  • 同一套文档同时服务产品接入、研究脚本和自动化工作流
  • 账户、登录和 API key 管理在站点右上角完成,数据请求走标准 HTTP API

推荐阅读顺序

如果你是第一次接入,建议先读完“认证与 API Key”“请求约定”“返回结构与错误”,再进入股票、指数、基金等具体数据文档。这样你看到每个 endpoint 的时候,会知道参数、分页、时间字段和错误码分别意味着什么。

第一个请求

GET/api/v1/markets

List supported markets

listMarkets

需要 API Key

这条接口适合作为连通性和响应结构的第一条请求。它返回平台支持的市场标识,通常也是后续查询里会反复使用的参数来源。

该接口未定义请求参数。

状态码说明Schema
200Market collectionMarketCollectionResponse
401UnauthorizedErrorResponse

MarketCollectionResponse

字段类型必填说明
dataArray<Market>
data[].idMarketId
data[].namestring
metaMeta
meta.next_cursorstring | null
linksSelfLinks
links.selfstring
curlbash
curl https://heliumlabz.com/api/v1/markets
JavaScript fetchts
const response = await fetch("https://heliumlabz.com/api/v1/markets");
const payload = await response.json();

console.log(payload.data);

接下来读什么

  • 如果你需要受保护接口,继续看“认证与 API Key”
  • 如果你需要知道日期、时间、分页和查询参数约定,继续看“请求约定”
  • 如果你准备直接拉股票、指数或基金数据,进入对应数据域文档

关于 Reference 页面

站内保留了一份原始 OpenAPI Reference,它适合快速查 operationId、路径和 schema 名称。真正的接入说明、示例和字段解释,以这套人工维护的文档为主。