API do gerador de enderecos residenciais reais

Autenticacao

Exceto saude, prontidao e OpenAPI, todos os endpoints exigem um Bearer Token criado no painel. Os tokens aceitam permissoes de leitura ou geracao, limite por minuto e expiracao.

Authorization: Bearer YOUR_API_TOKEN

GET/api/v1/health

Permissao: public

Verifica se o processo da API esta disponivel.

Parametros

Sem parametros de solicitacao.

Exemplos de chamada

curl "https://address.example/api/v1/health" \

import json
from urllib.request import Request, urlopen

request = Request(
    "https://address.example/api/v1/health",
    method="GET"
)
with urlopen(request) as response:
    print(json.load(response))

const response = await fetch("https://address.example/api/v1/health");
const payload = await response.json();
console.log(payload);

Resposta bem-sucedida

{
  "status": "ok"
}

GET/api/v1/ready

Permissao: public

Verifica se a API e o PostgreSQL estao prontos para receber trafego.

Parametros

Sem parametros de solicitacao.

Exemplos de chamada

curl "https://address.example/api/v1/ready" \

import json
from urllib.request import Request, urlopen

request = Request(
    "https://address.example/api/v1/ready",
    method="GET"
)
with urlopen(request) as response:
    print(json.load(response))

const response = await fetch("https://address.example/api/v1/ready");
const payload = await response.json();
console.log(payload);

Resposta bem-sucedida

{
  "status": "ready"
}

GET/api/v1/countries

Permissao: read

Lista paises, recursos, contagens e atalhos.

Parametros

Sem parametros de solicitacao.

Exemplos de chamada

curl "https://address.example/api/v1/countries" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \

import json
from urllib.request import Request, urlopen

request = Request(
    "https://address.example/api/v1/countries",
    headers={"Authorization":"Bearer YOUR_API_TOKEN"},
    method="GET"
)
with urlopen(request) as response:
    print(json.load(response))

const response = await fetch("https://address.example/api/v1/countries", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_API_TOKEN"
  },
});
const payload = await response.json();
console.log(payload);

Resposta bem-sucedida

{
  "data": [
    {
      "code": "US",
      "residentialAvailable": true,
      "residentialCount": 50000,
      "generationMode": "synchronized-pool"
    }
  ]
}

GET/api/v1/availability

Permissao: read

Retorna a lista leve de disponibilidade residencial.

Parametros

Sem parametros de solicitacao.

Exemplos de chamada

curl "https://address.example/api/v1/availability" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \

import json
from urllib.request import Request, urlopen

request = Request(
    "https://address.example/api/v1/availability",
    headers={"Authorization":"Bearer YOUR_API_TOKEN"},
    method="GET"
)
with urlopen(request) as response:
    print(json.load(response))

const response = await fetch("https://address.example/api/v1/availability", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_API_TOKEN"
  },
});
const payload = await response.json();
console.log(payload);

Resposta bem-sucedida

{
  "data": [
    {
      "code": "US",
      "residentialAvailable": true
    }
  ]
}

GET/api/v1/client-context

Permissao: read

Resolve o pais e o contexto de localizacao do IP.

Parametros

ipOpcional · query · stringOptional IPv4 or IPv6 address; omitted means the request IP.

Exemplos de chamada

curl "https://address.example/api/v1/client-context?ip=198.51.100.7" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \

import json
from urllib.request import Request, urlopen

request = Request(
    "https://address.example/api/v1/client-context?ip=198.51.100.7",
    headers={"Authorization":"Bearer YOUR_API_TOKEN"},
    method="GET"
)
with urlopen(request) as response:
    print(json.load(response))

const response = await fetch("https://address.example/api/v1/client-context?ip=198.51.100.7", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_API_TOKEN"
  },
});
const payload = await response.json();
console.log(payload);

Resposta bem-sucedida

{
  "data": {
    "country": "US",
    "region": "California",
    "city": "Los Angeles",
    "matchLevel": "city"
  }
}

GET/api/v1/locations/search

Permissao: read

Pesquisa regioes, cidades, distritos ou codigos postais com paginacao.

