Address

Explore what information is available for addresses.

This type represents a physical or postal location commonly associated with a person or organization, such as a permanent home or office address.

Should I use state or region?

Some countries use regions instead of states for administrative divisions, so we included both to let you choose the best option for your scenario.

Properties

These are the available properties:

street(optional) string: The full street address. For example, "123 Main St".
city(optional) string: The city name. For example, "New York" or "São Paulo".
district(optional) string: The city district. For example, "Downtown".
region(optional) string: The name of the region or state. For example, "California".
state(optional) string: An alias for the region property.
country(optional) string: The country identifier. For example, "US" or "United States".
We recommend using the ISO 3166-1 alpha-2 code, but the identifier format is up to the implementation and can be a code, name, or any other identifier.
postalCode(optional) string: The postal or ZIP code. For example, "90210", "SW1A 1AA", or "12345-6789".