Get price statistics (POST)

Retrieve price statistics with routes specified in the request body. Use this method to query multiple routes in a single request, or to query your subscription routes by omitting the routes array.

Rate Limit: 10 requests per minute
Typical Response Time: 2-16 seconds

Route Quota: Each subscription has a limit on unique routes you can query. Routes are uniquely identified by origin, destination, mode, and load tag. Only routes that return actual data (with coverage) count toward your quota. Once a route is stored with coverage, you can query it repeatedly without using quota. If you exceed your quota, you'll receive an error message indicating how many routes you're allowed and how many you requested.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

OCEAN REGIONS = [
"Gulf Area",
"Red Sea",
"Asia, Central",
"Asia, Southern",
"Asia, China, South-East Asia",
"Africa, Sub-Saharan",
"Africa, Northern",
"Europe, Eastern",
"Europe, Northern",
"Europe, Southern",
"Oceania, Australia",
"Americas, US East",
"Americas, US West",
"Americas, Canada East",
"Americas, Canada West",
"Americas, Central",
"Americas, South East",
"Americas, South West"
]

AIR_REGIONS = [
"Middle East",
"Asia, Southern",
"Americas, Caribbean",
"Europe, Southern",
"Middle Africa",
"Americas, South",
"Americas, US West",
"Europe, Northern",
"Oceania, Australia",
"Oceania, Pacific Islands",
"Africa, Western",
"Europe, Eastern",
"Africa, Eastern",
"Africa, Southern",
"Americas, Central",
"Asia, South-eastern",
"Americas, Canada East",
"Americas, Canada West",
"Asia, Greater China",
"Africa, Northern",
"Asia, Central",
"Asia, Japan",
"Asia, Korea",
"Europe, Russia",
"Oceania, New Zealand",
"Americas, US East",
"Americas, US Central"
]

Route types

Alongside P2P (port to port), C2C (country to country) and R2R (region to region), six mixed-level route types are now supported: P2R (port to region), R2P (region to port), P2C (port to country), C2P (country to port), C2R (country to region) and R2C (region to country).

Set the route type on each object in the routes array. Ports are UN/LOCODE for ocean or IATA for air, countries are two-letter ISO codes, and regions are a three-letter region code or the full region name listed above. Numeric region ids are not accepted. Every type except P2P requires exact route matching.

When one side is a country or a region, the API prices the port pairs behind it with the most rate coverage, up to 30 per request and split evenly across the country's regions, and returns them as a single series. The request counts as one route against your quota no matter how many pairs sit behind it.

For example, a P2C route with origin CNSHA and destination US returns ocean rates from Shanghai into the United States, averaged across the busiest Shanghai-to-US port pairs. The mirror case, a C2P route with origin US and destination LHR, returns air rates from across the United States into London Heathrow.


Query Params
date
required

Start date for the statistics in YYYY-MM-DD format

date
required

End date for the statistics in YYYY-MM-DD format

string
enum

Type of tradelane. Required if routes array is not provided in body

Allowed:
string
enum
Defaults to weekly

Data version. Defaults to your subscription's default version

Allowed:
string
enum
Defaults to similar

Route matching mode. Use 'exact' to return only exact route matches, or 'similar' to return averaged statistics across similar routes. Note: 'similar' mode is only available for port-to-port (P2P) route types; all other route types support 'exact' mode only.

Allowed:
string
Defaults to ALL

Filter by shipment priority

string
enum
Defaults to SPOT

Type of rate to filter by. Requires special permissions for CONTRACT and ALL types. LCL supports SPOT only

Allowed:
boolean
Defaults to false

Include change metrics (volatility and change percentage) in the response

string
enum
Defaults to all

LCL only. Shipment size band in CBM: all (whole lane), lt1 (under 1 CBM), 1-3, 3-10, 10plus. Ignored for FCL and Air. lt1 returns data only with price_basis=total.

Allowed:
string
enum
Defaults to per_cbm

LCL only. per_cbm returns USD per cubic metre; total returns USD for the whole shipment. Prices are all-in. Ignored for FCL and Air.

Allowed:
Body Params

Request body for specifying routes. If omitted, uses your subscription's configured routes

Request body for POST requests

string
enum
required

Default mode for all routes in the array

Allowed:
routes
array of objects

Array of route objects. If omitted, uses your subscription's configured routes

routes
Responses

Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json