Skip to main content
POST /v1/data/customs/companies/run Pricing: $0.04 per companie ($38.00 per 1,000).

Request

Send the inputs under params. Only the keys below are accepted; any other key returns 422 invalid_params.
string[]
Product keywords to match against customs goods descriptions.
string
Customs HS code (4 or more digits) to anchor the trade query.
string
default:"importers"
Which side of the trade to rank: importing companies or exporting companies.Allowed values: importers (Importers), exporters (Exporters).
string
Name of the trading partner company on the other side of the shipments, used to narrow the ranking.
string[]
Origin countries to filter the trade records by, as ISO 3166 alpha-3 codes (e.g. COL, 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/companies?expand=options.
string[]
Destination countries to filter the trade records by, as ISO 3166 alpha-3 codes (e.g. COL, 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/companies?expand=options.
integer
default:"50"
How many companies to return in total. Defaults to 50; use 0 for all.Max 100.

Example

Response fields

Each row in data is one companie, keyed by these fields.

Example response

Abridged: long text and lists are shortened.
For the individual shipments use customs/shipments; for aggregate country-level trade use customs/trade-stats.