Skip to main content
Skip table of contents

Ships Inside Zone Search Endpoint

Receive data about ships present or previously present inside a specified zone (polygon).

Endpoint

/search/shipsinzone

Request Example

https://api.vesselsvalue.com/search/shipsinzone?token=<your_token>&format=<format>

Parameters

Parameter

Values

Required?

Notes

?token=

<your token>

Yes

Your API authorization token.

&polygon_id=

<polygon_id>

Yes

Returns data for the provided polygon_id.

&ship_id=

<comma separated list of ship_id>

No

Returns data for only the supplied ship_id within the provided polygon_id.

&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.

JavaScript errors detected

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

If this problem persists, please contact our support.