Skip to content

filings

The filings.* commands read public SEC EDGAR filings through Finance CLI’s SEC and edgartools integration. Use this namespace when a workflow needs filing discovery, canonical 10-K sections, structured XBRL statement rows, or filing summary reports.

For SEC access, set FINANCE_SEC_USER_AGENT in environments where SEC requires explicit caller identification.

Fetch recent SEC filings for a public company.

finance filings.recent resolves a ticker to SEC company metadata and returns recent filings filtered by form type. Each filing includes form, accession number, filing date, report date, acceptance timestamp, filing items, and the SEC filing URL.

Use this command first when the user provides a ticker but not a specific filing URL or accession number.

Terminal window
finance filings.recent SYMBOL [forms=8-K,10-Q limit=20 classify=false]
ArgumentRequiredDefaultAccepted valuesDescription
SYMBOLYesNonePublic ticker symbolCompany ticker to resolve through SEC metadata.
formsNoProvider defaultComma-separated SEC form types, such as 10-K,10-Q,8-KFilters returned filings by form.
limitNo20IntegerMaximum filings returned.
classifyNofalsetrue, falseAdds event classification when supported.
Terminal window
finance filings.recent AAPL forms=10-K,10-Q limit=2 --output json
finance filings.recent NVDA forms=8-K limit=10 classify=true --output json

This output was generated with finance filings.recent AAPL forms=10-K,10-Q limit=2 --output json.

{
"ok": true,
"data": {
"symbol": "AAPL",
"company_name": "Apple Inc.",
"cik": "0000320193",
"filings": [
{
"form": "10-Q",
"accession_no": "0000320193-26-000013",
"filed_at": "2026-05-01",
"report_date": "2026-03-28",
"acceptance_datetime": "2026-05-01T10:01:00.000Z",
"items": [],
"url": "https://www.sec.gov/Archives/edgar/data/320193/000032019326000013/aapl-20260328.htm"
},
{
"form": "10-Q",
"accession_no": "0000320193-26-000006",
"filed_at": "2026-01-30",
"report_date": "2025-12-27",
"acceptance_datetime": "2026-01-30T11:01:32.000Z",
"items": [],
"url": "https://www.sec.gov/Archives/edgar/data/320193/000032019326000006/aapl-20251227.htm"
}
],
"count": 2,
"source": "sec_edgar"
},
"error": null,
"warnings": []
}
FieldTypeDescription
okbooleanWhether the command completed successfully.
dataobject or nullCommand-specific result payload. It is null when ok is false.
errorstring or nullHuman-readable error message when ok is false; otherwise null.
warningsarrayNon-fatal warnings returned by the command.
data.symbolstringTicker passed to the command.
data.company_namestringCompany name from SEC metadata.
data.cikstringSEC CIK, zero-padded when returned by this command.
data.filingsarrayFiling rows after form and limit filtering.
data.filings[].formstringSEC form type.
data.filings[].accession_nostringFiling accession number.
data.filings[].filed_atstringFiling date.
data.filings[].report_datestringPeriod of report.
data.filings[].acceptance_datetimestringSEC acceptance timestamp.
data.filings[].itemsarrayForm items when available, mainly for event filings.
data.filings[].urlstringSEC filing document URL.
data.countintegerNumber of filings returned.
data.sourcestringProvider identifier.

List canonical and provider-discovered sections for a filing.

finance filings.sections resolves a filing by ticker, accession number, or URL and returns supported Finance CLI section keys plus the sections discovered by edgartools. Supported sections include canonical keys such as business, risk_factors, mda, financial_statements, and segments.

Use this command before finance filings.read when you need to confirm which sections are available in the target filing.

