sec-edgar

opencollection: 1.0.0
info:
  name: SEC EDGAR Submissions & XBRL API
  version: 1.0.0
items:
- info:
    name: Submissions
    type: folder
  items:
  - info:
      name: Get company filing submission history
      type: http
    http:
      method: GET
      url: https://data.sec.gov/submissions/CIK:cik.json
      params:
      - name: cik
        value: 0000320193
        type: path
        description: '10-digit Central Index Key (CIK) with leading zeros. Example: 0000320193 for Apple Inc.'
    docs: Returns all filing metadata for a company identified by CIK (Central Index Key). Includes recent filings inline
      and older filings referenced in separate data files. Contains company metadata, SIC code, fiscal year end, and filing
      history.
- info:
    name: Company Facts
    type: folder
  items:
  - info:
      name: Get all XBRL facts for a company
      type: http
    http:
      method: GET
      url: https://data.sec.gov/api/xbrl/companyfacts/CIK:cik.json
      params:
      - name: cik
        value: 0000320193
        type: path
        description: 10-digit CIK with leading zeros
    docs: Returns all structured financial data reported in XBRL-tagged SEC filings for a company. Covers all US-GAAP and
      DEI taxonomy concepts across all filings. Data is organized by concept with historical values per period.
- info:
    name: XBRL
    type: folder
  items:
  - info:
      name: Get a single XBRL concept for a company
      type: http
    http:
      method: GET
      url: https://data.sec.gov/api/xbrl/companyconcept/CIK:cik/:taxonomy/:concept.json
      params:
      - name: cik
        value: 0000320193
        type: path
      - name: taxonomy
        value: us-gaap
        type: path
        description: XBRL taxonomy namespace
      - name: concept
        value: AccountsPayableCurrent
        type: path
        description: XBRL concept name (camelCase)
    docs: Returns all historical values reported for a specific XBRL concept by a company. For example, retrieve all reported
      values of AccountsPayableCurrent from the us-gaap taxonomy across all filings.
  - info:
      name: Get all company values for a concept in a period
      type: http
    http:
      method: GET
      url: https://data.sec.gov/api/xbrl/frames/:taxonomy/:concept/:unit/:period.json
      params:
      - name: taxonomy
        value: us-gaap
        type: path
      - name: concept
        value: AccountsPayableCurrent
        type: path
      - name: unit
        value: USD
        type: path
        description: Unit of measure (USD, shares, pure)
      - name: period
        value: CY2023Q4I
        type: path
        description: 'Period identifier. For annual instant: CY{year}Q{quarter}I. For annual duration: CY{year}.'
    docs: Returns values for a given XBRL concept across all companies for a specific period. Useful for cross-company financial
      data comparisons and benchmarking.
- info:
    name: Full-Text Search
    type: folder
  items:
  - info:
      name: Full-text search across EDGAR filings
      type: http
    http:
      method: GET
      url: https://data.sec.gov/LATEST/search-index
      params:
      - name: q
        value: '"material weakness" AND "internal controls"'
        type: query
        description: Full-text search query (Elasticsearch query string syntax)
      - name: dateRange
        value: custom
        type: query
        description: Date range filter
      - name: startdt
        value: '2024-01-01'
        type: query
      - name: enddt
        value: '2025-12-31'
        type: query
      - name: forms
        value: 10-K,10-Q
        type: query
        description: Comma-separated list of form types to filter
      - name: entity
        value: Apple Inc
        type: query
        description: Company name search filter
      - name: _source
        value: ''
        type: query
        description: Response fields to include
      - name: from
        value: ''
        type: query
        description: Pagination offset
      - name: hits.hits.total.value
        value: ''
        type: query
        description: Maximum results to return
    docs: Searches the full text of all EDGAR filings submitted since 2001. Supports keyword search, form type filtering,
      date ranges, and entity-based queries. Returns filing metadata and snippets.
bundled: true