GetVesselSnapshot
GetVesselSnapshot retrieves a point-in-time view of AIS vessel traffic and disruptions. Empty/absent snapshot with fetched_at=0 or data_available=false means the relay snapshot is unavailable/degraded, not that traffic is confirmed absent.
Authorizations
User-issued WorldMonitor API key.
Query Parameters
North-east corner latitude of bounding box.
North-east corner longitude of bounding box.
South-west corner latitude of bounding box.
South-west corner longitude of bounding box.
When true, populate VesselSnapshot.candidate_reports with per-vessel position reports. Clients with no position callbacks should leave this false to keep responses small.
When true, populate VesselSnapshot.tanker_reports with per-vessel position reports for AIS ship-type 80-89 (tanker class). Used by the Energy Atlas live-tanker map layer. Stored separately from candidate_reports (which is military-only) so consumers self-select via this flag rather than the response field changing meaning.
Optional JMESPath expression applied server-side to project or reduce the JSON response before it is returned (mirrors the MCP jmespath argument). Invalid expressions, expressions larger than 1024 UTF-8 bytes, or projections that exceed the 256 KB output cap return HTTP 400 with a {_jmespath_error, original_keys} envelope. Grammar and worked examples: https://www.worldmonitor.app/docs/mcp-jmespath.
Response
Successful response
GetVesselSnapshotResponse contains the vessel traffic snapshot.
VesselSnapshot represents a point-in-time view of civilian AIS vessel data.
Time the relay snapshot was fetched, as Unix epoch milliseconds. A value of 0 means the snapshot is unavailable/degraded, not that vessel traffic is confirmed absent.. Warning: Values > 2^53 may lose precision in JavaScript
True when snapshot is populated. False means an absent snapshot is graceful degradation because the relay snapshot is unavailable.