Terminal window
finance filings.sections [SYMBOL] [accession=ACCESSION|url=URL] [form=10-K]
ArgumentRequiredDefaultAccepted valuesDescription
SYMBOLRequired unless accession or url is setNonePublic ticker symbolResolves the latest filing matching form.
symbolRequired unless positional SYMBOL, accession, or url is setNonePublic ticker symbolKeyword ticker form.
accessionRequired unless SYMBOL, symbol, or url is setNoneSEC accession numberReads a specific filing.
accession_noRequired unless another filing source is setNoneSEC accession numberAlias for accession.
urlRequired unless a symbol or accession is setNoneSEC filing URLReads a specific SEC filing URL.
formNo10-KSEC form typeForm used when resolving the latest filing by ticker.
Terminal window
finance filings.sections AAPL form=10-K --output json
finance filings.sections accession=0000320193-25-000079 --output json

This output was generated with finance filings.sections AAPL form=10-K --output json.

{
"ok": true,
"data": {
"filing": {
"company": "Apple Inc.",
"cik": "320193",
"form": "10-K",
"filing_date": "2025-10-31",
"period_of_report": "2025-09-27",
"accession_no": "0000320193-25-000079",
"filing_url": "https://www.sec.gov/Archives/edgar/data/320193/000032019325000079/aapl-20250927.htm",
"homepage_url": "https://www.sec.gov/Archives/edgar/data/320193/0000320193-25-000079-index.html",
"text_url": "https://www.sec.gov/Archives/edgar/data/320193/000032019325000079/0000320193-25-000079.txt"
},
"supported_sections": [
{
"key": "business",
"title": "Business",
"edgar_section": "part_i_item_1",
"available": true,
"char_count": 16051
},
{
"key": "risk_factors",
"title": "Risk Factors",
"edgar_section": "part_i_item_1a",
"available": true,
"char_count": 68160
},
{
"key": "mda",
"title": "Management's Discussion and Analysis",
"edgar_section": "part_ii_item_7",
"available": true,
"char_count": 18015
},
{
"key": "financial_statements",
"title": "Financial Statements and Supplementary Data",
"edgar_section": "part_ii_item_8",
"available": true,
"char_count": 60863
},
{
"key": "segments",
"title": "Segments",
"edgar_section": null,
"available": true,
"char_count": 720
}
],
"edgartools_sections": [
"part_i_item_1",
"part_ii_item_7a",
"part_ii_item_8",
"part_iv_item_8",
"part_ii_item_9",
"part_ii_item_9a",
"part_ii_item_9b",
"part_ii_item_9c",
"part_iii_item_10",
"part_iii_item_11",
"part_iii_item_12",
"part_iii_item_13",
"part_iii_item_14",
"part_iv_item_15",
"part_iv_item_16",
"part_iv_power_of_attorney_(included_on_the_signatures_page_of_this_annual_report_on_form_10-k).",
"part_i_item_1a",
"part_i_item_1b",
"part_i_item_1c",
"part_i_item_2",
"part_i_item_3",
"part_i_item_4",
"part_ii_item_5",
"part_ii_item_6",
"part_ii_item_7"
],
"source": "edgartools"
},
"error": null,
"warnings": []
}
FieldTypeDescription
okbooleanWhether the command completed successfully.
dataobject or nullCommand-specific result payload. It is null when ok is false.
errorstring or nullHuman-readable error message when ok is false; otherwise null.
warningsarrayNon-fatal warnings returned by the command.
data.filingobjectFiling metadata used for the section lookup.
data.filing.companystringCompany name.
data.filing.cikstringSEC CIK.
data.filing.formstringFiling form.
data.filing.filing_datestringFiling date.
data.filing.period_of_reportstringPeriod of report.
data.filing.accession_nostringSEC accession number.
data.filing.filing_urlstringPrimary filing document URL.
data.supported_sectionsarrayFinance CLI canonical section keys and availability.
data.supported_sections[].keystringSection key accepted by filings.read section=....
data.supported_sections[].availablebooleanWhether edgartools found text for the section.
data.supported_sections[].char_countintegerExtracted section character count.
data.edgartools_sectionsarrayRaw edgartools section identifiers discovered in the filing.
data.sourcestringProvider identifier.

