Skip to main content
POST
trade.shipments.count

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
direction
enum<string>
required

Which side of the trade records to count.

Available options:
imports,
exports
startDate
string
required

First day, YYYY-MM-DD; the upstream allows at most three years.

Required string length: 1 - 10
Pattern: ^(?:^\d{4}-\d{2}-\d{2}$)$
endDate
string
required

Last day, YYYY-MM-DD.

Required string length: 1 - 10
Pattern: ^(?:^\d{4}-\d{2}-\d{2}$)$
importer
string

Importing company name.

Required string length: 1 - 512
exporter
string

Exporting company name.

Required string length: 1 - 512
product
string

Product description keywords.

sourceCountry
string

Two-letter country code for the customs dataset, when supported; unsupported countries decline before payment.

Pattern: ^[a-z]{2}$

Response

The result

total
number
required

Number of matching trade records.