PostalAddress

Members

Variables

category

string category;

for category queries like "restaurants", etc.

city

string city;

any human settlement including cities, towns, villages, hamlets, localities, etc.

cityDistrict

string cityDistrict;

these are usually boroughs or districts within a city that serve some official purpose e.g. "Brooklyn" or "Hackney" or "Bratislava IV"

country

string country;

sovereign nations and their dependent territories, anything with an ISO-3166 code.

countryRegion

string countryRegion;

informal subdivision of a country without any political status

entrance

string entrance;

numbered/lettered entrance

house

string house;

venue name e.g. "Brooklyn Academy of Music", and building names e.g. "Empire State Building"

houseNumber

string houseNumber;

usually refers to the external (street-facing) building number. In some countries this may be a compount, hyphenated number which also includes an apartment number, or a block number (a la Japan), but libpostal will just call it the house_number for simplicity.

island

string island;

named islands e.g. "Maui"

level

string level;

expressions indicating a floor number e.g. "3rd Floor", "Ground Floor", etc.

near

string near;

phrases like "in", "near", etc. used after a category phrase to help with parsing queries like "restaurants in Brooklyn"

poBox

string poBox;

post office box: typically found in non-physical (mail-only) addresses

postcode

string postcode;

postal codes used for mail sorting

road

string road;

street name(s)

staircase

string staircase;

numbered/lettered staircase

state

string state;

a first-level administrative division. Scotland, Northern Ireland, Wales, and England in the UK are mapped to "state" as well (convention used in OSM, GeoPlanet, etc.)

stateDistrict

string stateDistrict;

usually a second-level administrative division or county.

suburb

string suburb;

usually an unofficial neighborhood name like "Harlem", "South Bronx", or "Crown Heights"

unit

string unit;

an apartment, unit, office, lot, or other secondary unit designator

worldRegion

string worldRegion;

currently only used for appending “West Indies” after the country name, a pattern frequently used in the English-speaking Caribbean e.g. “Jamaica, West Indies”

• Postal
• PostalAddress