單一產品貿易 API 參考
讀取一個國家某個 HS 代碼與所有夥伴國的進出口,每個夥伴國、每個月份與每個流向各一列,並附上代碼名稱。
概覽
GET /
GET / 回傳一個國家在某個 HS 代碼上與所有夥伴國的貿易:每個夥伴國、每個月份與每個流向各一列,並附上代碼名稱。hs 為 2、4 或 6 位碼的代碼。
用它來了解哪些夥伴國買進或賣出某項產品。它接受與夥伴國路由相同的選項,而帶有 hs 的夥伴國請求會回傳相同的數字。
HS 版本中沒有的代碼會回傳 404 hs_。MCP 工具為 trade_,參數相同。
請求
英國在 2026 年 6 月與美國之間的品目 8517(電話機及其他發送或接收資料的設備),以及實際回應:
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
}每個流向各有一列。totals 包含品目 8517 與美國之間的總額,即兩列的加總,而 official_ 為 null,因為發布機構沒有列示單一產品的總額。
參數
| 參數 | 位置 | 類型 | 必填 | 預設值 | 允許值與意義 |
|---|---|---|---|---|---|
country | path | 字串 | 是 | 無 | 申報國的 ISO 3166-1 alpha-3 代碼,使用大寫,例如 GBR。不是國家的代碼會回傳 400。沒有數字的國家會回傳 404 country_。 |
hs | path | 字串 | 是 | 無 | 2、4 或 6 位碼的 HS 代碼,例如 85、8517 或 851713。其他位數會回傳 400。在 HS 版本中沒有名稱,且該國也沒有資料列的代碼,會回傳 404 hs_。泰國以 4 位碼保存,因此對泰國查詢 6 位碼的代碼會回傳 404 basis_。 |
partner | query | 字串 | 否 | 所有夥伴國 | 單一夥伴國的 ISO 3166-1 alpha-3 代碼,使用大寫。不是該國夥伴國的代碼會回傳 400 unknown_。 |
flow | query | 字串 | 否 | 兩個流向 | export 或 import。 |
start | query | 字串,YYYY-MM | 否 | 已收錄的最新月份 | 起始月份,含該月。帶有 start 而無 end 時,回應會涵蓋至已收錄的最新月份。start 晚於 end 會回傳 400。 |
end | query | 字串,YYYY-MM | 否 | 已收錄的最新月份 | 結束月份,含該月。僅帶 end 時,回應為不晚於該月的最新已收錄月份。 |
basis | query | 字串 | 否 | 已收錄的最佳來源 | own、third_ 或 partner_。依名稱指定單一來源,並略過順序。對該問題沒有資料的來源會回傳 404 basis_。 |
currency | query | 字串 | 否 | 來源自己的貨幣 | USD。以各月的每日平均匯率換算。 |
top | query | 整數 | 否 | 所有資料列 | 1 至 1000。每個月份與流向保留金額最大的 N 個國家資料列,依金額排名,金額相同時以夥伴國代碼決定順序,並為每列加上 rank。群組與未分配的資料列不排名。為計算所得。最多涵蓋 12 個月。不適用於夥伴國申報回應。 |
share | query | 布林值 | 否 | false | true 會為每一列加上 share:其金額除以同月份、同流向各國資料列的加總,以 1 為基準的小數表示,保留 6 位小數。為計算所得。最多涵蓋 12 個月。不適用於夥伴國申報回應。 |
ytd | query | 布林值 | 否 | false | true 會將已儲存月份中自 1 月至 end(預設:最新月份)的資料加總,且 period_ 為 year_。請傳入 end,不要傳入 start:帶有 start 的請求會回傳 400。缺少月份會回傳 404 period_。為計算所得。不適用於夥伴國申報回應。 |
change | query | 布林值 | 否 | false | true 會為每一列加上 change:去年同月(或年初至今)的資料、兩者的差額,以及雙方的發布狀態。缺少前一年的月份會回傳 404 period_。為計算所得。最多涵蓋 12 個月。不適用於夥伴國申報回應。 |
include_ | query | 布林值 | 否 | false | true 也會回傳發布機構列示的群組資料列,例如歐盟或東協(ASEAN)。群組資料列絕不計入加總、排名或占比。 |
limit | query | 整數 | 否 | 500 | 1 至 1000。單頁最多的資料列數。 |
cursor | query | 字串 | 否 | 無 | 上一頁的 next_,其他所有參數保持不變。 |
回應
回應包含夥伴國路由的欄位(列於該頁面),以及下列三個關於產品的欄位。totals 包含該產品的總額,即所有頁面中其資料列的加總,且 official_ 為 null。
| 欄位 | 含義 |
|---|---|
product_ | 所查詢的 HS 代碼。 |
product_ | 2 代表章,4 代表品目,6 代表子目。 |
product_ | 代碼名稱。對於不是 HS 產品的資料行為 null,例如智利發布機構的剩餘代碼 999999,它會連同其資料列一併回應。 |
rows 的每一項是一個月份與流向中的一個夥伴國,欄位與夥伴國路由相同。
| 欄位 | 含義 |
|---|---|
flow | export 或 import。 |
period | 月份,YYYY-MM。年初至今時為其最後一個月。 |
period_ | month 或 year_。 |
period_ | 該列涵蓋的第一天與最後一天,YYYY-MM-DD。 |
value | currency 的整單位,以十進位字串表示。 |
net_ | 淨重(公斤),以十進位字串表示,發布機構有提供時才有。否則為 null。 |
rank | 搭配 top:該列的排名,最大者為 1。否則為 null。 |
share | 搭配 share:該列占總額的比例,6 位小數。否則為 null。 |
change | 搭配 change:一個物件,包含 previous_、previous_、absolute(金額減去前期金額)、percent(百分比,4 位小數,前期金額為 0 時為 null)、release_ 與 previous_(preliminary、revised、final,發布機構未說明時為 null)。去年同期的資料列不存在,或未要求 change 時為 null。 |
partner | 夥伴國的 ISO 3166-1 alpha-3 代碼、群組代碼(例如 EUU),或在沒有國家的資料行中為空。 |
partner_ | 發布機構自己對該夥伴國的稱呼。 |
partner_ | country、group 或 unallocated。 |
unallocated_ | 未分配的資料列:not_、confidential、stores_、free_、other 或 rest。否則為 null。 |
更多範例
該版本沒有的代碼
沒有名稱也沒有資料列的 HS 代碼會回傳 404,且免費:
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"
}來源
每個請求由一個來源提供資料,依此順序採用第一個有資料列的來源:該國自有的海關或統計機構(basis 為 own)、該國向 UN Comtrade 提交的申報(third_,僅夥伴國總額),然後是其他國家對該國的申報,並將流向對調(partner_)。其他國家的申報,只有在至少 200 個申報國有關於該國的資料列時,才會排在 UN Comtrade 之前,這超過 Narwhal 所收錄的數量,因此它們排在最後。依產品查詢時,UN Comtrade 沒有任何資料,所以順序是 own,然後是 partner_,且 partner_ 僅達章(2 位碼)。basis 可依名稱指定單一來源。回應中的 basis、source 與 note 欄位說明由哪個來源提供資料,且同一個回應絕不混用不同來源。夥伴國申報回應與該國自有數字是不同的衡量方式,絕非官方數字。夥伴國申報回應僅達章,因此對於自有機構僅提供夥伴國總額的國家,4 或 6 位碼的代碼會回傳 404 basis_。
貨幣
金額為 currency 所指貨幣的整單位,以十進位字串表示。預設為來源發布時使用的貨幣,例如英國稅務海關總署(HM Revenue & Customs)使用 GBP。currency=USD 會以該月每日匯率的平均值換算各月。各月使用的匯率列在 fx 中,calculated 則標明已換算的欄位。沒有匯率的月份會回傳 404 rate_。若匯率來源無法回應,請求會回傳 503 upstream_。已經是 USD 的回應會原樣回傳。
分頁
limit 設定單頁最多的資料列數,範圍為 1 至 1000,預設為 500。符合條件的資料列較多時,next_ 會帶有下一頁的游標:將它作為 cursor 傳入,其他參數保持不變。來自不同請求的游標會回傳 400 invalid_。total 計算所有頁面中符合條件的資料列。MCP 工具單次結果最多回傳 200 列。
價格
回傳至少一列資料的請求算一次呼叫,每 1,000 次呼叫收費 $2。較長回應的每一頁各算一次呼叫,不論 limit 為何。沒有資料列的回應免費,所有錯誤也免費。
錯誤
這些錯誤使用共用的問題格式,並附有 request_。缺少或無效的金鑰(401)、餘額低於該次呼叫的價格(402)以及每分鐘請求過多(429),是所有路由共有的帳戶錯誤:請見「錯誤與額度」。
| 狀態 | 代碼 | 發生時機 |
|---|---|---|
400 | invalid_query | 缺少參數、參數格式錯誤或超出允許值:例如 start=2026-13、start 晚於 end、ytd 與 start 一併傳入,或傳入了 as_ 或 version(這些路由提供目前已收錄的資料)。另外,對夥伴國申報回應要求 top、share、ytd 或 change 時也是。 |
400 | invalid_cursor | 此游標不是該請求所回傳的游標,或其後有其他參數已變更。 |
400 | unknown_partner | 在所查詢的月份中,partner 不是該國的夥伴國,例如 ZZZ is not a partner of GBR.。 |
400 | range_too_large | top、share、ytd 或 change 涵蓋超過 12 個月、夥伴國申報回應涵蓋超過 12 個月,或產品回應(任何層級,2、4 或 6 位碼)在未帶 hs 或 partner 時涵蓋超過 12 個已收錄月份。開放式查詢會以 invalid_ 拒絕超過 12 個月的區間。 |
404 | country_not_covered | Narwhal 在任何來源中都沒有該國的貿易資料列。 |
404 | period_not_published | 所查詢的月份未收錄(No trade rows for 2026-10.),或 ytd 或 change 所需的某個月份缺漏。 |
404 | basis_not_available | 所指定的來源,或順序中的每個來源,都沒有符合該問題的資料。detail 會說明原因:例如該國自有機構僅提供夥伴國總額而無產品,或夥伴國申報回應僅達章(2 位碼),或泰國自有機構僅以 4 位碼保存卻被要求 6 位碼。請見涵蓋範圍路由。 |
404 | hs_code_not_found | HS 版本沒有該代碼的名稱,且該國也沒有其資料列,例如英國與代碼 999999 會回應 HS 2022 has no code 999999.。該國檔案確實收錄但沒有名稱的代碼(發布機構的剩餘資料行)會回傳 200,且 product_ 為 null。 |
404 | rate_not_available | 要求了 currency=USD,但某個月份沒有匯率。 |
503 | upstream_unavailable | 匯率來源無法回應。這會影響 currency=USD,以及需要換算的夥伴國申報回應。請稍後再試。 |
503 | trade_data_unavailable | 目前無法讀取產品檔案。請稍後再試。 |
此頁面對你有幫助嗎?