vessels_in_area
Retrieve vessels within a specified sea area using a bounding box or region key. Filters the data to that area so you see only the relevant vessels.
Instructions
Vessels inside one area of sea, rather than everywhere the server watches.
This exists because a selection covering several regions can hold far more vessels than any one caller wants at once, and sending all of them is expensive for an answer about one strait. Ask for the water you care about.
The area filters what has already been collected, which is a different question from what is subscribed to: a region switched away from still has vessels in the store until they age out, and an area nobody is subscribed to simply returns nothing.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| bbox | No | Area to report, as 'south,west,north,east' in degrees, for example '1.0,103.0,2.0,104.5'. Leave blank to use region instead. | |
| limit | No | Maximum vessels to return, between 1 and 500. The response always states how many were in the area, so a truncated answer is visible rather than silent. | |
| region | No | A region key to report instead of a bbox, for example 'malaysia'. Call list_regions for the available keys. Ignored when bbox is given. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |