/comtrade/datasets/search

POST /api/comtrade/datasets/search

Price: 1 credit

List UN Comtrade dataset availability records — which reporter/period datasets are published

How to use it

Discover which UN Comtrade datasets are published. Returns a list of dataset availability records, optionally filtered by reporter_code and period, each with the total record count, checksum and release dates. Use this as an entry point to learn what trade data exists before drilling into a trades search.

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 string nullable — Reporter area code(s), comma-separated (M49/UN numeric). Omit for all reporters (examples: "842", "842,156")
• period string nullable — Period(s), comma-separated. Year (YYYY) for annual, year-month (YYYYMM) for monthly (examples: "2022", "2020,2021,2022")
• count integer required — Number of dataset availability records to return (min: 1)

Response

• @type string (default: "ComtradeDataset")
• dataset_code string nullable
• type_code string nullable
• freq_code string nullable
• period string nullable
• reporter_code integer nullable
• reporter_iso string nullable
• reporter_desc string nullable
• classification_code string nullable
• classification_search_code string nullable
• is_original_classification boolean nullable
• is_extended_flow_code boolean nullable
• is_extended_partner_code boolean nullable
• is_extended_partner2_code boolean nullable
• is_extended_cmd_code boolean nullable
• is_extended_customs_code boolean nullable
• is_extended_mot_code boolean nullable
• total_records integer nullable
• dataset_checksum integer nullable
• first_released string nullable
• last_released 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 — The entity was not found, or a precondition failed 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.