AddrID
API v1 · OpenAPI 3.1

AddrID API 文档

OpenAPI JSON创建 API Key
所有端点都返回 JSON。生成响应默认 no-store，完整模拟资料不会写入服务器日志。

快速开始

curl https://addrid.com/api/v1/generate \
  -H "Authorization: Bearer $ADDRID_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"country":"US","locale":"en_US","count":2,"seed":12004}'

端点

POST/api/v1/generate生成一条或多条记录
POST/api/v1/generate/batch按当前配额批量生成
GET/api/v1/countries国家与字段能力元数据
GET/api/v1/localesLocale 能力矩阵
GET/api/v1/usage每日用量汇总

请求字段

country、locale、count、seed、gender、ageMin、ageMax、region、city、fields、preset、includeCompany、includeInternet 和 outputFormat 均通过 Zod 校验。

响应结构

{
  "success": true,
  "data": [{ "synthetic": true }],
  "meta": {
    "count": 1,
    "seed": 12004,
    "locale": "en_US",
    "generatedAt": "…",
    "synthetic": true,
    "warnings": []
  }
}

限流

响应包含 RateLimit-Limit、RateLimit-Remaining 和 RateLimit-Reset。每个 API Key 有独立的分钟限额和每日配额。

错误码

401 API Key 无效
密钥缺失、已吊销、已过期或无效。
403 Origin 被拒绝
请求 Origin 不在密钥允许列表中。
422 校验失败
一个或多个请求字段未通过校验。
429 配额已耗尽
分钟或每日配额已经耗尽。