{ "openapi": "3.0.3", "info": { "title": "SecFeed API", "version": "1.0.0", "description": "Every SEC EDGAR filing since 1993 as clean JSON: search and full-text search, a real-time stream and webhooks, XBRL financial statements, Forms 3/4/5, 13F, 13D/13G, 8-K items, proxy pay and governance data, offerings, funds and enforcement. Get a free key at https://secfeedapi.com. SecFeed is an independent service, not affiliated with or endorsed by the U.S. Securities and Exchange Commission.", "contact": { "name": "SecFeed", "email": "support@secfeedapi.com", "url": "https://secfeedapi.com" }, "termsOfService": "https://secfeedapi.com/terms/" }, "externalDocs": { "description": "Documentation", "url": "https://secfeedapi.com/docs/" }, "servers": [ { "url": "https://secfeedapi.com" } ], "tags": [ { "name": "Search & retrieve", "description": "Find filings, read their files, and get new ones as EDGAR publishes them." }, { "name": "Extraction & financials", "description": "Sections of 10-K, 10-Q and 8-K filings, and XBRL financial data." }, { "name": "Ownership & insiders", "description": "Insider trades (Forms 3, 4, 5), Form 144, 13F holdings, 13D and 13G." }, { "name": "Material events (8-K)", "description": "8-K filings classified by item, with feeds for the most watched items." }, { "name": "Company data", "description": "Pay, board, auditor, subsidiaries, shares, dilution, meetings and M&A filings." }, { "name": "Governance, pay & audit datasets", "description": "Structured data extracted from proxy statements, auditor's reports and SEC enforcement releases." }, { "name": "Offerings", "description": "IPOs, Reg D private placements, Reg CF crowdfunding and Reg A." }, { "name": "Funds, advisers & broker-dealers", "description": "N-PORT, N-CEN, N-PX, fund fees, Form ADV and broker-dealer reports." }, { "name": "Enforcement & regulatory", "description": "SEC litigation, administrative proceedings, AAERs, press releases and SRO rule filings." }, { "name": "Reference", "description": "Ticker, CIK, CUSIP, name, exchange and industry lookups." }, { "name": "AI agents", "description": "The SecFeed MCP server for Claude, ChatGPT, Cursor and other MCP clients." } ], "paths": { "/v1/filings": { "get": { "tags": [ "Search & retrieve" ], "summary": "Search every EDGAR filing since 1993 with a Lucene-style query over ticker, cik, formType, filedAt, companyName, accessi", "description": "Search every EDGAR filing since 1993 with a Lucene-style query over ticker, cik, formType, filedAt, companyName, accessionNo, sic, state, items (8-K) and periodOfReport.\n\nExample: `/v1/filings?query=ticker:AAPL AND formType:\"10-K\"&size=5`", "operationId": "getFilings", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "query", "in": "query", "required": false, "schema": { "type": "string" }, "example": "ticker:AAPL AND formType:\"10-K\"" }, { "name": "from", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "size", "in": "query", "required": false, "schema": { "type": "integer" }, "description": "Max 200", "example": 5 }, { "name": "sort", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "asc", "desc" ] } } ] }, "post": { "tags": [ "Search & retrieve" ], "summary": "Search every EDGAR filing since 1993 with a Lucene-style query over ticker, cik, formType, filedAt, companyName, accessi", "description": "Search every EDGAR filing since 1993 with a Lucene-style query over ticker, cik, formType, filedAt, companyName, accessionNo, sic, state, items (8-K) and periodOfReport.\n\nExample: `/v1/filings?query=ticker:AAPL AND formType:\"10-K\"&size=5`", "operationId": "postFilings", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "query": { "type": "string" }, "from": { "type": "integer" }, "size": { "type": "integer", "description": "Max 200" }, "sort": { "type": "string", "enum": [ "asc", "desc" ] } } } } } } } }, "/v1/full-text-search": { "get": { "tags": [ "Search & retrieve" ], "summary": "Search the full text of every filing and exhibit since 2001", "description": "Search the full text of every filing and exhibit since 2001. Exact phrases in quotes.\n\nExample: `/v1/full-text-search?query=\"going concern\"&formTypes=10-K&startDate=2026-01-01`", "operationId": "getFullTextSearch", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "query", "in": "query", "required": false, "schema": { "type": "string" }, "example": "\"going concern\"" }, { "name": "formTypes", "in": "query", "required": false, "schema": { "type": "string" }, "example": "10-K" }, { "name": "ciks", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "startDate", "in": "query", "required": false, "schema": { "type": "string" }, "example": "2026-01-01" }, { "name": "endDate", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer" } } ] }, "post": { "tags": [ "Search & retrieve" ], "summary": "Search the full text of every filing and exhibit since 2001", "description": "Search the full text of every filing and exhibit since 2001. Exact phrases in quotes.\n\nExample: `/v1/full-text-search?query=\"going concern\"&formTypes=10-K&startDate=2026-01-01`", "operationId": "postFullTextSearch", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "query": { "type": "string" }, "formTypes": { "type": "string" }, "ciks": { "type": "string" }, "startDate": { "type": "string" }, "endDate": { "type": "string" }, "page": { "type": "integer" } } } } } } } }, "/v1/filings/csv": { "get": { "tags": [ "Search & retrieve" ], "summary": "Filing search results as CSV (up to 200 rows)", "description": "Filing search results as CSV (up to 200 rows).\n\nExample: `/v1/filings/csv?query=formType:\"S-1\" AND filedAt:[2026-09-01 TO 2026-09-30]`", "operationId": "getFilingsCsv", "responses": { "200": { "description": "OK", "content": { "text/csv": { "schema": {} } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "query", "in": "query", "required": false, "schema": { "type": "string" }, "example": "formType:\"S-1\" AND filedAt:[2026-09-01 TO 2026-09-30]" }, { "name": "size", "in": "query", "required": false, "schema": { "type": "integer" } } ] } }, "/v1/stream": { "get": { "tags": [ "Search & retrieve" ], "summary": "Server-Sent Events: each new filing the moment EDGAR publishes it", "description": "Server-Sent Events: each new filing the moment EDGAR publishes it.\n\nExample: `/v1/stream?formTypes=8-K,4`", "operationId": "getStream", "responses": { "200": { "description": "OK", "content": { "text/event-stream": { "schema": {} } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "formTypes", "in": "query", "required": false, "schema": { "type": "string" }, "example": "8-K,4" }, { "name": "ciks", "in": "query", "required": false, "schema": { "type": "string" } } ] } }, "/v1/stream/latest": { "get": { "tags": [ "Search & retrieve" ], "summary": "The latest filings seen by the stream, each with seenAt and latencyMs", "description": "The latest filings seen by the stream, each with seenAt and latencyMs.\n\nExample: `/v1/stream/latest?size=20`", "operationId": "getStreamLatest", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "size", "in": "query", "required": false, "schema": { "type": "integer" }, "example": 20 } ] } }, "/v1/stream/latency": { "get": { "tags": [ "Search & retrieve" ], "summary": "Measured delivery latency (p50, p90, p99) from EDGAR publishing a filing to SecFeed, and from EDGAR accepting it, last N", "description": "Measured delivery latency (p50, p90, p99) from EDGAR publishing a filing to SecFeed, and from EDGAR accepting it, last N hours.\n\nExample: `/v1/stream/latency?hours=24`", "operationId": "getStreamLatency", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "hours", "in": "query", "required": false, "schema": { "type": "integer" }, "example": 24 } ] } }, "/v1/webhooks": { "post": { "tags": [ "Search & retrieve" ], "summary": "Push new filings to your HTTPS endpoint", "description": "Push new filings to your HTTPS endpoint.\n\nExample: `/v1/webhooks`\n\nBody: `{\"url\", \"formTypes\": [], \"ciks\": []}`", "operationId": "postWebhooks", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "format": "uri", "description": "Your HTTPS endpoint." }, "formTypes": { "type": "array", "items": { "type": "string" }, "description": "Only these form types, e.g. [\"8-K\", \"4\"]." }, "ciks": { "type": "array", "items": { "type": "string" }, "description": "Only these companies." } } } } } } }, "get": { "tags": [ "Search & retrieve" ], "summary": "The webhooks registered on your API key", "description": "The webhooks registered on your API key.\n\nExample: `/v1/webhooks`", "operationId": "getWebhooks", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [] } }, "/v1/webhooks/delete": { "post": { "tags": [ "Search & retrieve" ], "summary": "Remove one of your webhooks", "description": "Remove one of your webhooks.\n\nExample: `/v1/webhooks/delete`\n\nBody: `{\"id\"}`", "operationId": "postWebhooksDelete", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "The webhook id from GET /v1/webhooks." } } } } } } } }, "/v1/ingestion-log": { "get": { "tags": [ "Search & retrieve" ], "summary": "Filings EDGAR published on a day, counted by form type", "description": "Filings EDGAR published on a day, counted by form type.\n\nExample: `/v1/ingestion-log?date=2026-10-09`", "operationId": "getIngestionLog", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "date", "in": "query", "required": false, "schema": { "type": "string" }, "example": "2026-10-09" } ] } }, "/v1/files": { "get": { "tags": [ "Search & retrieve" ], "summary": "Every file in a filing: documents, exhibits, XBRL, images", "description": "Every file in a filing: documents, exhibits, XBRL, images.\n\nExample: `/v1/files?cik=320193&accessionNo=0000320193-26-000020`", "operationId": "getFiles", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "cik", "in": "query", "required": false, "schema": { "type": "string" }, "example": "320193" }, { "name": "accessionNo", "in": "query", "required": false, "schema": { "type": "string" }, "example": "0000320193-26-000020" } ] } }, "/v1/download": { "get": { "tags": [ "Search & retrieve" ], "summary": "Any EDGAR archive file as filed", "description": "Any EDGAR archive file as filed.\n\nExample: `/v1/download?url=https://www.sec.gov/Archives/edgar/data/320193/000032019326000020/0000320193-26-000020-index.htm`", "operationId": "getDownload", "responses": { "200": { "description": "OK", "content": { "application/octet-stream": { "schema": {} } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "url", "in": "query", "required": false, "schema": { "type": "string" }, "example": "https://www.sec.gov/Archives/edgar/data/320193/000032019326000020/0000320193-26-000020-index.htm" } ] } }, "/v1/pdf": { "get": { "tags": [ "Search & retrieve" ], "summary": "Any filing or exhibit rendered to PDF", "description": "Any filing or exhibit rendered to PDF.\n\nExample: `/v1/pdf?url=https://www.sec.gov/Archives/edgar/data/1045810/000104581026000078/0001045810-26-000078-index.htm`", "operationId": "getPdf", "responses": { "200": { "description": "OK", "content": { "application/pdf": { "schema": {} } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "url", "in": "query", "required": false, "schema": { "type": "string" }, "example": "https://www.sec.gov/Archives/edgar/data/1045810/000104581026000078/0001045810-26-000078-index.htm" } ] } }, "/v1/bulk": { "get": { "tags": [ "Search & retrieve" ], "summary": "Catalog of bulk datasets and months", "description": "Catalog of bulk datasets and months.\n\nExample: `/v1/bulk`", "operationId": "getBulk", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [] } }, "/v1/bulk/download": { "get": { "tags": [ "Search & retrieve" ], "summary": "A dataset month as gzipped JSON Lines", "description": "A dataset month as gzipped JSON Lines.\n\nExample: `/v1/bulk/download?dataset=insider-transactions&month=2026-10`", "operationId": "getBulkDownload", "responses": { "200": { "description": "OK", "content": { "application/gzip": { "schema": {} } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "dataset", "in": "query", "required": false, "schema": { "type": "string" }, "example": "insider-transactions" }, { "name": "month", "in": "query", "required": false, "schema": { "type": "string" }, "example": "2026-10" }, { "name": "formType", "in": "query", "required": false, "schema": { "type": "string" } } ] } }, "/v1/extractor": { "get": { "tags": [ "Extraction & financials" ], "summary": "One item of a 10-K (1, 1A, 7...), 10-Q (part1item2, part2item1a...) or 8-K (2-2, 5-2...) as text or html", "description": "One item of a 10-K (1, 1A, 7...), 10-Q (part1item2, part2item1a...) or 8-K (2-2, 5-2...) as text or html.\n\nExample: `/v1/extractor?url=https://www.sec.gov/Archives/edgar/data/1045810/000104581026000021/0001045810-26-000021-index.htm&item=1A`", "operationId": "getExtractor", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "url", "in": "query", "required": false, "schema": { "type": "string" }, "example": "https://www.sec.gov/Archives/edgar/data/1045810/000104581026000021/0001045810-26-000021-index.htm" }, { "name": "item", "in": "query", "required": false, "schema": { "type": "string" }, "example": "1A" }, { "name": "type", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "text", "html" ] } } ] } }, "/v1/xbrl-to-json": { "get": { "tags": [ "Extraction & financials" ], "summary": "Every statement of a filing from its XBRL, in the company's order, plus the cover page", "description": "Every statement of a filing from its XBRL, in the company's order, plus the cover page.\n\nExample: `/v1/xbrl-to-json?accessionNo=0000320193-26-000020&cik=320193`", "operationId": "getXbrlToJson", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "accessionNo", "in": "query", "required": false, "schema": { "type": "string" }, "description": "One of: accessionNo, htmUrl, xbrlUrl.", "example": "0000320193-26-000020" }, { "name": "htmUrl", "in": "query", "required": false, "schema": { "type": "string" }, "description": "One of: accessionNo, htmUrl, xbrlUrl." }, { "name": "xbrlUrl", "in": "query", "required": false, "schema": { "type": "string" }, "description": "One of: accessionNo, htmUrl, xbrlUrl." }, { "name": "cik", "in": "query", "required": false, "schema": { "type": "string" }, "example": "320193" }, { "name": "notes", "in": "query", "required": false, "schema": { "type": "string", "default": "true" } } ] } }, "/v1/financial-statements": { "get": { "tags": [ "Extraction & financials" ], "summary": "Income statement, balance sheet, cash flow (totals) for the latest n 10-K or 10-Q", "description": "Income statement, balance sheet, cash flow (totals) for the latest n 10-K or 10-Q.\n\nExample: `/v1/financial-statements?ticker=NVDA&formType=10-K`", "operationId": "getFinancialStatements", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "ticker", "in": "query", "required": false, "schema": { "type": "string" }, "description": "One of: ticker, cik.", "example": "NVDA" }, { "name": "cik", "in": "query", "required": false, "schema": { "type": "string" }, "description": "One of: ticker, cik." }, { "name": "formType", "in": "query", "required": false, "schema": { "type": "string" }, "example": "10-K" }, { "name": "n", "in": "query", "required": false, "schema": { "type": "integer" } } ] } }, "/v1/financial-statements/xlsx": { "get": { "tags": [ "Extraction & financials" ], "summary": "One filing's statements as an Excel workbook: a sheet per statement, periods as columns", "description": "One filing's statements as an Excel workbook: a sheet per statement, periods as columns.\n\nExample: `/v1/financial-statements/xlsx?accessionNo=0000320193-26-000020&cik=320193`", "operationId": "getFinancialStatementsXlsx", "responses": { "200": { "description": "OK", "content": { "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": {} } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "accessionNo", "in": "query", "required": false, "schema": { "type": "string" }, "example": "0000320193-26-000020" }, { "name": "cik", "in": "query", "required": false, "schema": { "type": "string" }, "example": "320193" } ] } }, "/v1/xbrl/company-facts": { "get": { "tags": [ "Extraction & financials" ], "summary": "Every XBRL fact a company has reported", "description": "Every XBRL fact a company has reported.\n\nExample: `/v1/xbrl/company-facts?ticker=MSFT`", "operationId": "getXbrlCompanyFacts", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "ticker", "in": "query", "required": false, "schema": { "type": "string" }, "description": "One of: ticker, cik.", "example": "MSFT" }, { "name": "cik", "in": "query", "required": false, "schema": { "type": "string" }, "description": "One of: ticker, cik." } ] } }, "/v1/xbrl/company-concept": { "get": { "tags": [ "Extraction & financials" ], "summary": "One concept over time for a company", "description": "One concept over time for a company.\n\nExample: `/v1/xbrl/company-concept?ticker=AAPL&concept=Revenues`", "operationId": "getXbrlCompanyConcept", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "ticker", "in": "query", "required": false, "schema": { "type": "string" }, "description": "One of: ticker, cik.", "example": "AAPL" }, { "name": "cik", "in": "query", "required": false, "schema": { "type": "string" }, "description": "One of: ticker, cik." }, { "name": "concept", "in": "query", "required": false, "schema": { "type": "string" }, "example": "Revenues" }, { "name": "taxonomy", "in": "query", "required": false, "schema": { "type": "string" } } ] } }, "/v1/xbrl/frames": { "get": { "tags": [ "Extraction & financials" ], "summary": "One concept across all companies for a period", "description": "One concept across all companies for a period.\n\nExample: `/v1/xbrl/frames?concept=Assets&period=CY2025Q4I`", "operationId": "getXbrlFrames", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "concept", "in": "query", "required": false, "schema": { "type": "string" }, "example": "Assets" }, { "name": "period", "in": "query", "required": false, "schema": { "type": "string" }, "description": "CY2025, CY2025Q4I", "example": "CY2025Q4I" }, { "name": "unit", "in": "query", "required": false, "schema": { "type": "string" } } ] } }, "/v1/insider-trading": { "get": { "tags": [ "Ownership & insiders" ], "summary": "Forms 3, 4, 5: every transaction and holding with owners, roles, prices, footnotes, 10b5-1 flag", "description": "Forms 3, 4, 5: every transaction and holding with owners, roles, prices, footnotes, 10b5-1 flag.\n\nExample: `/v1/insider-trading?code=P&minValue=100000`", "operationId": "getInsiderTrading", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "ticker", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "cik", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "owner", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "code", "in": "query", "required": false, "schema": { "type": "string" }, "description": "P,S,A,M...", "example": "P" }, { "name": "minValue", "in": "query", "required": false, "schema": { "type": "string" }, "example": "100000" }, { "name": "startDate", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "formType", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "table", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "from", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "size", "in": "query", "required": false, "schema": { "type": "integer" } } ] } }, "/v1/form-144": { "get": { "tags": [ "Ownership & insiders" ], "summary": "Proposed sales of restricted and control securities: flat fields (seller, relationship, shares, market value, broker, sa", "description": "Proposed sales of restricted and control securities: flat fields (seller, relationship, shares, market value, broker, sale date, past 3 months of sales).\n\nFilters: flat.=value.\n\nExample: `/v1/form-144?flat.aggregateMarketValue__gte=1000000&fields=flat`", "operationId": "getForm144", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "cik", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "startDate", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "fields", "in": "query", "required": false, "schema": { "type": "string", "default": "flat" }, "example": "flat" } ] } }, "/v1/form-13f": { "get": { "tags": [ "Ownership & insiders" ], "summary": "13F-HR cover pages and information tables (every field)", "description": "13F-HR cover pages and information tables (every field).\n\nExample: `/v1/form-13f?cik=1067983`", "operationId": "getForm13f", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "cik", "in": "query", "required": false, "schema": { "type": "string" }, "example": "1067983" }, { "name": "startDate", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "required": false, "schema": { "type": "string" } } ] } }, "/v1/form-13f/holdings": { "get": { "tags": [ "Ownership & insiders" ], "summary": "13F positions as rows: issuer, CUSIP, value, shares, put/call, voting authority", "description": "13F positions as rows: issuer, CUSIP, value, shares, put/call, voting authority.\n\nExample: `/v1/form-13f/holdings?cusip=037833100&period=06-30-2026`", "operationId": "getForm13fHoldings", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "cusip", "in": "query", "required": false, "schema": { "type": "string" }, "example": "037833100" }, { "name": "cik", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "period", "in": "query", "required": false, "schema": { "type": "string" }, "description": "MM-DD-YYYY, pass it with a CUSIP", "example": "06-30-2026" }, { "name": "from", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "size", "in": "query", "required": false, "schema": { "type": "integer" }, "description": "Max 1000" } ] } }, "/v1/form-13d-13g": { "get": { "tags": [ "Ownership & insiders" ], "summary": "Schedules 13D and 13G: issuer, CUSIPs, each reporting person's voting and dispositive power and percent of class, purpos", "description": "Schedules 13D and 13G: issuer, CUSIPs, each reporting person's voting and dispositive power and percent of class, purpose of transaction.\n\nExample: `/v1/form-13d-13g?formType=SCHEDULE 13D&flat.maxPercentOfClass__gte=10`", "operationId": "getForm13d13g", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "cik", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "startDate", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "formType", "in": "query", "required": false, "schema": { "type": "string" }, "example": "SCHEDULE 13D" }, { "name": "flat.maxPercentOfClass__gte", "in": "query", "required": false, "schema": { "type": "string" }, "example": "10" }, { "name": "fields", "in": "query", "required": false, "schema": { "type": "string", "default": "flat" } } ] } }, "/v1/form-8k": { "get": { "tags": [ "Material events (8-K)" ], "summary": "8-K filings classified by item, with item text on request", "description": "8-K filings classified by item, with item text on request.\n\nExample: `/v1/form-8k?item=1.05&text=true`", "operationId": "getForm8k", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "item", "in": "query", "required": false, "schema": { "type": "string" }, "description": "1.01...9.01", "example": "1.05" }, { "name": "cik", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "startDate", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "text", "in": "query", "required": false, "schema": { "type": "string", "default": "true" }, "example": "true" } ] } }, "/v1/form-8k/material-agreements": { "get": { "tags": [ "Material events (8-K)" ], "summary": "8-K Item 1.01 feed with the item text", "description": "8-K Item 1.01 feed with the item text.\n\nExample: `/v1/form-8k/material-agreements`", "operationId": "getForm8kMaterialAgreements", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "cik", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "startDate", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "required": false, "schema": { "type": "string" } } ] } }, "/v1/form-8k/agreement-terminations": { "get": { "tags": [ "Material events (8-K)" ], "summary": "8-K Item 1.02 feed with the item text", "description": "8-K Item 1.02 feed with the item text.\n\nExample: `/v1/form-8k/agreement-terminations`", "operationId": "getForm8kAgreementTerminations", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "cik", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "startDate", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "required": false, "schema": { "type": "string" } } ] } }, "/v1/form-8k/bankruptcy": { "get": { "tags": [ "Material events (8-K)" ], "summary": "8-K Item 1.03 feed with the item text", "description": "8-K Item 1.03 feed with the item text.\n\nExample: `/v1/form-8k/bankruptcy`", "operationId": "getForm8kBankruptcy", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "cik", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "startDate", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "required": false, "schema": { "type": "string" } } ] } }, "/v1/form-8k/cybersecurity-incidents": { "get": { "tags": [ "Material events (8-K)" ], "summary": "8-K Item 1.05 feed with the item text", "description": "8-K Item 1.05 feed with the item text.\n\nExample: `/v1/form-8k/cybersecurity-incidents`", "operationId": "getForm8kCybersecurityIncidents", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "cik", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "startDate", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "required": false, "schema": { "type": "string" } } ] } }, "/v1/form-8k/acquisitions": { "get": { "tags": [ "Material events (8-K)" ], "summary": "8-K Item 2.01 feed with the item text", "description": "8-K Item 2.01 feed with the item text.\n\nExample: `/v1/form-8k/acquisitions`", "operationId": "getForm8kAcquisitions", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "cik", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "startDate", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "required": false, "schema": { "type": "string" } } ] } }, "/v1/form-8k/earnings-results": { "get": { "tags": [ "Material events (8-K)" ], "summary": "8-K Item 2.02 feed with the item text", "description": "8-K Item 2.02 feed with the item text.\n\nExample: `/v1/form-8k/earnings-results`", "operationId": "getForm8kEarningsResults", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "cik", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "startDate", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "required": false, "schema": { "type": "string" } } ] } }, "/v1/form-8k/delisting-notices": { "get": { "tags": [ "Material events (8-K)" ], "summary": "8-K Item 3.01 feed with the item text", "description": "8-K Item 3.01 feed with the item text.\n\nExample: `/v1/form-8k/delisting-notices`", "operationId": "getForm8kDelistingNotices", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "cik", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "startDate", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "required": false, "schema": { "type": "string" } } ] } }, "/v1/form-8k/auditor-changes": { "get": { "tags": [ "Material events (8-K)" ], "summary": "8-K Item 4.01 feed with the item text", "description": "8-K Item 4.01 feed with the item text.\n\nExample: `/v1/form-8k/auditor-changes`", "operationId": "getForm8kAuditorChanges", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "cik", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "startDate", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "required": false, "schema": { "type": "string" } } ] } }, "/v1/form-8k/restatements": { "get": { "tags": [ "Material events (8-K)" ], "summary": "8-K Item 4.02 feed with the item text", "description": "8-K Item 4.02 feed with the item text.\n\nExample: `/v1/form-8k/restatements`", "operationId": "getForm8kRestatements", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "cik", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "startDate", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "required": false, "schema": { "type": "string" } } ] } }, "/v1/form-8k/executive-changes": { "get": { "tags": [ "Material events (8-K)" ], "summary": "8-K Item 5.02 feed with the item text", "description": "8-K Item 5.02 feed with the item text.\n\nExample: `/v1/form-8k/executive-changes`", "operationId": "getForm8kExecutiveChanges", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "cik", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "startDate", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "required": false, "schema": { "type": "string" } } ] } }, "/v1/form-8k/shareholder-votes": { "get": { "tags": [ "Material events (8-K)" ], "summary": "8-K Item 5.07 feed with the item text", "description": "8-K Item 5.07 feed with the item text.\n\nExample: `/v1/form-8k/shareholder-votes`", "operationId": "getForm8kShareholderVotes", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "cik", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "startDate", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "required": false, "schema": { "type": "string" } } ] } }, "/v1/executive-compensation": { "get": { "tags": [ "Company data" ], "summary": "Summary Compensation Table from the latest proxy: salary, bonus, awards, total by executive and year", "description": "Summary Compensation Table from the latest proxy: salary, bonus, awards, total by executive and year.\n\nExample: `/v1/executive-compensation?ticker=MSFT`", "operationId": "getExecutiveCompensation", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "ticker", "in": "query", "required": false, "schema": { "type": "string" }, "description": "One of: ticker, cik.", "example": "MSFT" }, { "name": "cik", "in": "query", "required": false, "schema": { "type": "string" }, "description": "One of: ticker, cik." }, { "name": "accessionNo", "in": "query", "required": false, "schema": { "type": "string" } } ] } }, "/v1/directors": { "get": { "tags": [ "Company data" ], "summary": "Board members: director compensation, age, director since", "description": "Board members: director compensation, age, director since.\n\nExample: `/v1/directors?ticker=NVDA`", "operationId": "getDirectors", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "ticker", "in": "query", "required": false, "schema": { "type": "string" }, "description": "One of: ticker, cik.", "example": "NVDA" }, { "name": "cik", "in": "query", "required": false, "schema": { "type": "string" }, "description": "One of: ticker, cik." } ] } }, "/v1/audit-fees": { "get": { "tags": [ "Company data" ], "summary": "Audit, audit-related, tax and other fees by year", "description": "Audit, audit-related, tax and other fees by year.\n\nExample: `/v1/audit-fees?ticker=NVDA`", "operationId": "getAuditFees", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "ticker", "in": "query", "required": false, "schema": { "type": "string" }, "description": "One of: ticker, cik.", "example": "NVDA" }, { "name": "cik", "in": "query", "required": false, "schema": { "type": "string" }, "description": "One of: ticker, cik." } ] } }, "/v1/auditor": { "get": { "tags": [ "Company data" ], "summary": "Auditor name, location, PCAOB firm ID", "description": "Auditor name, location, PCAOB firm ID.\n\nExample: `/v1/auditor?ticker=AAPL`", "operationId": "getAuditor", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "ticker", "in": "query", "required": false, "schema": { "type": "string" }, "description": "One of: ticker, cik.", "example": "AAPL" }, { "name": "cik", "in": "query", "required": false, "schema": { "type": "string" }, "description": "One of: ticker, cik." } ] } }, "/v1/subsidiaries": { "get": { "tags": [ "Company data" ], "summary": "Subsidiaries and jurisdictions from Exhibit 21", "description": "Subsidiaries and jurisdictions from Exhibit 21.\n\nExample: `/v1/subsidiaries?ticker=AAPL`", "operationId": "getSubsidiaries", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "ticker", "in": "query", "required": false, "schema": { "type": "string" }, "description": "One of: ticker, cik.", "example": "AAPL" }, { "name": "cik", "in": "query", "required": false, "schema": { "type": "string" }, "description": "One of: ticker, cik." } ] } }, "/v1/shares-outstanding": { "get": { "tags": [ "Company data" ], "summary": "Shares outstanding and public float over time", "description": "Shares outstanding and public float over time.\n\nExample: `/v1/shares-outstanding?ticker=TSLA`", "operationId": "getSharesOutstanding", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "ticker", "in": "query", "required": false, "schema": { "type": "string" }, "description": "One of: ticker, cik.", "example": "TSLA" }, { "name": "cik", "in": "query", "required": false, "schema": { "type": "string" }, "description": "One of: ticker, cik." } ] } }, "/v1/pay-vs-performance": { "get": { "tags": [ "Company data" ], "summary": "Pay versus performance by fiscal year (PEO and other NEO pay, compensation actually paid, TSR, net income, company-selec", "description": "Pay versus performance by fiscal year (PEO and other NEO pay, compensation actually paid, TSR, net income, company-selected measure) plus insider-trading-policy and award-timing disclosures.\n\nExample: `/v1/pay-vs-performance?ticker=NVDA`", "operationId": "getPayVsPerformance", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "ticker", "in": "query", "required": false, "schema": { "type": "string" }, "description": "One of: ticker, cik.", "example": "NVDA" }, { "name": "cik", "in": "query", "required": false, "schema": { "type": "string" }, "description": "One of: ticker, cik." }, { "name": "accessionNo", "in": "query", "required": false, "schema": { "type": "string" } } ] } }, "/v1/equity-dilution": { "get": { "tags": [ "Company data" ], "summary": "Shares authorized, issued, outstanding, treasury, basic vs diluted, stock comp, buybacks, equity plan capacity", "description": "Shares authorized, issued, outstanding, treasury, basic vs diluted, stock comp, buybacks, equity plan capacity.\n\nExample: `/v1/equity-dilution?ticker=AAPL`", "operationId": "getEquityDilution", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "ticker", "in": "query", "required": false, "schema": { "type": "string" }, "description": "One of: ticker, cik.", "example": "AAPL" }, { "name": "cik", "in": "query", "required": false, "schema": { "type": "string" }, "description": "One of: ticker, cik." } ] } }, "/v1/shareholder-meetings": { "get": { "tags": [ "Company data" ], "summary": "Annual meeting date, record date, ballot items, and the 8-K 5.07 vote results", "description": "Annual meeting date, record date, ballot items, and the 8-K 5.07 vote results.\n\nExample: `/v1/shareholder-meetings?ticker=AAPL`", "operationId": "getShareholderMeetings", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "ticker", "in": "query", "required": false, "schema": { "type": "string" }, "description": "One of: ticker, cik.", "example": "AAPL" }, { "name": "cik", "in": "query", "required": false, "schema": { "type": "string" }, "description": "One of: ticker, cik." }, { "name": "accessionNo", "in": "query", "required": false, "schema": { "type": "string" } } ] } }, "/v1/related-party-transactions": { "get": { "tags": [ "Company data" ], "summary": "The related person transactions section of the latest proxy", "description": "The related person transactions section of the latest proxy.\n\nExample: `/v1/related-party-transactions?ticker=NVDA`", "operationId": "getRelatedPartyTransactions", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "ticker", "in": "query", "required": false, "schema": { "type": "string" }, "description": "One of: ticker, cik.", "example": "NVDA" }, { "name": "cik", "in": "query", "required": false, "schema": { "type": "string" }, "description": "One of: ticker, cik." }, { "name": "accessionNo", "in": "query", "required": false, "schema": { "type": "string" } } ] } }, "/v1/mergers-acquisitions": { "get": { "tags": [ "Company data" ], "summary": "Merger proxies, S-4/F-4, 425 communications, tender offers, 14D-9, going-private filings", "description": "Merger proxies, S-4/F-4, 425 communications, tender offers, 14D-9, going-private filings.\n\nExample: `/v1/mergers-acquisitions?startDate=2026-10-01`", "operationId": "getMergersAcquisitions", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "ticker", "in": "query", "required": false, "schema": { "type": "string" }, "description": "One of: ticker, cik." }, { "name": "cik", "in": "query", "required": false, "schema": { "type": "string" }, "description": "One of: ticker, cik." }, { "name": "formType", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "startDate", "in": "query", "required": false, "schema": { "type": "string" }, "example": "2026-10-01" }, { "name": "endDate", "in": "query", "required": false, "schema": { "type": "string" } } ] } }, "/v1/entities": { "get": { "tags": [ "Company data" ], "summary": "EDGAR entity profile: SIC, addresses, state, fiscal year end, former names", "description": "EDGAR entity profile: SIC, addresses, state, fiscal year end, former names.\n\nExample: `/v1/entities?cik=NVDA`", "operationId": "getEntities", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "cik", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Or ticker", "example": "NVDA" } ] } }, "/v1/director-compensation": { "get": { "tags": [ "Governance, pay & audit datasets" ], "summary": "Pay of non-employee directors and fund trustees: the pay table, retainer program, ownership guidelines, pay caps and def", "description": "Pay of non-employee directors and fund trustees: the pay table, retainer program, ownership guidelines, pay caps and deferral options.\n\nFilters: data.=value.\n\nExample: `/v1/director-compensation?ticker=AAPL`", "operationId": "getDirectorCompensation", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "ticker", "in": "query", "required": false, "schema": { "type": "string" }, "description": "One of: ticker, cik.", "example": "AAPL" }, { "name": "cik", "in": "query", "required": false, "schema": { "type": "string" }, "description": "One of: ticker, cik." }, { "name": "accessionNo", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "startDate", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "from", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "size", "in": "query", "required": false, "schema": { "type": "integer" }, "description": "Max 50" } ] }, "post": { "tags": [ "Governance, pay & audit datasets" ], "summary": "Pay of non-employee directors and fund trustees: the pay table, retainer program, ownership guidelines, pay caps and def", "description": "Pay of non-employee directors and fund trustees: the pay table, retainer program, ownership guidelines, pay caps and deferral options.\n\nFilters: data.=value.\n\nExample: `/v1/director-compensation?ticker=AAPL`", "operationId": "postDirectorCompensation", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "ticker": { "type": "string", "description": "One of: ticker, cik." }, "cik": { "type": "string", "description": "One of: ticker, cik." }, "accessionNo": { "type": "string" }, "startDate": { "type": "string" }, "endDate": { "type": "string" }, "from": { "type": "integer" }, "size": { "type": "integer", "description": "Max 50" } } } } } } } }, "/v1/executive-compensation-governance": { "get": { "tags": [ "Governance, pay & audit datasets" ], "summary": "Governance around executive pay: say-on-pay outcome, clawbacks, gross-ups, consultants, peers, ownership rules, repricin", "description": "Governance around executive pay: say-on-pay outcome, clawbacks, gross-ups, consultants, peers, ownership rules, repricing, grant timing and perks.\n\nFilters: data.=value.\n\nExample: `/v1/executive-compensation-governance?ticker=AAPL`", "operationId": "getExecutiveCompensationGovernance", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "ticker", "in": "query", "required": false, "schema": { "type": "string" }, "description": "One of: ticker, cik.", "example": "AAPL" }, { "name": "cik", "in": "query", "required": false, "schema": { "type": "string" }, "description": "One of: ticker, cik." }, { "name": "accessionNo", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "startDate", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "from", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "size", "in": "query", "required": false, "schema": { "type": "integer" }, "description": "Max 50" } ] }, "post": { "tags": [ "Governance, pay & audit datasets" ], "summary": "Governance around executive pay: say-on-pay outcome, clawbacks, gross-ups, consultants, peers, ownership rules, repricin", "description": "Governance around executive pay: say-on-pay outcome, clawbacks, gross-ups, consultants, peers, ownership rules, repricing, grant timing and perks.\n\nFilters: data.=value.\n\nExample: `/v1/executive-compensation-governance?ticker=AAPL`", "operationId": "postExecutiveCompensationGovernance", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "ticker": { "type": "string", "description": "One of: ticker, cik." }, "cik": { "type": "string", "description": "One of: ticker, cik." }, "accessionNo": { "type": "string" }, "startDate": { "type": "string" }, "endDate": { "type": "string" }, "from": { "type": "integer" }, "size": { "type": "integer", "description": "Max 50" } } } } } } } }, "/v1/severance-change-in-control": { "get": { "tags": [ "Governance, pay & audit datasets" ], "summary": "What named executives stand to receive on termination or a change in control, plus retirement, deferral and separation a", "description": "What named executives stand to receive on termination or a change in control, plus retirement, deferral and separation arrangements.\n\nFilters: data.=value.\n\nExample: `/v1/severance-change-in-control?ticker=AAPL`", "operationId": "getSeveranceChangeInControl", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "ticker", "in": "query", "required": false, "schema": { "type": "string" }, "description": "One of: ticker, cik.", "example": "AAPL" }, { "name": "cik", "in": "query", "required": false, "schema": { "type": "string" }, "description": "One of: ticker, cik." }, { "name": "accessionNo", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "startDate", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "from", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "size", "in": "query", "required": false, "schema": { "type": "integer" }, "description": "Max 50" } ] }, "post": { "tags": [ "Governance, pay & audit datasets" ], "summary": "What named executives stand to receive on termination or a change in control, plus retirement, deferral and separation a", "description": "What named executives stand to receive on termination or a change in control, plus retirement, deferral and separation arrangements.\n\nFilters: data.=value.\n\nExample: `/v1/severance-change-in-control?ticker=AAPL`", "operationId": "postSeveranceChangeInControl", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "ticker": { "type": "string", "description": "One of: ticker, cik." }, "cik": { "type": "string", "description": "One of: ticker, cik." }, "accessionNo": { "type": "string" }, "startDate": { "type": "string" }, "endDate": { "type": "string" }, "from": { "type": "integer" }, "size": { "type": "integer", "description": "Max 50" } } } } } } } }, "/v1/board-oversight": { "get": { "tags": [ "Governance, pay & audit datasets" ], "summary": "How the board is built and run: independence, leadership, committees, attendance, outside boards, risk allocation and se", "description": "How the board is built and run: independence, leadership, committees, attendance, outside boards, risk allocation and self-evaluation.\n\nFilters: data.=value.\n\nExample: `/v1/board-oversight?ticker=AAPL`", "operationId": "getBoardOversight", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "ticker", "in": "query", "required": false, "schema": { "type": "string" }, "description": "One of: ticker, cik.", "example": "AAPL" }, { "name": "cik", "in": "query", "required": false, "schema": { "type": "string" }, "description": "One of: ticker, cik." }, { "name": "accessionNo", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "startDate", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "from", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "size", "in": "query", "required": false, "schema": { "type": "integer" }, "description": "Max 50" } ] }, "post": { "tags": [ "Governance, pay & audit datasets" ], "summary": "How the board is built and run: independence, leadership, committees, attendance, outside boards, risk allocation and se", "description": "How the board is built and run: independence, leadership, committees, attendance, outside boards, risk allocation and self-evaluation.\n\nFilters: data.=value.\n\nExample: `/v1/board-oversight?ticker=AAPL`", "operationId": "postBoardOversight", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "ticker": { "type": "string", "description": "One of: ticker, cik." }, "cik": { "type": "string", "description": "One of: ticker, cik." }, "accessionNo": { "type": "string" }, "startDate": { "type": "string" }, "endDate": { "type": "string" }, "from": { "type": "integer" }, "size": { "type": "integer", "description": "Max 50" } } } } } } } }, "/v1/shareholder-rights": { "get": { "tags": [ "Governance, pay & audit datasets" ], "summary": "Rights shareholders hold and defenses the board holds: board cycle, voting classes, election standard, charter/bylaw pro", "description": "Rights shareholders hold and defenses the board holds: board cycle, voting classes, election standard, charter/bylaw provisions and governance ballot items.\n\nFilters: data.=value.\n\nExample: `/v1/shareholder-rights?ticker=AAPL`", "operationId": "getShareholderRights", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "ticker", "in": "query", "required": false, "schema": { "type": "string" }, "description": "One of: ticker, cik.", "example": "AAPL" }, { "name": "cik", "in": "query", "required": false, "schema": { "type": "string" }, "description": "One of: ticker, cik." }, { "name": "accessionNo", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "startDate", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "from", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "size", "in": "query", "required": false, "schema": { "type": "integer" }, "description": "Max 50" } ] }, "post": { "tags": [ "Governance, pay & audit datasets" ], "summary": "Rights shareholders hold and defenses the board holds: board cycle, voting classes, election standard, charter/bylaw pro", "description": "Rights shareholders hold and defenses the board holds: board cycle, voting classes, election standard, charter/bylaw provisions and governance ballot items.\n\nFilters: data.=value.\n\nExample: `/v1/shareholder-rights?ticker=AAPL`", "operationId": "postShareholderRights", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "ticker": { "type": "string", "description": "One of: ticker, cik." }, "cik": { "type": "string", "description": "One of: ticker, cik." }, "accessionNo": { "type": "string" }, "startDate": { "type": "string" }, "endDate": { "type": "string" }, "from": { "type": "integer" }, "size": { "type": "integer", "description": "Max 50" } } } } } } } }, "/v1/esg-oversight": { "get": { "tags": [ "Governance, pay & audit datasets" ], "summary": "Board-level oversight of ESG, cyber, AI, political spending and human capital, with workforce, climate, board diversity ", "description": "Board-level oversight of ESG, cyber, AI, political spending and human capital, with workforce, climate, board diversity and ESG pay metrics.\n\nFilters: data.=value.\n\nExample: `/v1/esg-oversight?ticker=AAPL`", "operationId": "getEsgOversight", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "ticker", "in": "query", "required": false, "schema": { "type": "string" }, "description": "One of: ticker, cik.", "example": "AAPL" }, { "name": "cik", "in": "query", "required": false, "schema": { "type": "string" }, "description": "One of: ticker, cik." }, { "name": "accessionNo", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "startDate", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "from", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "size", "in": "query", "required": false, "schema": { "type": "integer" }, "description": "Max 50" } ] }, "post": { "tags": [ "Governance, pay & audit datasets" ], "summary": "Board-level oversight of ESG, cyber, AI, political spending and human capital, with workforce, climate, board diversity ", "description": "Board-level oversight of ESG, cyber, AI, political spending and human capital, with workforce, climate, board diversity and ESG pay metrics.\n\nFilters: data.=value.\n\nExample: `/v1/esg-oversight?ticker=AAPL`", "operationId": "postEsgOversight", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "ticker": { "type": "string", "description": "One of: ticker, cik." }, "cik": { "type": "string", "description": "One of: ticker, cik." }, "accessionNo": { "type": "string" }, "startDate": { "type": "string" }, "endDate": { "type": "string" }, "from": { "type": "integer" }, "size": { "type": "integer", "description": "Max 50" } } } } } } } }, "/v1/compliance-signals": { "get": { "tags": [ "Governance, pay & audit datasets" ], "summary": "Regulatory red flags in a proxy: cover page status, filer status, listings, late Section 16 reports, auditor changes, po", "description": "Regulatory red flags in a proxy: cover page status, filer status, listings, late Section 16 reports, auditor changes, policy disclosures and listing deficiencies.\n\nFilters: data.=value.\n\nExample: `/v1/compliance-signals?ticker=AAPL`", "operationId": "getComplianceSignals", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "ticker", "in": "query", "required": false, "schema": { "type": "string" }, "description": "One of: ticker, cik.", "example": "AAPL" }, { "name": "cik", "in": "query", "required": false, "schema": { "type": "string" }, "description": "One of: ticker, cik." }, { "name": "accessionNo", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "startDate", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "from", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "size", "in": "query", "required": false, "schema": { "type": "integer" }, "description": "Max 50" } ] }, "post": { "tags": [ "Governance, pay & audit datasets" ], "summary": "Regulatory red flags in a proxy: cover page status, filer status, listings, late Section 16 reports, auditor changes, po", "description": "Regulatory red flags in a proxy: cover page status, filer status, listings, late Section 16 reports, auditor changes, policy disclosures and listing deficiencies.\n\nFilters: data.=value.\n\nExample: `/v1/compliance-signals?ticker=AAPL`", "operationId": "postComplianceSignals", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "ticker": { "type": "string", "description": "One of: ticker, cik." }, "cik": { "type": "string", "description": "One of: ticker, cik." }, "accessionNo": { "type": "string" }, "startDate": { "type": "string" }, "endDate": { "type": "string" }, "from": { "type": "integer" }, "size": { "type": "integer", "description": "Max 50" } } } } } } } }, "/v1/vote-standards": { "get": { "tags": [ "Governance, pay & audit datasets" ], "summary": "What is on the ballot and how each item passes: record date, voting classes, quorum, election standard, per-item thresho", "description": "What is on the ballot and how each item passes: record date, voting classes, quorum, election standard, per-item thresholds and say-on-pay history.\n\nFilters: data.=value.\n\nExample: `/v1/vote-standards?ticker=AAPL`", "operationId": "getVoteStandards", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "ticker", "in": "query", "required": false, "schema": { "type": "string" }, "description": "One of: ticker, cik.", "example": "AAPL" }, { "name": "cik", "in": "query", "required": false, "schema": { "type": "string" }, "description": "One of: ticker, cik." }, { "name": "accessionNo", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "startDate", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "from", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "size", "in": "query", "required": false, "schema": { "type": "integer" }, "description": "Max 50" } ] }, "post": { "tags": [ "Governance, pay & audit datasets" ], "summary": "What is on the ballot and how each item passes: record date, voting classes, quorum, election standard, per-item thresho", "description": "What is on the ballot and how each item passes: record date, voting classes, quorum, election standard, per-item thresholds and say-on-pay history.\n\nFilters: data.=value.\n\nExample: `/v1/vote-standards?ticker=AAPL`", "operationId": "postVoteStandards", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "ticker": { "type": "string", "description": "One of: ticker, cik." }, "cik": { "type": "string", "description": "One of: ticker, cik." }, "accessionNo": { "type": "string" }, "startDate": { "type": "string" }, "endDate": { "type": "string" }, "from": { "type": "integer" }, "size": { "type": "integer", "description": "Max 50" } } } } } } } }, "/v1/shareholder-proposals-proxy-contests": { "get": { "tags": [ "Governance, pay & audit datasets" ], "summary": "Activism signals: contests and dissidents, shareholder proposals, nomination agreements, 13D holders, engagement, solici", "description": "Activism signals: contests and dissidents, shareholder proposals, nomination agreements, 13D holders, engagement, solicitation cost, deadlines and proxy access.\n\nFilters: data.=value.\n\nExample: `/v1/shareholder-proposals-proxy-contests?ticker=AAPL`", "operationId": "getShareholderProposalsProxyContests", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "ticker", "in": "query", "required": false, "schema": { "type": "string" }, "description": "One of: ticker, cik.", "example": "AAPL" }, { "name": "cik", "in": "query", "required": false, "schema": { "type": "string" }, "description": "One of: ticker, cik." }, { "name": "accessionNo", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "startDate", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "from", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "size", "in": "query", "required": false, "schema": { "type": "integer" }, "description": "Max 50" } ] }, "post": { "tags": [ "Governance, pay & audit datasets" ], "summary": "Activism signals: contests and dissidents, shareholder proposals, nomination agreements, 13D holders, engagement, solici", "description": "Activism signals: contests and dissidents, shareholder proposals, nomination agreements, 13D holders, engagement, solicitation cost, deadlines and proxy access.\n\nFilters: data.=value.\n\nExample: `/v1/shareholder-proposals-proxy-contests?ticker=AAPL`", "operationId": "postShareholderProposalsProxyContests", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "ticker": { "type": "string", "description": "One of: ticker, cik." }, "cik": { "type": "string", "description": "One of: ticker, cik." }, "accessionNo": { "type": "string" }, "startDate": { "type": "string" }, "endDate": { "type": "string" }, "from": { "type": "integer" }, "size": { "type": "integer", "description": "Max 50" } } } } } } } }, "/v1/insider-5pct-holder-ownership": { "get": { "tags": [ "Governance, pay & audit datasets" ], "summary": "Who owns the company: the beneficial ownership table, insider group totals, control, pledging and hedging rules, unveste", "description": "Who owns the company: the beneficial ownership table, insider group totals, control, pledging and hedging rules, unvested awards, holder agreements and fund holders.\n\nFilters: data.=value.\n\nExample: `/v1/insider-5pct-holder-ownership?ticker=AAPL`", "operationId": "getInsider5pctHolderOwnership", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "ticker", "in": "query", "required": false, "schema": { "type": "string" }, "description": "One of: ticker, cik.", "example": "AAPL" }, { "name": "cik", "in": "query", "required": false, "schema": { "type": "string" }, "description": "One of: ticker, cik." }, { "name": "accessionNo", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "startDate", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "from", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "size", "in": "query", "required": false, "schema": { "type": "integer" }, "description": "Max 50" } ] }, "post": { "tags": [ "Governance, pay & audit datasets" ], "summary": "Who owns the company: the beneficial ownership table, insider group totals, control, pledging and hedging rules, unveste", "description": "Who owns the company: the beneficial ownership table, insider group totals, control, pledging and hedging rules, unvested awards, holder agreements and fund holders.\n\nFilters: data.=value.\n\nExample: `/v1/insider-5pct-holder-ownership?ticker=AAPL`", "operationId": "postInsider5pctHolderOwnership", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "ticker": { "type": "string", "description": "One of: ticker, cik." }, "cik": { "type": "string", "description": "One of: ticker, cik." }, "accessionNo": { "type": "string" }, "startDate": { "type": "string" }, "endDate": { "type": "string" }, "from": { "type": "integer" }, "size": { "type": "integer", "description": "Max 50" } } } } } } } }, "/v1/fund-reorganizations": { "get": { "tags": [ "Governance, pay & audit datasets" ], "summary": "Fund proxy actions: participating funds, share and preferred classes, leverage, proposals, reorganizations, policy chang", "description": "Fund proxy actions: participating funds, share and preferred classes, leverage, proposals, reorganizations, policy changes and structural changes.\n\nFilters: data.=value.\n\nExample: `/v1/fund-reorganizations?ticker=AAPL`", "operationId": "getFundReorganizations", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "ticker", "in": "query", "required": false, "schema": { "type": "string" }, "description": "One of: ticker, cik.", "example": "AAPL" }, { "name": "cik", "in": "query", "required": false, "schema": { "type": "string" }, "description": "One of: ticker, cik." }, { "name": "accessionNo", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "startDate", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "from", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "size", "in": "query", "required": false, "schema": { "type": "integer" }, "description": "Max 50" } ] }, "post": { "tags": [ "Governance, pay & audit datasets" ], "summary": "Fund proxy actions: participating funds, share and preferred classes, leverage, proposals, reorganizations, policy chang", "description": "Fund proxy actions: participating funds, share and preferred classes, leverage, proposals, reorganizations, policy changes and structural changes.\n\nFilters: data.=value.\n\nExample: `/v1/fund-reorganizations?ticker=AAPL`", "operationId": "postFundReorganizations", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "ticker": { "type": "string", "description": "One of: ticker, cik." }, "cik": { "type": "string", "description": "One of: ticker, cik." }, "accessionNo": { "type": "string" }, "startDate": { "type": "string" }, "endDate": { "type": "string" }, "from": { "type": "integer" }, "size": { "type": "integer", "description": "Max 50" } } } } } } } }, "/v1/audit-reports/financial-statements": { "get": { "tags": [ "Governance, pay & audit datasets" ], "summary": "Structured facts from an independent auditor's opinion on financial statements: opinion, frameworks, going concern, expl", "description": "Structured facts from an independent auditor's opinion on financial statements: opinion, frameworks, going concern, explanatory paragraphs, CAMs and auditor details.\n\nFilters: data.=value.\n\nExample: `/v1/audit-reports/financial-statements?ticker=AAPL`", "operationId": "getAuditReportsFinancialStatements", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "ticker", "in": "query", "required": false, "schema": { "type": "string" }, "description": "One of: ticker, cik.", "example": "AAPL" }, { "name": "cik", "in": "query", "required": false, "schema": { "type": "string" }, "description": "One of: ticker, cik." }, { "name": "accessionNo", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "startDate", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "from", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "size", "in": "query", "required": false, "schema": { "type": "integer" }, "description": "Max 50" } ] }, "post": { "tags": [ "Governance, pay & audit datasets" ], "summary": "Structured facts from an independent auditor's opinion on financial statements: opinion, frameworks, going concern, expl", "description": "Structured facts from an independent auditor's opinion on financial statements: opinion, frameworks, going concern, explanatory paragraphs, CAMs and auditor details.\n\nFilters: data.=value.\n\nExample: `/v1/audit-reports/financial-statements?ticker=AAPL`", "operationId": "postAuditReportsFinancialStatements", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "ticker": { "type": "string", "description": "One of: ticker, cik." }, "cik": { "type": "string", "description": "One of: ticker, cik." }, "accessionNo": { "type": "string" }, "startDate": { "type": "string" }, "endDate": { "type": "string" }, "from": { "type": "integer" }, "size": { "type": "integer", "description": "Max 50" } } } } } } } }, "/v1/audit-reports/icfr": { "get": { "tags": [ "Governance, pay & audit datasets" ], "summary": "Structured facts from an independent auditor's opinion on internal control over financial reporting: framework, opinion,", "description": "Structured facts from an independent auditor's opinion on internal control over financial reporting: framework, opinion, material weaknesses and auditor details.\n\nFilters: data.=value.\n\nExample: `/v1/audit-reports/icfr?ticker=AAPL`", "operationId": "getAuditReportsIcfr", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "ticker", "in": "query", "required": false, "schema": { "type": "string" }, "description": "One of: ticker, cik.", "example": "AAPL" }, { "name": "cik", "in": "query", "required": false, "schema": { "type": "string" }, "description": "One of: ticker, cik." }, { "name": "accessionNo", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "startDate", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "from", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "size", "in": "query", "required": false, "schema": { "type": "integer" }, "description": "Max 50" } ] }, "post": { "tags": [ "Governance, pay & audit datasets" ], "summary": "Structured facts from an independent auditor's opinion on internal control over financial reporting: framework, opinion,", "description": "Structured facts from an independent auditor's opinion on internal control over financial reporting: framework, opinion, material weaknesses and auditor details.\n\nFilters: data.=value.\n\nExample: `/v1/audit-reports/icfr?ticker=AAPL`", "operationId": "postAuditReportsIcfr", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "ticker": { "type": "string", "description": "One of: ticker, cik." }, "cik": { "type": "string", "description": "One of: ticker, cik." }, "accessionNo": { "type": "string" }, "startDate": { "type": "string" }, "endDate": { "type": "string" }, "from": { "type": "integer" }, "size": { "type": "integer", "description": "Max 50" } } } } } } } }, "/v1/sec-enforcement-actions": { "get": { "tags": [ "Governance, pay & audit datasets" ], "summary": "One SEC enforcement press release: parties charged, allegations, settlement and penalties, relief sought, statutes, staf", "description": "One SEC enforcement press release: parties charged, allegations, settlement and penalties, relief sought, statutes, staff and cooperating agencies.\n\nFilters: data.=value.\n\nExample: `/v1/sec-enforcement-actions`", "operationId": "getSecEnforcementActions", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "startDate", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "from", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "size", "in": "query", "required": false, "schema": { "type": "integer" }, "description": "Max 50" } ] }, "post": { "tags": [ "Governance, pay & audit datasets" ], "summary": "One SEC enforcement press release: parties charged, allegations, settlement and penalties, relief sought, statutes, staf", "description": "One SEC enforcement press release: parties charged, allegations, settlement and penalties, relief sought, statutes, staff and cooperating agencies.\n\nFilters: data.=value.\n\nExample: `/v1/sec-enforcement-actions`", "operationId": "postSecEnforcementActions", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "startDate": { "type": "string" }, "endDate": { "type": "string" }, "from": { "type": "integer" }, "size": { "type": "integer", "description": "Max 50" } } } } } } } }, "/v1/audit-reports/content": { "get": { "tags": [ "Governance, pay & audit datasets" ], "summary": "Full text of one auditor's report", "description": "Full text of one auditor's report.\n\nExample: `/v1/audit-reports/content?id=`", "operationId": "getAuditReportsContent", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "query", "required": false, "schema": { "type": "string" }, "description": "From the audit reports APIs" } ] } }, "/v1/ipo": { "get": { "tags": [ "Offerings" ], "summary": "S-1, F-1, S-11, 424B4 with offering terms: shares, price, ticker, exchange, proceeds, underwriters", "description": "S-1, F-1, S-11, 424B4 with offering terms: shares, price, ticker, exchange, proceeds, underwriters.\n\nExample: `/v1/ipo?formType=424B4`", "operationId": "getIpo", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "formType", "in": "query", "required": false, "schema": { "type": "string" }, "example": "424B4" }, { "name": "cik", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "startDate", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "terms", "in": "query", "required": false, "schema": { "type": "string" } } ] } }, "/v1/form-d": { "get": { "tags": [ "Offerings" ], "summary": "Reg D private placements: flat fields (issuer, industry, offering and sold amounts, investors, exemptions, related perso", "description": "Reg D private placements: flat fields (issuer, industry, offering and sold amounts, investors, exemptions, related persons) plus every original field.\n\nFilters: flat.=value; flat.__gte/__lte; data.=value.\n\nExample: `/v1/form-d?flat.totalOfferingAmount__gte=10000000&fields=flat`", "operationId": "getFormD", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "cik", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "startDate", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "fields", "in": "query", "required": false, "schema": { "type": "string", "default": "flat" }, "example": "flat" } ] } }, "/v1/form-c": { "get": { "tags": [ "Offerings" ], "summary": "Reg CF crowdfunding offerings and reports", "description": "Reg CF crowdfunding offerings and reports.\n\nExample: `/v1/form-c`", "operationId": "getFormC", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "cik", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "startDate", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "required": false, "schema": { "type": "string" } } ] } }, "/v1/reg-a": { "get": { "tags": [ "Offerings" ], "summary": "Reg A: 1-A offerings, 1-K annual, 1-Z exit reports", "description": "Reg A: 1-A offerings, 1-K annual, 1-Z exit reports.\n\nExample: `/v1/reg-a`", "operationId": "getRegA", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "cik", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "startDate", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "formType", "in": "query", "required": false, "schema": { "type": "string" } } ] } }, "/v1/n-port": { "get": { "tags": [ "Funds, advisers & broker-dealers" ], "summary": "Fund portfolio holdings (N-PORT, every field)", "description": "Fund portfolio holdings (N-PORT, every field).\n\nExample: `/v1/n-port?startDate=2026-10-01`", "operationId": "getNPort", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "cik", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "startDate", "in": "query", "required": false, "schema": { "type": "string" }, "example": "2026-10-01" }, { "name": "endDate", "in": "query", "required": false, "schema": { "type": "string" } } ] } }, "/v1/n-cen": { "get": { "tags": [ "Funds, advisers & broker-dealers" ], "summary": "Fund annual census (N-CEN)", "description": "Fund annual census (N-CEN).\n\nExample: `/v1/n-cen`", "operationId": "getNCen", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "cik", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "startDate", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "required": false, "schema": { "type": "string" } } ] } }, "/v1/n-px": { "get": { "tags": [ "Funds, advisers & broker-dealers" ], "summary": "Proxy voting records (N-PX)", "description": "Proxy voting records (N-PX).\n\nExample: `/v1/n-px`", "operationId": "getNPx", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "cik", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "startDate", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "required": false, "schema": { "type": "string" } } ] } }, "/v1/form-adv/firms": { "get": { "tags": [ "Funds, advisers & broker-dealers" ], "summary": "Investment adviser firms: search, or one firm by CRD with registration, offices, filings, brochures", "description": "Investment adviser firms: search, or one firm by CRD with registration, offices, filings, brochures.\n\nExample: `/v1/form-adv/firms?crd=105958`", "operationId": "getFormAdvFirms", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "query", "in": "query", "required": false, "schema": { "type": "string" }, "description": "One of: query, crd." }, { "name": "crd", "in": "query", "required": false, "schema": { "type": "string" }, "description": "One of: query, crd.", "example": "105958" } ] } }, "/v1/form-adv/individuals": { "get": { "tags": [ "Funds, advisers & broker-dealers" ], "summary": "Investment adviser representatives", "description": "Investment adviser representatives.\n\nExample: `/v1/form-adv/individuals?query=john smith`", "operationId": "getFormAdvIndividuals", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "query", "in": "query", "required": false, "schema": { "type": "string" }, "description": "One of: query, crd.", "example": "john smith" }, { "name": "crd", "in": "query", "required": false, "schema": { "type": "string" }, "description": "One of: query, crd." } ] } }, "/v1/fund-fees": { "get": { "tags": [ "Funds, advisers & broker-dealers" ], "summary": "Fee tables for every series and share class: management fee, 12b-1, total and net expense ratios, sales charges, expense", "description": "Fee tables for every series and share class: management fee, 12b-1, total and net expense ratios, sales charges, expense examples.\n\nExample: `/v1/fund-fees?cik=36405`", "operationId": "getFundFees", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "cik", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Trust", "example": "36405" }, { "name": "accessionNo", "in": "query", "required": false, "schema": { "type": "string" } } ] } }, "/v1/x-17a-5": { "get": { "tags": [ "Funds, advisers & broker-dealers" ], "summary": "Broker-dealer annual reports: cover data and the audited report PDF", "description": "Broker-dealer annual reports: cover data and the audited report PDF.\n\nExample: `/v1/x-17a-5`", "operationId": "getX17a5", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "cik", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "startDate", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "required": false, "schema": { "type": "string" } } ] } }, "/v1/enforcement/litigation-releases": { "get": { "tags": [ "Enforcement & regulatory" ], "summary": "SEC civil actions filed in federal court", "description": "SEC civil actions filed in federal court.\n\nExample: `/v1/enforcement/litigation-releases`", "operationId": "getEnforcementLitigationReleases", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "page", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "details", "in": "query", "required": false, "schema": { "type": "string", "default": "true" } } ] } }, "/v1/enforcement/administrative-proceedings": { "get": { "tags": [ "Enforcement & regulatory" ], "summary": "SEC administrative orders and proceedings", "description": "SEC administrative orders and proceedings.\n\nExample: `/v1/enforcement/administrative-proceedings`", "operationId": "getEnforcementAdministrativeProceedings", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "page", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "details", "in": "query", "required": false, "schema": { "type": "string", "default": "true" } } ] } }, "/v1/enforcement/aaer": { "get": { "tags": [ "Enforcement & regulatory" ], "summary": "Accounting and Auditing Enforcement Releases", "description": "Accounting and Auditing Enforcement Releases.\n\nExample: `/v1/enforcement/aaer`", "operationId": "getEnforcementAaer", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "page", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "details", "in": "query", "required": false, "schema": { "type": "string", "default": "true" } } ] } }, "/v1/enforcement/press-releases": { "get": { "tags": [ "Enforcement & regulatory" ], "summary": "SEC press releases, including enforcement actions", "description": "SEC press releases, including enforcement actions.\n\nExample: `/v1/enforcement/press-releases`", "operationId": "getEnforcementPressReleases", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "page", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "details", "in": "query", "required": false, "schema": { "type": "string", "default": "true" } } ] } }, "/v1/enforcement/sro-filings": { "get": { "tags": [ "Enforcement & regulatory" ], "summary": "SRO rule filings: FINRA, MSRB, DTC, exchanges, clearing agencies", "description": "SRO rule filings: FINRA, MSRB, DTC, exchanges, clearing agencies. Omit org to list them.\n\nExample: `/v1/enforcement/sro-filings?org=finra`", "operationId": "getEnforcementSroFilings", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "org", "in": "query", "required": false, "schema": { "type": "string" }, "example": "finra" }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer" } } ] } }, "/v1/mapping/ticker": { "get": { "tags": [ "Reference" ], "summary": "Ticker to CIK, name, exchange", "description": "Ticker to CIK, name, exchange.\n\nExample: `/v1/mapping/ticker?ticker=BRK-B`", "operationId": "getMappingTicker", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "ticker", "in": "query", "required": false, "schema": { "type": "string" }, "example": "BRK-B" } ] } }, "/v1/mapping/cik": { "get": { "tags": [ "Reference" ], "summary": "CIK to tickers", "description": "CIK to tickers.\n\nExample: `/v1/mapping/cik?cik=320193`", "operationId": "getMappingCik", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "cik", "in": "query", "required": false, "schema": { "type": "string" }, "example": "320193" } ] } }, "/v1/mapping/cusip": { "get": { "tags": [ "Reference" ], "summary": "CUSIP to issuer and ticker", "description": "CUSIP to issuer and ticker.\n\nExample: `/v1/mapping/cusip?cusip=743315103`", "operationId": "getMappingCusip", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "cusip", "in": "query", "required": false, "schema": { "type": "string" }, "example": "743315103" } ] } }, "/v1/mapping/name": { "get": { "tags": [ "Reference" ], "summary": "Company name search", "description": "Company name search.\n\nExample: `/v1/mapping/name?name=apple`", "operationId": "getMappingName", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "name", "in": "query", "required": false, "schema": { "type": "string" }, "example": "apple" } ] } }, "/v1/mapping/exchange": { "get": { "tags": [ "Reference" ], "summary": "Every listed company on an exchange", "description": "Every listed company on an exchange.\n\nExample: `/v1/mapping/exchange?exchange=NYSE`", "operationId": "getMappingExchange", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "exchange", "in": "query", "required": false, "schema": { "type": "string" }, "description": "NYSE, Nasdaq, CBOE, OTC", "example": "NYSE" } ] } }, "/v1/mapping/sic": { "get": { "tags": [ "Reference" ], "summary": "Companies by SIC industry code", "description": "Companies by SIC industry code.\n\nExample: `/v1/mapping/sic?sic=3674`", "operationId": "getMappingSic", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "sic", "in": "query", "required": false, "schema": { "type": "string" }, "example": "3674" }, { "name": "from", "in": "query", "required": false, "schema": { "type": "integer" } } ] } }, "/mcp": { "post": { "tags": [ "AI agents" ], "summary": "MCP server over HTTP (JSON-RPC)", "description": "MCP server over HTTP (JSON-RPC). Or run locally over stdio: python3 -m fw.mcp. 28 tools covering every API above.\n\nExample: `/mcp`\n\ninitialize, tools/list and ping need no API key; tools/call does.", "operationId": "postMcp", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "jsonrpc": { "type": "string", "enum": [ "2.0" ] }, "id": {}, "method": { "type": "string" }, "params": { "type": "object" } } } } } } } } }, "components": { "schemas": { "Error": { "type": "object", "properties": { "error": { "type": "string" } }, "required": [ "error" ] } } } }