Get estimated rates

get

https://api.xeneta.com/v3.0/ocean/estimated-rates

Returns estimated rate within the specified parameters on the port-to-port level only.

Query Params

origin

string

required

Defaults to CNSGH

Defines the origin port of the requested estimated rate data. Only UN/LOCODE values matching Xeneta's geo-hierarchy are supported, anything else will result in an error or an empty response.

destination

string

required

Defaults to USPHL

Defines the destination port of the requested estimated rate data. Only UN/LOCODE values matching Xeneta's geo-hierarchy are supported, anything else will result in an error or an empty response.

date_from

date

required

Defaults to 2023-02-01

Defines the start date of the date range for the requested estimated rates in the YYYY-MM-DD format.

date_to

date

required

Defaults to 2023-02-05

Defines the end date of the date range for the requested estimated rates in the YYYY-MM-DD format. The total range cannot exceed 31 days.

contract_length

string

required

Defaults to long

Defines the type of contract for the requested estimated rate data. Accepted values are long or short. The total range cannot exceed 31 days.

contracted_within

string

required

Defaults to all

Defines the maximum age of the contracts to be included in the requested estimated rate data, relative to each day. Accepted values include all, 3months and 6months. Using any value other than all when contract_length is set to short will return an error.

container_type

string

required

Defaults to 40DC

Defines the container type of the requested market rate data. Accepted values include 20DC, 20RE, 20TK, 40DC, 40RH and 40HC.

thc_methodology

string

required

Defaults to meth

Defines whether the requested market rate data should include the terminal handling charge. Accepted values include meth, othc, dthc, none and both. Selecting meth will use Xeneta's default methodology for the requested origin and destination.

Response

200200