Operations related to addresses. Addresses provide standardized address data.
Overview
Languages
Servers
Mock server
https://docs.aryeo.com/_mock/api/aryeo/
Production
https://api.aryeo.com/v1/
Bodyapplication/json
AddressPostPayload
The geographic latitude of some reference point of the location, specified in degrees and decimal parts. Positive numbers must not include the plus symbol.
Example: 42.35157458574123
The geographic longitude of some reference point of the location, specified in degrees and decimal parts. Positive numbers must not include the plus symbol.
Example: -71.05763741484657
The street number portion of a location's address. In some areas, the street number may contain non-numeric characters. This field can also contain extensions and modifiers to the street number, such as '1/2' or '-B'.
Example: "107"
The street name portion of a location's address.
Example: "South St"
The number or portion of a larger building or complex. Examples are: 'APT G', '55', etc.
Example: "Unit 2F"
The postal code portion of a location's address.
Example: "02111"
A sub-section or area of a defined city. Examples would be SoHo in New York, NY, Ironbound in Newark, NJ or Inside the Beltway.
Example: "Leather District"
The County, Parish or other regional authority of the location.
Example: "Suffolk County"
The ISO 3166-2 subdivision code for the state or province of the location. For example, “MA” for Massachusetts, United States.
Example: "MA"
A sub-section or area of a defined state or province. Examples would be the Keys in FL or Hudson Valley in NY.
Example: "Cape Cod"
The ISO 3166-1 country code for this for the country of the location.
Example: "US"
- Mock serverhttps://docs.aryeo.com/_mock/api/aryeo/addresses
- Productionhttps://api.aryeo.com/v1/addresses
- JS
- PHP
- Go
- Python
- Java
- C#
- cURL
const resp = await fetch(
`https://docs.aryeo.com/_mock/api/aryeo/addresses`,
{
method: 'POST',
headers: {
'Content-Type': 'application/json'
},
body: JSON.stringify({
latitude: 42.35157458574123,
longitude: -71.05763741484657,
street_number: '107',
street_name: 'South St',
unit_number: 'Unit 2F',
postal_code: '02111',
city: 'Boston',
city_region: 'Leather District',
county_or_parish: 'Suffolk County',
state_or_province: 'MA',
state_or_province_region: 'Cape Cod',
country: 'US',
country_region: 'Napa Valley'
})
}
);
const data = await resp.json();
console.log(data);Response
application/json
{ "status": "success", "data": { "id": "00000000-0000-4000-8000-000000000000", "latitude": 42.35157458574123, "longitude": -71.05763741484657, "street_number": "107", "street_name": "South St", "unit_number": "Unit 2F", "postal_code": "02111", "city": "Boston", "city_region": "Leather District", "county_or_parish": "Suffolk County", "state_or_province": "MA", "state_or_province_region": "Cape Cod", "country": "US", "country_region": "Napa Valley", "timezone": "America/New_York", "unparsed_address": "107 South St, Boston MA, 02111", "unparsed_address_part_one": "107 South St, Unit 2F", "unparsed_address_part_two": "Boston, MA 02111", "is_map_dirty": true }, "timestamp": "2021-06-30T20:30:00Z" }
- Mock serverhttps://docs.aryeo.com/_mock/api/aryeo/addresses/{address}
- Productionhttps://api.aryeo.com/v1/addresses/{address}
- JS
- PHP
- Go
- Python
- Java
- C#
- cURL
const address = '00000000-0000-4000-8000-000000000000';
const resp = await fetch(
`https://docs.aryeo.com/_mock/api/aryeo/addresses/${address}`,
{method: 'GET'}
);
const data = await resp.text();
console.log(data);Response
application/json
{ "status": "success", "data": { "id": "00000000-0000-4000-8000-000000000000", "latitude": 42.35157458574123, "longitude": -71.05763741484657, "street_number": "107", "street_name": "South St", "unit_number": "Unit 2F", "postal_code": "02111", "city": "Boston", "city_region": "Leather District", "county_or_parish": "Suffolk County", "state_or_province": "MA", "state_or_province_region": "Cape Cod", "country": "US", "country_region": "Napa Valley", "timezone": "America/New_York", "unparsed_address": "107 South St, Boston MA, 02111", "unparsed_address_part_one": "107 South St, Unit 2F", "unparsed_address_part_two": "Boston, MA 02111", "is_map_dirty": true }, "timestamp": "2021-06-30T20:30:00Z" }
Bodyapplication/json
AddressPatchPayload
The geographic latitude of some reference point of the location, specified in degrees and decimal parts. Positive numbers must not include the plus symbol.
Example: 42.35157458574123
The geographic longitude of some reference point of the location, specified in degrees and decimal parts. Positive numbers must not include the plus symbol.
Example: -71.05763741484657
The street number portion of a location's address. In some areas, the street number may contain non-numeric characters. This field can also contain extensions and modifiers to the street number, such as '1/2' or '-B'.
Example: "107"
The street name portion of a location's address.
Example: "South St"
The number or portion of a larger building or complex. Examples are: 'APT G', '55', etc.
Example: "Unit 2F"
The postal code portion of a location's address.
Example: "02111"
A sub-section or area of a defined city. Examples would be SoHo in New York, NY, Ironbound in Newark, NJ or Inside the Beltway.
Example: "Leather District"
The County, Parish or other regional authority of the location.
Example: "Suffolk County"
The ISO 3166-2 subdivision code for the state or province of the location. For example, “MA” for Massachusetts, United States.
Example: "MA"
A sub-section or area of a defined state or province. Examples would be the Keys in FL or Hudson Valley in NY.
Example: "Cape Cod"
The ISO 3166-1 country code for this for the country of the location.
Example: "US"
A sub-section or area of a defined country. Examples would be Napa Valley in the US, or the Amalfi Coast in Italy.
Example: "Napa Valley"
The type of external ID for the address.
Value"GOOGLE"
The external ID for the address.
Example: "1234567890"
The URL for the address.
Example: "https://www.google.com"
- Mock serverhttps://docs.aryeo.com/_mock/api/aryeo/addresses/{address}
- Productionhttps://api.aryeo.com/v1/addresses/{address}
- JS
- PHP
- Go
- Python
- Java
- C#
- cURL
const address = '00000000-0000-4000-8000-000000000000';
const resp = await fetch(
`https://docs.aryeo.com/_mock/api/aryeo/addresses/${address}`,
{
method: 'PATCH',
headers: {
'Content-Type': 'application/json'
},
body: JSON.stringify({
latitude: 42.35157458574123,
longitude: -71.05763741484657,
street_number: '107',
street_name: 'South St',
unit_number: 'Unit 2F',
postal_code: '02111',
city: 'Boston',
city_region: 'Leather District',
county_or_parish: 'Suffolk County',
state_or_province: 'MA',
state_or_province_region: 'Cape Cod',
country: 'US',
country_region: 'Napa Valley',
external_type: 'GOOGLE',
external_id: '1234567890',
external_url: 'https://www.google.com',
external_data: [{}],
is_map_dirty: true
})
}
);
const data = await resp.json();
console.log(data);Response
application/json
{ "status": "success", "data": { "id": "00000000-0000-4000-8000-000000000000", "latitude": 42.35157458574123, "longitude": -71.05763741484657, "street_number": "107", "street_name": "South St", "unit_number": "Unit 2F", "postal_code": "02111", "city": "Boston", "city_region": "Leather District", "county_or_parish": "Suffolk County", "state_or_province": "MA", "state_or_province_region": "Cape Cod", "country": "US", "country_region": "Napa Valley", "timezone": "America/New_York", "unparsed_address": "107 South St, Boston MA, 02111", "unparsed_address_part_one": "107 South St, Unit 2F", "unparsed_address_part_two": "Boston, MA 02111", "is_map_dirty": true }, "timestamp": "2021-06-30T20:30:00Z" }