Parametros

countryOpcional · query · string · Padrao: USISO 3166-1 alpha-2 country code.

fieldOpcional · query · string · Padrao: cityCatalog field to return.

qOpcional · query · stringOptional case-insensitive search text.

regionOpcional · query · stringExact parent region value.

regionIdOpcional · query · stringStable parent region ID.

cityIdOpcional · query · stringStable parent city ID.

residentialOpcional · query · boolean · Padrao: falseRestrict counts to published residential records.

cursorOpcional · query · stringOpaque cursor returned by the previous page.

limitOpcional · query · integer · Padrao: 100 · 20-200Page size from 20 through 200.

Exemplos de chamada

curl "https://address.example/api/v1/locations/search?country=US&field=city&regionId=1416&limit=100" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \

import json
from urllib.request import Request, urlopen

request = Request(
    "https://address.example/api/v1/locations/search?country=US&field=city&regionId=1416&limit=100",
    headers={"Authorization":"Bearer YOUR_API_TOKEN"},
    method="GET"
)
with urlopen(request) as response:
    print(json.load(response))

const response = await fetch("https://address.example/api/v1/locations/search?country=US&field=city&regionId=1416&limit=100", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_API_TOKEN"
  },
});
const payload = await response.json();
console.log(payload);

Resposta bem-sucedida

{
  "data": {
    "cities": [
      {
        "id": "example-city",
        "value": "Los Angeles",
        "availableCount": 120
      }
    ],
    "total": 1,
    "nextCursor": null
  }
}

GET/api/v1/generate

Permissao: generate

Gera aleatoriamente um endereco residencial publicado e um perfil de teste.

Parametros

countryOpcional · query · string · Padrao: USISO 3166-1 alpha-2 country code.

regionOpcional · query · stringExact first-level region value.

regionIdOpcional · query · stringStable region ID from location search.

cityOpcional · query · stringExact city value.

cityIdOpcional · query · stringStable city ID from location search.

districtOpcional · query · stringExact district value where supported.

districtIdOpcional · query · stringStable district ID from location search.

postcodeOpcional · query · stringExact postcode value.

postcodeIdOpcional · query · stringStable postcode ID from location search.

modeOpcional · query · stringUse ip-region to match the request or supplied IP.

ipOpcional · query · stringIPv4 or IPv6 used with ip-region mode.

qOpcional · query · stringText that must occur in the selected address components.

strategyOpcional · query · string · Padrao: randomSelection strategy; both modes select from the synchronized database.

residentialOpcional · query · boolean · Padrao: trueLegacy compatibility flag; generation always returns residential records.

seedOpcional · query · stringOptional reproducible random seed.

requestIdOpcional · query · stringCaller-provided request correlation ID.

Exemplos de chamada

curl "https://address.example/api/v1/generate?country=US&region=California&requestId=YOUR_REQUEST_ID" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \

import json
from urllib.request import Request, urlopen

request = Request(
    "https://address.example/api/v1/generate?country=US&region=California&requestId=YOUR_REQUEST_ID",
    headers={"Authorization":"Bearer YOUR_API_TOKEN"},
    method="GET"
)
with urlopen(request) as response:
    print(json.load(response))

const response = await fetch("https://address.example/api/v1/generate?country=US&region=California&requestId=YOUR_REQUEST_ID", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_API_TOKEN"
  },
});
const payload = await response.json();
console.log(payload);

Resposta bem-sucedida

{
  "data": {
    "requestId": "YOUR_REQUEST_ID",
    "country": "US",
    "mode": "residential",
    "sourcesTried": [
      "address-pool-v2"
    ],
    "result": {
      "address": {
        "id": "address-id",
        "countryCode": "US",
        "formattedAddress": "Example address"
      }
    }
  }
}

POST/api/v1/generate/batch

Permissao: generate

Gera ate 50 enderecos residenciais com filtros estruturados, exclusoes e unicidade.

Parametros

countObrigatorio · body · integer · 1-50Number of addresses to generate.

filtersObrigatorio · body · objectCountry and exact administrative, postcode, or text filters.

