/comtrade/commodities/search

POST /api/comtrade/commodities/search

Price: 20 credits

Search UN Comtrade commodity classification codes (HS/SITC/BEC) by keyword, code or parent

How to use it

Search the UN Comtrade commodity classifications (HS revisions H0-H6, SITC S1-S4, BEC B4/B5, EB services). Find commodity codes by a keyword matched against the description, by exact code, or by listing the direct children of a parent code to walk the classification tree. Each result gives the code, description, parent code, aggregation level and whether it is a leaf node. Use the returned codes as cmd_code in trades search.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• classification string — Classification scheme whose commodity codes to search (default: "H6"; one of: "H0", "H1", "H2", "H3", "H4", "H5", "H6", "S1", "S2", "S3", "S4", "B4", "B5", "EB02", "EB10", "EB10S")
• keyword string nullable — Filter commodities whose description contains this text (examples: "coffee", "vehicles")
• code string nullable — Filter to a specific commodity code (exact match) (examples: "0901", "8703")
• parent string nullable — Filter to direct children of this parent commodity code (examples: "09", "87")
• count integer required — Number of commodities to return (min: 1)

Response

• @type string (default: "ComtradeCommodity")
• code string required
• text string nullable
• parent string nullable
• aggr_level integer nullable
• is_leaf boolean nullable
• standard_unit_abbr 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.