MaritimeService

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.

get/api/maritime/v1/get-vessel-snapshot

Request

  • Base URL: https://api.worldmonitor.app
  • URL: https://api.worldmonitor.app/api/maritime/v1/get-vessel-snapshot
  • Auth: one of:
    • API key in header X-WorldMonitor-Key
    • API key in header X-Api-Key

Query parameters

ne_latnumber double

North-east corner latitude of bounding box.

ne_lonnumber double

North-east corner longitude of bounding box.

sw_latnumber double

South-west corner latitude of bounding box.

sw_lonnumber double

South-west corner longitude of bounding box.

include_candidatesboolean

When true, populate VesselSnapshot.candidate_reports with per-vessel position reports. Clients with no position callbacks should leave this false to keep responses small.

include_tankersboolean

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.

jmespathstring

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

OK

fetchedAtinteger

Warning: Values > 2^53 may lose precision in JavaScript

dataAvailableboolean

True when snapshot is populated. False means an absent snapshot is graceful degradation because the relay snapshot is unavailable.

Changes

No recorded changes to this operation across all 1 revision of this API.