Read a canonical filing section as bounded text.

finance filings.read resolves a filing and extracts a section such as business, risk_factors, mda, or segments. It returns filing metadata, section metadata, bounded text, character counts, and truncation state.

Use this command when you need narrative 10-K text for quote extraction, document scanning, or downstream analysis. Use filings.statement or filings.report instead for structured financial statement rows.

Terminal window
finance filings.read [SYMBOL] [accession=ACCESSION|url=URL] [form=10-K section=business|risk_factors|mda|segments max_chars=8000]
ArgumentRequiredDefaultAccepted valuesDescription
SYMBOL / symbolRequired unless accession or url is setNonePublic ticker symbolResolves the latest filing matching form.
accession / accession_noRequired unless symbol or URL is setNoneSEC accession numberReads a specific filing.
urlRequired unless symbol or accession is setNoneSEC filing URLReads a specific filing URL.
formNo10-KSEC form typeForm used when resolving by ticker.
sectionNobusinessbusiness, risk_factors, mda, financial_statements, segmentsCanonical section key.
max_charsNo8000IntegerMaximum section text characters returned.
Terminal window
finance filings.read AAPL form=10-K section=business max_chars=300 --output json
finance filings.read accession=0000320193-25-000079 section=risk_factors max_chars=3000 --output json

This output was generated with finance filings.read AAPL form=10-K section=business max_chars=300 --output json.

{
"ok": true,
"data": {
"filing": {
"company": "Apple Inc.",
"cik": "320193",
"form": "10-K",
"filing_date": "2025-10-31",
"period_of_report": "2025-09-27",
"accession_no": "0000320193-25-000079",
"filing_url": "https://www.sec.gov/Archives/edgar/data/320193/000032019325000079/aapl-20250927.htm",
"homepage_url": "https://www.sec.gov/Archives/edgar/data/320193/0000320193-25-000079-index.html",
"text_url": "https://www.sec.gov/Archives/edgar/data/320193/000032019325000079/0000320193-25-000079.txt"
},
"section": {
"key": "business",
"title": "Business",
"edgar_section": "part_i_item_1"
},
"text": "Item 1. Business\n\nCompany Background\n\nThe Company designs, manufactures and markets smartphones, personal computers, tablets, wearables and accessories, and sells a variety of related services. The Company’s fiscal year is the 52- or 53-week period that ends on the last Saturday of September.\n\nProdu",
"char_count": 16051,
"returned_chars": 300,
"truncated": true,
"source": "edgartools"
},
"error": null,
"warnings": []
}
FieldTypeDescription
okbooleanWhether the command completed successfully.
dataobject or nullCommand-specific result payload. It is null when ok is false.
errorstring or nullHuman-readable error message when ok is false; otherwise null.
warningsarrayNon-fatal warnings returned by the command.
data.filingobjectFiling metadata.
data.section.keystringSection key that was read.
data.section.titlestringHuman-readable section title.
data.section.edgar_sectionstring or nullUnderlying edgartools/SEC section identifier.
data.textstringSection text after max_chars truncation.
data.char_countintegerFull section character count.
data.returned_charsintegerCharacters returned in data.text.
data.truncatedbooleanWhether section text was truncated.
data.sourcestringProvider identifier.

Read structured XBRL statement rows from a filing.

finance filings.statement returns rows from an XBRL statement family: income statement, balance sheet, or cash flow statement. Rows include concept names, labels, hierarchy metadata, balance type, parent links, and period-indexed values.

Use this command when the question asks for structured financial statement line items. Use query to narrow large statements before sending results to another tool or model.

