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

# GetOilStocksAnalysis

> GetOilStocksAnalysis retrieves the IEA oil stocks days-of-cover ranking and regional summary.



## OpenAPI

````yaml /api/EconomicService.openapi.yaml get /api/economic/v1/get-oil-stocks-analysis
openapi: 3.1.0
info:
  title: EconomicService API
  version: 1.0.0
servers:
  - url: https://api.worldmonitor.app
security:
  - WorldMonitorKey: []
  - ApiKeyHeader: []
paths:
  /api/economic/v1/get-oil-stocks-analysis:
    get:
      tags:
        - EconomicService
      summary: GetOilStocksAnalysis
      description: >-
        GetOilStocksAnalysis retrieves the IEA oil stocks days-of-cover ranking
        and regional summary.
      operationId: GetOilStocksAnalysis
      parameters:
        - 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:
                belowObligation:
                  - example
                dataMonth: example
                ieaMembers:
                  - belowObligation: true
                    daysOfCover: 7
                    iso2: US
                    netExporter: true
                    obligationMet: true
                regionalSummary:
                  asiaPacific:
                    avgDays: 7
                    countBelowObligation: 1
                    minDays: 7
                  europe:
                    avgDays: 7
                    countBelowObligation: 1
                    minDays: 7
                  northAmerica:
                    avgDays: 7
                    netExporters: 1
                unavailable: false
              schema:
                $ref: '#/components/schemas/GetOilStocksAnalysisResponse'
        '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:
    GetOilStocksAnalysisResponse:
      type: object
      properties:
        updatedAt:
          type: string
          description: UTC ISO-8601 timestamp when this analysis was written.
        dataMonth:
          type: string
          description: 'Data month in YYYY-MM format (source: IEA monthly release).'
        ieaMembers:
          type: array
          items:
            $ref: '#/components/schemas/OilStocksAnalysisMember'
        belowObligation:
          type: array
          items:
            type: string
            description: ISO2 codes of countries currently below the 90-day obligation.
        regionalSummary:
          $ref: '#/components/schemas/OilStocksRegionalSummary'
        unavailable:
          type: boolean
          description: |-
            True when upstream seed data is unavailable (fallback result).
             True when the upstream or seed-backed variant is unavailable; empty payload fields
             are graceful degradation, not confirmed zero data.
      description: >-
        GetOilStocksAnalysisResponse contains the IEA oil stocks days-of-cover
        analysis.
    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
    OilStocksAnalysisMember:
      type: object
      properties:
        iso2:
          type: string
          description: ISO 3166-1 alpha-2 country code.
        daysOfCover:
          type: integer
          format: int32
          description: >-
            Days of supply cover (absent when country is a net exporter or data
            anomaly).
        netExporter:
          type: boolean
          description: True when the country is classified as a net exporter by IEA.
        belowObligation:
          type: boolean
          description: True when days_of_cover < 90 (IEA 90-day obligation threshold).
        obligationMet:
          type: boolean
          description: True when the 90-day obligation is met (net exporters always true).
        rank:
          type: integer
          format: int32
          description: >-
            Rank within the IEA member ranking (1-indexed, net exporters ranked
            last).
        vsObligation:
          type: integer
          format: int32
          description: days_of_cover - 90; absent for net exporters.
      description: >-
        OilStocksAnalysisMember holds days-of-cover data and obligation status
        for one IEA member country.
    OilStocksRegionalSummary:
      type: object
      properties:
        europe:
          $ref: '#/components/schemas/OilStocksRegionalSummaryEurope'
        asiaPacific:
          $ref: '#/components/schemas/OilStocksRegionalSummaryAsiaPacific'
        northAmerica:
          $ref: '#/components/schemas/OilStocksRegionalSummaryNorthAmerica'
      description: >-
        OilStocksRegionalSummary holds regional aggregates for the three IEA
        regions.
    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.
    OilStocksRegionalSummaryEurope:
      type: object
      properties:
        avgDays:
          type: integer
          format: int32
          description: Mean days of cover across non-net-exporter European members.
        minDays:
          type: integer
          format: int32
          description: Minimum days of cover across non-net-exporter European members.
        countBelowObligation:
          type: integer
          format: int32
          description: Count of European members below the 90-day obligation.
      description: >-
        OilStocksRegionalSummaryEurope aggregates days-of-cover for European IEA
        members.
    OilStocksRegionalSummaryAsiaPacific:
      type: object
      properties:
        avgDays:
          type: integer
          format: int32
          description: Mean days of cover across Asia-Pacific members (AU, JP, KR, NZ).
        minDays:
          type: integer
          format: int32
          description: Minimum days of cover across Asia-Pacific members.
        countBelowObligation:
          type: integer
          format: int32
          description: Count of Asia-Pacific members below the 90-day obligation.
      description: >-
        OilStocksRegionalSummaryAsiaPacific aggregates days-of-cover for
        Asia-Pacific IEA members.
    OilStocksRegionalSummaryNorthAmerica:
      type: object
      properties:
        netExporters:
          type: integer
          format: int32
          description: Count of net exporters in North America (CA, MX, US).
        avgDays:
          type: integer
          format: int32
          description: >-
            Average days of cover for non-exporter North American members (if
            any).
      description: >-
        OilStocksRegionalSummaryNorthAmerica aggregates data for North American
        IEA members.
  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).

````