AddrID
API v1 · OpenAPI 3.1

AddrID API documentation

OpenAPI JSONCreate API key
Every endpoint returns JSON. Generated responses use no-store and complete synthetic records are never written to server logs.

Quick start

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}'

Endpoints

POST/api/v1/generateGenerate one or more records
POST/api/v1/generate/batchBatch generation up to your current limit
GET/api/v1/countriesCountry and capability metadata
GET/api/v1/localesLocale capability matrix
GET/api/v1/usageDaily usage totals

Request fields

country, locale, count, seed, gender, ageMin, ageMax, region, city, fields, preset, includeCompany, includeInternet and outputFormat are validated with Zod.

Response envelope

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

Rate limits

Responses include RateLimit-Limit, RateLimit-Remaining and RateLimit-Reset. Limits apply per API key, with an additional daily quota.

Errors

401 Invalid API key
Key missing, revoked, expired or invalid.
403 Origin rejected
Request origin is outside the key allowlist.
422 Validation failed
One or more request fields failed validation.
429 Quota exceeded
Minute or daily quota has been exhausted.