SEC EDGAR Submissions & XBRL API — XBRL

naftiko: 1.0.0-alpha2
info:
  label: SEC EDGAR Submissions & XBRL API — XBRL
  description: 'SEC EDGAR Submissions & XBRL API — XBRL. 3 operations. Lead operation: Get a single XBRL concept for a company.
    Self-contained Naftiko capability covering one Sec Edgar business surface.'
  tags:
  - Sec Edgar
  - XBRL
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    SEC_EDGAR_API_KEY: SEC_EDGAR_API_KEY
capability:
  consumes:
  - type: http
    namespace: submissions-xbrl
    baseUri: https://data.sec.gov
    description: SEC EDGAR Submissions & XBRL API — XBRL business capability. Self-contained, no shared references.
    resources:
    - name: api-xbrl-companyconcept-CIK{cik}-taxonomy-concept}.json
      path: /api/xbrl/companyconcept/CIK{cik}/{taxonomy}/{concept}.json
      operations:
      - name: getcompanyconcept
        method: GET
        description: Get a single XBRL concept for a company
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: cik
          in: path
          type: string
          required: true
        - name: taxonomy
          in: path
          type: string
          description: XBRL taxonomy namespace
          required: true
        - name: concept
          in: path
          type: string
          description: XBRL concept name (camelCase)
          required: true
    - name: api-xbrl-companyfacts-CIK{cik}.json
      path: /api/xbrl/companyfacts/CIK{cik}.json
      operations:
      - name: getcompanyfacts
        method: GET
        description: Get all XBRL facts for a company
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: cik
          in: path
          type: string
          description: 10-digit CIK with leading zeros
          required: true
    - name: api-xbrl-frames-taxonomy-concept-unit-period}.json
      path: /api/xbrl/frames/{taxonomy}/{concept}/{unit}/{period}.json
      operations:
      - name: getxbrlframes
        method: GET
        description: Get all company values for a concept in a period
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: taxonomy
          in: path
          type: string
          required: true
        - name: concept
          in: path
          type: string
          required: true
        - name: unit
          in: path
          type: string
          description: Unit of measure (USD, shares, pure)
          required: true
        - name: period
          in: path
          type: string
          description: 'Period identifier. For annual instant: CY{year}Q{quarter}I. For annual duration: CY{year}.'
          required: true
  exposes:
  - type: rest
    namespace: submissions-xbrl-rest
    port: 8080
    description: REST adapter for SEC EDGAR Submissions & XBRL API — XBRL. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/api/xbrl/companyconcept/cik-cik/{taxonomy}/concept-json
      name: api-xbrl-companyconcept-cik-cik-taxonomy-concept-json
      description: REST surface for api-xbrl-companyconcept-CIK{cik}-taxonomy-concept}.json.
      operations:
      - method: GET
        name: getcompanyconcept
        description: Get a single XBRL concept for a company
        call: submissions-xbrl.getcompanyconcept
        with:
          cik: rest.cik
          taxonomy: rest.taxonomy
          concept: rest.concept
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/xbrl/companyfacts/cik-cik-json
      name: api-xbrl-companyfacts-cik-cik-json
      description: REST surface for api-xbrl-companyfacts-CIK{cik}.json.
      operations:
      - method: GET
        name: getcompanyfacts
        description: Get all XBRL facts for a company
        call: submissions-xbrl.getcompanyfacts
        with:
          cik: rest.cik
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/xbrl/frames/{taxonomy}/{concept}/{unit}/period-json
      name: api-xbrl-frames-taxonomy-concept-unit-period-json
      description: REST surface for api-xbrl-frames-taxonomy-concept-unit-period}.json.
      operations:
      - method: GET
        name: getxbrlframes
        description: Get all company values for a concept in a period
        call: submissions-xbrl.getxbrlframes
        with:
          taxonomy: rest.taxonomy
          concept: rest.concept
          unit: rest.unit
          period: rest.period
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: submissions-xbrl-mcp
    port: 9090
    transport: http
    description: MCP adapter for SEC EDGAR Submissions & XBRL API — XBRL. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: get-single-xbrl-concept-company
      description: Get a single XBRL concept for a company
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: submissions-xbrl.getcompanyconcept
      with:
        cik: tools.cik
        taxonomy: tools.taxonomy
        concept: tools.concept
      outputParameters:
      - type: object
        mapping: $.
    - name: get-all-xbrl-facts-company
      description: Get all XBRL facts for a company
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: submissions-xbrl.getcompanyfacts
      with:
        cik: tools.cik
      outputParameters:
      - type: object
        mapping: $.
    - name: get-all-company-values-concept
      description: Get all company values for a concept in a period
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: submissions-xbrl.getxbrlframes
      with:
        taxonomy: tools.taxonomy
        concept: tools.concept
        unit: tools.unit
        period: tools.period
      outputParameters:
      - type: object
        mapping: $.