Skip to main content

Convert XBRL data to JSON format

GET 
/v1/xbrl-converter

Converts XBRL data to JSON format using one of three possible input methods.

Input Methods​

  1. HTML URL (htm-url)

  2. XBRL URL (xbrl-url)

  3. Accession Number (accession-no)

    • The SEC filing accession number
    • Example: 0001564590-21-004599
note

Only one of the three parameters should be provided. If multiple parameters are provided, the priority order is:

  1. htm-url
  2. xbrl-url
  3. accession-no

Supported Filing Types​

  • Annual Reports (10-K)
  • Quarterly Reports (10-Q)
  • Current Reports (8-K)
  • Registration Statements (S-1, S-3)
  • Foreign Private Issuer Reports (20-F, 40-F)

Response Format​

The API returns a JSON object containing:

  • Financial statements (Income Statement, Balance Sheet, Cash Flow Statement)
  • Accounting policies and footnotes
  • Company information
  • Filing metadata

Example Response​

{
  "StatementsOfIncome": {
    "RevenueFromContractWithCustomerExcludingAssessedTax": [
      {
        "decimals": "-6",
        "unitRef": "U_USD",
        "period": {
          "startDate": "2023-07-01",
          "endDate": "2024-06-30"
        },
        "value": "245122000000"
      }
    ]
  }
}

Request​

Query Parameters

    htm-url string

    URL of the filing ending with .htm or .html

    xbrl-url string

    URL of the XBRL file ending with .xml

    accession-no string

    SEC filing accession number

Responses​

Successful conversion

Schema

    property name* any
Loading...