API 指南

三个 REST 端点，GET 请求，JSON 响应

本站提供三个公开 API，均为 GET 请求、JSON 响应、无需鉴权。 响应头 Cache-Control: no-store，每次调用都返回新数据。

GET/api/generate

生成一条完整记录

参数说明必填
state州缩写（如 NY）。不传则全国随机可选
city城市名（需配合 state）。不传则州内随机可选
has_number1 时强制街道含门牌号可选
zip41 时生成 ZIP+4 格式邮编可选

GET/api/generate/batch

批量生成记录

参数说明必填
count生成条数，钳制到 1-100，默认 10必填
state州缩写可选
city城市名可选
has_number1 时强制门牌号可选
zip41 时 ZIP+4可选

GET/api/cities

返回州的城市列表；不传 state 返回全部州

参数说明必填
state州缩写。不传返回全部州列表可选

curl 示例

单条生成（纽约 + ZIP+4）：

curl "https://www.usaddrgen.com/api/generate?state=NY&zip4=1"

批量生成 20 条加州：

curl "https://www.usaddrgen.com/api/generate/batch?count=20&state=CA"

获取纽约城市列表：

curl "https://www.usaddrgen.com/api/cities?state=NY"

响应示例

单条生成响应：

{
  "success": true,
  "data": {
    "fullName": "Sarah Rivera",
    "street": "679 2nd Place",
    "city": "Garden City",
    "state": "NY",
    "zipCode": "11530",
    "latitude": "40.714005",
    "longitude": "-73.665025",
    "isRealAddress": true,
    "phone": "(518) 401-2338",
    "ssn": "937-20-5804",
    "cardNumber": "4222 4075 9755 8100",
    "..."
  }
}