> ## 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.

# GetUSNIFleetReport

> GetUSNIFleetReport retrieves the latest parsed USNI Fleet Tracker report.



## OpenAPI

````yaml /api/MilitaryService.openapi.yaml get /api/military/v1/get-usni-fleet-report
openapi: 3.1.0
info:
  title: MilitaryService API
  version: 1.0.0
servers:
  - url: https://api.worldmonitor.app
security:
  - WorldMonitorKey: []
  - ApiKeyHeader: []
paths:
  /api/military/v1/get-usni-fleet-report:
    get:
      tags:
        - MilitaryService
      summary: GetUSNIFleetReport
      description: >-
        GetUSNIFleetReport retrieves the latest parsed USNI Fleet Tracker
        report.
      operationId: GetUSNIFleetReport
      parameters:
        - name: force_refresh
          in: query
          description: When true, bypass cache and fetch fresh data from USNI.
          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:
                cached: true
                error: example
                report:
                  articleDate: '2026-01-15'
                  articleTitle: example
                  articleUrl: https://example.com/worldmonitor
                  battleForceSummary:
                    deployed: 1
                    totalShips: 1
                    underway: 1
                  parsingWarnings:
                    - example
                stale: true
              schema:
                $ref: '#/components/schemas/GetUSNIFleetReportResponse'
        '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:
    GetUSNIFleetReportResponse:
      type: object
      properties:
        report:
          $ref: '#/components/schemas/USNIFleetReport'
        cached:
          type: boolean
          description: Whether the response was served from cache.
        stale:
          type: boolean
          description: Whether the cached data is stale (served after a fetch failure).
        error:
          type: string
          description: Error message, if any.
      description: GetUSNIFleetReportResponse returns the parsed USNI Fleet Tracker report.
    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
    USNIFleetReport:
      type: object
      properties:
        articleUrl:
          type: string
          description: URL of the source article.
        articleDate:
          type: string
          description: Publication date of the article.
        articleTitle:
          type: string
          description: Title of the article.
        battleForceSummary:
          $ref: '#/components/schemas/BattleForceSummary'
        vessels:
          type: array
          items:
            $ref: '#/components/schemas/USNIVessel'
        strikeGroups:
          type: array
          items:
            $ref: '#/components/schemas/USNIStrikeGroup'
        regions:
          type: array
          items:
            type: string
            description: Unique region names mentioned in the article.
        parsingWarnings:
          type: array
          items:
            type: string
            description: Warnings generated during parsing.
        timestamp:
          type: integer
          format: int64
          description: >-
            Time the report was generated, as Unix epoch milliseconds.. Warning:
            Values > 2^53 may lose precision in JavaScript
      description: >-
        USNIFleetReport is the full parsed output of a USNI Fleet Tracker
        article.
    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.
    BattleForceSummary:
      type: object
      properties:
        totalShips:
          type: integer
          minimum: 0
          format: int32
          description: Total ships in the battle force.
        deployed:
          type: integer
          minimum: 0
          format: int32
          description: Number of ships currently deployed.
        underway:
          type: integer
          minimum: 0
          format: int32
          description: Number of ships currently underway.
      description: BattleForceSummary contains fleet-wide ship count statistics.
    USNIVessel:
      type: object
      properties:
        name:
          type: string
          minLength: 1
          description: Vessel name (e.g., "USS Abraham Lincoln").
        hullNumber:
          type: string
          minLength: 1
          description: Hull designation (e.g., "CVN-72", "DDG-51").
        vesselType:
          type: string
          description: >-
            Vessel type classification (e.g., "carrier", "destroyer",
            "submarine").
        region:
          type: string
          description: Region name where the vessel is operating.
        regionLat:
          type: number
          format: double
          description: Approximate latitude for the region.
        regionLon:
          type: number
          format: double
          description: Approximate longitude for the region.
        deploymentStatus:
          type: string
          description: >-
            Deployment status (e.g., "deployed", "underway", "in-port",
            "unknown").
        homePort:
          type: string
          description: Home port, if identified from the article text.
        strikeGroup:
          type: string
          description: Strike group assignment, if any.
        activityDescription:
          type: string
          description: Brief activity description parsed from article prose.
        articleUrl:
          type: string
          description: URL of the USNI article this vessel was parsed from.
        articleDate:
          type: string
          description: Publication date of the USNI article.
      required:
        - name
        - hullNumber
      description: >-
        USNIVessel represents a single vessel parsed from a USNI Fleet Tracker
        article.
    USNIStrikeGroup:
      type: object
      properties:
        name:
          type: string
          description: Strike group name (e.g., "Abraham Lincoln Carrier Strike Group").
        carrier:
          type: string
          description: Carrier name and hull (e.g., "USS Abraham Lincoln (CVN-72)").
        airWing:
          type: string
          description: Assigned air wing (e.g., "Carrier Air Wing Nine").
        destroyerSquadron:
          type: string
          description: Assigned destroyer squadron.
        escorts:
          type: array
          items:
            type: string
            description: Escort vessels in the strike group.
      description: >-
        USNIStrikeGroup represents a carrier strike group parsed from the
        article.
  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).

````