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

# GetDemographicsCapability

> GetDemographicsCapability returns age, education and industrial-workforce observations for one country. PRO-gated. Requires entitlement tier >= 1.



## OpenAPI

````yaml /api/ResilienceService.openapi.yaml get /api/resilience/v1/get-demographics-capability
openapi: 3.1.0
info:
  title: ResilienceService API
  version: 1.0.0
servers:
  - url: https://api.worldmonitor.app
security:
  - WorldMonitorKey: []
  - ApiKeyHeader: []
paths:
  /api/resilience/v1/get-demographics-capability:
    get:
      tags:
        - ResilienceService
      summary: GetDemographicsCapability
      description: >-
        GetDemographicsCapability returns age, education and
        industrial-workforce observations for one country. PRO-gated. Requires
        entitlement tier >= 1.
      operationId: GetDemographicsCapability
      parameters:
        - name: countryCode
          in: query
          description: Required ISO 3166-1 alpha-2 country code.
          required: true
          example: US
          schema:
            type: string
        - 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:
                ageStructure:
                  available: true
                  medianAgeYears:
                    available: true
                    source: example
                    unit: example
                    value: 1.5
                    year: 1
                  oldAgeDependencyRatioPercent:
                    available: true
                    source: example
                    unit: example
                    value: 1.5
                    year: 1
                  totalDependencyRatioPercent:
                    available: true
                    source: example
                    unit: example
                    value: 1.5
                    year: 1
                  workingAgePopulationPeople:
                    available: true
                    source: example
                    unit: example
                    value: 1.5
                    year: 1
                available: true
                countryCode: US
                education:
                  available: true
                  researchersPerMillion:
                    available: true
                    source: example
                    unit: example
                    value: 1.5
                    year: 1
                  stemGraduatesSharePercent:
                    available: true
                    source: example
                    unit: example
                    value: 1.5
                    year: 1
                  tertiaryEnrollmentGrossPercent:
                    available: true
                    source: example
                    unit: example
                    value: 1.5
                    year: 1
                fetchedAt: '2026-01-15T12:00:00Z'
              schema:
                $ref: '#/components/schemas/GetDemographicsCapabilityResponse'
        '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: PRO entitlement access denied.
          headers:
            X-Billing-Verification:
              description: >-
                Present when the 403 is a billing-provider-confirmed
                subscription lapse (value subscription_lapsed, matching the body
                `code`).
              schema:
                type: string
          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'
        '503':
          description: >-
            Service unavailable. Billing-verification responses include code and
            X-Billing-Verification; other gateway infrastructure failures use
            the generic GatewayError shape.
          headers:
            Retry-After:
              description: Seconds to wait before retrying (1-60).
              schema:
                type: string
            X-Billing-Verification:
              description: >-
                Billing-verification state that produced this response (matches
                the body `code`).
              schema:
                type: string
            X-Validation-Mode:
              description: >-
                Present with value degraded when user API-key validation is
                temporarily unavailable.
              schema:
                type: string
            X-RateLimit-Mode:
              description: >-
                Present with value degraded when a fail-closed rate-limit
                dependency is unavailable.
              schema:
                type: string
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/BillingVerificationError'
                  - $ref: '#/components/schemas/GatewayError'
        default:
          description: Gateway or handler error response.
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/Error'
                  - $ref: '#/components/schemas/GatewayError'
      security:
        - WorldMonitorKey: []
        - ApiKeyHeader: []
        - BearerAuth: []
