POST /v1/data/customs/companies/run
Pricing: $0.04 per companie ($38.00 per 1,000).
Request
Send the inputs underparams. Only the keys below are accepted; any other key returns 422 invalid_params.
Which side of the trade to rank: importing companies or exporting companies.Allowed values:
importers (Importers), exporters (Exporters).Name of the trading partner company on the other side of the shipments, used to narrow the ranking.
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.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.Example
Response fields
Each row indata is one companie, keyed by these fields.
Example response
Abridged: long text and lists are shortened.Related APIs
For the individual shipments usecustoms/shipments; for aggregate country-level trade use customs/trade-stats.