Terminal window
finance filings.statement [SYMBOL] [accession=ACCESSION|url=URL] [form=10-K statement=income|balance|cashflow query=TEXT include_abstract=false max_rows=0]
ArgumentRequiredDefaultAccepted valuesDescription
SYMBOL / symbolRequired unless accession or url is setNonePublic ticker symbolResolves the latest filing matching form.
accession / accession_noRequired unless symbol or URL is setNoneSEC accession numberReads a specific filing.
urlRequired unless symbol or accession is setNoneSEC filing URLReads a specific filing URL.
formNo10-KSEC form typeForm used when resolving by ticker.
statementNoincomeincome, balance, cashflowStatement family.
queryNoNoneTextFilters rows by concept or label.
include_abstractNofalsetrue, falseIncludes abstract/header rows when true.
max_rowsNo0Integer; 0 means unlimitedMaximum rows returned after filtering.
Terminal window
finance filings.statement COST statement=balance query="Common Stock" max_rows=3 --output json
finance filings.statement AAPL statement=income max_rows=20 --output json

This output was generated with finance filings.statement COST statement=balance query="Common Stock" max_rows=3 --output json.

{
"ok": true,
"data": {
"filing": {
"company": "COSTCO WHOLESALE CORP /NEW",
"cik": "909832",
"form": "10-K",
"filing_date": "2025-10-08",
"period_of_report": "2025-08-31",
"accession_no": "0000909832-25-000101",
"filing_url": "https://www.sec.gov/Archives/edgar/data/909832/000090983225000101/cost-20250831.htm",
"homepage_url": "https://www.sec.gov/Archives/edgar/data/909832/0000909832-25-000101-index.html",
"text_url": "https://www.sec.gov/Archives/edgar/data/909832/000090983225000101/0000909832-25-000101.txt"
},
"statement": "balance",
"periods": [
"2025-08-31",
"2024-09-01",
"2023-09-03"
],
"rows": [
{
"concept": "us-gaap_CommonStockValue",
"label": "Common Stock $.005 par value; 900,000,000 shares authorized; 443,237,000 and 442,126,000 shares issued and outstanding",
"level": 4,
"abstract": false,
"balance": "credit",
"parent": "us-gaap_StockholdersEquityIncludingPortionAttributableToNoncontrollingInterestAbstract",
"calculation_parent": "us-gaap_StockholdersEquity",
"values": {
"2025-08-31": {
"raw": 2000000,
"reported": 2,
"unit": "usd",
"decimals": -6,
"period_type": "instant",
"preferred_sign": 1
},
"2024-09-01": {
"raw": 2000000,
"reported": 2,
"unit": "usd",
"decimals": -6,
"period_type": "instant",
"preferred_sign": 1
}
}
}
],
"count": 1,
"truncated": false,
"source": "edgartools"
},
"error": null,
"warnings": []
}
FieldTypeDescription
okbooleanWhether the command completed successfully.
dataobject or nullCommand-specific result payload. It is null when ok is false.
errorstring or nullHuman-readable error message when ok is false; otherwise null.
warningsarrayNon-fatal warnings returned by the command.
data.filingobjectFiling metadata.
data.statementstringStatement family used for the query.
data.periodsarrayPeriod labels available in the statement.
data.rowsarrayStatement rows after filtering.
data.rows[].conceptstringXBRL concept name.
data.rows[].labelstringReported row label.
data.rows[].levelintegerPresentation hierarchy level.
data.rows[].abstractbooleanWhether the row is an abstract/header row.
data.rows[].balancestring or nullXBRL balance type when available.
data.rows[].parentstring or nullPresentation parent concept.
data.rows[].calculation_parentstring or nullCalculation parent concept.
data.rows[].valuesobjectValues keyed by period.
data.rows[].values.*.rawnumber or nullRaw XBRL value.
data.rows[].values.*.reportednumber or nullValue scaled by XBRL decimals.
data.rows[].values.*.unitstring or nullUnit such as usd.
data.rows[].values.*.decimalsinteger or nullXBRL decimals metadata.
data.countintegerRows returned.
data.truncatedbooleanWhether rows were truncated by max_rows.
data.sourcestringProvider identifier.

