Trade Stoppages Endpoint

Receive Trade stoppage data for the fleet of ships associated with your API account.

Endpoint

/fleet/trade/stoppages

Request Example

https://api.vesselsvalue.com/fleet/trade/stoppages?token=<your_token>&format=<format>

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.

&imo=

<specified IMO>

Yes

A valid ship IMO. Returns data for any vessels where the IMO matches this value.

To return more than one ship, list IMOs with commas between them i.e. 1234567, 1234567

&from=

<Y-m-dTH:i:sZ>

e.g. 2024-01-02T18:07:27.963Z

No

Optional, restricts the stoppages returned to those ending after this ISO 8601 datetime.
Defaults to returning all data if not provided.

&to=

<Y-m-dTH:i:sZ>

e.g. 2024-01-02T18:07:27.963Z

No

Optional, restricts the stoppages returned to those starting before this ISO 8601 datetime.
Defaults to returning all data if not provided.