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.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
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.
