The Aryeo API provides access to the Aryeo platform.
https://docs.aryeo.com/_mock/api/aryeo/
https://api.aryeo.com/v1/
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.
The geographic longitude of some reference point of the location, specified in degrees and decimal parts. Positive numbers must not include the plus symbol.
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'.
The street name portion of a location's address.
The number or portion of a larger building or complex. Examples are: 'APT G', '55', etc.
The postal code portion of a location's address.
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.
The County, Parish or other regional authority of the location.
The ISO 3166-2 subdivision code for the state or province of the location. For example, “MA” for Massachusetts, United States.
A sub-section or area of a defined state or province. Examples would be the Keys in FL or Hudson Valley in NY.
The ISO 3166-1 country code for this for the country of the location.
https://docs.aryeo.com/_mock/api/aryeo/addresses
https://api.aryeo.com/v1/addresses
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);{ "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" }
https://docs.aryeo.com/_mock/api/aryeo/addresses/{address}
https://api.aryeo.com/v1/addresses/{address}
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);https://docs.aryeo.com/_mock/api/aryeo/addresses/{address}
https://api.aryeo.com/v1/addresses/{address}
const address = '00000000-0000-4000-8000-000000000000';
const resp = await fetch(
`https://docs.aryeo.com/_mock/api/aryeo/addresses/${address}`,
{method: 'PATCH'}
);
const data = await resp.text();
console.log(data);