optionsOpcional · body · objectRandomness, uniqueness, strategy, and request correlation options.

excludeAddressIdsOpcional · body · arrayAddress IDs that must not be returned.

Exemplos de chamada

curl -X POST "https://address.example/api/v1/generate/batch" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  --data '{
  "count": 3,
  "filters": {
    "country": "US",
    "region": "California",
    "city": "Los Angeles"
  },
  "options": {
    "unique": true,
    "strategy": "random",
    "seed": "example-seed"
  },
  "excludeAddressIds": []
}'

import json
from urllib.request import Request, urlopen

request = Request(
    "https://address.example/api/v1/generate/batch",
    headers={"Authorization":"Bearer YOUR_API_TOKEN","Content-Type":"application/json"},
    data=json.dumps({"count":3,"filters":{"country":"US","region":"California","city":"Los Angeles"},"options":{"unique":true,"strategy":"random","seed":"example-seed"},"excludeAddressIds":[]}),
    method="POST"
)
with urlopen(request) as response:
    print(json.load(response))

const response = await fetch("https://address.example/api/v1/generate/batch", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_API_TOKEN",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "count": 3,
    "filters": {
      "country": "US",
      "region": "California",
      "city": "Los Angeles"
    },
    "options": {
      "unique": true,
      "strategy": "random",
      "seed": "example-seed"
    },
    "excludeAddressIds": []
  })
});
const payload = await response.json();
console.log(payload);

Resposta bem-sucedida

{
  "data": {
    "requestId": "batch-request-id",
    "requestedCount": 3,
    "returnedCount": 3,
    "unique": true,
    "results": [
      {
        "address": {
          "id": "address-id",
          "countryCode": "US"
        }
      }
    ]
  }
}

GET/api/v1/locations/hierarchy

Permissao: read

Lista subdivisoes administrativas ou codigos postais filhos de um pais, regiao ou cidade.

Parametros

countryObrigatorio · query · stringISO 3166-1 alpha-2 country code.

childTypeObrigatorio · query · stringChild catalog type to return.

parentTypeOpcional · query · string · Padrao: countryType of parent identified by parentId.

parentIdOpcional · query · stringStable region or city ID; omit for a country parent.

qOpcional · query · stringOptional child-name search text.

residentialOpcional · query · boolean · Padrao: trueInclude residential availability and disable uncovered options.

cursorOpcional · query · stringOpaque cursor returned by the previous page.

limitOpcional · query · integer · Padrao: 100 · 20-200Page size from 20 through 200.

Exemplos de chamada

curl "https://address.example/api/v1/locations/hierarchy?country=US&parentType=region&parentId=1416&childType=city&limit=100" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \

import json
from urllib.request import Request, urlopen

request = Request(
    "https://address.example/api/v1/locations/hierarchy?country=US&parentType=region&parentId=1416&childType=city&limit=100",
    headers={"Authorization":"Bearer YOUR_API_TOKEN"},
    method="GET"
)
with urlopen(request) as response:
    print(json.load(response))

const response = await fetch("https://address.example/api/v1/locations/hierarchy?country=US&parentType=region&parentId=1416&childType=city&limit=100", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_API_TOKEN"
  },
});
const payload = await response.json();
console.log(payload);

Resposta bem-sucedida

{
  "data": {
    "parent": {
      "type": "region",
      "id": "1416"
    },
    "childType": "city",
    "children": [
      {
        "id": "example-city",
        "value": "Los Angeles",
        "availableCount": 120
      }
    ],
    "total": 1,
    "nextCursor": null
  }
}

GET/api/v1/coverage

Permissao: read

Relata as tres regras de conclusao da sincronizacao para os paises ativos.

Parametros

countryOpcional · query · stringOptional ISO country code filter.

includeCompleteOpcional · query · boolean · Padrao: trueInclude countries that already satisfy all three rules.

Exemplos de chamada

curl "https://address.example/api/v1/coverage?country=US&includeComplete=true" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \

import json
from urllib.request import Request, urlopen

request = Request(
    "https://address.example/api/v1/coverage?country=US&includeComplete=true",
    headers={"Authorization":"Bearer YOUR_API_TOKEN"},
    method="GET"
)
with urlopen(request) as response:
    print(json.load(response))

