Ingest custom XBRL filings

Allows Enterprise customers to upload and ingest custom SEC-style XBRL filings to build/query their private lattice instance.

post/api/xbrl/ingest

Request

  • Base URL: https://financesec.api.caleralabs.com
  • URL: https://financesec.api.caleralabs.com/api/xbrl/ingest
  • Auth: API key in header X-License-Key

Request body

tickerstring required

The ticker symbol of the company.

company_namestring required

The full name of the company.

filing_type'10-K' | '10-Q' | '8-K' required

The type of filing.

fiscal_yearstring

The fiscal year for the filing.

xbrl_datastring required

Base64-encoded XML or raw XBRL JSON payload.

Example request

{
  "ticker": "AAPL",
  "company_name": "Apple Inc.",
  "filing_type": "10-K",
  "fiscal_year": "2025",
  "xbrl_data": "<xbrli:xbrl>...</xbrli:xbrl>"
}

Response

Filing ingested successfully

statusstring
job_idstring
companies_addedinteger

Example response

{
  "status": "INGESTED",
  "job_id": "job_xbrl_183204",
  "companies_added": 1
}

Changes

No recorded changes to this operation across all 1 revision of this API.