curl --request GET \
--url https://api.worldmonitor.app/api/maritime/v1/get-vessel-snapshot \
--header 'X-WorldMonitor-Key: <api-key>'import requests
url = "https://api.worldmonitor.app/api/maritime/v1/get-vessel-snapshot"
headers = {"X-WorldMonitor-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-WorldMonitor-Key': '<api-key>'}};
fetch('https://api.worldmonitor.app/api/maritime/v1/get-vessel-snapshot', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.worldmonitor.app/api/maritime/v1/get-vessel-snapshot",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-WorldMonitor-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.worldmonitor.app/api/maritime/v1/get-vessel-snapshot"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-WorldMonitor-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.worldmonitor.app/api/maritime/v1/get-vessel-snapshot")
.header("X-WorldMonitor-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.worldmonitor.app/api/maritime/v1/get-vessel-snapshot")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-WorldMonitor-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"dataAvailable": true,
"fetchedAt": 1717200000000,
"snapshot": {
"candidateReports": [
{
"course": 1,
"heading": 1,
"lat": 40.7128,
"lon": -74.006,
"mmsi": "123456789"
}
],
"densityZones": [
{
"deltaPct": 1.5,
"id": "example-id",
"intensity": 1.5,
"location": {
"latitude": 40.7128,
"longitude": -74.006
},
"name": "WorldMonitor Analyst",
"note": "example"
}
],
"disruptions": [
{
"changePct": 1.5,
"darkShips": 1,
"description": "Example WorldMonitor observation.",
"id": "example-id",
"location": {
"latitude": 40.7128,
"longitude": -74.006
},
"name": "WorldMonitor Analyst"
}
],
"sequence": 1,
"snapshotAt": 1717200000000
}
}{
"violations": [
{
"field": "<string>",
"description": "<string>"
}
]
}{
"error": "<string>"
}{
"error": "<string>",
"code": "subscription_lapsed",
"requiredTier": 123,
"currentTier": 123,
"planKey": "<string>"
}{
"message": "<string>"
}{
"error": "<string>",
"code": "renewal_verification_pending",
"requiredTier": 123
}{
"message": "<string>"
}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.
curl --request GET \
--url https://api.worldmonitor.app/api/maritime/v1/get-vessel-snapshot \
--header 'X-WorldMonitor-Key: <api-key>'import requests
url = "https://api.worldmonitor.app/api/maritime/v1/get-vessel-snapshot"
headers = {"X-WorldMonitor-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-WorldMonitor-Key': '<api-key>'}};
fetch('https://api.worldmonitor.app/api/maritime/v1/get-vessel-snapshot', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.worldmonitor.app/api/maritime/v1/get-vessel-snapshot",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-WorldMonitor-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.worldmonitor.app/api/maritime/v1/get-vessel-snapshot"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-WorldMonitor-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.worldmonitor.app/api/maritime/v1/get-vessel-snapshot")
.header("X-WorldMonitor-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.worldmonitor.app/api/maritime/v1/get-vessel-snapshot")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-WorldMonitor-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"dataAvailable": true,
"fetchedAt": 1717200000000,
"snapshot": {
"candidateReports": [
{
"course": 1,
"heading": 1,
"lat": 40.7128,
"lon": -74.006,
"mmsi": "123456789"
}
],
"densityZones": [
{
"deltaPct": 1.5,
"id": "example-id",
"intensity": 1.5,
"location": {
"latitude": 40.7128,
"longitude": -74.006
},
"name": "WorldMonitor Analyst",
"note": "example"
}
],
"disruptions": [
{
"changePct": 1.5,
"darkShips": 1,
"description": "Example WorldMonitor observation.",
"id": "example-id",
"location": {
"latitude": 40.7128,
"longitude": -74.006
},
"name": "WorldMonitor Analyst"
}
],
"sequence": 1,
"snapshotAt": 1717200000000
}
}{
"violations": [
{
"field": "<string>",
"description": "<string>"
}
]
}{
"error": "<string>"
}{
"error": "<string>",
"code": "subscription_lapsed",
"requiredTier": 123,
"currentTier": 123,
"planKey": "<string>"
}{
"message": "<string>"
}{
"error": "<string>",
"code": "renewal_verification_pending",
"requiredTier": 123
}{
"message": "<string>"
}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.
Show child attributes
Show child attributes
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.
Was this page helpful?