BLS Public Data API — Surveys

naftiko: 1.0.0-alpha2
info:
  label: BLS Public Data API — Surveys
  description: 'BLS Public Data API — Surveys. 2 operations. Lead operation: U.S. Bureau of Labor Statistics Get All Surveys.
    Self-contained Naftiko capability covering one U S Bureau Of Labor Statistics business surface.'
  tags:
  - U S Bureau Of Labor Statistics
  - Surveys
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    U_S_BUREAU_OF_LABOR_STATISTICS_API_KEY: U_S_BUREAU_OF_LABOR_STATISTICS_API_KEY
capability:
  consumes:
  - type: http
    namespace: bls-public-data-surveys
    baseUri: https://api.bls.gov/publicAPI/v2
    description: BLS Public Data API — Surveys business capability. Self-contained, no shared references.
    resources:
    - name: surveys
      path: /surveys
      operations:
      - name: getallsurveys
        method: GET
        description: U.S. Bureau of Labor Statistics Get All Surveys
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: registrationkey
          in: query
          type: string
          description: BLS API registration key.
    - name: surveys-surveyId
      path: /surveys/{surveyId}
      operations:
      - name: getsurveymetadata
        method: GET
        description: U.S. Bureau of Labor Statistics Get Survey Metadata
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: surveyId
          in: path
          type: string
          description: Survey abbreviation (e.g., CPS for Current Population Survey, CES for Current Employment Statistics,
            AP for Average Price Data).
          required: true
        - name: registrationkey
          in: query
          type: string
          description: BLS API registration key.
    authentication:
      type: apikey
      key: registrationkey
      value: '{{env.U_S_BUREAU_OF_LABOR_STATISTICS_API_KEY}}'
      placement: query
  exposes:
  - type: rest
    namespace: bls-public-data-surveys-rest
    port: 8080
    description: REST adapter for BLS Public Data API — Surveys. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/surveys
      name: surveys
      description: REST surface for surveys.
      operations:
      - method: GET
        name: getallsurveys
        description: U.S. Bureau of Labor Statistics Get All Surveys
        call: bls-public-data-surveys.getallsurveys
        with:
          registrationkey: rest.registrationkey
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/surveys/{surveyid}
      name: surveys-surveyid
      description: REST surface for surveys-surveyId.
      operations:
      - method: GET
        name: getsurveymetadata
        description: U.S. Bureau of Labor Statistics Get Survey Metadata
        call: bls-public-data-surveys.getsurveymetadata
        with:
          surveyId: rest.surveyId
          registrationkey: rest.registrationkey
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: bls-public-data-surveys-mcp
    port: 9090
    transport: http
    description: MCP adapter for BLS Public Data API — Surveys. One tool per consumed operation, routed inline through this
      capability's consumes block.
    tools:
    - name: u-s-bureau-labor-statistics-get
      description: U.S. Bureau of Labor Statistics Get All Surveys
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: bls-public-data-surveys.getallsurveys
      with:
        registrationkey: tools.registrationkey
      outputParameters:
      - type: object
        mapping: $.
    - name: u-s-bureau-labor-statistics-get-2
      description: U.S. Bureau of Labor Statistics Get Survey Metadata
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: bls-public-data-surveys.getsurveymetadata
      with:
        surveyId: tools.surveyId
        registrationkey: tools.registrationkey
      outputParameters:
      - type: object
        mapping: $.