curl --request GET \
--url https://{defaultHost}/v1/public/atlas/{country_code} \
--header 'Authorization: Bearer <token>'{
"address_formats": {
"edit": "{{country}}_{{name}}_{{line_1}}_{{line_2}}_{{city}}{{state}}{{postal_code}}",
"show": "{{name}}_{{line_1}}_{{line_2}}_{{city}} {{state}} {{postal_code}}_{{country}}"
},
"address_labels": {
"line_1": "Address",
"line_2": "Apartment, suite, etc",
"city": "City",
"state": "State",
"postal_code": "ZIP code"
},
"city_required": true,
"code": "US",
"name": "United States",
"postal_code_required": true,
"state_required": true,
"states": [
{
"code": "AL",
"name": "Alabama"
},
{
"code": "AK",
"name": "Alaska"
},
{
"code": "AS",
"name": "American Samoa"
},
{
"code": "AZ",
"name": "Arizona"
},
{
"code": "AR",
"name": "Arkansas"
},
{
"code": "CA",
"name": "California"
},
{
"code": "CO",
"name": "Colorado"
},
{
"code": "CT",
"name": "Connecticut"
},
{
"code": "DE",
"name": "Delaware"
},
{
"code": "DC",
"name": "Washington DC"
},
{
"code": "FM",
"name": "Micronesia"
},
{
"code": "FL",
"name": "Florida"
},
{
"code": "GA",
"name": "Georgia"
},
{
"code": "GU",
"name": "Guam"
},
{
"code": "HI",
"name": "Hawaii"
},
{
"code": "ID",
"name": "Idaho"
},
{
"code": "IL",
"name": "Illinois"
},
{
"code": "IN",
"name": "Indiana"
},
{
"code": "IA",
"name": "Iowa"
},
{
"code": "KS",
"name": "Kansas"
},
{
"code": "KY",
"name": "Kentucky"
},
{
"code": "LA",
"name": "Louisiana"
},
{
"code": "ME",
"name": "Maine"
},
{
"code": "MH",
"name": "Marshall Islands"
},
{
"code": "MD",
"name": "Maryland"
},
{
"code": "MA",
"name": "Massachusetts"
},
{
"code": "MI",
"name": "Michigan"
},
{
"code": "MN",
"name": "Minnesota"
},
{
"code": "MS",
"name": "Mississippi"
},
{
"code": "MO",
"name": "Missouri"
},
{
"code": "MT",
"name": "Montana"
},
{
"code": "NE",
"name": "Nebraska"
},
{
"code": "NV",
"name": "Nevada"
},
{
"code": "NH",
"name": "New Hampshire"
},
{
"code": "NJ",
"name": "New Jersey"
},
{
"code": "NM",
"name": "New Mexico"
},
{
"code": "NY",
"name": "New York"
},
{
"code": "NC",
"name": "North Carolina"
},
{
"code": "ND",
"name": "North Dakota"
},
{
"code": "MP",
"name": "Northern Mariana Islands"
},
{
"code": "OH",
"name": "Ohio"
},
{
"code": "OK",
"name": "Oklahoma"
},
{
"code": "OR",
"name": "Oregon"
},
{
"code": "PW",
"name": "Palau"
},
{
"code": "PA",
"name": "Pennsylvania"
},
{
"code": "PR",
"name": "Puerto Rico"
},
{
"code": "RI",
"name": "Rhode Island"
},
{
"code": "SC",
"name": "South Carolina"
},
{
"code": "SD",
"name": "South Dakota"
},
{
"code": "TN",
"name": "Tennessee"
},
{
"code": "TX",
"name": "Texas"
},
{
"code": "UT",
"name": "Utah"
},
{
"code": "VT",
"name": "Vermont"
},
{
"code": "VA",
"name": "Virginia"
},
{
"code": "WA",
"name": "Washington"
},
{
"code": "WV",
"name": "West Virginia"
},
{
"code": "WI",
"name": "Wisconsin"
},
{
"code": "WY",
"name": "Wyoming"
},
{
"code": "VI",
"name": "U.S. Virgin Islands"
},
{
"code": "AA",
"name": "Armed Forces Americas"
},
{
"code": "AE",
"name": "Armed Forces Europe"
},
{
"code": "AP",
"name": "Armed Forces Pacific"
}
]
}Returns detailed address information for a given country.
curl --request GET \
--url https://{defaultHost}/v1/public/atlas/{country_code} \
--header 'Authorization: Bearer <token>'{
"address_formats": {
"edit": "{{country}}_{{name}}_{{line_1}}_{{line_2}}_{{city}}{{state}}{{postal_code}}",
"show": "{{name}}_{{line_1}}_{{line_2}}_{{city}} {{state}} {{postal_code}}_{{country}}"
},
"address_labels": {
"line_1": "Address",
"line_2": "Apartment, suite, etc",
"city": "City",
"state": "State",
"postal_code": "ZIP code"
},
"city_required": true,
"code": "US",
"name": "United States",
"postal_code_required": true,
"state_required": true,
"states": [
{
"code": "AL",
"name": "Alabama"
},
{
"code": "AK",
"name": "Alaska"
},
{
"code": "AS",
"name": "American Samoa"
},
{
"code": "AZ",
"name": "Arizona"
},
{
"code": "AR",
"name": "Arkansas"
},
{
"code": "CA",
"name": "California"
},
{
"code": "CO",
"name": "Colorado"
},
{
"code": "CT",
"name": "Connecticut"
},
{
"code": "DE",
"name": "Delaware"
},
{
"code": "DC",
"name": "Washington DC"
},
{
"code": "FM",
"name": "Micronesia"
},
{
"code": "FL",
"name": "Florida"
},
{
"code": "GA",
"name": "Georgia"
},
{
"code": "GU",
"name": "Guam"
},
{
"code": "HI",
"name": "Hawaii"
},
{
"code": "ID",
"name": "Idaho"
},
{
"code": "IL",
"name": "Illinois"
},
{
"code": "IN",
"name": "Indiana"
},
{
"code": "IA",
"name": "Iowa"
},
{
"code": "KS",
"name": "Kansas"
},
{
"code": "KY",
"name": "Kentucky"
},
{
"code": "LA",
"name": "Louisiana"
},
{
"code": "ME",
"name": "Maine"
},
{
"code": "MH",
"name": "Marshall Islands"
},
{
"code": "MD",
"name": "Maryland"
},
{
"code": "MA",
"name": "Massachusetts"
},
{
"code": "MI",
"name": "Michigan"
},
{
"code": "MN",
"name": "Minnesota"
},
{
"code": "MS",
"name": "Mississippi"
},
{
"code": "MO",
"name": "Missouri"
},
{
"code": "MT",
"name": "Montana"
},
{
"code": "NE",
"name": "Nebraska"
},
{
"code": "NV",
"name": "Nevada"
},
{
"code": "NH",
"name": "New Hampshire"
},
{
"code": "NJ",
"name": "New Jersey"
},
{
"code": "NM",
"name": "New Mexico"
},
{
"code": "NY",
"name": "New York"
},
{
"code": "NC",
"name": "North Carolina"
},
{
"code": "ND",
"name": "North Dakota"
},
{
"code": "MP",
"name": "Northern Mariana Islands"
},
{
"code": "OH",
"name": "Ohio"
},
{
"code": "OK",
"name": "Oklahoma"
},
{
"code": "OR",
"name": "Oregon"
},
{
"code": "PW",
"name": "Palau"
},
{
"code": "PA",
"name": "Pennsylvania"
},
{
"code": "PR",
"name": "Puerto Rico"
},
{
"code": "RI",
"name": "Rhode Island"
},
{
"code": "SC",
"name": "South Carolina"
},
{
"code": "SD",
"name": "South Dakota"
},
{
"code": "TN",
"name": "Tennessee"
},
{
"code": "TX",
"name": "Texas"
},
{
"code": "UT",
"name": "Utah"
},
{
"code": "VT",
"name": "Vermont"
},
{
"code": "VA",
"name": "Virginia"
},
{
"code": "WA",
"name": "Washington"
},
{
"code": "WV",
"name": "West Virginia"
},
{
"code": "WI",
"name": "Wisconsin"
},
{
"code": "WY",
"name": "Wyoming"
},
{
"code": "VI",
"name": "U.S. Virgin Islands"
},
{
"code": "AA",
"name": "Armed Forces Americas"
},
{
"code": "AE",
"name": "Armed Forces Europe"
},
{
"code": "AP",
"name": "Armed Forces Pacific"
}
]
}Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
The locale to use when returning the country information. Must follow CLDR locale format (e.g., "en", "en-US"). Unsupported or invalid locales will fall back to "en".
Success
Was this page helpful?