Parse An Address

POST/v1/addver/parses

Parses a freeform address string into its individual components (house number, street name, city, state, postal code, etc.).

Useful for extracting structured data from a single-line address without running a full verification.

Uses 1 lookup.

Body ParametersJSONExpand Collapse

address: string

The address you want to verify, written on a single line.

ReturnsExpand Collapse

data: object { category, city, cityDistrict, 13 more }

category: optional string

The category of the location (e.g. restaurant).

city: optional string

The city name.

cityDistrict: optional string

The borough within a city.

country: optional string

The country.

house: optional string

The name of the location.

houseNumber: optional string

The house or street number.

island: optional string

The name of the island.

level: optional string

The floor.

near: optional string

Populated if the input query contains a near/in qualifier.

poBox: optional string

The postal office box.

postcode: optional string

The postal or ZIP code.

road: optional string

The street name.

state: optional string

The state or province.

stateDistrict: optional string

The county.

suburb: optional string

The unofficial neighborhood name.

unit: optional string

The apartment, unit, office, lot, or other secondary unit designator.

message: string

status: "success" or "error"

One of the following:

"success"

"error"

Parse An Address

curl https://api.postgrid.com/v1/addver/parses \
    -H 'Content-Type: application/json' \
    -H "X-API-Key: $POSTGRID_ADDRESS_VERIFICATION_API_KEY" \
    -d '{
          "address": "address"
        }'

{
  "data": {
    "category": "category",
    "city": "city",
    "cityDistrict": "cityDistrict",
    "country": "country",
    "house": "house",
    "houseNumber": "houseNumber",
    "island": "island",
    "level": "level",
    "near": "near",
    "poBox": "poBox",
    "postcode": "postcode",
    "road": "road",
    "state": "state",
    "stateDistrict": "stateDistrict",
    "suburb": "suburb",
    "unit": "unit"
  },
  "message": "message",
  "status": "success"
}

Returns Examples

{
  "data": {
    "category": "category",
    "city": "city",
    "cityDistrict": "cityDistrict",
    "country": "country",
    "house": "house",
    "houseNumber": "houseNumber",
    "island": "island",
    "level": "level",
    "near": "near",
    "poBox": "poBox",
    "postcode": "postcode",
    "road": "road",
    "state": "state",
    "stateDistrict": "stateDistrict",
    "suburb": "suburb",
    "unit": "unit"
  },
  "message": "message",
  "status": "success"
}