List filing summary reports available through edgartools.

finance filings.reports returns the named reports attached to a filing, optionally filtered by query. Reports include note disclosures, detail tables, statement schedules, and other report fragments exposed by edgartools.

Use this command before finance filings.report when you need to discover the exact report short name to read.

Terminal window
finance filings.reports [SYMBOL] [accession=ACCESSION|url=URL] [form=10-K query=TEXT]
ArgumentRequiredDefaultAccepted valuesDescription
SYMBOL / symbolRequired unless accession or url is setNonePublic ticker symbolResolves the latest filing matching form.
accession / accession_noRequired unless symbol or URL is setNoneSEC accession numberReads a specific filing.
urlRequired unless symbol or accession is setNoneSEC filing URLReads a specific filing URL.
formNo10-KSEC form typeForm used when resolving by ticker.
queryNoNoneTextFilters report short names, long names, and categories.
Terminal window
finance filings.reports COST form=10-K query=lease --output json
finance filings.reports COST form=10-K --output json

This output was generated with finance filings.reports COST form=10-K query=lease --output json.

{
"ok": true,
"data": {
"filing": {
"company": "COSTCO WHOLESALE CORP /NEW",
"cik": "909832",
"form": "10-K",
"filing_date": "2025-10-08",
"period_of_report": "2025-08-31",
"accession_no": "0000909832-25-000101",
"filing_url": "https://www.sec.gov/Archives/edgar/data/909832/000090983225000101/cost-20250831.htm",
"homepage_url": "https://www.sec.gov/Archives/edgar/data/909832/0000909832-25-000101-index.html",
"text_url": "https://www.sec.gov/Archives/edgar/data/909832/000090983225000101/0000909832-25-000101.txt"
},
"reports": [
{
"short_name": "Leases",
"long_name": "9952161 - Disclosure - Leases",
"category": "Notes",
"file_name": "R13.htm"
},
{
"short_name": "Leases (Tables)",
"long_name": "9955516 - Disclosure - Leases (Tables)",
"category": "Tables",
"file_name": "R28.htm"
},
{
"short_name": "Accounting Policies - Leases (Details)",
"long_name": "9955528 - Disclosure - Accounting Policies - Leases (Details)",
"category": "Details",
"file_name": "R38.htm"
},
{
"short_name": "Leases, Supplemental Balance Sheet Information (Details)",
"long_name": "9955543 - Disclosure - Leases, Supplemental Balance Sheet Information (Details)",
"category": "Details",
"file_name": "R52.htm"
},
{
"short_name": "Leases, Components of Lease Expense (Details)",
"long_name": "9955544 - Disclosure - Leases, Components of Lease Expense (Details)",
"category": "Details",
"file_name": "R53.htm"
},
{
"short_name": "Leases, Supplemental Cash Flow Information (Details)",
"long_name": "9955545 - Disclosure - Leases, Supplemental Cash Flow Information (Details)",
"category": "Details",
"file_name": "R54.htm"
},
{
"short_name": "Leases, Future Minimum Payments (Details)",
"long_name": "9955546 - Disclosure - Leases, Future Minimum Payments (Details)",
"category": "Details",
"file_name": "R55.htm"
}
],
"count": 7,
"query": "lease",
"source": "edgartools"
},
"error": null,
"warnings": []
}
FieldTypeDescription
okbooleanWhether the command completed successfully.
dataobject or nullCommand-specific result payload. It is null when ok is false.
errorstring or nullHuman-readable error message when ok is false; otherwise null.
warningsarrayNon-fatal warnings returned by the command.
data.filingobjectFiling metadata.
data.reportsarrayMatching report descriptors.
data.reports[].short_namestringReport name accepted by filings.report name=....
data.reports[].long_namestringFull provider report name.
data.reports[].categorystringReport category, such as Notes, Tables, or Details.
data.reports[].file_namestringFiling report file name.
data.countintegerNumber of matching reports.
data.querystring or nullQuery filter used.
data.sourcestringProvider identifier.