components:
  schemas:
    GetDemographicsCapabilityResponse:
      type: object
      properties:
        countryCode:
          type: string
        available:
          type: boolean
          description: True when at least one validated observation exists for the country.
        fetchedAt:
          type: string
          description: ISO-8601 time the canonical snapshot was generated.
        stages:
          type: array
          items:
            $ref: '#/components/schemas/DemographicsCapabilityStage'
        ageStructure:
          $ref: '#/components/schemas/DemographicsAgeStructure'
        education:
          $ref: '#/components/schemas/DemographicsEducation'
        industrialWorkforce:
          $ref: '#/components/schemas/DemographicsIndustrialWorkforce'
    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.
        code:
          type: string
          enum:
            - subscription_lapsed
          description: >-
            Machine-readable denial code, present when the 403 is a
            billing-provider-confirmed subscription lapse (mirrored in the
            X-Billing-Verification response header).
        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
    BillingVerificationError:
      type: object
      description: >-
        Returned with HTTP 503 when paid access cannot be confirmed right now:
        the billing provider is re-verifying a recently expired subscription, or
        the entitlement backend is unreachable. Retryable — honor Retry-After.
      properties:
        error:
          type: string
          description: Human-readable billing-verification failure reason.
        code:
          type: string
          enum:
            - renewal_verification_pending
            - renewal_verification_failed
            - entitlement_verification_unavailable
          description: >-
            Machine-readable billing-verification state, mirrored in the
            X-Billing-Verification response header.
        requiredTier:
          type: integer
          format: int32
          description: >-
            Minimum entitlement tier required for this endpoint, when the denial
            came from a tier gate.
      required:
        - error
        - code
    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
    DemographicsCapabilityStage:
      type: object
      properties:
        name:
          type: string
          description: 'Stable stage name: wpp, education, or ilostat.'
        status:
          type: string
          description: Seeder state, normally fresh, retained, or unavailable.
        fetchedAt:
          type: string
          description: ISO-8601 time of the data retained for this stage.
        recordCount:
          type: integer
          minimum: 0
          format: int32
          description: Number of country records retained for the stage.
        newestObservationYear:
          type: integer
          minimum: 0
          format: int32
          description: Most recent source observation year retained for the stage.
      description: >-
        Independent fetch-stage state. One failed stage must not hide healthy
        groups.
    DemographicsAgeStructure:
      type: object
      properties:
        available:
          type: boolean
        medianAgeYears:
          $ref: '#/components/schemas/CapabilityObservation'
        oldAgeDependencyRatioPercent:
          $ref: '#/components/schemas/CapabilityObservation'
        totalDependencyRatioPercent:
          $ref: '#/components/schemas/CapabilityObservation'
        workingAgePopulationPeople:
          $ref: '#/components/schemas/CapabilityObservation'
        workingAgePopulationProjected10yPeople:
          $ref: '#/components/schemas/CapabilityObservation'
    DemographicsEducation:
      type: object
      properties:
        available:
          type: boolean
        tertiaryEnrollmentGrossPercent:
          $ref: '#/components/schemas/CapabilityObservation'
        stemGraduatesSharePercent:
          $ref: '#/components/schemas/CapabilityObservation'
        researchersPerMillion:
          $ref: '#/components/schemas/CapabilityObservation'
    DemographicsIndustrialWorkforce:
      type: object
      properties:
        available:
          type: boolean
        craftTradesEmploymentPeople:
          $ref: '#/components/schemas/CapabilityObservation'
        plantMachineOperatorsEmploymentPeople:
          $ref: '#/components/schemas/CapabilityObservation'
        trainedIndustrialWorkforcePeople:
          $ref: '#/components/schemas/CapabilityObservation'
        manufacturingEmploymentSharePercent:
          $ref: '#/components/schemas/CapabilityObservation'
    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.
    CapabilityObservation:
      type: object
      properties:
        available:
          type: boolean
          description: >-
            True only when value, year, source and unit passed the server
            contract.
        value:
          type: number
          format: double
          description: >-
            Numeric observation. Read available first: zero is also the proto3
            placeholder.
        year:
          type: integer
          minimum: 0
          format: int32
          description: Observation year from the source, not the seed run year.
        source:
          type: string
          description: Provider or dataset attribution stored with the observation.
        unit:
          type: string
          description: Human-readable unit such as "percent", "people", or "years".
      description: >-
        CapabilityObservation keeps a measured zero distinct from a missing
        value.
  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).
    BearerAuth:
      type: http
      scheme: bearer
      description: >-
        Bearer token: a Clerk-issued JWT for browser session flows, passed as
        Authorization: Bearer <token>.

````