Skip to content
PostGrid PostGrid
Get started
API Reference
Address Verification

Parse An Address

address_verification.parse_an_address(AddressVerificationParseAnAddressParams**kwargs) -> AddressVerificationParseAnAddressResponse
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.
ParametersExpand Collapse
address: str

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

ReturnsExpand Collapse
class AddressVerificationParseAnAddressResponse: …
data: Data
category: Optional[str]

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

city: Optional[str]

The city name.

city_district: Optional[str]

The borough within a city.

country: Optional[str]

The country.

house: Optional[str]

The name of the location.

house_number: Optional[str]

The house or street number.

island: Optional[str]

The name of the island.

level: Optional[str]

The floor.

near: Optional[str]

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

po_box: Optional[str]

The postal office box.

postcode: Optional[str]

The postal or ZIP code.

road: Optional[str]

The street name.

state: Optional[str]

The state or province.

state_district: Optional[str]

The county.

suburb: Optional[str]

The unofficial neighborhood name.

unit: Optional[str]

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

message: str
status: Literal["success", "error"]
One of the following:
"success"
"error"

Parse An Address

import os
from postgrid import PostGrid

client = PostGrid(
    address_verification_api_key=os.environ.get("POSTGRID_ADDRESS_VERIFICATION_API_KEY"),  # This is the default and can be omitted
)
response = client.address_verification.parse_an_address(
    address="address",
)
print(response.data)
{
  "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"
}