Read a named filing summary report and optional filtered rows.

finance filings.report reads one report discovered by filings.reports. It returns report metadata, rendered text, structured rows when parseable, character counts, row counts, and truncation metadata.

Use this command when you need a specific filing note table or disclosure report, such as leases, debt, revenue recognition, or balance sheet details.

Terminal window
finance filings.report [SYMBOL] [accession=ACCESSION|url=URL] name='Report Short Name' [form=10-K query=TEXT max_rows=25 max_chars=8000]
ArgumentRequiredDefaultAccepted valuesDescription
SYMBOL / symbolRequired unless accession or url is setNonePublic ticker symbolResolves the latest filing matching form.
accession / accession_noRequired unless symbol or URL is setNoneSEC accession numberReads a specific filing.
urlRequired unless symbol or accession is setNoneSEC filing URLReads a specific filing URL.
nameYesNoneReport short nameReport to read. Use filings.reports to discover this value.
reportYes, unless name is setNoneReport short nameAlias for name.
formNo10-KSEC form typeForm used when resolving by ticker.
queryNoNoneTextFilters structured report rows.
max_rowsNo25Integer; 0 means unlimitedMaximum structured rows returned.
max_charsNo8000IntegerMaximum report text characters returned.
Terminal window
finance filings.report COST name='Leases, Supplemental Balance Sheet Information (Details)' query='operating lease liabilities' max_rows=3 --output json
finance filings.report COST name='Consolidated Balance Sheets (Parenthetical)' --output json

This output was generated with finance filings.report COST name='Leases, Supplemental Balance Sheet Information (Details)' query='operating lease liabilities' max_rows=3 --output json.

