Skip to main content
GET
GetUSNIFleetReport

Authorizations

X-WorldMonitor-Key
string
header
required

User-issued WorldMonitor API key.

Query Parameters

force_refresh
boolean

When true, bypass cache and fetch fresh data from USNI.

jmespath
string

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

GetUSNIFleetReportResponse returns the parsed USNI Fleet Tracker report.

report
object

USNIFleetReport is the full parsed output of a USNI Fleet Tracker article.

cached
boolean

Whether the response was served from cache.

stale
boolean

Whether the cached data is stale (served after a fetch failure).

error
string

Error message, if any.