const response = await fetch("https://address.example/api/v1/coverage?country=US&includeComplete=true", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_API_TOKEN"
  },
});
const payload = await response.json();
console.log(payload);

Resposta bem-sucedida

{
  "data": {
    "countries": [
      {
        "countryCode": "US",
        "complete": false,
        "rules": {
          "total": {
            "current": 42000,
            "target": 50000,
            "met": false
          },
          "administrativeCoverage": {
            "actual": 0.98,
            "target": 1,
            "met": false
          },
          "regionalMinimums": {
            "actual": 0.95,
            "target": 1,
            "met": false
          }
        }
      }
    ]
  }
}

GET/api/v1/addresses/{id}

Permissao: read

Recupera um endereco sincronizado atualmente publicado pelo ID.

Parametros

idObrigatorio · path · stringAddress ID returned by generate or batch generation.

Exemplos de chamada

curl "https://address.example/api/v1/addresses/pool-v2-address-id" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \

import json
from urllib.request import Request, urlopen

request = Request(
    "https://address.example/api/v1/addresses/pool-v2-address-id",
    headers={"Authorization":"Bearer YOUR_API_TOKEN"},
    method="GET"
)
with urlopen(request) as response:
    print(json.load(response))

const response = await fetch("https://address.example/api/v1/addresses/pool-v2-address-id", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_API_TOKEN"
  },
});
const payload = await response.json();
console.log(payload);

Resposta bem-sucedida

{
  "data": {
    "address": {
      "id": "pool-v2-address-id",
      "countryCode": "US",
      "formattedAddress": "Example address"
    }
  }
}

POST/api/v1/address-translation

Permissao: generate

Traduz um endereco sincronizado para um idioma compativel.

Parametros

addressIdObrigatorio · body · stringAddress ID returned by generate.

targetLocaleObrigatorio · body · stringTarget display locale.

Exemplos de chamada

curl -X POST "https://address.example/api/v1/address-translation" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  --data '{
  "addressId": "address-id",
  "targetLocale": "zh-CN"
}'

import json
from urllib.request import Request, urlopen

request = Request(
    "https://address.example/api/v1/address-translation",
    headers={"Authorization":"Bearer YOUR_API_TOKEN","Content-Type":"application/json"},
    data=json.dumps({"addressId":"address-id","targetLocale":"zh-CN"}),
    method="POST"
)
with urlopen(request) as response:
    print(json.load(response))

const response = await fetch("https://address.example/api/v1/address-translation", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_API_TOKEN",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "addressId": "address-id",
    "targetLocale": "zh-CN"
  })
});
const payload = await response.json();
console.log(payload);

Resposta bem-sucedida

{
  "data": {
    "components": {
      "street": "示例街道",
      "houseNumber": "20"
    },
    "lines": [
      "示例地址"
    ],
    "singleLine": "示例地址"
  }
}

GET/api/v1/data-health

Permissao: read

Relata a saude dos pools sincronizados e erros de configuracao.

Parametros

Sem parametros de solicitacao.

Exemplos de chamada

curl "https://address.example/api/v1/data-health" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \

import json
from urllib.request import Request, urlopen

request = Request(
    "https://address.example/api/v1/data-health",
    headers={"Authorization":"Bearer YOUR_API_TOKEN"},
    method="GET"
)
with urlopen(request) as response:
    print(json.load(response))

const response = await fetch("https://address.example/api/v1/data-health", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_API_TOKEN"
  },
});
const payload = await response.json();
console.log(payload);

Resposta bem-sucedida

{
  "data": {
    "healthy": true,
    "countries": [
      {
        "code": "US",
        "ready": true,
        "count": 50000
      }
    ],
    "configurationErrors": []
  }
}

Erros

400INVALID_REQUEST

401UNAUTHORIZED

404NO_POOL_COVERAGE / ADDRESS_NOT_FOUND

429RATE_LIMITED · Retry-After: 60

500 / 503INTERNAL_ERROR / SERVICE_UNAVAILABLE