Atoka API User Reference

Companies package "Foreign Market"

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
areas[] Private field

List of areas where the company might be operating. Areas might be of different levels: countries, intermediate regions, sub-regions or continents. Each single data-point might also be official or not, depending on the source it was gathered from.

- -
areas[].amount Private field

The volume (in euros) of export towards the area; this field is available only if the area was extracted from balance sheets (has provenance "balanceSheets").

5432000 -
areas[].continent Private field

UN M.49 code of the area continent; if area type is "continent", this is the most specific information available about the area (eg: 150).

"string" foreignMarketContinents
areas[].continentLabel Private field

Name of the area continent (eg: Europa).

"string" -
areas[].intermediateRegion Private field

UN M.49 code of the area intermediate region; if area type is "intermediateRegion", this is the most specific information available about the area (eg: 830).

"string" foreignMarketIntermediateRegions
areas[].intermediateRegionLabel Private field

Name of the area intermediate region (eg: Isole del Canale).

"string" -
areas[].lastUpdate Private field

When the information was last updated.

date -
areas[].official Private field

Whether this area comes from an official source (such as the balance sheet) or has been inferred from different sources.

true foreignMarketOfficial
areas[].provenance[] Private field

Provenance of the area information. Currently three sources are available: "infocamere" means the area was made available through ItalianCom, the website InfoCamere offers to italian companies exporting abroad; "balanceSheets" is used for areas stated by the company itself in their financial notes to the accounts, which are automatically read and analysed by our data ingestion pipeline; lastly, "webLang" means the area was inferred by the company websites, in particular presence of multi-language content, analysed by our artificial intelligence systems.

"infocamere", "webLang", "balanceSheets" -
areas[].state Private field

ISO 3166-2 code of the area state (country); if area type is "state", this is the most specific information available about the area (eg: JE).

"string" foreignMarketStates
areas[].stateLabel Private field

Name of the area state (country) (eg: Jersey)

"string" -
areas[].subRegion Private field

UN M.49 code of the area sub-region; if area type is "subRegion", this is the most specific information available about the area (eg: 154).

"string" foreignMarketSubRegions
areas[].subRegionLabel Private field

Name of the area sub-region (eg: Europa settentrionale).

"string" -
areas[].type Private field

Areas form a taxonomy: they are contained inside one another, they might have "parent" areas (bigger areas that contains them) and "children" areas (smaller areas that split the parent one); for foreign market areas we have four different levels: continents, sub-regions, intermediate regions, and states. Please notice that intermediate regions are available only in some specific cases: for example Europe (as a continent) is split in four sub-regions: Eastern Europe, Northern Europe, Southern Europe and Western Europe; among those, only Northern Europe has intermediate regions: Channel Island (which hosts two states: Jersey and Guernsey). Hence Jersey (with "state" level) will have both subRegion and intermediateRegion, while Italy (also with "state" level) will have only subRegion.

"string" -
exportPropensity.score Private field

This score represents the tendency of companies to operate with foreign markets. The value is computed using companies for which we have evidence of export as example on which we built a profile that indicates not an export activity, but characteristics that indicate the likelihood that a company is interested in pursuing foreign markets.

The value is normalized score from 0 to 100

float -
exportPropensity.scoreLabel Private field

text representation of the exportPropensity score, values can be: minimum, low, medium, high, very high, certain

"string" exportScores
exportPropensity.updateTime Private field

last update time for score

date -
Example JSON fragment for package
{
"exportPropensity": {
"score": 0.42,
"scoreLabel": "foo",
"updateTime": "2015-12-24"
},
"areas": [
{
"continent": "foo",
"continentLabel": "foo",
"subRegion": "foo",
"subRegionLabel": "foo",
"intermediateRegion": "foo",
"intermediateRegionLabel": "foo",
"state": "foo",
"stateLabel": "foo",
"type": "foo",
"official": false,
"lastUpdate": "2015-12-24",
"provenance": [
"infocamere",
...
],
"amount": 0.42
},
...
]
}