/comtrade/datasets/metadata

POST /api/comtrade/datasets/metadata

Price: 1 credit

Get UN Comtrade dataset methodology metadata — currency, valuation, trade system, conversion factors

How to use it

Get the methodology metadata for a UN Comtrade dataset (reporter + period). Returns notes describing the reporting currency, import/export valuation basis (CIF/FOB), trade system, currency conversion factors, partner-country attribution and the publication note and date. Use this to interpret trade values correctly before comparing across reporters.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• type_code string — Trade type — goods (C) or services (S) (default: "C"; one of: "C", "S")
• freq_code string — Frequency — annual (A) or monthly (M) (default: "A"; one of: "A", "M")
• classification string — Commodity/service classification scheme (default: "HS"; one of: "HS", "H0", "H1", "H2", "H3", "H4", "H5", "H6", "SITC", "S1", "S2", "S3", "S4", "ST", "BEC", "B4", "B5", "EB", "EB02", "EB10", "EB10S")
• reporter_code integer required — Reporter area code (M49/UN numeric) (examples: 842, 156; >: 0)
• period string required — Period — year (YYYY) for annual, year-month (YYYYMM) for monthly (examples: "2022")

Response

• @type string (default: "ComtradeDatasetNote")
• dataset_code string nullable
• type_code string nullable
• freq_code string nullable
• period string nullable
• reporter_code integer nullable
• reporter_description string nullable
• currency string nullable
• import_conv_factor string nullable
• export_conv_factor string nullable
• trade_system string nullable
• classification_code string nullable
• import_valuation string nullable
• export_valuation string nullable
• import_partner_country string nullable
• export_partner_country string nullable
• import_partner2_country string nullable
• export_partner2_country string nullable
• publication_note string nullable
• publication_date string nullable
• publication_date_short string nullable

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — No metadata is available for the requested reporter, period and classification Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.