Skip to main content
POST
trade.exporters.rank

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
catalog
enum<string>
required

Which side of customs records to search: imports or exports.

Available options:
imports,
exports
endDate
string
required

Query window end, YYYY-MM-DD.

Required string length: 1 - 512
pageNo
integer
required

Page number, starting at 1.

Required range: 0 <= x <= 1000000
startDate
string
required

Query window start, YYYY-MM-DD. The window may span at most three years.

Required string length: 1 - 512
containProducer
boolean

Include producer companies (available on Russia/Kazakhstan sources).

countryOfDestinationCode
string

Destination country ISO3 code(s), semicolon-separated (e.g. 'USA;CHN').

Required string length: 1 - 20000
countryOfOriginCode
string

Origin country ISO3 code(s), semicolon-separated (e.g. 'CHN;USA').

Required string length: 1 - 20000
exporter
string

Exporter company name (min 2 chars). Drop company suffixes and special characters for better matching.

Required string length: 1 - 512
hsCode
string

Customs HS code, 4+ digits (e.g. '630492'). A 2-digit chapter code works only combined with productDesc or a company name.

Required string length: 1 - 20000
importer
string

Importer company name (min 2 chars). Drop company suffixes and special characters for better matching.

Required string length: 1 - 512
optimizationModel
boolean

Prefer the vendor's optimized data sources.

limit
number

How many to return, 1 to 20. Default 10.

Required range: x >= 1
portOfArrival
string

Arrival port name.

Required string length: 1 - 512
portOfDeparture
string

Departure port name.

Required string length: 1 - 512
productDesc
string

Product description keywords; separate multiple keywords with semicolons (e.g. 'electronics; home appliance').

Required string length: 1 - 512
quantityUnit
string

Quantity unit filter (e.g. 'PCS', 'PKG').

Required string length: 1 - 512
searchMode
string

Set to FUZZY_SINGLE for single-keyword fuzzy matching; omit for the default smart search.

Required string length: 1 - 512
transportType
string

Transport mode (e.g. sea, air, road).

Required string length: 1 - 512

Response

The result

results
object[]
required

The matching items.

nextCursor
string

Pass as cursor to get the next page; absent on the last page.