{ "openapi": "3.0.1", "info": { "title": "SEC Material Contract Intelligence", "description": "Find material agreement, customer contract, partnership, procurement, and exhibit leads from official SEC filings.", "version": "0.1", "x-build-id": "34drmFM0Wu5SnUfYO" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/taroyamada~sec-material-contract-intelligence/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-taroyamada-sec-material-contract-intelligence", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/taroyamada~sec-material-contract-intelligence/runs": { "post": { "operationId": "runs-sync-taroyamada-sec-material-contract-intelligence", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/taroyamada~sec-material-contract-intelligence/run-sync": { "post": { "operationId": "run-sync-taroyamada-sec-material-contract-intelligence", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "properties": { "tickers": { "title": "Tickers", "type": "array", "description": "Ticker symbols to resolve through the SEC company ticker index.", "default": [ "MSFT" ], "items": { "type": "string" } }, "ciks": { "title": "CIKs", "type": "array", "description": "SEC Central Index Key values. Use this when a ticker is unavailable or ambiguous.", "items": { "type": "string" } }, "issuers": { "title": "Issuers", "type": "array", "description": "Mixed ticker symbols or CIK numbers to inspect. Prefer Tickers and CIKs for clearer runs.", "default": [], "items": { "type": "string" } }, "accessionNumbers": { "title": "Accession numbers", "type": "array", "description": "Optional direct SEC accession numbers to inspect, such as 0000789019-26-000111.", "items": { "type": "string" } }, "formTypes": { "title": "Form types", "type": "array", "description": "SEC forms to include.", "default": [ "8-K", "10-K", "10-Q" ], "items": { "type": "string" } }, "startDate": { "title": "Start date", "type": "string", "description": "Optional filing date lower bound in YYYY-MM-DD format. Overrides daysBack start when set.", "default": "" }, "endDate": { "title": "End date", "type": "string", "description": "Optional filing date upper bound in YYYY-MM-DD format. Defaults to today when empty.", "default": "" }, "daysBack": { "title": "Days back", "minimum": 1, "maximum": 3650, "type": "integer", "description": "How far back to scan recent SEC filings.", "default": 365 }, "limit": { "title": "Result limit", "minimum": 1, "maximum": 500, "type": "integer", "description": "Maximum rows to emit.", "default": 50 }, "maxFilingsPerIssuer": { "title": "Max filings per issuer", "minimum": 1, "maximum": 500, "type": "integer", "description": "Maximum matching filings to inspect per issuer before row limiting.", "default": 50 }, "maxExhibitsPerFiling": { "title": "Max exhibits per filing", "minimum": 0, "maximum": 100, "type": "integer", "description": "Maximum Exhibit 10-style attachments to emit per filing.", "default": 12 }, "contractKeywords": { "title": "Contract keywords", "type": "array", "description": "Additional phrases to flag in filing metadata or fetched exhibit text.", "items": { "type": "string" } }, "counterpartyTerms": { "title": "Counterparty terms", "type": "array", "description": "Optional customer, partner, supplier, agency, or competitor names to highlight.", "items": { "type": "string" } }, "includeExhibitText": { "title": "Fetch exhibit text", "type": "boolean", "description": "Fetch Exhibit 10 documents for value, effective-date, and counterparty hints. Leave off for lighter metadata-only runs.", "default": false }, "maxExhibitChars": { "title": "Max exhibit characters", "minimum": 1000, "maximum": 50000, "type": "integer", "description": "Maximum exhibit text characters to analyze when Fetch exhibit text is enabled.", "default": 12000 }, "emitFilingRowsWithoutExhibits": { "title": "Emit filing-only rows", "type": "boolean", "description": "Emit a filing-level row when a relevant filing has no Exhibit 10-style attachment in the SEC directory index.", "default": true }, "requestDelayMs": { "title": "Delay between SEC filing requests", "minimum": 0, "maximum": 5000, "type": "integer", "description": "Delay between SEC Archives filing requests.", "default": 120 }, "timeoutMs": { "title": "HTTP timeout (ms)", "minimum": 1000, "maximum": 60000, "type": "integer", "description": "HTTP timeout for SEC API and Archives requests.", "default": 25000 }, "secUserAgent": { "title": "SEC User-Agent", "type": "string", "description": "Optional SEC-compliant User-Agent with contact information.", "default": "" }, "delivery": { "title": "Delivery", "enum": [ "dataset", "webhook" ], "type": "string", "description": "Where to send results. Dry runs never push dataset rows or webhooks.", "default": "dataset" }, "webhookUrl": { "title": "Webhook URL", "type": "string", "description": "Required when delivery=webhook.", "default": "" }, "dryRun": { "title": "Dry run", "type": "boolean", "description": "Run without writing dataset rows or posting webhook output.", "default": false } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } } } } } } } } }