EN

API 文档

返回结构与错误

理解单对象与集合响应的 envelope、常见错误码,以及如何稳定解析 schema。

打开 llm.txt

Axiora 的接口不是“裸数组”式返回,而是围绕 datametalinks 组织统一 envelope。写客户端时,应先按 envelope 解析,再处理内部字段。

统一响应 envelope

GET/api/v1/markets/{market}

Get one market

getMarket

状态码说明Schema
200Market resourceMarketResponse
401UnauthorizedErrorResponse
404Resource not foundErrorResponse

MarketResponse

字段类型必填说明
dataMarket
data.idMarketId
data.namestring
linksSelfLinks
links.selfstring

单对象响应通常包含:

  • data:真正的业务对象
  • links:当前资源或相关链接

集合接口模式

GET/api/v1/equities

List equities

listEquities

状态码说明Schema
200Equity collectionInstrumentCollectionResponse
400Invalid request parametersErrorResponse
401UnauthorizedErrorResponse

InstrumentCollectionResponse

字段类型必填说明
dataArray<Instrument>
data[].idstring
data[].codestring
data[].exchangeMarketId
data[].marketstring
data[].asset_classequity | index | fund
data[].boardstring
data[].namestring
metaMeta
meta.next_cursorstring | null
linksSelfLinks
links.selfstring

集合响应在 data 之外,通常还会多出:

  • meta:分页和结果规模信息
  • links:翻页或自引用信息

错误响应

OpenAPI 里统一定义了未授权、未找到和参数错误等常见失败返回。客户端至少要做好这几类失败的分支处理。

ErrorResponse

字段类型必填说明
errorobject
error.codestring
error.messagestring
典型错误处理ts
const response = await fetch(url, options);

if (!response.ok) {
const payload = await response.json();
throw new Error(payload.error?.message ?? "Unknown API error");
}

const payload = await response.json();

不要只按 HTTP 200 处理

即使同一数据域里的多个接口返回结构类似,也不要把错误体当成成功体解析。先判断 HTTP 状态,再进入业务字段处理。