Atoka API User Reference

Companies package "Locations"

Available fields
Description
Data
Used by filters
Facet
Match
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.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)

- locationsMin locationsMax
Example JSON fragment for package
{ // Companies package "Locations"
"count": int, // total number of secondary company locations (does not include headquarters)
"totalCount": int, // total number of company locations (including both headquarters and secondary locations)
"items": [
{
"id": "string", // unique ID of this address that can be used throughout all Atoka API endpoints
"address": {
"fullAddress": "string", // complete address of this location
"toponym": "string", // toponym describing the address (e.g. 'via', 'piazza' etc.)
"streetName": "string", // name of the street where the company is located
"streetNumber": "string", // number of building where the company is located
"hamlet": "string", // hamlet for this location
"postcode": "string", // postcode for this location
"municipality": "string", // municipality where the company is located
"province": "string", // province where the company is located
"provinceCode": "string", // code of the province where the company is located
"region": "string", // region where the company is located
"macroregion": "string", // macro region where the company is located
"state": "string", // state where the company is located
"lat": float, // latitude of this company location
"lon": float, // longitude of this company location
"latlonPrecision": int, // precision of the geolocation data ('lat' and 'lon')
"distance": int // distance from the passed coordinates
},
"type": "string" // type of address (magazzino, etc...)
},
...
],
"anyAddress": { // list of all sites of a company (available when `anyAddress=true`)
"postcodes": [ // postcodes where the company is located
"string",
...
],
"municipalities": [ // municipalities where the company is located
"string",
...
],
"provinces": [ // provinces where the company is located
"string",
...
],
"regions": [ // regions where the company is located
"string",
...
],
"macroregions": [ // macroregions where the company is located
"string",
...
],
"distance": int // distance to nearest address
}
}