Skip to main content
Skip table of contents

Congestion (Country) Endpoint

Receive a time series of aggregated Average Waiting time for all ports within a specified country, for ships of a specified VV type.

Endpoint

/v2/location/country/<country_id>/delay/average-hours/<ship_type_id>

Request Example

https://api.vesselsvalue.com/v2/location/country/<country_id>/delay/average-hours/<ship_type_id>?token=<your_token>&format=<format>

Options

Options

Values

Required?

Notes

<country_id>

Integer

Yes

The VV provided Country ID of the port you are fetching data for.

<ship_type_id>

Integer

Yes

The VV provided Ship Type ID which describes a select group of ships, such as Bulkers, or Capesize.

Parameters

Parameter

Values

Required?

Notes

?token=

<your_token>

Yes

Your API authorization token.

&format=

json
xml
csv

No

Sets output format.
Defaults to json if not provided.

&output=

ftp

No

Forces format to csv and saves output to your VesselsValue FTP account.

&from

YYYY-MM-DD

No

Sets the earliest date for which to provide data.
Defaults to the current date - 1 year if not provided.

&to

YYYY-MM-DD

No

Sets the latest date for which to provide data.
Defaults to the current date if not provided.

&waiting_status

all
laden
ballast
cargo_ops

No

Defines the status of the waiting ships to include.
Defaults to "all" if not provided.
"all" = no filtering.
"laden" = Where our Trade service classifies the ship as laden while it was waiting.
"ballast" = Where our Trade service classifies the ship as ballast while it was waiting.
"cargo_ops" = Where our Trade service classifies the ship as performing a mix of load and discharge while it was waiting, or vessels which do not operate laden/ballast.

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.