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.

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

Allowed:
boolean
Defaults to false

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

Body Params

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

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
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json