Address Search

Retrieve Address

Returns the full address for an autocomplete suggestion id.

This is the charged step of address autocomplete. A successful retrieval decrements your lookup balance. An id which resolves to no address returns 404.

Every address comes back in one US-shaped format, whatever country or dataset it came from: up to two address lines and US field names such as zip_code, state and city.

get/autocomplete/addresses/{address}/usa

Request

  • Base URL: https://api.addresszen.com/v1
  • URL: https://api.addresszen.com/v1/autocomplete/addresses/{address}/usa
  • Auth: HTTP bearer

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.

licenseestring

Licensee Key

Uniquely identifies a licensee.

filterstring

Restrict Result Fields

Comma separated whitelist of address elements to return.

E.g. filter=line_1,line_2,line_3 returns only the line_1, line_2 and line_3 address elements in your response.

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 you specify multiple tags, the response comprises only requests that satisfy all of them. Searching "foo,bar" queries only requests tagged both "foo" and "bar".

Response

Success

code2000 required
message'Success' required

Example response

{
  "result": {
    "id": "usps_V124884241|1040||0001",
    "dataset": "usps",
    "country": "United States",
    "country_iso": "USA",
    "country_iso_2": "US",
    "language": "en",
    "primary_number": "1040",
    "secondary_number": "",
    "plus_4_code": "0001",
    "line_1": "1040 Waverly Ave",
    "line_2": "",
    "last_line": "Holtsville NY 00501-0001",
    "zip_code": "00501",
    "zip_plus_4_code": "00501-0001",
    "update_key_number": "V124884241",
    "record_type_code": "S",
    "carrier_route_id": "C000",
    "street_pre_directional_abbreviation": "",
    "street_name": "Waverly",
    "street_suffix_abbreviation": "Ave",
    "street_post_directional_abbreviation": "",
    "building_or_firm_name": "",
    "address_secondary_abbreviation": "",
    "base_alternate_code": "B",
    "lacs_status_indicator": "",
    "government_building_indicator": "",
    "state_abbreviation": "NY",
    "state": "New York",
    "municipality_city_state_key": "",
    "urbanization_city_state_key": "",
    "preferred_last_line_city_state_key": "V13916",
    "county": "Suffolk",
    "city": "Holtsville",
    "city_abbreviation": "",
    "preferred_city": "Holtsville",
    "city_state_name_facility_code": "P",
    "zip_classification_code": "U",
    "city_state_mailing_name_indicator": "Y",
    "carrier_route_rate_sortation": "C",
    "finance_number": 353910,
    "congressional_district_number": 2,
    "county_number": 103
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.