Atoka API User Reference
Companies package "Locations"
API tokens are configured to access only the packages each user needs; this means you might not have access to the content of this package. Ask your sales contact!
Available fields | Description | Data | Used by filters | Facet | Match | Stats |
|---|---|---|---|---|---|---|
| anyAddress.distance THIS FEATURE IS NOT IMPLEMENTED, YET. If you need it, just get in touch with us at sales@atoka.io | distance to nearest address | int | distance anyAddress=true | |||
| anyAddress.macroregions[] | macroregions where the company is located | "string" | macroregions macroregionsExclude anyAddress=true | |||
| anyAddress.municipalities[] | municipalities where the company is located | "string" | municipalities municipalitiesExclude anyAddress=true | |||
| anyAddress.postcodes[] | postcodes where the company is located | "string" | postcodes postcodesExclude anyAddress=true | |||
| anyAddress.provinces[] | provinces where the company is located | "string" | provinces provincesExclude anyAddress=true | |||
| anyAddress.regions[] | regions where the company is located | "string" | regions regionsExclude anyAddress=true | |||
| count | total number of secondary company locations (does not include headquarters) | int | - | |||
| items[].address.distance | distance from the passed coordinates | int | distance | |||
| items[].address.fullAddress | complete address of this location | "string" | - | |||
| items[].address.hamlet | hamlet for this location | "string" | - | |||
| items[].address.lat | latitude of this company location | float | - | |||
| items[].address.latlonPrecision | precision of the geolocation data ('lat' and 'lon') | int | - | |||
| items[].address.lon | longitude of this company location | float | - | |||
| items[].address.macroregion | macro region where the company is located | "string" | - | |||
| items[].address.municipality | municipality where the company is located | "string" | - | |||
| items[].address.postcode | postcode for this location | "string" | - | |||
| items[].address.province | province where the company is located | "string" | - | |||
| items[].address.provinceCode | code of the province where the company is located | "string" | - | |||
| items[].address.region | region where the company is located | "string" | - | |||
| items[].address.state | state where the company is located | "string" | - | |||
| items[].address.stateCode | stateCode for this state | "string" | - | |||
| items[].address.streetName | name of the street where the company is located | "string" | - | |||
| items[].address.streetNumber | number of building where the company is located | "string" | - | |||
| items[].address.toponym | toponym describing the address (e.g. 'via', 'piazza' etc.) | "string" | - | |||
| items[].id | unique ID of this address that can be used throughout all Atoka API endpoints | "string" | - | |||
| items[].type THIS FEATURE IS NOT IMPLEMENTED, YET. If you need it, just get in touch with us at sales@atoka.io | type of address (magazzino, etc...) | "string" | - | |||
| totalCount | total number of company locations (including both headquarters and secondary locations) | int | locationsMin locationsMax |
Example JSON fragment for package
{"count": 42, "totalCount": 42, "items": [{"id": "foo", "address": {"fullAddress": "foo", "toponym": "foo", "streetName": "foo", "streetNumber": "foo", "hamlet": "foo", "postcode": "foo", "municipality": "foo", "province": "foo", "provinceCode": "foo", "region": "foo", "macroregion": "foo", "state": "foo", "stateCode": "foo", "lat": 0.42, "lon": 0.42, "latlonPrecision": 42, "distance": 42 },"type": "foo" },...],"anyAddress": {"postcodes": ["foo",...],"municipalities": ["foo",...],"provinces": ["foo",...],"regions": ["foo",...],"macroregions": ["foo",...],"distance": 42 }}