Skip to main content
GET
/
api
/
maritime
/
v1
/
get-vessel-snapshot
GetVesselSnapshot
curl --request GET \
  --url https://api.example.com/api/maritime/v1/get-vessel-snapshot
{
  "snapshot": {
    "snapshotAt": 123,
    "densityZones": [
      {
        "id": "<string>",
        "name": "<string>",
        "location": {
          "latitude": 0,
          "longitude": 0
        },
        "intensity": 50,
        "deltaPct": 123,
        "shipsPerDay": 123,
        "note": "<string>"
      }
    ],
    "disruptions": [
      {
        "id": "<string>",
        "name": "<string>",
        "type": "AIS_DISRUPTION_TYPE_UNSPECIFIED",
        "location": {
          "latitude": 0,
          "longitude": 0
        },
        "severity": "AIS_DISRUPTION_SEVERITY_UNSPECIFIED",
        "changePct": 123,
        "windowHours": 123,
        "darkShips": 123,
        "vesselCount": 123,
        "region": "<string>",
        "description": "<string>"
      }
    ],
    "sequence": 123,
    "status": {
      "connected": true,
      "vessels": 123,
      "messages": 123
    },
    "candidateReports": [
      {
        "mmsi": "<string>",
        "name": "<string>",
        "lat": 123,
        "lon": 123,
        "shipType": 123,
        "heading": 123,
        "speed": 123,
        "course": 123,
        "timestamp": 123
      }
    ],
    "tankerReports": [
      {
        "mmsi": "<string>",
        "name": "<string>",
        "lat": 123,
        "lon": 123,
        "shipType": 123,
        "heading": 123,
        "speed": 123,
        "course": 123,
        "timestamp": 123
      }
    ]
  }
}

Documentation Index

Fetch the complete documentation index at: https://worldmonitor.app/docs/llms.txt

Use this file to discover all available pages before exploring further.

Query Parameters

ne_lat
number<double>

North-east corner latitude of bounding box.

ne_lon
number<double>

North-east corner longitude of bounding box.

sw_lat
number<double>

South-west corner latitude of bounding box.

sw_lon
number<double>

South-west corner longitude of bounding box.

include_candidates
boolean

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_tankers
boolean

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.

Response

Successful response

GetVesselSnapshotResponse contains the vessel traffic snapshot.

snapshot
object

VesselSnapshot represents a point-in-time view of civilian AIS vessel data.