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
|
No |
Sets output format.
|
|
&output= |
ftp |
No |
Forces format to csv and saves output to your VesselsValue FTP account. |