{
"ok": true,
"data": {
"filing": {
"company": "COSTCO WHOLESALE CORP /NEW",
"cik": "909832",
"form": "10-K",
"filing_date": "2025-10-08",
"period_of_report": "2025-08-31",
"accession_no": "0000909832-25-000101",
"filing_url": "https://www.sec.gov/Archives/edgar/data/909832/000090983225000101/cost-20250831.htm",
"homepage_url": "https://www.sec.gov/Archives/edgar/data/909832/0000909832-25-000101-index.html",
"text_url": "https://www.sec.gov/Archives/edgar/data/909832/000090983225000101/0000909832-25-000101.txt"
},
"report": {
"short_name": "Leases, Supplemental Balance Sheet Information (Details)",
"long_name": "9955543 - Disclosure - Leases, Supplemental Balance Sheet Information (Details)",
"category": "Details",
"file_name": "R52.htm"
},
"text": "Leases, Supplemental Balance \n Sheet Information (Details) - \n USD ($) \n $ in Millions Aug. 31, 2025 Sep. 01, 2024 \n ────────────────────────────────────────────────────────────────────────────── \n Operating Lease and Finance \n Lease Right-of-Use-Assets \n [Abstract] \n Operating lease right-of-use $ 2,725 $ 2,617 \n assets \n Finance lease assets $ 1,488 $ 1,433 \n Finance lease assets Other long-term Other long-term \n assets assets \n OperatingLeaseandFinanceLeaseri $ 4,213 $ 4,050 \n ghtofuseassets \n Current Operating and Finance \n Lease Liabilities [Abstract] \n Current operating lease 208 179 \n liabilities \n Current finance lease $ 78 $ 147 \n liabilities \n Operating lease liabilities Other current Other current \n liabilities liabilities \n Finance lease liabilities Other current Other current \n liabilities liabilities \n Long-Term Operating and Finance \n Lease Liabilities [Abstract] \n Long-term operating lease $ 2,460 $ 2,375 \n liabilities \n Long-term finance lease $ 1,401 $ 1,351 \n liabilities \n Long-term finance lease Other long-term Other long-term \n liabilities liabilities liabilities \n OperatingLeaseandFinanceLeaseLi $ 4,147 $ 4,052 \n abilities \n Other Supplemental Balance \n Sheet Information [Abstract] \n Operating Lease, Weighted 20 years 19 years \n Average Remaining Lease Term \n Finance Lease, Weighted Average 25 years 23 years \n Remaining Lease Term \n Operating Lease, Weighted 3% 3% \n Average Discount Rate, Percent \n Finance Lease, Weighted Average 5% 5% \n Discount Rate, Percent",
"rows": [
{
"table": "Leases, Supplemental Balance Sheet Information (Details) - USD ($) $ in Millions",
"context": [
"Current Operating and Finance Lease Liabilities [Abstract]"
],
"label": "Current operating lease liabilities",
"concept": "us-gaap_OperatingLeaseLiabilityCurrent",
"abstract": false,
"values": [
{
"column": "Aug. 31, 2025",
"text": "208",
"number": 208
},
{
"column": "Sep. 01, 2024",
"text": "179",
"number": 179
}
]
},
{
"table": "Leases, Supplemental Balance Sheet Information (Details) - USD ($) $ in Millions",
"context": [
"Current Operating and Finance Lease Liabilities [Abstract]"
],
"label": "Current finance lease liabilities",
"concept": "us-gaap_FinanceLeaseLiabilityCurrent",
"abstract": false,
"values": [
{
"column": "Aug. 31, 2025",
"text": "$ 78",
"number": 78
},
{
"column": "Sep. 01, 2024",
"text": "$ 147",
"number": 147
}
]
},
{
"table": "Leases, Supplemental Balance Sheet Information (Details) - USD ($) $ in Millions",
"context": [
"Current Operating and Finance Lease Liabilities [Abstract]"
],
"label": "Operating lease liabilities",
"concept": "us-gaap_OperatingLeaseLiabilityCurrentStatementOfFinancialPositionExtensibleList",
"abstract": false,
"values": [
{
"column": "Aug. 31, 2025",
"text": "Other current liabilities",
"number": null
},
{
"column": "Sep. 01, 2024",
"text": "Other current liabilities",
"number": null
}
]
}
],
"row_count": 3,
"row_query": "operating lease liabilities",
"rows_truncated": true,
"char_count": 1506,
"returned_chars": 1506,
"truncated": false,
"source": "edgartools"
},
"error": null,
"warnings": []
}
FieldTypeDescription
okbooleanWhether the command completed successfully.
dataobject or nullCommand-specific result payload. It is null when ok is false.
errorstring or nullHuman-readable error message when ok is false; otherwise null.
warningsarrayNon-fatal warnings returned by the command.
data.filingobjectFiling metadata.
data.reportobjectReport descriptor selected by name or report.
data.report.short_namestringReport short name.
data.report.long_namestringFull provider report name.
data.report.categorystringReport category.
data.report.file_namestringFiling report file name.
data.textstringRendered report text after max_chars truncation.
data.rowsarrayStructured report rows when parseable.
data.rows[].tablestringSource table title.
data.rows[].contextarrayHierarchical row context.
data.rows[].labelstringRow label.
data.rows[].conceptstring or nullXBRL concept when available.
data.rows[].abstractbooleanWhether the row is abstract/header-like.
data.rows[].valuesarrayColumn values for the row.
data.rows[].values[].columnstringColumn header.
data.rows[].values[].textstringRaw cell text.
data.rows[].values[].numbernumber or nullParsed numeric value when available.
data.row_countintegerNumber of structured rows returned.
data.row_querystring or nullRow filter used.
data.rows_truncatedbooleanWhether rows were truncated by max_rows.
data.char_countintegerFull report text character count.
data.returned_charsintegerCharacters returned in data.text.
data.truncatedbooleanWhether report text was truncated by max_chars.
data.sourcestringProvider identifier.