> ## Documentation Index > Fetch the complete documentation index at: https://www.worldmonitor.app/docs/llms.txt > Use this file to discover all available pages before exploring further. # 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. ## OpenAPI ````yaml /api/MaritimeService.openapi.yaml get /api/maritime/v1/get-vessel-snapshot openapi: 3.1.0 info: title: MaritimeService API version: 1.0.0 servers: - url: https://api.worldmonitor.app security: - WorldMonitorKey: [] - ApiKeyHeader: [] paths: /api/maritime/v1/get-vessel-snapshot: get: tags: - MaritimeService summary: GetVesselSnapshot description: >- 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. operationId: GetVesselSnapshot parameters: - name: ne_lat in: query description: North-east corner latitude of bounding box. required: false example: 40.7128 schema: type: number format: double - name: ne_lon in: query description: North-east corner longitude of bounding box. required: false example: -74.006 schema: type: number format: double - name: sw_lat in: query description: South-west corner latitude of bounding box. required: false example: 40.7128 schema: type: number format: double - name: sw_lon in: query description: South-west corner longitude of bounding box. required: false example: -74.006 schema: type: number format: double - name: include_candidates in: query description: |- When true, populate VesselSnapshot.candidate_reports with per-vessel position reports. Clients with no position callbacks should leave this false to keep responses small. required: false example: true schema: type: boolean - name: include_tankers in: query description: |- 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. required: false example: true schema: type: boolean - name: jmespath in: query description: >- 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. required: false example: keys(@) schema: type: string responses: '200': description: Successful response content: application/json: example: 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 schema: $ref: '#/components/schemas/GetVesselSnapshotResponse' '400': description: Validation error content: application/json: schema: oneOf: - $ref: '#/components/schemas/ValidationError' - $ref: '#/components/schemas/JmespathProjectionError' '401': description: Missing or invalid API key. content: application/json: schema: $ref: '#/components/schemas/UnauthorizedError' '403': description: >- API access requires an active subscription (the API key's subscription is inactive or expired). content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' '429': description: Rate limit exceeded. headers: X-RateLimit-Limit: description: Maximum requests allowed in the active rate-limit window. schema: type: string X-RateLimit-Remaining: description: Requests remaining in the active rate-limit window. schema: type: string X-RateLimit-Reset: description: >- Unix epoch milliseconds when the active rate-limit window resets. schema: type: string Retry-After: description: Seconds to wait before retrying the request. schema: type: string content: application/json: schema: oneOf: - $ref: '#/components/schemas/Error' - $ref: '#/components/schemas/RateLimitError' default: description: Gateway or handler error response. content: application/json: schema: oneOf: - $ref: '#/components/schemas/Error' - $ref: '#/components/schemas/GatewayError' components: schemas: GetVesselSnapshotResponse: type: object properties: snapshot: $ref: '#/components/schemas/VesselSnapshot' fetchedAt: type: integer format: int64 description: >- 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 dataAvailable: type: boolean description: |- True when snapshot is populated. False means an absent snapshot is graceful degradation because the relay snapshot is unavailable. description: GetVesselSnapshotResponse contains the vessel traffic snapshot. ValidationError: type: object properties: violations: type: array items: $ref: '#/components/schemas/FieldViolation' description: List of validation violations required: - violations description: >- ValidationError is returned when request validation fails. It contains a list of field violations describing what went wrong. JmespathProjectionError: description: >- Returned when a REST jmespath projection is invalid or exceeds the expression/output byte limits. properties: _jmespath_error: description: Projection error discriminator and details. type: string original_keys: description: Top-level keys or shape of the unprojected response. items: type: string type: array required: - _jmespath_error - original_keys type: object UnauthorizedError: type: object properties: error: type: string description: Human-readable error message. required: - error description: >- Returned when the API key is missing, malformed, or lacks current API access. ForbiddenError: type: object properties: error: type: string description: Human-readable entitlement failure reason. requiredTier: type: integer format: int32 description: Minimum entitlement tier required for this endpoint. currentTier: type: integer format: int32 description: Caller entitlement tier when known. planKey: type: string description: Caller plan key when known. required: - error description: >- Returned when a PRO-gated endpoint denies access because the caller has no resolved authenticated user, entitlements cannot be verified, or the caller lacks the required entitlement tier. Error: type: object properties: message: type: string description: Error message (e.g., 'user not found', 'database connection failed') description: >- Error is returned when a handler encounters an error. It contains a simple error message that the developer can customize. RateLimitError: type: object description: Returned when a gateway or handler rate limit rejects the request. properties: error: type: string description: Human-readable rate-limit failure reason. required: - error GatewayError: type: object description: >- Returned by gateway infrastructure errors before an RPC handler runs, such as origin, routing, method, authentication, or quota checks. properties: error: oneOf: - type: string - type: object additionalProperties: true description: Gateway error reason or structured gateway failure details. required: - error VesselSnapshot: type: object properties: snapshotAt: type: integer format: int64 description: >- Snapshot timestamp, as Unix epoch milliseconds.. Warning: Values > 2^53 may lose precision in JavaScript densityZones: type: array items: $ref: '#/components/schemas/AisDensityZone' disruptions: type: array items: $ref: '#/components/schemas/AisDisruption' sequence: type: integer format: int32 description: >- Monotonic sequence number from the relay. Clients use this to detect stale responses during polling. status: $ref: '#/components/schemas/AisSnapshotStatus' candidateReports: type: array items: $ref: '#/components/schemas/SnapshotCandidateReport' tankerReports: type: array items: $ref: '#/components/schemas/SnapshotCandidateReport' description: >- VesselSnapshot represents a point-in-time view of civilian AIS vessel data. FieldViolation: type: object properties: field: type: string description: >- The field path that failed validation (e.g., 'user.email' for nested fields). For header validation, this will be the header name (e.g., 'X-API-Key') description: type: string description: >- Human-readable description of the validation violation (e.g., 'must be a valid email address', 'required field missing') required: - field - description description: FieldViolation describes a single validation error for a specific field. AisDensityZone: type: object properties: id: type: string minLength: 1 description: Zone identifier. name: type: string description: Zone name (e.g., "Strait of Malacca"). location: $ref: '#/components/schemas/GeoCoordinates' intensity: type: number maximum: 100 minimum: 0 format: double description: Traffic intensity score (0-100). deltaPct: type: number format: double description: Change from baseline as a percentage. shipsPerDay: type: integer format: int32 description: Estimated ships per day. note: type: string description: Analyst note. required: - id description: AisDensityZone represents a zone of concentrated vessel traffic. AisDisruption: type: object properties: id: type: string minLength: 1 description: Disruption identifier. name: type: string description: Descriptive name. type: type: string enum: - AIS_DISRUPTION_TYPE_UNSPECIFIED - AIS_DISRUPTION_TYPE_GAP_SPIKE - AIS_DISRUPTION_TYPE_CHOKEPOINT_CONGESTION description: |- AisDisruptionType represents the type of AIS tracking anomaly. Maps to TS union: 'gap_spike' | 'chokepoint_congestion'. location: $ref: '#/components/schemas/GeoCoordinates' severity: type: string enum: - AIS_DISRUPTION_SEVERITY_UNSPECIFIED - AIS_DISRUPTION_SEVERITY_LOW - AIS_DISRUPTION_SEVERITY_ELEVATED - AIS_DISRUPTION_SEVERITY_HIGH description: AisDisruptionSeverity represents the severity of an AIS disruption. changePct: type: number format: double description: Percentage change from normal. windowHours: type: integer format: int32 description: Analysis window in hours. darkShips: type: integer format: int32 description: Number of dark ships (AIS off) detected. vesselCount: type: integer format: int32 description: Number of vessels in the affected area. region: type: string description: Region name. description: type: string description: Human-readable description. required: - id description: AisDisruption represents a detected anomaly in AIS vessel tracking data. AisSnapshotStatus: type: object properties: connected: type: boolean description: Whether the relay WebSocket is connected to the AIS provider. vessels: type: integer format: int32 description: Number of vessels currently tracked by the relay. messages: type: integer format: int32 description: Total AIS messages processed in the current session. description: AisSnapshotStatus reports relay health at the time of the snapshot. SnapshotCandidateReport: type: object properties: mmsi: type: string description: Maritime Mobile Service Identity. name: type: string description: Vessel name (may be empty if unknown). lat: type: number format: double description: Latitude in decimal degrees. lon: type: number format: double description: Longitude in decimal degrees. shipType: type: integer format: int32 description: AIS ship type code (0 if unknown). heading: type: integer format: int32 description: Heading in degrees (0-359, or 511 for unavailable). speed: type: number format: double description: Speed over ground in knots. course: type: integer format: int32 description: Course over ground in degrees. timestamp: type: integer format: int64 description: >- Report timestamp, as Unix epoch milliseconds.. Warning: Values > 2^53 may lose precision in JavaScript description: |- SnapshotCandidateReport is a per-vessel position report attached to a snapshot. Used to drive the client-side position callback system. GeoCoordinates: type: object properties: latitude: type: number maximum: 90 minimum: -90 format: double description: Latitude in decimal degrees (-90 to 90). longitude: type: number maximum: 180 minimum: -180 format: double description: Longitude in decimal degrees (-180 to 180). description: GeoCoordinates represents a geographic location using WGS84 coordinates. securitySchemes: WorldMonitorKey: type: apiKey in: header name: X-WorldMonitor-Key description: User-issued WorldMonitor API key. ApiKeyHeader: type: apiKey in: header name: X-Api-Key description: Alias header for the WorldMonitor API key (X-WorldMonitor-Key). ````