Introduction

The VesselsValue API calls provide an output data either directly in response to the AP via a URL, or as files that are made available to download separately via FTP.

Your Token

API Access to VesselsValue data requires a connection token that is unique to each client. Your token is always 20 alphanumeric characters.

Your token will be provided in a separate communication once your access is authorized and tested.

Your API will only contain the vessels that have been specified on your contract. These can be specified by IMOs, VesselsValue vessel types, or vessels within your specified portfolio

Your API is limited by a weekly, daily, hourly pull frequency, as specified in your contract. If you hit your set quota and feel you need more pulls available, please reach out to your Account Manager https://www.vesselsvalue.com/contact/

How an API URL Request is Built

The URL for any API request is built as:

• The core API host

• Followed by the endpoint

• Followed by the parameter block appended to the URL and concatenated using &.

An example being:

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

Useful to Know

• Any references to your fleet is referring to the ships which have been specified on your contract i.e. IMOs, VesselsValue vessel types or vessels within your specified portfolio

• The parameter values should not include <> braces.

• When using output to FTP mode, the files will be created into directories that mirror the endpoint location of each API call. Each endpoint has a specific file naming convention.