Skip to main content
POST /v1/data/customs/shipments/run Pricing: $0.03 per customs shipment record ($32.00 per 1,000).

Request

Send the inputs under params. Only the keys below are accepted; any other key returns 422 invalid_params.
string
default:"imports"
Whether to search import or export customs records.Allowed values: imports (Imports), exports (Exports).
string[]
Product keywords to search for in the shipment goods description.
string
Customs tariff code to filter shipments, 4 or more digits.
string[]
Importing company name to search for.
string[]
Exporting company name to search for.
string[]
Search only these countries’ customs datasets (for example america, mexico, india); leave empty to search all of them. Some countries have several datasets, e.g. the US has america, america_ship and america_stat.165 allowed values, for example afghanistan (Afghanistan), africa_bol (Africa BOL), america (America BOL), america_ship (America Master BOL), america_stat (America STAT), angola (Angola), angola_stat (Angola STAT), argentina (Argentina), argentina_bol (Argentina BOL), argentina_un_stat (Argentina STAT). Fetch the full list with GET /v1/data/customs/shipments?expand=options.
string[]
Origin countries to filter shipments by, as ISO 3166 alpha-3 codes (e.g. CHN, USA). Pick from the list; English country names are also accepted.248 allowed values, for example AFG (Afghanistan), ALA (Aland Islands), ALB (Albania), DZA (Algeria), ASM (American Samoa), AND (Andorra), AGO (Angola), AIA (Anguilla), ATA (Antarctica), ATG (Antigua and Barbuda). Fetch the full list with GET /v1/data/customs/shipments?expand=options.
string[]
Destination countries to filter shipments by, as ISO 3166 alpha-3 codes (e.g. CHN, USA). Pick from the list; English country names are also accepted.248 allowed values, for example AFG (Afghanistan), ALA (Aland Islands), ALB (Albania), DZA (Algeria), ASM (American Samoa), AND (Andorra), AGO (Angola), AIA (Anguilla), ATA (Antarctica), ATG (Antigua and Barbuda). Fetch the full list with GET /v1/data/customs/shipments?expand=options.
date
Earliest shipment date to include, within the last three years.
date
Latest shipment date to include.
integer
default:"50"
How many customs shipment records to return in total. Defaults to 50; use 0 for all.Max 500.

Example

Response fields

Each row in data is one customs shipment record, keyed by these fields.

Example response

Abridged: long text and lists are shortened.
For ranked importers and exporters of a product use customs/companies; for aggregate trade by HS code or country use customs/trade-stats.