DEVELOPER DOCS / API V1

币种与关联地区

查询 ISO 币种、名称、符号及使用地区,并导出参考目录。

GET/v1/currencies

用途与边界

匿名与登录返回相同参考字段,币种导出不要求登录。此接口不返回汇率,不支持生效日期筛选;报价请使用 /v1/exchange-rates。名称和关联地区是参考数据,不代表支付或结算支持。

请求参数

参数类型 / 位置说明
q / countrystring · query搜索代码、名称、符号或关联地区;country 按地区筛选。
cursor / limitstring / integer · 选填 · query默认 50 条,limit 为 1–500。保持筛选不变并使用 next_cursor;400 INVALID_CURSOR 时检查参数,409 CURSOR_VERSION_MISMATCH 时重建快照。
formatjson | csv | xlsx · query默认 json。导出使用同一筛选、不接受 cursor,直接返回文件。

请求示例

cURL / 合成示例
curl 'https://YOUR_IR21DATA_HOST/api/v1/currencies?q=USD&limit=20' -H "X-API-Key: $IR21DATA_API_KEY"

curl 'https://YOUR_IR21DATA_HOST/api/v1/currencies?country=US&format=csv' -H "X-API-Key: $IR21DATA_API_KEY" -o currencies.csv

成功响应示例

以下是结构示例,不是当前在线目录的查询结果。

JSON
{
  "code": 0,
  "data": {
    "items": [
      {
        "code": "USD",
        "name_cn": "美元",
        "name_en": "US Dollar",
        "symbol": "$",
        "country_iso2s": [
          "US"
        ],
        "source": "synthetic-example"
      }
    ],
    "total": 1,
    "next_cursor": null
  },
  "meta": {
    "request_id": "example-request-id",
    "dataset_version": "example-v1",
    "source_mode": "demo",
    "source_published_at": null,
    "ingested_at": "2026-09-08T00:00:00Z"
  }
}

data 字段语义

字段类型说明
items / total / next_cursorarray / number / string | null当前页、匹配总数、下一页游标;null 表示结束,未命中为 items:[]。
code / name_cn / name_en / symbolstring币种代码、名称与符号;符号不是唯一标识。
country_iso2sstring[]关联地区,可为多值。
sourcestring参考数据署名;与汇率报价来源分开。

响应、鉴权与错误

数据接口支持X-API-Key 或同源 Cookie 会话。匿名访问为受限公共投影,完整字段权限由 API 服务执行。JSON 成功响应统一为{code:0,data,meta};文件导出直接返回文件。

字段说明
meta.request_id本次请求标识,用于排查错误,不包含密钥。
meta.dataset_version / source_mode当前数据版本与 demo / ir21 / reference / mixed 来源模式。
meta.source_published_at源发布时间;未知为 null。
meta.ingested_at平台导入时间,ISO 格式 UTC。

400 表示参数不符,401 表示需要有效凭证,403 表示权限不足,409 表示目录或游标版本冲突,429 表示调用限制,503 表示服务或数据源暂不可用。请读取错误响应的 code、message、request_id,详见错误与重试。

ERROR / 示意结构
{
  "code": "EXAMPLE_ERROR_CODE",
  "message": "具体错误原因由服务端返回",
  "request_id": "example-request-id"
}