{ "openapi": "3.0.1", "info": { "title": "Sec Edgar Company Filings Export", "description": "SEC Portfolio Filing Delta Export keeps a portfolio filing database current without manually combining company exports, removing duplicate filings, or investigating whether an empty export means no new filings or a failed company check.", "version": "0.0", "x-build-id": "KwwnCLSApRkrCIYb3" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/first_watch~sec-edgar-company-filings-export/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-first_watch-sec-edgar-company-filings-export", "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/first_watch~sec-edgar-company-filings-export/runs": { "post": { "operationId": "runs-sync-first_watch-sec-edgar-company-filings-export", "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/first_watch~sec-edgar-company-filings-export/run-sync": { "post": { "operationId": "run-sync-first_watch-sec-edgar-company-filings-export", "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", "required": [ "mode", "date_from" ], "properties": { "mode": { "title": "Source mode", "enum": [ "inline", "remote" ], "type": "string", "description": "Inline processes supplied SEC JSON without source requests. Remote retrieves official SEC JSON.", "default": "inline" }, "date_from": { "title": "First filing date", "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$", "type": "string", "description": "Inclusive YYYY-MM-DD calendar date, from 1900 onward. Ambiguous slash-style dates are rejected." }, "date_to": { "title": "Last filing date", "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$", "type": "string", "description": "Inclusive YYYY-MM-DD calendar date. Defaults to the UTC date at run start." }, "forms": { "title": "Issuer forms", "minItems": 1, "maxItems": 6, "type": "array", "description": "One to six unique values: 10-K, 10-K/A, 10-Q, 10-Q/A, 8-K and 8-K/A. Values are checked at runtime.", "items": { "type": "string" }, "default": [ "10-K", "10-K/A", "10-Q", "10-Q/A", "8-K", "8-K/A" ] }, "portfolio": { "title": "Portfolio records", "minItems": 1, "maxItems": 500, "type": "array", "description": "Alternative to portfolio_csv. Each object requires identifier and optionally portfolio_id. Identifiers are CIKs, tickers, or official company submissions HTTPS URLs. Identifier and portfolio_id are strings of at most 128 characters. Remove portfolio_csv first.", "items": { "type": "object" } }, "portfolio_csv": { "title": "Portfolio CSV", "minLength": 1, "maxLength": 262144, "type": "string", "description": "Actual CSV text with identifier and optional portfolio_id headers. Maximum 256 KiB and 500 records. Supply this or portfolio, not both." }, "snapshots": { "title": "Inline SEC snapshots", "minItems": 1, "maxItems": 500, "type": "array", "description": "Each object has a ten-digit cik, exactly one of submissions (SEC JSON object) or submissions_base64 (canonical base64 UTF-8 JSON), and optional historical_files mapping referenced filenames to JSON objects or base64 JSON. Remote mode excludes snapshots.", "items": { "type": "object" } }, "checkpoint": { "title": "Portable checkpoint", "type": "object", "description": "Object with version: 1 and seen_by_cik mapping ten-digit CIKs to unique accessions. Maximum 250,000 keys across 10,000 companies. Mutually exclusive with state_store_id." }, "state_store_id": { "title": "Named state store", "pattern": "^[A-Za-z0-9][A-Za-z0-9_-]*$", "minLength": 3, "maxLength": 63, "type": "string", "description": "Customer-supplied store name or ID for automatic checkpoint and ticker-cache state. Required remotely. Arrange a single writer and omit checkpoint." }, "sec_user_agent": { "title": "SEC access identity", "minLength": 8, "maxLength": 250, "type": "string", "description": "Remote only: application or organization name followed by a monitored email address. Excluded from result rows and ordinary logs." }, "remote_serialized": { "title": "Sequential SEC scheduling confirmed", "type": "boolean", "description": "Required remotely. Confirm all clients sharing your SEC egress identity are scheduled sequentially. This acknowledgement does not create a distributed lock.", "default": false }, "max_results": { "title": "Maximum new filings", "minimum": 1, "maximum": 100000, "type": "integer", "description": "A company exceeding remaining capacity fails before delivery. Independent companies continue.", "default": 100000 }, "maxTotalChargeUsd": { "title": "Additional spending ceiling", "minimum": 0, "maximum": 1000000, "type": "integer", "description": "Optional integer ceiling supplementing platform spending limits. Local verification assigns one unit to each billing event." } } }, "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 }, "PROXY_UNBLOCKER_UNITS": { "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 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }