Skip to main content
POST
/
api
/
comtrade
/
datasets
/
metadata
/comtrade/datasets/metadata
curl --request POST \
  --url https://api.anysite.io/api/comtrade/datasets/metadata \
  --header 'Content-Type: application/json' \
  --header 'access-token: <api-key>' \
  --data '
{
  "reporter_code": 123,
  "period": "<string>",
  "timeout": 300,
  "type_code": "C",
  "freq_code": "A",
  "classification": "HS"
}
'
[
  {
    "@type": "@comtrade_dataset_note",
    "dataset_code": "<string>",
    "type_code": "<string>",
    "freq_code": "<string>",
    "period": "<string>",
    "reporter_code": 123,
    "reporter_description": "<string>",
    "currency": "<string>",
    "import_conv_factor": "<string>",
    "export_conv_factor": "<string>",
    "trade_system": "<string>",
    "classification_code": "<string>",
    "import_valuation": "<string>",
    "export_valuation": "<string>",
    "import_partner_country": "<string>",
    "export_partner_country": "<string>",
    "import_partner2_country": "<string>",
    "export_partner2_country": "<string>",
    "publication_note": "<string>",
    "publication_date": "<string>",
    "publication_date_short": "<string>"
  }
]

Authorizations

​
access-token
string
header
required

API token from the dashboard

Headers

​
access-token
string
required

Body

application/json
​
reporter_code
integer
required

Reporter area code (M49/UN numeric)

Examples:

842

156

​
period
string
required

Period — year (YYYY) for annual, year-month (YYYYMM) for monthly

Example:

"2022"

​
timeout
integer
default:300

Max scrapping execution timeout (in seconds)

Required range: 20 <= x <= 1500
​
type_code
enum<string>
default:C

Trade type — goods (C) or services (S)

Available options:
C,
S
​
freq_code
enum<string>
default:A

Frequency — annual (A) or monthly (M)

Available options:
A,
M
​
classification
enum<string>
default:HS

Commodity/service classification scheme

Available options:
HS,
H0,
H1,
H2,
H3,
H4,
H5,
H6,
SITC,
S1,
S2,
S3,
S4,
ST,
BEC,
B4,
B5,
EB,
EB02,
EB10,
EB10S

Response

Successful Response

​
@type
string
default:@comtrade_dataset_note
​
dataset_code
string | null
​
type_code
string | null
​
freq_code
string | null
​
period
string | null
​
reporter_code
integer | null
​
reporter_description
string | null
​
currency
string | null
​
import_conv_factor
string | null
​
export_conv_factor
string | null
​
trade_system
string | null
​
classification_code
string | null
​
import_valuation
string | null
​
export_valuation
string | null
​
import_partner_country
string | null
​
export_partner_country
string | null
​
import_partner2_country
string | null
​
export_partner2_country
string | null
​
publication_note
string | null
​
publication_date
string | null
​
publication_date_short
string | null