cURL
curl --request GET \ --url https://api.example.com/api/military/v1/get-usni-fleet-report
{ "report": { "articleUrl": "<string>", "articleDate": "<string>", "articleTitle": "<string>", "battleForceSummary": { "totalShips": 1, "deployed": 1, "underway": 1 }, "vessels": [ { "name": "<string>", "hullNumber": "<string>", "vesselType": "<string>", "region": "<string>", "regionLat": 123, "regionLon": 123, "deploymentStatus": "<string>", "homePort": "<string>", "strikeGroup": "<string>", "activityDescription": "<string>", "articleUrl": "<string>", "articleDate": "<string>" } ], "strikeGroups": [ { "name": "<string>", "carrier": "<string>", "airWing": "<string>", "destroyerSquadron": "<string>", "escorts": [ "<string>" ] } ], "regions": [ "<string>" ], "parsingWarnings": [ "<string>" ], "timestamp": 123 }, "cached": true, "stale": true, "error": "<string>" }
GetUSNIFleetReport retrieves the latest parsed USNI Fleet Tracker report.
When true, bypass cache and fetch fresh data from USNI.
Successful response
GetUSNIFleetReportResponse returns the parsed USNI Fleet Tracker report.
USNIFleetReport is the full parsed output of a USNI Fleet Tracker article.
Show child attributes
Whether the response was served from cache.
Whether the cached data is stale (served after a fetch failure).
Error message, if any.
Was this page helpful?