{ "openapi": "3.1.0", "info": { "title": "Corpus API", "description": "Point-in-time financial and governed-document data for the US and India.", "version": "2026-07-20" }, "paths": { "/catalog": { "get": { "tags": [ "Catalog" ], "summary": "Catalog", "operationId": "catalog_catalog_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogResponse" } } } } }, "security": [] } }, "/us/companies": { "get": { "tags": [ "US \u00b7 Companies" ], "summary": "Us Companies", "operationId": "us_companies_us_companies_get", "parameters": [ { "name": "ticker", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ticker" } }, { "name": "as_of", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "As Of" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 2000, "minimum": 1, "default": 100, "title": "Limit" } }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 0, "title": "Offset" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompaniesResponse" } } } }, "400": { "description": "Invalid parameter combination", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Insufficient jurisdiction or scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Unknown resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Request schema validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "503": { "description": "Source content is unavailable or still processing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "X-API-KEY": [] } ] } }, "/us/companies/{cik}": { "get": { "tags": [ "US \u00b7 Companies" ], "summary": "Us Company", "operationId": "us_company_us_companies__cik__get", "parameters": [ { "name": "cik", "in": "path", "required": true, "schema": { "type": "string", "title": "Cik" } }, { "name": "as_of", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "As Of" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyResponse" } } } }, "400": { "description": "Invalid parameter combination", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Insufficient jurisdiction or scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Unknown resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Request schema validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "503": { "description": "Source content is unavailable or still processing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "X-API-KEY": [] } ] } }, "/us/prices": { "get": { "tags": [ "US \u00b7 Prices" ], "summary": "Us Prices", "operationId": "us_prices_us_prices_get", "parameters": [ { "name": "ticker", "in": "query", "required": true, "schema": { "type": "string", "title": "Ticker" } }, { "name": "as_of", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "As Of" } }, { "name": "start_date", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "Start Date" } }, { "name": "end_date", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "End Date" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 10000, "minimum": 1, "default": 5000, "title": "Limit" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/USPricesResponse" } } } }, "400": { "description": "Invalid parameter combination", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Insufficient jurisdiction or scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Unknown resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Request schema validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "503": { "description": "Source content is unavailable or still processing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "X-API-KEY": [] } ] } }, "/us/financials": { "get": { "tags": [ "US \u00b7 Financial Statements" ], "summary": "Us Financials", "operationId": "us_financials_us_financials_get", "parameters": [ { "name": "ticker", "in": "query", "required": true, "schema": { "type": "string", "title": "Ticker" } }, { "name": "as_of", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "As Of" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 200, "minimum": 1, "default": 40, "title": "Limit" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FinancialsResponse" } } } }, "400": { "description": "Invalid parameter combination", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Insufficient jurisdiction or scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Unknown resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Request schema validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "503": { "description": "Source content is unavailable or still processing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "X-API-KEY": [] } ] } }, "/us/financials/income-statements": { "get": { "tags": [ "US \u00b7 financials" ], "summary": "Us Income", "operationId": "us_income_us_financials_income_statements_get", "parameters": [ { "name": "ticker", "in": "query", "required": true, "schema": { "type": "string", "title": "Ticker" } }, { "name": "as_of", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "As Of" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 200, "minimum": 1, "default": 40, "title": "Limit" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IncomeStatementsResponse" } } } }, "400": { "description": "Invalid parameter combination", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Insufficient jurisdiction or scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Unknown resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Request schema validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "503": { "description": "Source content is unavailable or still processing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "X-API-KEY": [] } ] } }, "/us/financials/balance-sheets": { "get": { "tags": [ "US \u00b7 financials" ], "summary": "Us Balance", "operationId": "us_balance_us_financials_balance_sheets_get", "parameters": [ { "name": "ticker", "in": "query", "required": true, "schema": { "type": "string", "title": "Ticker" } }, { "name": "as_of", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "As Of" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 200, "minimum": 1, "default": 40, "title": "Limit" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BalanceSheetsResponse" } } } }, "400": { "description": "Invalid parameter combination", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Insufficient jurisdiction or scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Unknown resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Request schema validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "503": { "description": "Source content is unavailable or still processing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "X-API-KEY": [] } ] } }, "/us/financials/cash-flow-statements": { "get": { "tags": [ "US \u00b7 financials" ], "summary": "Us Cash Flow", "operationId": "us_cash_flow_us_financials_cash_flow_statements_get", "parameters": [ { "name": "ticker", "in": "query", "required": true, "schema": { "type": "string", "title": "Ticker" } }, { "name": "as_of", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "As Of" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 200, "minimum": 1, "default": 40, "title": "Limit" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CashFlowStatementsResponse" } } } }, "400": { "description": "Invalid parameter combination", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Insufficient jurisdiction or scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Unknown resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Request schema validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "503": { "description": "Source content is unavailable or still processing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "X-API-KEY": [] } ] } }, "/us/financials/as-reported": { "get": { "tags": [ "US \u00b7 Financial Statements" ], "summary": "Us As Reported", "operationId": "us_as_reported_us_financials_as_reported_get", "parameters": [ { "name": "ticker", "in": "query", "required": true, "schema": { "type": "string", "title": "Ticker" } }, { "name": "as_of", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "As Of" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 200, "minimum": 1, "default": 40, "title": "Limit" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AsReportedResponse" } } } }, "400": { "description": "Invalid parameter combination", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Insufficient jurisdiction or scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Unknown resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Request schema validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "503": { "description": "Source content is unavailable or still processing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "X-API-KEY": [] } ] } }, "/us/fundamentals/ledger": { "get": { "tags": [ "US \u00b7 Financial Statements" ], "summary": "Us Ledger", "operationId": "us_ledger_us_fundamentals_ledger_get", "parameters": [ { "name": "ticker", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ticker" } }, { "name": "cik", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cik" } }, { "name": "concept", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Concept" } }, { "name": "statement", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Statement" } }, { "name": "as_of", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "As Of" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 50000, "minimum": 1, "default": 1000, "title": "Limit" } }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 0, "title": "Offset" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FundamentalLedgerResponse" } } } }, "400": { "description": "Invalid parameter combination", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Insufficient jurisdiction or scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Unknown resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Request schema validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "503": { "description": "Source content is unavailable or still processing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "X-API-KEY": [] } ] } }, "/us/filings/items": { "get": { "tags": [ "US \u00b7 SEC Filings" ], "summary": "Us Filing Items", "operationId": "us_filing_items_us_filings_items_get", "parameters": [ { "name": "ticker", "in": "query", "required": true, "schema": { "type": "string", "title": "Ticker" } }, { "name": "filing_type", "in": "query", "required": true, "schema": { "type": "string", "title": "Filing Type" } }, { "name": "year", "in": "query", "required": true, "schema": { "type": "integer", "title": "Year" } }, { "name": "quarter", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer", "maximum": 4, "minimum": 1 }, { "type": "null" } ], "title": "Quarter" } }, { "name": "item", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Item" } }, { "name": "accession_number", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Accession Number" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FilingItemsResponse" } } } }, "400": { "description": "Invalid parameter combination", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Insufficient jurisdiction or scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Unknown resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Request schema validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "503": { "description": "Source content is unavailable or still processing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FilingProcessingErrorResponse" } } } } }, "security": [ { "X-API-KEY": [] } ] } }, "/us/filings": { "get": { "tags": [ "US \u00b7 SEC Filings" ], "summary": "Us Filings", "operationId": "us_filings_us_filings_get", "parameters": [ { "name": "ticker", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ticker" } }, { "name": "cik", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cik" } }, { "name": "accession_number", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Accession Number" } }, { "name": "filing_type", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "title": "Filing Type" } }, { "name": "filing_date_start", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "Filing Date Start" } }, { "name": "filing_date_end", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "Filing Date End" } }, { "name": "report_date_start", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "Report Date Start" } }, { "name": "report_date_end", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "Report Date End" } }, { "name": "as_of", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "As Of" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 1000, "minimum": 1, "default": 100, "title": "Limit" } }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 0, "title": "Offset" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/USFilingsResponse" } } } }, "400": { "description": "Invalid parameter combination", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Insufficient jurisdiction or scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Unknown resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Request schema validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "503": { "description": "Source content is unavailable or still processing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FilingProcessingErrorResponse" } } } } }, "security": [ { "X-API-KEY": [] } ] } }, "/us/filings/{accession_number}": { "get": { "tags": [ "US \u00b7 SEC Filings" ], "summary": "Us Filing", "operationId": "us_filing_us_filings__accession_number__get", "parameters": [ { "name": "accession_number", "in": "path", "required": true, "schema": { "type": "string", "title": "Accession Number" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/USFilingResponse" } } } }, "400": { "description": "Invalid parameter combination", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Insufficient jurisdiction or scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Unknown resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Request schema validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "503": { "description": "Source content is unavailable or still processing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FilingProcessingErrorResponse" } } } } }, "security": [ { "X-API-KEY": [] } ] } }, "/us/filings/{accession_number}/content": { "get": { "tags": [ "US \u00b7 filings" ], "summary": "Us Filing Content", "operationId": "us_filing_content_us_filings__accession_number__content_get", "parameters": [ { "name": "accession_number", "in": "path", "required": true, "schema": { "type": "string", "title": "Accession Number" } }, { "name": "format", "in": "query", "required": false, "schema": { "type": "string", "pattern": "^(normalized|raw)$", "default": "normalized", "title": "Format" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FilingContentResponse" } } } }, "400": { "description": "Invalid parameter combination", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Insufficient jurisdiction or scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Unknown resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Request schema validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "503": { "description": "Source content is unavailable or still processing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FilingProcessingErrorResponse" } } } } }, "security": [ { "X-API-KEY": [] } ] } }, "/us/filings/{accession_number}/index": { "get": { "tags": [ "US \u00b7 filings" ], "summary": "Us Filing Index", "operationId": "us_filing_index_us_filings__accession_number__index_get", "parameters": [ { "name": "accession_number", "in": "path", "required": true, "schema": { "type": "string", "title": "Accession Number" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FilingFilesResponse" } } } }, "400": { "description": "Invalid parameter combination", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Insufficient jurisdiction or scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Unknown resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Request schema validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "503": { "description": "Source content is unavailable or still processing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FilingProcessingErrorResponse" } } } } }, "security": [ { "X-API-KEY": [] } ] } }, "/us/filings/{accession_number}/xbrl": { "get": { "tags": [ "US \u00b7 filings" ], "summary": "Us Filing Xbrl", "operationId": "us_filing_xbrl_us_filings__accession_number__xbrl_get", "parameters": [ { "name": "accession_number", "in": "path", "required": true, "schema": { "type": "string", "title": "Accession Number" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FilingFilesResponse" } } } }, "400": { "description": "Invalid parameter combination", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Insufficient jurisdiction or scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Unknown resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Request schema validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "503": { "description": "Source content is unavailable or still processing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FilingProcessingErrorResponse" } } } } }, "security": [ { "X-API-KEY": [] } ] } }, "/us/insider-transactions": { "get": { "tags": [ "US \u00b7 ownership" ], "summary": "Us Insider Transactions", "operationId": "us_insider_transactions_us_insider_transactions_get", "parameters": [ { "name": "accession_number", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Accession Number" } }, { "name": "ticker", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ticker" } }, { "name": "issuer_cik", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Issuer Cik" } }, { "name": "reporting_owner_cik", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Reporting Owner Cik" } }, { "name": "start_date", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "Start Date" } }, { "name": "end_date", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "End Date" } }, { "name": "transaction_code", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Transaction Code" } }, { "name": "acquired_disposed", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "pattern": "^[AD]$" }, { "type": "null" } ], "title": "Acquired Disposed" } }, { "name": "is_derivative", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Derivative" } }, { "name": "as_of", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "As Of" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 1000, "minimum": 1, "default": 100, "title": "Limit" } }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 0, "title": "Offset" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InsiderTransactionsResponse" } } } }, "400": { "description": "Invalid parameter combination", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Insufficient jurisdiction or scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Unknown resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Request schema validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "503": { "description": "Source content is unavailable or still processing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "X-API-KEY": [] } ] } }, "/us/institutional-holdings": { "get": { "tags": [ "US \u00b7 ownership" ], "summary": "Us Institutional Holdings", "operationId": "us_institutional_holdings_us_institutional_holdings_get", "parameters": [ { "name": "accession_number", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Accession Number" } }, { "name": "manager_cik", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Manager Cik" } }, { "name": "cusip", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cusip" } }, { "name": "start_date", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "Start Date" } }, { "name": "end_date", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "End Date" } }, { "name": "put_call", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "pattern": "^(PUT|CALL)$" }, { "type": "null" } ], "title": "Put Call" } }, { "name": "as_of", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "As Of" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 1000, "minimum": 1, "default": 100, "title": "Limit" } }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 0, "title": "Offset" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InstitutionalHoldingsResponse" } } } }, "400": { "description": "Invalid parameter combination", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Insufficient jurisdiction or scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Unknown resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Request schema validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "503": { "description": "Source content is unavailable or still processing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "X-API-KEY": [] } ] } }, "/us/edgar-research/coverage": { "get": { "tags": [ "US \u00b7 ownership" ], "summary": "Us Edgar Research Coverage", "description": "Coverage ledger for the normalized Form 4 and Form 13F API resources.", "operationId": "us_edgar_research_coverage_us_edgar_research_coverage_get", "parameters": [ { "name": "as_of", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "As Of" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EdgarResearchCoverageResponse" } } } }, "400": { "description": "Invalid parameter combination", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Insufficient jurisdiction or scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Unknown resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Request schema validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "503": { "description": "Source content is unavailable or still processing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "X-API-KEY": [] } ] } }, "/us/corporate-events": { "get": { "tags": [ "US \u00b7 events" ], "summary": "Us Corporate Events", "operationId": "us_corporate_events_us_corporate_events_get", "parameters": [ { "name": "ticker", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ticker" } }, { "name": "issuer_cik", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Issuer Cik" } }, { "name": "item_number", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Item Number" } }, { "name": "start_date", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "Start Date" } }, { "name": "end_date", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "End Date" } }, { "name": "as_of", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "As Of" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 1000, "minimum": 1, "default": 100, "title": "Limit" } }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 0, "title": "Offset" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CorporateEventsResponse" } } } }, "400": { "description": "Invalid parameter combination", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Insufficient jurisdiction or scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Unknown resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Request schema validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "503": { "description": "Source content is unavailable or still processing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "X-API-KEY": [] } ] } }, "/us/search": { "post": { "tags": [ "US \u00b7 Search" ], "summary": "Us Search", "operationId": "us_search_us_search_post", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/USSearchRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/USSearchResponse" } } } }, "400": { "description": "Invalid parameter combination", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Insufficient jurisdiction or scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Unknown resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Request schema validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "503": { "description": "Source content is unavailable or still processing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "X-API-KEY": [] } ] } }, "/india/securities": { "get": { "tags": [ "India \u00b7 Securities" ], "summary": "India Securities", "operationId": "india_securities_india_securities_get", "parameters": [ { "name": "isin", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Isin" } }, { "name": "as_of", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "As Of" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 2000, "minimum": 1, "default": 100, "title": "Limit" } }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 0, "title": "Offset" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecuritiesResponse" } } } }, "400": { "description": "Invalid parameter combination", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Insufficient jurisdiction or scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Unknown resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Request schema validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "503": { "description": "Source content is unavailable or still processing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "X-API-KEY": [] } ] } }, "/india/securities/{isin}": { "get": { "tags": [ "India \u00b7 Securities" ], "summary": "India Security", "operationId": "india_security_india_securities__isin__get", "parameters": [ { "name": "isin", "in": "path", "required": true, "schema": { "type": "string", "title": "Isin" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecurityResponse" } } } }, "400": { "description": "Invalid parameter combination", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Insufficient jurisdiction or scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Unknown resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Request schema validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "503": { "description": "Source content is unavailable or still processing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "X-API-KEY": [] } ] } }, "/india/prices": { "get": { "tags": [ "India \u00b7 Prices" ], "summary": "India Prices", "operationId": "india_prices_india_prices_get", "parameters": [ { "name": "isin", "in": "query", "required": true, "schema": { "type": "string", "title": "Isin" } }, { "name": "as_of", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "As Of" } }, { "name": "start_date", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "Start Date" } }, { "name": "end_date", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "End Date" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 10000, "minimum": 1, "default": 5000, "title": "Limit" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IndiaPricesResponse" } } } }, "400": { "description": "Invalid parameter combination", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Insufficient jurisdiction or scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Unknown resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Request schema validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "503": { "description": "Source content is unavailable or still processing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "X-API-KEY": [] } ] } }, "/india/filings": { "get": { "tags": [ "India \u00b7 Annual Reports" ], "summary": "India Filings", "operationId": "india_filings_india_filings_get", "parameters": [ { "name": "company", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Company" } }, { "name": "year", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Year" } }, { "name": "as_of", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "As Of" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 1000, "minimum": 1, "default": 100, "title": "Limit" } }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 0, "title": "Offset" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IndiaFilingsResponse" } } } }, "400": { "description": "Invalid parameter combination", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Insufficient jurisdiction or scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Unknown resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Request schema validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "503": { "description": "Source content is unavailable or still processing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "X-API-KEY": [] } ] } }, "/india/filings/{artifact_id}": { "get": { "tags": [ "India \u00b7 Annual Reports" ], "summary": "India Filing", "operationId": "india_filing_india_filings__artifact_id__get", "parameters": [ { "name": "artifact_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Artifact Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IndiaFilingResponse" } } } }, "400": { "description": "Invalid parameter combination", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Insufficient jurisdiction or scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Unknown resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Request schema validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "503": { "description": "Source content is unavailable or still processing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "X-API-KEY": [] } ] } }, "/india/filings/{artifact_id}/text": { "get": { "tags": [ "India \u00b7 Annual Reports" ], "summary": "India Filing Text", "operationId": "india_filing_text_india_filings__artifact_id__text_get", "parameters": [ { "name": "artifact_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Artifact Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IndiaFilingTextResponse" } } } }, "400": { "description": "Invalid parameter combination", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Insufficient jurisdiction or scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Unknown resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Request schema validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "503": { "description": "Source content is unavailable or still processing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "X-API-KEY": [] } ] } }, "/india/filings/{artifact_id}/pdf": { "get": { "tags": [ "India \u00b7 Annual Reports" ], "summary": "India Filing Pdf", "operationId": "india_filing_pdf_india_filings__artifact_id__pdf_get", "parameters": [ { "name": "artifact_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Artifact Id" } } ], "responses": { "200": { "description": "The source annual-report PDF.", "content": { "application/pdf": { "schema": { "type": "string", "format": "binary" } } } }, "400": { "description": "Invalid parameter combination", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Insufficient jurisdiction or scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Unknown resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Request schema validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "503": { "description": "Source content is unavailable or still processing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "X-API-KEY": [] } ] } }, "/india/news/categories": { "get": { "tags": [ "India \u00b7 News" ], "summary": "India News Categories", "operationId": "india_news_categories_india_news_categories_get", "parameters": [ { "name": "as_of", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "As Of" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CategoriesResponse" } } } }, "400": { "description": "Invalid parameter combination", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Insufficient jurisdiction or scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Unknown resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Request schema validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "503": { "description": "Source content is unavailable or still processing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "X-API-KEY": [] } ] } }, "/india/news": { "get": { "tags": [ "India \u00b7 News" ], "summary": "India News", "operationId": "india_news_india_news_get", "parameters": [ { "name": "category", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Category" } }, { "name": "as_of", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "As Of" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 1000, "minimum": 1, "default": 100, "title": "Limit" } }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 0, "title": "Offset" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewsResponse" } } } }, "400": { "description": "Invalid parameter combination", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Insufficient jurisdiction or scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Unknown resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Request schema validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "503": { "description": "Source content is unavailable or still processing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "X-API-KEY": [] } ] } }, "/india/judgments/courts": { "get": { "tags": [ "India \u00b7 Judgments" ], "summary": "India Judgment Courts", "operationId": "india_judgment_courts_india_judgments_courts_get", "parameters": [ { "name": "court_level", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Court Level" } }, { "name": "as_of", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "As Of" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CategoriesResponse" } } } }, "400": { "description": "Invalid parameter combination", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Insufficient jurisdiction or scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Unknown resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Request schema validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "503": { "description": "Source content is unavailable or still processing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "X-API-KEY": [] } ] } }, "/india/judgments": { "get": { "tags": [ "India \u00b7 Judgments" ], "summary": "India Judgments", "operationId": "india_judgments_india_judgments_get", "parameters": [ { "name": "court_level", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Court Level" } }, { "name": "court", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Court" } }, { "name": "year", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Year" } }, { "name": "query", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Query" } }, { "name": "as_of", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "As Of" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 1000, "minimum": 1, "default": 100, "title": "Limit" } }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 0, "title": "Offset" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JudgmentsResponse" } } } }, "400": { "description": "Invalid parameter combination", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Insufficient jurisdiction or scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Unknown resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Request schema validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "503": { "description": "Source content is unavailable or still processing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "X-API-KEY": [] } ] } }, "/india/judgments/{judgment_id}": { "get": { "tags": [ "India \u00b7 Judgments" ], "summary": "India Judgment", "operationId": "india_judgment_india_judgments__judgment_id__get", "parameters": [ { "name": "judgment_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Judgment Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JudgmentResponse" } } } }, "400": { "description": "Invalid parameter combination", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Insufficient jurisdiction or scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Unknown resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Request schema validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "503": { "description": "Source content is unavailable or still processing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "X-API-KEY": [] } ] } }, "/india/judgments/{judgment_id}/text": { "get": { "tags": [ "India \u00b7 Judgments" ], "summary": "India Judgment Text", "operationId": "india_judgment_text_india_judgments__judgment_id__text_get", "parameters": [ { "name": "judgment_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Judgment Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IndiaJudgmentTextResponse" } } } }, "400": { "description": "Invalid parameter combination", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Insufficient jurisdiction or scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Unknown resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Request schema validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "503": { "description": "Source content is unavailable or still processing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "X-API-KEY": [] } ] } }, "/india/judgments/{judgment_id}/pdf": { "get": { "tags": [ "India \u00b7 Judgments" ], "summary": "India Judgment Pdf", "operationId": "india_judgment_pdf_india_judgments__judgment_id__pdf_get", "parameters": [ { "name": "judgment_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Judgment Id" } } ], "responses": { "200": { "description": "The source judgment PDF.", "content": { "application/pdf": { "schema": { "type": "string", "format": "binary" } } } }, "400": { "description": "Invalid parameter combination", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Insufficient jurisdiction or scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Unknown resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Request schema validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "503": { "description": "Source content is unavailable or still processing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "X-API-KEY": [] } ] } }, "/india/search": { "post": { "tags": [ "India \u00b7 Search" ], "summary": "India Search", "operationId": "india_search_india_search_post", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IndiaSearchRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IndiaSearchResponse" } } } }, "400": { "description": "Invalid parameter combination", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Insufficient jurisdiction or scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Unknown resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Request schema validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "503": { "description": "Source content is unavailable or still processing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "X-API-KEY": [] } ] } }, "/india/exports": { "post": { "tags": [ "India \u00b7 Exports" ], "summary": "Export Query", "description": "Run a constrained string query and stream the result as an Excel workbook (or CSV/Parquet).\n\nauth(india:read + data:export) -> OPA(export prices) -> as-of lakehouse read -> legal_basis drop ->\nproject -> serialize. The default ``fmt=xlsx`` is the analyst surface (SPEC.md \u00a78\n\"Query -> Excel\"); ``csv``/``parquet`` are the same panel in other encodings.", "operationId": "export_query_india_exports_post", "parameters": [ { "name": "q", "in": "query", "required": true, "schema": { "type": "string", "description": "Constrained string query, e.g. 'prices isin=INE_AAA,INE_BBB start=2020-01-01 end=2020-12-31 columns=close,volume'.", "title": "Q" }, "description": "Constrained string query, e.g. 'prices isin=INE_AAA,INE_BBB start=2020-01-01 end=2020-12-31 columns=close,volume'." }, { "name": "fmt", "in": "query", "required": false, "schema": { "enum": [ "xlsx", "csv", "parquet" ], "type": "string", "default": "xlsx", "title": "Fmt" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 200000, "minimum": 1, "default": 50000, "title": "Limit" } } ], "responses": { "200": { "description": "Governed export bytes in the requested format.", "content": { "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "type": "string", "format": "binary" } }, "text/csv": { "schema": { "type": "string", "format": "binary" } }, "application/vnd.apache.parquet": { "schema": { "type": "string", "format": "binary" } } } }, "422": { "description": "Request schema validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "400": { "description": "Invalid parameter combination", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Insufficient jurisdiction or scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Unknown resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "503": { "description": "Source content is unavailable or still processing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "X-API-KEY": [] } ] } }, "/india/prices.csv": { "get": { "tags": [ "India \u00b7 Exports" ], "summary": "Prices Csv", "description": "Convenience GET that streams as-of prices straight to CSV (no string query to compose).\n\nSame edge contract and bitemporal as-of semantics as ``POST /india/exports``; the constraints are\nstructured query params instead of a string query. Handy for ``curl``/spreadsheet ``=IMPORTDATA``.", "operationId": "prices_csv_india_prices_csv_get", "parameters": [ { "name": "isin", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Restrict to these ISINs (repeatable). Omit for all ISINs.", "title": "Isin" }, "description": "Restrict to these ISINs (repeatable). Omit for all ISINs." }, { "name": "start", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "description": "Inclusive trade_date lower bound (YYYY-MM-DD).", "title": "Start" }, "description": "Inclusive trade_date lower bound (YYYY-MM-DD)." }, { "name": "end", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "description": "Inclusive trade_date upper bound (YYYY-MM-DD).", "title": "End" }, "description": "Inclusive trade_date upper bound (YYYY-MM-DD)." }, { "name": "as_of", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "description": "Knowledge-time cutoff (YYYY-MM-DD). Default: today (latest known).", "title": "As Of" }, "description": "Knowledge-time cutoff (YYYY-MM-DD). Default: today (latest known)." }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 200000, "minimum": 1, "default": 50000, "title": "Limit" } } ], "responses": { "200": { "description": "Governed India price rows as CSV.", "content": { "text/csv": { "schema": { "type": "string", "format": "binary" } } } }, "422": { "description": "Request schema validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "400": { "description": "Invalid parameter combination", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Insufficient jurisdiction or scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Unknown resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "503": { "description": "Source content is unavailable or still processing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "X-API-KEY": [] } ] } }, "/ask": { "post": { "tags": [ "Search" ], "summary": "Ask Endpoint", "description": "Plan tool calls over the governed read surface, execute them under the as-of/trust gate,\nand synthesize a cited answer through the shared Corpus API runtime.", "operationId": "ask_endpoint_ask_post", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AskRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AskResponse" } } } }, "422": { "description": "Request schema validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "400": { "description": "Invalid parameter combination", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Insufficient jurisdiction or scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Unknown resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "503": { "description": "Source content is unavailable or still processing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "X-API-KEY": [] } ] } } }, "components": { "schemas": { "AsReportedResponse": { "properties": { "as_reported_statements": { "items": { "$ref": "#/components/schemas/AsReportedStatement" }, "type": "array", "title": "As Reported Statements" }, "meta": { "$ref": "#/components/schemas/Meta" } }, "type": "object", "required": [ "as_reported_statements", "meta" ], "title": "AsReportedResponse" }, "AsReportedStatement": { "properties": { "ticker": { "type": "string", "title": "Ticker" }, "accession_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Accession Number" }, "report_period": { "type": "string", "format": "date", "title": "Report Period" }, "statement": { "type": "string", "title": "Statement" }, "line_items": { "items": { "additionalProperties": true, "type": "object" }, "type": "array", "title": "Line Items" } }, "type": "object", "required": [ "ticker", "report_period", "statement", "line_items" ], "title": "AsReportedStatement" }, "AskRequest": { "properties": { "q": { "type": "string", "minLength": 1, "title": "Q", "description": "Natural-language question." }, "as_of": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "As Of", "description": "As-of knowledge cutoff (UTC). Default: now (latest known)." }, "market": { "anyOf": [ { "type": "string", "enum": [ "IN", "US" ] }, { "type": "null" } ], "title": "Market", "description": "Jurisdiction to query. Omit only for an explicitly cross-jurisdiction request; the credential must then carry both us:read and india:read." } }, "type": "object", "required": [ "q" ], "title": "AskRequest" }, "AskResponse": { "properties": { "answer": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Answer" }, "planner": { "type": "string", "enum": [ "llm", "fallback" ], "title": "Planner" }, "model": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Model" }, "as_of": { "type": "string", "format": "date-time", "title": "As Of" }, "steps": { "items": { "additionalProperties": true, "type": "object" }, "type": "array", "title": "Steps" }, "data": { "items": { "additionalProperties": true, "type": "object" }, "type": "array", "title": "Data" }, "citations": { "items": { "additionalProperties": true, "type": "object" }, "type": "array", "title": "Citations" }, "note": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Note" } }, "type": "object", "required": [ "answer", "planner", "as_of", "steps", "data", "citations" ], "title": "AskResponse" }, "BalanceSheet": { "properties": { "ticker": { "type": "string", "title": "Ticker" }, "report_period": { "type": "string", "format": "date", "title": "Report Period" }, "fiscal_period": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Fiscal Period" }, "period": { "anyOf": [ { "type": "string", "enum": [ "annual", "quarterly", "ttm" ] }, { "type": "null" } ], "title": "Period" }, "currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Currency" }, "accession_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Accession Number" }, "filing_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Filing Url" }, "filing_date": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "Filing Date" }, "filing_datetime": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Filing Datetime" }, "assets": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Assets" }, "current_assets": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Current Assets" }, "cash_and_equivalents": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Cash And Equivalents" }, "inventory": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Inventory" }, "liabilities": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Liabilities" }, "current_liabilities": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Current Liabilities" }, "long_term_debt": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Long Term Debt" }, "shareholders_equity": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Shareholders Equity" } }, "type": "object", "required": [ "ticker", "report_period" ], "title": "BalanceSheet" }, "BalanceSheetsResponse": { "properties": { "balance_sheets": { "items": { "$ref": "#/components/schemas/BalanceSheet" }, "type": "array", "title": "Balance Sheets" }, "meta": { "$ref": "#/components/schemas/Meta" } }, "type": "object", "required": [ "balance_sheets", "meta" ], "title": "BalanceSheetsResponse" }, "CashFlowStatement": { "properties": { "ticker": { "type": "string", "title": "Ticker" }, "report_period": { "type": "string", "format": "date", "title": "Report Period" }, "fiscal_period": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Fiscal Period" }, "period": { "anyOf": [ { "type": "string", "enum": [ "annual", "quarterly", "ttm" ] }, { "type": "null" } ], "title": "Period" }, "currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Currency" }, "accession_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Accession Number" }, "filing_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Filing Url" }, "filing_date": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "Filing Date" }, "filing_datetime": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Filing Datetime" }, "operating_cash_flow": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Operating Cash Flow" }, "investing_cash_flow": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Investing Cash Flow" }, "financing_cash_flow": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Financing Cash Flow" }, "capital_expenditure": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Capital Expenditure" }, "dividends_paid": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Dividends Paid" } }, "type": "object", "required": [ "ticker", "report_period" ], "title": "CashFlowStatement" }, "CashFlowStatementsResponse": { "properties": { "cash_flow_statements": { "items": { "$ref": "#/components/schemas/CashFlowStatement" }, "type": "array", "title": "Cash Flow Statements" }, "meta": { "$ref": "#/components/schemas/Meta" } }, "type": "object", "required": [ "cash_flow_statements", "meta" ], "title": "CashFlowStatementsResponse" }, "CatalogDataset": { "properties": { "id": { "type": "string", "title": "Id" }, "path": { "type": "string", "title": "Path" }, "methods": { "items": { "type": "string", "enum": [ "GET", "POST" ] }, "type": "array", "title": "Methods" }, "scopes": { "items": { "type": "string" }, "type": "array", "title": "Scopes" }, "any_of_scopes": { "items": { "type": "string" }, "type": "array", "title": "Any Of Scopes" } }, "type": "object", "required": [ "id", "path", "methods" ], "title": "CatalogDataset" }, "CatalogJurisdiction": { "properties": { "id": { "type": "string", "enum": [ "US", "IN" ], "title": "Id" }, "name": { "type": "string", "title": "Name" }, "base_path": { "type": "string", "title": "Base Path" }, "datasets": { "items": { "$ref": "#/components/schemas/CatalogDataset" }, "type": "array", "title": "Datasets" } }, "type": "object", "required": [ "id", "name", "base_path", "datasets" ], "title": "CatalogJurisdiction" }, "CatalogResponse": { "properties": { "jurisdictions": { "items": { "$ref": "#/components/schemas/CatalogJurisdiction" }, "type": "array", "title": "Jurisdictions" }, "shared": { "items": { "$ref": "#/components/schemas/CatalogDataset" }, "type": "array", "title": "Shared" }, "permissions": { "items": { "type": "string" }, "type": "array", "title": "Permissions" } }, "type": "object", "required": [ "jurisdictions", "shared", "permissions" ], "title": "CatalogResponse" }, "CategoriesResponse": { "properties": { "categories": { "items": { "$ref": "#/components/schemas/CategoryFacet" }, "type": "array", "title": "Categories" }, "meta": { "$ref": "#/components/schemas/Meta" } }, "type": "object", "required": [ "categories", "meta" ], "title": "CategoriesResponse" }, "CategoryFacet": { "properties": { "category": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Category" }, "court": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Court" }, "court_level": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Court Level" }, "count": { "type": "integer", "title": "Count" } }, "type": "object", "required": [ "count" ], "title": "CategoryFacet" }, "CompaniesResponse": { "properties": { "companies": { "items": { "$ref": "#/components/schemas/Company" }, "type": "array", "title": "Companies" }, "meta": { "$ref": "#/components/schemas/Meta" } }, "type": "object", "required": [ "companies", "meta" ], "title": "CompaniesResponse" }, "Company": { "properties": { "ticker": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ticker" }, "name": { "type": "string", "title": "Name" }, "cik": { "type": "string", "title": "Cik" }, "exchange": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Exchange" }, "sic_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Sic Code" }, "sic_industry": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Sic Industry" }, "sector": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Sector" }, "industry": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Industry" }, "location": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Location" }, "is_active": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Active" }, "sec_filings_url": { "type": "string", "title": "Sec Filings Url" } }, "type": "object", "required": [ "name", "cik", "sec_filings_url" ], "title": "Company" }, "CompanyResponse": { "properties": { "company": { "$ref": "#/components/schemas/Company" } }, "type": "object", "required": [ "company" ], "title": "CompanyResponse" }, "CorporateEvent": { "properties": { "accession_number": { "type": "string", "title": "Accession Number" }, "issuer_cik": { "type": "string", "title": "Issuer Cik" }, "issuer_ticker": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Issuer Ticker" }, "filing_type": { "type": "string", "title": "Filing Type" }, "event_date": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "Event Date" }, "filing_datetime": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Filing Datetime" }, "item_number": { "type": "string", "title": "Item Number" }, "item_name": { "type": "string", "title": "Item Name" }, "text": { "type": "string", "title": "Text" }, "source_offsets": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Source Offsets" }, "parser_version": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Parser Version" }, "knowledge_time": { "type": "string", "format": "date-time", "title": "Knowledge Time" }, "source_id": { "type": "string", "title": "Source Id", "default": "sec_edgar" } }, "type": "object", "required": [ "accession_number", "issuer_cik", "filing_type", "item_number", "item_name", "text", "knowledge_time" ], "title": "CorporateEvent" }, "CorporateEventsResponse": { "properties": { "events": { "items": { "$ref": "#/components/schemas/CorporateEvent" }, "type": "array", "title": "Events" }, "meta": { "$ref": "#/components/schemas/Meta" } }, "type": "object", "required": [ "events", "meta" ], "title": "CorporateEventsResponse" }, "EdgarResearchCoverageResponse": { "properties": { "datasets": { "items": { "$ref": "#/components/schemas/EdgarResearchDatasetCoverage" }, "type": "array", "title": "Datasets" }, "meta": { "$ref": "#/components/schemas/Meta" } }, "type": "object", "required": [ "datasets", "meta" ], "title": "EdgarResearchCoverageResponse" }, "EdgarResearchDatasetCoverage": { "properties": { "dataset": { "type": "string", "enum": [ "form4", "form13f" ], "title": "Dataset" }, "resource_path": { "type": "string", "title": "Resource Path" }, "bulk_archives_available": { "type": "integer", "title": "Bulk Archives Available", "default": 0 }, "bulk_accessions": { "type": "integer", "title": "Bulk Accessions", "default": 0 }, "bulk_rows": { "type": "integer", "title": "Bulk Rows", "default": 0 }, "bulk_min_filing_date": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "Bulk Min Filing Date" }, "bulk_max_filing_date": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "Bulk Max Filing Date" }, "direct_accessions_available": { "type": "integer", "title": "Direct Accessions Available", "default": 0 }, "direct_accessions_needs_review": { "type": "integer", "title": "Direct Accessions Needs Review", "default": 0 }, "last_bulk_load_time": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Last Bulk Load Time" } }, "type": "object", "required": [ "dataset", "resource_path" ], "title": "EdgarResearchDatasetCoverage" }, "ErrorResponse": { "properties": { "error": { "type": "string", "title": "Error" }, "message": { "type": "string", "title": "Message" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Request Id" } }, "type": "object", "required": [ "error", "message" ], "title": "ErrorResponse" }, "FilingContentResponse": { "properties": { "accession_number": { "type": "string", "title": "Accession Number" }, "content_type": { "type": "string", "title": "Content Type" }, "content": { "type": "string", "title": "Content" }, "encoding": { "type": "string", "enum": [ "utf-8", "base64" ], "title": "Encoding", "default": "utf-8" }, "content_hash": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Content Hash" }, "parser_version": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Parser Version" } }, "type": "object", "required": [ "accession_number", "content_type", "content" ], "title": "FilingContentResponse" }, "FilingFile": { "properties": { "file_name": { "type": "string", "title": "File Name" }, "role": { "type": "string", "title": "Role" }, "content_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Content Type" }, "sec_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Sec Url" }, "sha256": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Sha256" }, "byte_size": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Byte Size" }, "storage_status": { "type": "string", "title": "Storage Status" } }, "type": "object", "required": [ "file_name", "role", "storage_status" ], "title": "FilingFile" }, "FilingFilesResponse": { "properties": { "accession_number": { "type": "string", "title": "Accession Number" }, "files": { "items": { "$ref": "#/components/schemas/FilingFile" }, "type": "array", "title": "Files" }, "meta": { "$ref": "#/components/schemas/Meta" } }, "type": "object", "required": [ "accession_number", "files", "meta" ], "title": "FilingFilesResponse" }, "FilingItem": { "properties": { "number": { "type": "string", "title": "Number" }, "name": { "type": "string", "title": "Name" }, "text": { "type": "string", "title": "Text" }, "exhibits": { "items": { "additionalProperties": true, "type": "object" }, "type": "array", "title": "Exhibits" }, "source_offsets": { "anyOf": [ { "additionalProperties": { "type": "integer" }, "type": "object" }, { "type": "null" } ], "title": "Source Offsets" }, "parser_version": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Parser Version" } }, "type": "object", "required": [ "number", "name", "text" ], "title": "FilingItem" }, "FilingItemsResponse": { "properties": { "resource": { "type": "string", "const": "filing_items", "title": "Resource", "default": "filing_items" }, "ticker": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ticker" }, "cik": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cik" }, "filing_type": { "type": "string", "title": "Filing Type" }, "accession_number": { "type": "string", "title": "Accession Number" }, "year": { "type": "integer", "title": "Year" }, "quarter": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Quarter" }, "items": { "items": { "$ref": "#/components/schemas/FilingItem" }, "type": "array", "title": "Items" } }, "type": "object", "required": [ "filing_type", "accession_number", "year", "items" ], "title": "FilingItemsResponse" }, "FilingProcessingErrorResponse": { "properties": { "error": { "type": "string", "title": "Error" }, "message": { "type": "string", "title": "Message" }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Request Id" }, "accession_number": { "type": "string", "title": "Accession Number" }, "retry_after_seconds": { "type": "integer", "title": "Retry After Seconds" } }, "type": "object", "required": [ "error", "message", "accession_number", "retry_after_seconds" ], "title": "FilingProcessingErrorResponse" }, "FinancialsResponse": { "properties": { "income_statements": { "items": { "$ref": "#/components/schemas/IncomeStatement" }, "type": "array", "title": "Income Statements" }, "balance_sheets": { "items": { "$ref": "#/components/schemas/BalanceSheet" }, "type": "array", "title": "Balance Sheets" }, "cash_flow_statements": { "items": { "$ref": "#/components/schemas/CashFlowStatement" }, "type": "array", "title": "Cash Flow Statements" }, "meta": { "$ref": "#/components/schemas/Meta" } }, "type": "object", "required": [ "income_statements", "balance_sheets", "cash_flow_statements", "meta" ], "title": "FinancialsResponse" }, "FundamentalFact": { "properties": { "report_period": { "type": "string", "format": "date", "title": "Report Period" }, "statement": { "type": "string", "title": "Statement" }, "fiscal_year": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Fiscal Year" }, "currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Currency" }, "knowledge_time": { "type": "string", "format": "date-time", "title": "Knowledge Time" }, "filed": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "Filed" }, "concept": { "type": "string", "title": "Concept" }, "value": { "title": "Value" }, "accession_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Accession Number" }, "filing_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Filing Type" }, "source_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Source Id" } }, "type": "object", "required": [ "report_period", "statement", "knowledge_time", "concept", "value" ], "title": "FundamentalFact" }, "FundamentalLedgerResponse": { "properties": { "facts": { "items": { "$ref": "#/components/schemas/FundamentalFact" }, "type": "array", "title": "Facts" }, "meta": { "$ref": "#/components/schemas/Meta" } }, "type": "object", "required": [ "facts", "meta" ], "title": "FundamentalLedgerResponse" }, "IncomeStatement": { "properties": { "ticker": { "type": "string", "title": "Ticker" }, "report_period": { "type": "string", "format": "date", "title": "Report Period" }, "fiscal_period": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Fiscal Period" }, "period": { "anyOf": [ { "type": "string", "enum": [ "annual", "quarterly", "ttm" ] }, { "type": "null" } ], "title": "Period" }, "currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Currency" }, "accession_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Accession Number" }, "filing_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Filing Url" }, "filing_date": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "Filing Date" }, "filing_datetime": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Filing Datetime" }, "revenue": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Revenue" }, "cost_of_revenue": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Cost Of Revenue" }, "gross_profit": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Gross Profit" }, "operating_income": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Operating Income" }, "net_income": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Net Income" }, "earnings_per_share_basic": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Earnings Per Share Basic" }, "earnings_per_share_diluted": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Earnings Per Share Diluted" } }, "type": "object", "required": [ "ticker", "report_period" ], "title": "IncomeStatement" }, "IncomeStatementsResponse": { "properties": { "income_statements": { "items": { "$ref": "#/components/schemas/IncomeStatement" }, "type": "array", "title": "Income Statements" }, "meta": { "$ref": "#/components/schemas/Meta" } }, "type": "object", "required": [ "income_statements", "meta" ], "title": "IncomeStatementsResponse" }, "IndiaAnnualReportSearchResult": { "properties": { "artifact_id": { "type": "string", "title": "Artifact Id" }, "company_name": { "type": "string", "title": "Company Name" }, "bse_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Bse Code" }, "nse_symbol": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Nse Symbol" }, "period_year": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Period Year" }, "document_type": { "type": "string", "const": "annual_report", "title": "Document Type" }, "snippet": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Snippet" } }, "type": "object", "required": [ "artifact_id", "company_name", "document_type" ], "title": "IndiaAnnualReportSearchResult" }, "IndiaFiling": { "properties": { "artifact_id": { "type": "string", "title": "Artifact Id" }, "company_name": { "type": "string", "title": "Company Name" }, "bse_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Bse Code" }, "nse_symbol": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Nse Symbol" }, "period_month": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Period Month" }, "period_year": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Period Year" }, "page_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Page Count" }, "ocr_pages": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Ocr Pages" }, "char_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Char Count" }, "is_scanned": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Scanned" }, "pdf_available": { "type": "boolean", "title": "Pdf Available" }, "text_available": { "type": "boolean", "title": "Text Available" }, "knowledge_time": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Knowledge Time" } }, "type": "object", "required": [ "artifact_id", "company_name", "pdf_available", "text_available" ], "title": "IndiaFiling" }, "IndiaFilingResponse": { "properties": { "filing": { "$ref": "#/components/schemas/IndiaFiling" } }, "type": "object", "required": [ "filing" ], "title": "IndiaFilingResponse" }, "IndiaFilingTextResponse": { "properties": { "artifact_id": { "type": "string", "title": "Artifact Id" }, "text": { "type": "string", "title": "Text" } }, "type": "object", "required": [ "artifact_id", "text" ], "title": "IndiaFilingTextResponse" }, "IndiaFilingsResponse": { "properties": { "filings": { "items": { "$ref": "#/components/schemas/IndiaFiling" }, "type": "array", "title": "Filings" }, "meta": { "$ref": "#/components/schemas/Meta" } }, "type": "object", "required": [ "filings", "meta" ], "title": "IndiaFilingsResponse" }, "IndiaJudgmentSearchResult": { "properties": { "judgment_id": { "type": "string", "title": "Judgment Id" }, "court_level": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Court Level" }, "court": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Court" }, "bench": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Bench" }, "case_title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Case Title" }, "case_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Case Number" }, "cnr": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cnr" }, "judges": { "anyOf": [ { "type": "string" }, { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Judges" }, "disposal_nature": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Disposal Nature" }, "registration_date": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "Registration Date" }, "decision_date": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "Decision Date" }, "year": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Year" }, "details": { "additionalProperties": true, "type": "object", "title": "Details" }, "has_pdf": { "type": "boolean", "title": "Has Pdf" }, "has_text": { "type": "boolean", "title": "Has Text" }, "knowledge_time": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Knowledge Time" }, "document_type": { "type": "string", "const": "judgment", "title": "Document Type" } }, "type": "object", "required": [ "judgment_id", "has_pdf", "has_text", "document_type" ], "title": "IndiaJudgmentSearchResult" }, "IndiaJudgmentTextResponse": { "properties": { "judgment_id": { "type": "string", "title": "Judgment Id" }, "text": { "type": "string", "title": "Text" } }, "type": "object", "required": [ "judgment_id", "text" ], "title": "IndiaJudgmentTextResponse" }, "IndiaPricesResponse": { "properties": { "isin": { "type": "string", "title": "Isin" }, "nse_symbol": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Nse Symbol" }, "bse_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Bse Code" }, "prices": { "items": { "$ref": "#/components/schemas/Price" }, "type": "array", "title": "Prices" }, "meta": { "$ref": "#/components/schemas/Meta" } }, "type": "object", "required": [ "isin", "prices", "meta" ], "title": "IndiaPricesResponse" }, "IndiaSearchFilters": { "properties": { "document_type": { "anyOf": [ { "type": "string", "enum": [ "annual_report", "judgment" ] }, { "type": "null" } ], "title": "Document Type" }, "year": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Year" }, "court": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Court" }, "court_level": { "anyOf": [ { "type": "string", "enum": [ "high_court", "district_court" ] }, { "type": "null" } ], "title": "Court Level" } }, "additionalProperties": false, "type": "object", "title": "IndiaSearchFilters" }, "IndiaSearchRequest": { "properties": { "query": { "type": "string", "maxLength": 1000, "minLength": 1, "title": "Query" }, "limit": { "type": "integer", "maximum": 100.0, "minimum": 1.0, "title": "Limit", "default": 20 }, "offset": { "type": "integer", "minimum": 0.0, "title": "Offset", "default": 0 }, "as_of": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "As Of" }, "filters": { "$ref": "#/components/schemas/IndiaSearchFilters" } }, "type": "object", "required": [ "query" ], "title": "IndiaSearchRequest" }, "IndiaSearchResponse": { "properties": { "results": { "items": { "anyOf": [ { "$ref": "#/components/schemas/IndiaAnnualReportSearchResult" }, { "$ref": "#/components/schemas/IndiaJudgmentSearchResult" } ] }, "type": "array", "title": "Results" }, "meta": { "$ref": "#/components/schemas/Meta" } }, "type": "object", "required": [ "results", "meta" ], "title": "IndiaSearchResponse" }, "InsiderTransaction": { "properties": { "accession_number": { "type": "string", "title": "Accession Number" }, "transaction_ordinal": { "type": "integer", "title": "Transaction Ordinal" }, "issuer_cik": { "type": "string", "title": "Issuer Cik" }, "issuer_ticker": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Issuer Ticker" }, "reporting_owner_cik": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Reporting Owner Cik" }, "reporting_owner_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Reporting Owner Name" }, "officer_title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Officer Title" }, "is_director": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Director" }, "is_officer": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Officer" }, "is_ten_percent_owner": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Ten Percent Owner" }, "is_other": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Other" }, "security_title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Security Title" }, "transaction_date": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "Transaction Date" }, "transaction_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Transaction Code" }, "acquired_disposed": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Acquired Disposed" }, "shares": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Shares" }, "price_per_share": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Price Per Share" }, "shares_owned_after": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Shares Owned After" }, "ownership_nature": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ownership Nature" }, "is_derivative": { "type": "boolean", "title": "Is Derivative", "default": false }, "knowledge_time": { "type": "string", "format": "date-time", "title": "Knowledge Time" }, "source_id": { "type": "string", "title": "Source Id", "default": "sec_edgar" } }, "type": "object", "required": [ "accession_number", "transaction_ordinal", "issuer_cik", "knowledge_time" ], "title": "InsiderTransaction" }, "InsiderTransactionsResponse": { "properties": { "transactions": { "items": { "$ref": "#/components/schemas/InsiderTransaction" }, "type": "array", "title": "Transactions" }, "meta": { "$ref": "#/components/schemas/Meta" } }, "type": "object", "required": [ "transactions", "meta" ], "title": "InsiderTransactionsResponse" }, "InstitutionalHolding": { "properties": { "accession_number": { "type": "string", "title": "Accession Number" }, "holding_ordinal": { "type": "integer", "title": "Holding Ordinal" }, "manager_cik": { "type": "string", "title": "Manager Cik" }, "report_date": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "Report Date" }, "issuer_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Issuer Name" }, "class_title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Class Title" }, "cusip": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cusip" }, "value_thousands_usd": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Value Thousands Usd" }, "value_reported": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Value Reported" }, "value_unit": { "anyOf": [ { "type": "string", "enum": [ "USD", "USD_thousands" ] }, { "type": "null" } ], "title": "Value Unit" }, "value_usd": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Value Usd" }, "shares_or_principal": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Shares Or Principal" }, "shares_or_principal_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Shares Or Principal Type" }, "put_call": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Put Call" }, "investment_discretion": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Investment Discretion" }, "other_manager": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Other Manager" }, "voting_sole": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Voting Sole" }, "voting_shared": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Voting Shared" }, "voting_none": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Voting None" }, "knowledge_time": { "type": "string", "format": "date-time", "title": "Knowledge Time" }, "source_id": { "type": "string", "title": "Source Id", "default": "sec_edgar" } }, "type": "object", "required": [ "accession_number", "holding_ordinal", "manager_cik", "knowledge_time" ], "title": "InstitutionalHolding" }, "InstitutionalHoldingsResponse": { "properties": { "holdings": { "items": { "$ref": "#/components/schemas/InstitutionalHolding" }, "type": "array", "title": "Holdings" }, "meta": { "$ref": "#/components/schemas/Meta" } }, "type": "object", "required": [ "holdings", "meta" ], "title": "InstitutionalHoldingsResponse" }, "Judgment": { "properties": { "judgment_id": { "type": "string", "title": "Judgment Id" }, "court_level": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Court Level" }, "court": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Court" }, "bench": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Bench" }, "case_title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Case Title" }, "case_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Case Number" }, "cnr": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cnr" }, "judges": { "anyOf": [ { "type": "string" }, { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Judges" }, "disposal_nature": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Disposal Nature" }, "registration_date": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "Registration Date" }, "decision_date": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "Decision Date" }, "year": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Year" }, "details": { "additionalProperties": true, "type": "object", "title": "Details" }, "has_pdf": { "type": "boolean", "title": "Has Pdf" }, "has_text": { "type": "boolean", "title": "Has Text" }, "knowledge_time": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Knowledge Time" } }, "type": "object", "required": [ "judgment_id", "has_pdf", "has_text" ], "title": "Judgment" }, "JudgmentResponse": { "properties": { "judgment": { "$ref": "#/components/schemas/Judgment" } }, "type": "object", "required": [ "judgment" ], "title": "JudgmentResponse" }, "JudgmentsResponse": { "properties": { "judgments": { "items": { "$ref": "#/components/schemas/Judgment" }, "type": "array", "title": "Judgments" }, "meta": { "$ref": "#/components/schemas/Meta" } }, "type": "object", "required": [ "judgments", "meta" ], "title": "JudgmentsResponse" }, "Meta": { "properties": { "jurisdiction": { "anyOf": [ { "type": "string", "enum": [ "US", "IN" ] }, { "type": "null" } ], "title": "Jurisdiction" }, "count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Count" }, "limit": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Limit" }, "offset": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Offset" }, "next_offset": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Next Offset" }, "as_of": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "As Of" }, "normalization_version": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Normalization Version" }, "provenance": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Provenance" } }, "type": "object", "title": "Meta" }, "NewsItem": { "properties": { "source_id": { "type": "string", "title": "Source Id" }, "title": { "type": "string", "title": "Title" }, "url": { "type": "string", "title": "Url" }, "published_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Published At" }, "summary": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Summary" }, "category": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Category" } }, "type": "object", "required": [ "source_id", "title", "url" ], "title": "NewsItem" }, "NewsResponse": { "properties": { "news": { "items": { "$ref": "#/components/schemas/NewsItem" }, "type": "array", "title": "News" }, "meta": { "$ref": "#/components/schemas/Meta" } }, "type": "object", "required": [ "news", "meta" ], "title": "NewsResponse" }, "Price": { "properties": { "date": { "type": "string", "format": "date", "title": "Date" }, "open": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Open" }, "high": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "High" }, "low": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Low" }, "close": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Close" }, "volume": { "anyOf": [ { "type": "integer" }, { "type": "number" }, { "type": "null" } ], "title": "Volume" }, "adjusted_close": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Adjusted Close" }, "knowledge_time": { "type": "string", "format": "date-time", "title": "Knowledge Time" } }, "type": "object", "required": [ "date", "knowledge_time" ], "title": "Price" }, "SecuritiesResponse": { "properties": { "securities": { "items": { "$ref": "#/components/schemas/Security" }, "type": "array", "title": "Securities" }, "meta": { "$ref": "#/components/schemas/Meta" } }, "type": "object", "required": [ "securities", "meta" ], "title": "SecuritiesResponse" }, "Security": { "properties": { "isin": { "type": "string", "title": "Isin" }, "company_name": { "type": "string", "title": "Company Name" }, "nse_symbol": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Nse Symbol" }, "bse_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Bse Code" }, "is_active": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Active" } }, "type": "object", "required": [ "isin", "company_name" ], "title": "Security" }, "SecurityResponse": { "properties": { "security": { "$ref": "#/components/schemas/Security" } }, "type": "object", "required": [ "security" ], "title": "SecurityResponse" }, "USFiling": { "properties": { "cik": { "type": "string", "title": "Cik" }, "accession_number": { "type": "string", "title": "Accession Number" }, "filing_type": { "type": "string", "title": "Filing Type" }, "report_date": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "Report Date" }, "filing_date": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "Filing Date" }, "filing_datetime": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Filing Datetime" }, "ticker": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ticker" }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Url" }, "is_xbrl": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Xbrl" }, "content_status": { "type": "string", "enum": [ "pending", "available", "not_provided", "unsupported", "permanent_source_error" ], "title": "Content Status", "default": "pending" } }, "type": "object", "required": [ "cik", "accession_number", "filing_type" ], "title": "USFiling" }, "USFilingResponse": { "properties": { "filing": { "$ref": "#/components/schemas/USFiling" } }, "type": "object", "required": [ "filing" ], "title": "USFilingResponse" }, "USFilingsResponse": { "properties": { "filings": { "items": { "$ref": "#/components/schemas/USFiling" }, "type": "array", "title": "Filings" }, "meta": { "$ref": "#/components/schemas/Meta" } }, "type": "object", "required": [ "filings", "meta" ], "title": "USFilingsResponse" }, "USPricesResponse": { "properties": { "ticker": { "type": "string", "title": "Ticker" }, "prices": { "items": { "$ref": "#/components/schemas/Price" }, "type": "array", "title": "Prices" }, "meta": { "$ref": "#/components/schemas/Meta" } }, "type": "object", "required": [ "ticker", "prices", "meta" ], "title": "USPricesResponse" }, "USSearchFilters": { "properties": { "ticker": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ticker" }, "filing_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Filing Type" } }, "additionalProperties": false, "type": "object", "title": "USSearchFilters" }, "USSearchRequest": { "properties": { "query": { "type": "string", "maxLength": 1000, "minLength": 1, "title": "Query" }, "limit": { "type": "integer", "maximum": 100.0, "minimum": 1.0, "title": "Limit", "default": 20 }, "offset": { "type": "integer", "minimum": 0.0, "title": "Offset", "default": 0 }, "as_of": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "As Of" }, "filters": { "$ref": "#/components/schemas/USSearchFilters" } }, "type": "object", "required": [ "query" ], "title": "USSearchRequest" }, "USSearchResponse": { "properties": { "results": { "items": { "$ref": "#/components/schemas/USSearchResult" }, "type": "array", "title": "Results" }, "meta": { "$ref": "#/components/schemas/Meta" } }, "type": "object", "required": [ "results", "meta" ], "title": "USSearchResponse" }, "USSearchResult": { "properties": { "accession_number": { "type": "string", "title": "Accession Number" }, "ticker": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ticker" }, "cik": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cik" }, "filing_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Filing Type" }, "item_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Item Number" }, "item_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Item Name" }, "snippet": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Snippet" } }, "type": "object", "required": [ "accession_number" ], "title": "USSearchResult" } }, "securitySchemes": { "X-API-KEY": { "type": "apiKey", "in": "header", "name": "X-API-KEY", "description": "Provisioned Corpus API key with the required jurisdiction and operation scopes." } } }, "servers": [ { "url": "https://corpus-api.onera.app", "description": "Production" } ] }