Atoka API User Reference

Companies package "Base"

Available fields
Description
Data
Used by filters
Facet
Match
active

is the company active?

- active
ateco[] - -
ateco[].code

codice ATECO 2007 (the most specific one)

"string" -
ateco[].description

short description of ATECO 2007 code

"string" -
ateco[].rootCode

the class of the ATECO 2007 code

"string" -
cciaa

forms, together with rea, the company identification info given by the Italian Chamber of Commerce (this is REA province code, e.g. "TN" for "Trento")

- regNumbers cciaa
founded

when the company started its activity

- ageMin ageMax foundedFrom foundedTo age ageUnknown
govCode

public administration code (if the company is a PA)

- govCodes
govType

official ISTAT type of the public administration (if the company is a PA)

- govTypes govTypesExclude
inGroup

whether the company is part of a company group or not (the whole group can be retrieved with the cervedGroups package)

true | false -
legalClass

legal status class of the company (e.g. "Società Di Capitale")

- legalClasses legalClassesExclude
legalForms[] - -
legalForms[].level

level 1 is the same as the 'legalClass' field, it's included here for retro-compatibility but its usage is deprecated

int -
legalForms[].name

legal status of the company (e.g. "Società In Accomandita Semplice")

"string" legalForms
legalName

legal name of the company

- name namePrefix nameQuery
nace[] - nace naceExclude
nace[].code

most specific NACE code

"string" -
nace[].description

short description of NACE Code

"string" -
nace[].rootCode

the code of the root

"string" -
noRea

is the company a no rea?

- noRea
rea

forms, together with cciaa, the company identification info given by the Italian Chamber of Commerce (REA standing for "Repertorio Economico Amministrativo")

- regNumbers
registeredAddress.distance

distance from the passed coordinates

int distance
registeredAddress.fullAddress

complete address of this location

"string" -
registeredAddress.hamlet

hamlet of this location

"string" -
registeredAddress.lat

latitude for this location

float lat
registeredAddress.latlonPrecision

precision of the geolocation data ('lat' and 'lon')

int -
registeredAddress.lon

longitude for this location

float lon
registeredAddress.macroregion

macro region for this location

"string" macroregions macroregionsExclude anyAddress=false
registeredAddress.municipality

municipality for this location

"string" municipalities municipalitiesExclude anyAddress=false
registeredAddress.postcode

postcode for this location

"string" postcodes postcodesExclude anyAddress=false
registeredAddress.province

province for this location

"string" provinces provincesExclude anyAddress=false
registeredAddress.provinceCode

code of the province for this location

"string" -
registeredAddress.region

region for this location

"string" regions regionsExclude anyAddress=false
registeredAddress.state

state for this location

"string" -
registeredAddress.streetName

name of the street where the company is located

"string" -
registeredAddress.streetNumber

number of building where the company is located

"string" -
registeredAddress.toponym

toponym describing the address (e.g. 'via', 'piazza' etc.)

"string" -
signs[] - signs signsQuery
signs[].sign

the "signs" ("insegne") identifying a company

"string" -
startup

is the company a startup?

- startup
taxId

the tax ID ("codice fiscale") of the company

- taxIds regNumbers
vat

the VAT ID ("partita IVA") of the company

- vat regNumbers
Example JSON fragment for package
{ // Companies package "Base"
"rea": "string", // forms, together with `cciaa`, the company identification info given by the Italian Chamber of Commerce (REA standing for "Repertorio Economico Amministrativo")
"cciaa": "string", // forms, together with `rea`, the company identification info given by the Italian Chamber of Commerce (this is REA province code, e.g. "TN" for "Trento")
"vat": "string", // the VAT ID ("partita IVA") of the company
"taxId": "string", // the tax ID ("codice fiscale") of the company
"legalForms": [
{
"level": int, // level 1 is the same as the 'legalClass' field, it's included here for retro-compatibility but its usage is deprecated
"name": "string" // legal status of the company (e.g. "Società In Accomandita Semplice")
},
...
],
"legalClass": "string", // legal status class of the company (e.g. "Società Di Capitale")
"legalName": "string", // legal name of the company
"signs": [
{
"sign": "string" // the "signs" ("insegne") identifying a company
},
...
],
"startup": boolean, // is the company a [startup](glossary.html#startup)?
"govCode": "string", // [public administration](glossary.html#govtypes) code (if the company is a PA)
"govType": "string", // official ISTAT type of the [public administration](glossary.html#govtypes) (if the company is a PA)
"active": boolean, // is the company active?
"ateco": [
{ // ATECO code
"code": "string", // codice ATECO 2007 (the most specific one)
"description": "string", // short description of ATECO 2007 code
"rootCode": "string" // the class of the ATECO 2007 code
},
...
],
"founded": "date (in YYYY-MM-DD format)", // when the company started its activity
"nace": [
{ // Nace code
"code": "string", // most specific NACE code
"description": "string", // short description of NACE Code
"rootCode": "string" // the code of the root
},
...
],
"registeredAddress": { // registered address of the company
"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 of this location
"postcode": "string", // postcode for this location
"municipality": "string", // municipality for this location
"province": "string", // province for this location
"provinceCode": "string", // code of the province for this location
"region": "string", // region for this location
"macroregion": "string", // macro region for this location
"state": "string", // state for this location
"lat": float, // latitude for this location
"lon": float, // longitude for this location
"latlonPrecision": int, // precision of the geolocation data ('lat' and 'lon')
"distance": int // distance from the passed coordinates
},
"inGroup": boolean, // whether the company is part of a company group or not (the whole group can be retrieved with the `cervedGroups` package)
"noRea": boolean, // is the company a no rea?
}