v50

latestOpenAPI 3.0.3AGPLv3raw.githubusercontent.com2026-04-1028178439.6 KB
Address Search

Retrieve Address

Resolves an address autocompletion by its address ID.

Resolved addresses (including global addresses) are returned in a US format (up to 2 address lines) using US nomenclature (like zipcode, state and city).

get/autocomplete/addresses/{address}/usa

Path parameters

addressstring required

ID of address suggestion

ID of address suggestion provided by the API to fully retrieve.

Query parameters

api_keystring

API Key

Your unique identifier that allows access to our APIs.

Begins ak_. Available from your dashboard

tagsstring

** Tags ** A comma separated list of tags to query over.

Useful if you want to specify the circumstances in which the request was made.

If multiple tags are specified, the response will only comprise of requests for which all the tags are satisfied - i.e. searching "foo,bar" will only query requests which tagged both "foo" and "bar".

Response

Success

code2000 required
message'Success' required

Example response

{
  "result": {
    "id": "paf_8387729",
    "primary_number": "A298",
    "secondary_number": "123A",
    "plus_4_code": "1234",
    "line_1": "12 Armstrong Ct Apt 12",
    "line_2": "9450 Pinecroft Dr",
    "last_line": "Greenwich CT 06830-1234",
    "zip_code": "1234",
    "zip_plus_4_code": "12345-6789",
    "update_key_number": "00000001",
    "carrier_route_id": "R012",
    "street_name": "GOSHEN",
    "street_suffix_abbreviation": "ST",
    "building_or_firm_name": "POSTMASTER",
    "state_abbreviation": "NY",
    "state": "New York",
    "urbanization_city_state_key": "V18475",
    "preferred_last_line_city_state_key": "V13916",
    "county": "Suffolk",
    "city": "HOLTSVILLE",
    "city_abbreviation": "W TOWNSHEND",
    "preferred_city": "AGUADA",
    "finance_number": 351560,
    "congressional_district_number": 6,
    "county_number": 53
  }
}