GET
/v1/countries用途与边界
此参考目录匿名与登录字段相同。来源模式、版本与时间见 meta,不附加不存在的逐条 source 字段。不提供生效日期筛选或国家默认运营商;共享区号不能唯一确定国家。示例仅展示合成单页,实际共享区号可能有多页。
请求参数
| 参数 | 类型 / 位置 | 说明 |
|---|---|---|
q / country | string · query | q 搜索名称、ISO2/ISO3 或区号;country 精确筛选地区。 |
calling_code | string · query | 国际区号字符串;共享区号返回多个地区。 |
cursor / limit | string / integer · 选填 · query | 默认 50 条,limit 为 1–500。保持筛选不变并使用 next_cursor;400 INVALID_CURSOR 时检查参数,409 CURSOR_VERSION_MISMATCH 时重建快照。 |
请求示例
cURL / 合成示例
curl 'https://YOUR_IR21DATA_HOST/api/v1/countries?calling_code=1&limit=20' -H "X-API-Key: $IR21DATA_API_KEY"成功响应示例
以下是结构示例,不是当前在线目录的查询结果。
JSON
{
"code": 0,
"data": {
"items": [
{
"iso2": "US",
"iso3": "USA",
"name_cn": "美国",
"name_en": "United States",
"calling_codes": [
"1"
],
"currencies": [
"USD"
],
"mobile_portability_supported": null
}
],
"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_cursor | array / number / string | null | 当前页、匹配总数、下一页游标;null 表示结束,未命中为 items:[]。 |
iso2 / iso3 / name_cn / name_en | string | 地区代码与中英文名称。 |
calling_codes / currencies | string[] | 区号与 ISO 币种代码,可为多值。 |
mobile_portability_supported | boolean | null | 地区级参考值,不等于单网络声明或单号携转状态。null 为未知。 |
响应、鉴权与错误
数据接口支持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"
}