Trade in one product API reference
Read one country's exports and imports of one HS code with every partner, one row for each partner, month and flow, with the code's name.
Overview
GET /
GET / returns one country's trade in one HS code with every partner: one row for each partner, month and flow, and the code's name. hs is a code of 2, 4 or 6 digits.
Use it to see which partners buy or sell a product. It takes the same options as the partners route, and a partners request with hs answers the same figures.
A code that the HS edition does not have answers 404 hs_. The MCP tool is trade_ and takes the same parameters.
Request
Heading 8517 (telephone sets and other apparatus for sending and receiving data) of the United Kingdom with the United States in June 2026, and the real response:
curl -H "Authorization: Bearer $NARWHAL_API_KEY" \
"https://api.narwhalapi.com/v1/trade/GBR/products/8517?partner=USA&start=2026-06&end=2026-06"{
"country": "GBR",
"basis": "own",
"source": "HM Revenue & Customs",
"reporters_included": null,
"note": null,
"coverage": "full",
"partner_coverage": "all",
"scope": "goods",
"currency": "GBP",
"classification": "HS",
"edition": "2022",
"edition_basis": "inferred_from_year",
"valuation_basis": "not_stated",
"trade_system": "not_stated",
"partner_basis": "not_stated",
"trade_scope": "all_partners",
"latest_period": "2026-09",
"total_basis": "customs",
"totals": [
{
"period": "2026-06",
"flow": "export",
"official_total": null,
"sum_of_rows": "46135455"
},
{
"period": "2026-06",
"flow": "import",
"official_total": null,
"sum_of_rows": "89090099"
}
],
"fx": null,
"calculated": [
"sum_of_rows"
],
"total": 2,
"product_code": "8517",
"product_level": 4,
"product_label": "Telephone sets, incl. telephones for cellular networks or for other wireless networks; other apparatus for the transmission or reception of voice, images or other data, incl. apparatus for communication in a wired or wireless network [such as a local or wide area network]; parts thereof (excl. than transmission or reception apparatus of heading 8443, 8525, 8527 or 8528)",
"rows": [
{
"flow": "export",
"period": "2026-06",
"period_type": "month",
"period_start": "2026-06-01",
"period_end": "2026-06-30",
"value": "46135455",
"net_weight_kg": "74435",
"rank": null,
"share": null,
"change": null,
"partner": "USA",
"partner_label": "United States",
"partner_kind": "country",
"unallocated_reason": null
},
{
"flow": "import",
"period": "2026-06",
"period_type": "month",
"period_start": "2026-06-01",
"period_end": "2026-06-30",
"value": "89090099",
"net_weight_kg": "246068",
"rank": null,
"share": null,
"change": null,
"partner": "USA",
"partner_label": "United States",
"partner_kind": "country",
"unallocated_reason": null
}
],
"next_cursor": null
}There is one row for each flow. totals holds the total of heading 8517 with the United States, the sum of the two rows, and official_ is null because the publisher prints no total for one product.
Parameters
| Parameter | Where | Type | Required | Default | Allowed values and meaning |
|---|---|---|---|---|---|
country | path | string | Yes | None | ISO 3166-1 alpha-3 code of the reporting country, in capitals, such as GBR. A code that is not a country answers 400. A country with no figures answers 404 country_. |
hs | path | string | Yes | None | An HS code of 2, 4 or 6 digits, such as 85, 8517 or 851713. Any other length answers 400. A code that has no name in the HS edition and no rows for the country answers 404 hs_. Thailand is held at 4 digits, so for Thailand a code of 6 digits answers 404 basis_. |
partner | query | string | No | All partners | ISO 3166-1 alpha-3 code of one partner, in capitals. A code that is not a partner of the country answers 400 unknown_. |
flow | query | string | No | Both flows | export or import. |
start | query | string, YYYY-MM | No | The newest month held | First month, inclusive. With start and no end the answer runs to the newest month held. start after end answers 400. |
end | query | string, YYYY-MM | No | The newest month held | Last month, inclusive. With end alone the answer is the newest month held on or before it. |
basis | query | string | No | The best source held | own, third_ or partner_. Asks for one source by name and skips the order. A source with nothing for the question answers 404 basis_. |
currency | query | string | No | The source's own currency | USD. Converts each month with its average daily rate. |
top | query | integer | No | All rows | From 1 to 1000. Keeps the N largest country rows of each month and flow, ranked by value with ties broken by partner code, and adds rank to each row. Group and unallocated rows are not ranked. Calculated. Covers at most 12 months. Not for partner-reported answers. |
share | query | boolean | No | false | true adds share to each row: its value over the sum of the country rows of the same month and flow, as a fraction of 1 with 6 decimals. Calculated. Covers at most 12 months. Not for partner-reported answers. |
ytd | query | boolean | No | false | true sums January to end (default: the newest month) from the stored months, and period_ is year_. Send end, not start: with start the request answers 400. A missing month answers 404 period_. Calculated. Not for partner-reported answers. |
change | query | boolean | No | false | true adds change to each row: the same month (or year to date) a year earlier, with the difference and the release status of both sides. A missing month a year earlier answers 404 period_. Calculated. Covers at most 12 months. Not for partner-reported answers. |
include_ | query | boolean | No | false | true also returns the group rows the publisher prints, such as the EU or ASEAN. A group row is never part of a sum, a rank or a share. |
limit | query | integer | No | 500 | From 1 to 1000. The most rows in one page. |
cursor | query | string | No | None | The next_ of the previous page, with every other parameter unchanged. |
Response
The answer holds the fields of the partners route, which are listed on that page, and these three about the product. totals holds the total of that product, the sum of its rows over all pages, with official_ null.
| Field | Meaning |
|---|---|
product_ | The HS code asked for. |
product_ | 2 for a chapter, 4 for a heading, 6 for a subheading. |
product_ | The code's name. null for a line that is not an HS product, such as the publisher's residual code 999999 of Chile, which answers with its rows. |
Each item of rows is one partner in one month and flow, with the same fields as on the partners route.
| Field | Meaning |
|---|---|
flow | export or import. |
period | The month, YYYY-MM. For a year to date, its last month. |
period_ | month or year_. |
period_ | The first and last day the row covers, YYYY-MM-DD. |
value | Whole units of currency, as a decimal string. |
net_ | Net weight in kilograms, as a decimal string, where the publisher gives it. null otherwise. |
rank | With top: the row's rank, 1 for the largest. null otherwise. |
share | With share: the row's fraction of the total, 6 decimals. null otherwise. |
change | With change: an object with previous_, previous_, absolute (value minus previous value), percent (in percent with 4 decimals, null when the earlier value was 0), release_ and previous_ (preliminary, revised, final or null when the publisher does not say). null when the row a year earlier does not exist or change was not asked for. |
partner | ISO 3166-1 alpha-3 code of the partner, a group code such as EUU, or empty for a line that has no country. |
partner_ | The publisher's own name for the partner. |
partner_ | country, group or unallocated. |
unallocated_ | For an unallocated row: not_, confidential, stores_, free_, other or rest. null otherwise. |
More examples
A code the edition does not have
An HS code that has no name and no rows answers 404 and is free:
curl -H "Authorization: Bearer $NARWHAL_API_KEY" \
"https://api.narwhalapi.com/v1/trade/GBR/products/999999?start=2026-06&end=2026-06&flow=export&limit=3"{
"type": "https://narwhalapi.com/problems/hs-code-not-found",
"title": "HS code not found",
"status": 404,
"detail": "HS 2022 has no code 999999.",
"code": "hs_code_not_found",
"request_id": "16a6db4e-d5d6-45ee-954b-4512cf137e63"
}Sources
One source answers each request, the first that holds rows in this order: the country's own customs or statistics office (basis is own), the country's own filing with UN Comtrade (third_, partner totals only), then other countries' reports about it with the flows swapped (partner_). Other countries' reports would come before UN Comtrade only when at least 200 reporters have rows about the country, which is more than Narwhal holds, so they come last. By product, UN Comtrade holds nothing, so the order is own then partner_, and partner_ reaches chapters (2 digits) only. basis asks for one source by name. The answer's basis, source and note fields say which source answered, and the sources are never mixed in one answer. A partner-reported answer is a different measurement from the country's own figures and is never an official figure. Partner-reported answers reach chapters only, so a code of 4 or 6 digits answers 404 basis_ for a country whose own office gives partner totals only.
Currency
Values are whole units of the currency named in currency, written as decimal strings. By default that is the currency the source publishes in, for example GBP for HM Revenue & Customs. currency=USD converts each month with the average of that month's daily exchange rates. The rate used for each month is listed in fx, and calculated names the converted fields. A month with no rate answers 404 rate_. If the rate source cannot answer, the request answers 503 upstream_. An answer that is already in USD comes back as it is.
Paging
limit sets the most rows in one page, from 1 to 1000, and defaults to 500. When more rows match, next_ holds the cursor of the next page: send it as cursor with every other parameter unchanged. A cursor from a different request answers 400 invalid_. total counts the matching rows over all pages. The MCP tool returns at most 200 rows in one result.
Price
A request that returns at least one row is one call, at $2 per 1,000 calls. Every page of a long answer is one call, whatever limit is. An answer with no rows is free, and so is every error.
Errors
These errors use the shared problem shape with a request_. A missing or invalid key (401), a balance below the price of the call (402) and too many requests a minute (429) are the account errors every route shares: see Errors and credits.
| Status | Code | When it happens |
|---|---|---|
400 | invalid_query | A parameter is missing, malformed or outside its allowed values: for example start=2026-13, a start after end, ytd sent with start, or as_ or version sent (these routes serve what is held now). Also when top, share, ytd or change is asked of a partner-reported answer. |
400 | invalid_cursor | The cursor is not one this request returned, or another parameter changed since. |
400 | unknown_partner | partner is not a partner of the country in the months asked, for example ZZZ is not a partner of GBR. |
400 | range_too_large | top, share, ytd or change cover more than 12 months, a partner-reported answer covers more than 12 months, or a products answer, at any level (2, 4 or 6 digits), covers more than 12 months held without hs or partner. The open query refuses a window over 12 months as invalid_. |
404 | country_not_covered | Narwhal holds no trade rows for the country on any source. |
404 | period_not_published | The month asked is not held (No trade rows for 2026-10.), or a month that ytd or change needs is missing. |
404 | basis_not_available | The source asked for, or every source in the order, holds nothing for the question. The detail names why: for example that the country's own office gives partner totals only, not products, or that partner-reported answers reach chapters (2 digits) only, or that Thailand's own office is held at 4 digits and was asked for 6. See the coverage route. |
404 | hs_code_not_found | The HS edition has no name for the code and the country holds no rows for it, for example the United Kingdom and code 999999 answer HS 2022 has no code 999999. A code with no name that the country's files do hold (the publisher's residual lines) answers 200 with product_ null. |
404 | rate_not_available | currency=USD was asked and a month has no exchange rate. |
503 | upstream_unavailable | The exchange rate source cannot answer. It affects currency=USD and partner-reported answers that need a conversion. Try again shortly. |
503 | trade_data_unavailable | The product files cannot be read just now. Try again shortly. |
Was this page helpful?