Skip to Content

Filing Tables

Return filing table metadata or one hydrated structured table.

Tier: public | Cache: cold-allowed | Playground: authenticated only | Contract: 1.0.0

When To Use It

Use these tools when the answer depends on tables embedded in filing documents rather than normalized XBRL facts.

Request Examples

BASE_URL="${EDGAR_API_URL:-https://www.edgarparser.com}" curl -sS -G "$BASE_URL/api/tables" \ -H "Authorization: Bearer $EDGAR_API_KEY" \ --data-urlencode "ticker=AAPL" \ --data-urlencode "year=2025" \ --data-urlencode "quarter=4"
import os import requests base_url = os.getenv("EDGAR_API_URL", "https://www.edgarparser.com") headers = {"Authorization": f"Bearer {os.environ['EDGAR_API_KEY']}"} params = { "ticker": "AAPL", "year": 2025, "quarter": 4 } response = requests.get(f"{base_url}/api/tables", headers=headers, params=params, timeout=30) response.raise_for_status() data = response.json()

Key Response Fields

FieldTypeWhy It Matters
statusconst "success"Transport-level success indicator inside the JSON response.
semantic_status"ok" | "partial" | "empty" | "error" | nullWhether the response is semantically usable, partial, empty, or errored.
coverage_status"complete" | "partial" | "narrow" | "none" | nullCompleteness signal; do not present partial or narrow coverage as complete.
coverage_warningstring | nullHuman-readable explanation of missing or ambiguous coverage.
tablesarray<object | object>Matched or returned filing tables; inspect table id, title, and labels.
filingobject | nullTable result field; preserve row labels, column labels, and units when answering.
filing_identity_verifiedbooleanTable result field; preserve row labels, column labels, and units when answering.
filing_typestringTable result field; preserve row labels, column labels, and units when answering.

Response Fields To Inspect

  • table_id, title, section, and accession before using a table as evidence.
  • Row labels, column labels, units, and footnotes instead of inferring meaning from position alone.
  • Pagination or match-score fields when search returns multiple candidate tables.

Errors And Coverage

  • 401 or 403: the API key is missing, expired, or not allowed to use this tier.
  • 429: retry after the rate-limit window, and prefer broader batch or series tools over repeated single-period calls.
  • Cold work can take longer and may queue background fetch or parse work; use status fields or follow-up tools before finalizing.
  • Honor pagination and truncation metadata; request the next page instead of assuming the first response is complete.

Search Filing Tables, Compare Filing Tables, Filing Sections

Generated Reference

Contract

FieldValue
Toolget_filing_tables
MethodGET
Path/api/tables
Contract version1.0.0

Parameters

NameLocationRequiredTypeNotes
tickerqueryyesstring
yearqueryyesinteger
quarterqueryyesinteger
sectionquerynostring | null
table_idquerynostring | null
sourcequerynostring | null
accessionquerynostring | null

Response Schema (200)

{ "additionalProperties": true, "properties": { "coverage_status": { "anyOf": [ { "enum": [ "complete", "partial", "narrow", "none" ], "type": "string" }, { "type": "null" } ] }, "coverage_warning": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "filing": { "anyOf": [ { "additionalProperties": true, "properties": { "accession": { "anyOf": [ { "pattern": "^\\d{10}-\\d{2}-\\d{6}$", "type": "string" }, { "type": "null" } ] }, "cik": { "anyOf": [ { "pattern": "^\\d{1,10}$", "type": "string" }, { "type": "null" } ] }, "document_url": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ] }, "filing_date": { "anyOf": [ { "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string" }, { "type": "null" } ] }, "filing_url": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ] }, "fiscal_quarter": { "anyOf": [ { "maximum": 4.0, "minimum": 1.0, "type": "integer" }, { "type": "null" } ] }, "fiscal_year": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "form": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ] }, "form_type": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ] }, "period_end": { "anyOf": [ { "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string" }, { "type": "null" } ] }, "primary_document": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ] }, "primary_document_url": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ] }, "report_date": { "anyOf": [ { "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string" }, { "type": "null" } ] }, "url": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ] } }, "type": "object" }, { "type": "null" } ] }, "filing_identity_verified": { "default": false, "type": "boolean" }, "filing_type": { "type": "string" }, "semantic_status": { "anyOf": [ { "enum": [ "ok", "partial", "empty", "error" ], "type": "string" }, { "type": "null" } ] }, "status": { "const": "success", "type": "string" }, "table_count": { "minimum": 0.0, "type": "integer" }, "tables": { "items": { "anyOf": [ { "additionalProperties": true, "properties": { "data_rows": { "items": { "items": { "type": "string" }, "type": "array" }, "type": "array" }, "first_labels": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ] }, "header_rows": { "items": { "items": { "type": "string" }, "type": "array" }, "type": "array" }, "section": { "minLength": 1, "type": "string" }, "table_id": { "minLength": 1, "type": "string" }, "table_position": { "anyOf": [ { "minimum": 0.0, "type": "integer" }, { "type": "null" } ] }, "table_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "total_data_rows": { "anyOf": [ { "minimum": 0.0, "type": "integer" }, { "type": "null" } ] }, "unit_hint": { "anyOf": [ { "enum": [ "thousands", "millions", "billions" ], "type": "string" }, { "type": "null" } ] } }, "required": [ "table_id", "section", "header_rows", "data_rows" ], "type": "object" }, { "additionalProperties": true, "properties": { "section": { "minLength": 1, "type": "string" }, "table_id": { "minLength": 1, "type": "string" }, "table_position": { "anyOf": [ { "minimum": 0.0, "type": "integer" }, { "type": "null" } ] }, "table_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "total_data_rows": { "anyOf": [ { "minimum": 0.0, "type": "integer" }, { "type": "null" } ] }, "unit_hint": { "anyOf": [ { "enum": [ "thousands", "millions", "billions" ], "type": "string" }, { "type": "null" } ] } }, "required": [ "table_id", "section" ], "type": "object" } ] }, "type": "array" }, "ticker": { "minLength": 1, "type": "string" } }, "required": [ "status", "ticker", "filing_type", "table_count" ], "type": "object" }