Get vessels in radius (area scan)
get_vessels_in_radiusScan a circular area and return all vessels currently within a given radius (nautical miles, greater than 0 and at most 50). Specify the center in exactly one way: lat+lon coordinates, a port (port_unlocode or port_uuid), or a vessel to center on (mmsi/imo/uuid). Optional filters: type, type_specific, exclude, nav_status, and include_unknown_type. Returns up to 500 vessels per page, each with its distance (nautical miles) from the center; if more remain, pass the response's 'next' token via the 'next' argument to page through them. Credits are charged per vessel found.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| imo | No | Center the scan on a vessel, by IMO (exactly 7 digits). | |
| lat | No | Center latitude (-90..90). Must be used together with lon. Provide exactly one center: lat+lon, a port, or a vessel identifier. | |
| lon | No | Center longitude (-180..180). Must be used together with lat. | |
| mmsi | No | Center the scan on a vessel, by MMSI (exactly 9 digits). | |
| next | No | Optional: pagination token from a previous response's 'next' field, to fetch the next page (up to 500 vessels per page). | |
| type | No | Optional: only include vessels of this type (e.g. Tanker, Cargo). | |
| uuid | No | Center the scan on a vessel, by Datalastic vessel UUID. | |
| radius | Yes | Required. Scan radius in nautical miles, greater than 0 and at most 50. | |
| exclude | No | Optional: exclude vessels of this type. | |
| port_uuid | No | Center the scan on a port, by Datalastic port UUID. | |
| nav_status | No | Optional: filter by AIS navigational status number (e.g. 0 = under way using engine). | |
| port_unlocode | No | Center the scan on a port, by UN/LOCODE (e.g. ESVLC). | |
| type_specific | No | Optional: only include vessels of this specific subtype (e.g. LPG Tanker). | |
| include_unknown_type | No | Optional: include vessels that have no/unknown type. Defaults to the API default when omitted. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| next | Yes | ||
| point | Yes | ||
| total | Yes | ||
| vessels | Yes |