Atoka API User Reference
Contracts package "Base"
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 |
|---|---|---|---|---|---|---|
| amount | amount initially allocated for this contract | - | amountMin amountMax | |||
| amountPaid | actual amount paid for this contract | - | amountPaid | |||
| cig | a 10-digit alpha numeric code issued by the Government to all contractors | - | cig | |||
| commissioningBody.atokaMatched | whether we were able to match the commissioning body to an Atoka company | true | false | - | |||
| commissioningBody.id | unique Atoka ID of the commissioning body | "string" | commissioningBodies | |||
| commissioningBody.legalForms[].level Private field | int | - | ||||
| commissioningBody.legalForms[].name Private field | legal status of the company (e.g. "Società In Accomandita Semplice") | "string" | commissioningBodyLegalForms | |||
| commissioningBody.legalName | legal name of the commissioning body | "string" | - | |||
| commissioningBody.registeredAddress.macroregion | macro region for this location | "string" | commissioningBodyMacroregions | |||
| commissioningBody.registeredAddress.municipality | municipality for this location | "string" | commissioningBodyMunicipalities | |||
| commissioningBody.registeredAddress.postcode | postcode for this location | "string" | commissioningBodyPostcodes | |||
| commissioningBody.registeredAddress.province | province for this location | "string" | commissioningBodyProvinces | |||
| commissioningBody.registeredAddress.provinceCode | province code for this location | "string" | - | |||
| commissioningBody.registeredAddress.region | region for this location | "string" | commissioningBodyRegions | |||
| commissioningBody.registeredAddress.state | state for this location | "string" | - | |||
| commissioningBody.taxId | tax ID of the commissioning body | "string" | - | |||
| commissioningBody.vat | VAT of the commissioning body | "string" | - | |||
| contractorSelection.code | the contractor selection code | "string" | - | |||
| contractorSelection.label | short description of the code | "string" | - | |||
| endDate | end date of the contract | - | endDateFrom endDateTo | |||
| participantGroups[] | participating groups (awarded first): in contract details we return all participants, but on contracts search we return just the first 20 participants, organized in groups (please note: we never return a partial group) | - | - | |||
| participantGroups[].awarded | is this | true | false | participantsAwarded | |||
| participantGroups[].id | Unique ID that you can use throughout the API endpoints to reference to a specific company | "string" | participantsGroups | |||
| participantGroups[].participants[].ateco[].code Private field | ATECO 2007 code (the most specific one) | "string" | participantsAteco participantsAtecoExclude | |||
| participantGroups[].participants[].ateco[].description Private field | short description of ATECO 2007 code | "string" | - | |||
| participantGroups[].participants[].ateco[].rootCode Private field | the class of the ATECO 2007 code | "string" | - | |||
| participantGroups[].participants[].atokaMatched | whether we were able to match the commissioning body to an Atoka company | true | false | - | |||
| participantGroups[].participants[].id | Unique ID that you can use throughout the API endpoints to reference to a specific company | "string" | participants | |||
| participantGroups[].participants[].legalForms[].level | int | - | ||||
| participantGroups[].participants[].legalForms[].name | legal status of the company (e.g. "Società In Accomandita Semplice") | "string" | participantsLegalForms | |||
| participantGroups[].participants[].legalName | legal name of the company | "string" | - | |||
| participantGroups[].participants[].registeredAddress.macroregion | macro region for this location | "string" | participantsMacroregions | |||
| participantGroups[].participants[].registeredAddress.municipality | municipality for this location | "string" | participantsMunicipalities | |||
| participantGroups[].participants[].registeredAddress.postcode | postcode for this location | "string" | participantsPostcodes | |||
| participantGroups[].participants[].registeredAddress.province | province for this location | "string" | participantsProvinces | |||
| participantGroups[].participants[].registeredAddress.provinceCode | province code for this location | "string" | - | |||
| participantGroups[].participants[].registeredAddress.region | region for this location | "string" | participantsRegions | |||
| participantGroups[].participants[].registeredAddress.state | state for this location | "string" | - | |||
| participantGroups[].participants[].role | role of this participant in the contract ("leader", etc.) | "string" | - | |||
| participantGroups[].participants[].taxId | the tax ID ("codice fiscale") of the company | "string" | - | |||
| participantGroups[].participants[].vat | the VAT ID ("partita IVA") of the company | "string" | - | |||
| participantGroupsCount | total number of participating groups of companies | int | - | |||
| startDate | start date of the contract | - | startDateFrom startDateTo | |||
| url Private field | url where data was extracted | "string" | - | |||
| year Private field | end date of the contract | int | - |
Example JSON fragment for package
{"cig": "2434788", "url": "http://example.com/anac.xml", "startDate": "2015-12-24", "endDate": "2015-12-24", "year": 2014, "amount": 10000, "amountPaid": 0.42, "contractorSelection": {"code": "23", "label": "AFFIDAMENTO IN ECONOMIA - AFFIDAMENTO DIRETTO" },"commissioningBody": {"id": "1234567890abcdef", "legalName": "ACME S.R.L.", "vat": "155826477", "taxId": "155826477", "atokaMatched": true, "legalForms": [{"level": 42,"name": "foo" },...],"registeredAddress": {"postcode": "38100", "municipality": "Trento", "province": "Trento", "provinceCode": "TN", "region": "Trentino-Alto/Adige", "macroregion": "Nord-Est", "state": "Italia" }},"participantGroupsCount": 4, "participantGroups": [{"id": "2435355", "awarded": true, "participants": [{"id": "foo", "legalName": "foo", "vat": "foo", "taxId": "foo", "atokaMatched": false, "role": "foo", "ateco": [{"code": "64.92.09", "description": "altre attività creditizie nca", "rootCode": "G" },...],"legalForms": [{"level": 42,"name": "foo" },...],"registeredAddress": {"postcode": "38100", "municipality": "Trento", "province": "Trento", "provinceCode": "TN", "region": "Trentino-Alto/Adige", "macroregion": "Nord-Est", "state": "Italia" }},...]},...]}