Provenance
Freshness & coverage
Methods (10)
searchCompany
readFind companies by name or ticker. Returns CIK, tickers.
Required paramsqueryInput schema
{ "type": "object", "properties": { "query": { "type": "string" } }, "additionalProperties": false, "required": [ "query" ] }getCompanyFilings
readFull submission history with filing details.
Required paramscikInput schema
{ "type": "object", "properties": { "cik": { "oneOf": [ { "type": "string" }, { "type": "number" } ] } }, "additionalProperties": false, "required": [ "cik" ] }getRecentFilings
readRecent filings by form type (10-K, 10-Q, 8-K). Accepts cik/ticker/query/companyName.
Required paramscik or ticker or query or companyNameInput schema
{ "type": "object", "properties": { "cik": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "ticker": { "type": "string" }, "query": { "type": "string" }, "companyName": { "type": "string" }, "formType": { "type": "string" }, "form": { "type": "string" }, "limit": { "type": "number" } }, "additionalProperties": false, "allOf": [ { "anyOf": [ { "required": [ "cik" ] }, { "required": [ "ticker" ] }, { "required": [ "query" ] }, { "required": [ "companyName" ] } ] } ] }getCompanyFacts
readAll XBRL facts — revenue, assets, capex, D&A, EPS.
Required paramscikInput schema
{ "type": "object", "properties": { "cik": { "oneOf": [ { "type": "string" }, { "type": "number" } ] } }, "additionalProperties": false, "required": [ "cik" ] }getCompanyConcept
readSingle XBRL tag across all filings.
Required paramsciktagInput schema
{ "type": "object", "properties": { "cik": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "tag": { "type": "string" }, "taxonomy": { "type": "string" } }, "additionalProperties": false, "required": [ "cik", "tag" ] }getXbrlFrame
readCross-company data for one concept/period.
Required paramstagperiodInput schema
{ "type": "object", "properties": { "tag": { "type": "string" }, "period": { "type": "string" }, "taxonomy": { "type": "string" }, "unit": { "type": "string" } }, "additionalProperties": false, "required": [ "tag", "period" ] }searchFilings
readFull-text search across all SEC filings. Prefer getRecentFilings for recent filings for one company.
Required paramsqueryInput schema
{ "type": "object", "properties": { "query": { "type": "string", "description": "Literal full-text keywords sent as the SEC EDGAR q parameter.", "x-patchops-inference": "literal-search-term" }, "forms": { "type": "string" }, "form": { "type": "string" }, "formType": { "type": "string" }, "dateStart": { "type": "string" }, "dateEnd": { "type": "string" }, "from": { "type": "number" }, "size": { "type": "number" } }, "additionalProperties": false, "required": [ "query" ] }getInsiderTrading
readInsider transaction filings (Form 3/4/5).
Required paramscikInput schema
{ "type": "object", "properties": { "cik": { "oneOf": [ { "type": "string" }, { "type": "number" } ] }, "limit": { "type": "number" } }, "additionalProperties": false, "required": [ "cik" ] }getEPFinancials
readKey E&P metrics: revenue, capex, D&A, reserves, debt.
Required paramscikInput schema
{ "type": "object", "properties": { "cik": { "oneOf": [ { "type": "string" }, { "type": "number" } ] } }, "additionalProperties": false, "required": [ "cik" ] }compareCompanies
unknownCompare metric across multiple companies.
Required paramscikstagInput schema
{ "type": "object", "properties": { "ciks": { "type": "array", "items": { "oneOf": [ { "type": "string" }, { "type": "number" } ] } }, "tag": { "type": "string" }, "taxonomy": { "type": "string" } }, "additionalProperties": false, "required": [ "ciks", "tag" ] }
