{ "openapi": "3.0.1", "info": { "title": "Reg CF Crowdfunding Lifecycle & Outcomes Monitor — SEC EDGAR", "description": "Track US Regulation Crowdfunding beyond the offering feed: new Form C filings, C-U funding progress, C-AR annual reports with two-year revenue and net income, and C-TR/C-W terminations — straight from SEC EDGAR, keyless. Feed, issuer, outcomes and delta modes with honest per-row provenance.", "version": "1.0", "x-build-id": "OWws3eAGDZv8G6ohH" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/malonestar~reg-cf-lifecycle-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-malonestar-reg-cf-lifecycle-monitor", "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/malonestar~reg-cf-lifecycle-monitor/runs": { "post": { "operationId": "runs-sync-malonestar-reg-cf-lifecycle-monitor", "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/malonestar~reg-cf-lifecycle-monitor/run-sync": { "post": { "operationId": "run-sync-malonestar-reg-cf-lifecycle-monitor", "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" ], "properties": { "mode": { "title": "Mode", "enum": [ "feed", "outcomes", "issuer", "delta" ], "type": "string", "description": "What to return. \"feed\" = Regulation Crowdfunding lifecycle events (Form C offerings, C-U progress updates, C-AR annual reports, C-TR terminations, C-W withdrawals) in a date window. \"outcomes\" = Form C-AR annual reports with the issuer's two-year financials (total assets, revenue, net income, debt) parsed from each filing's XML. \"issuer\" = every Reg CF filing for one company (by cik or issuerQuery), XML-enriched. \"delta\" = only filings new since your last run for this scope, tracked in the named key-value store 'reg-cf-lifecycle-baseline'; the FIRST delta run stores a baseline and fails with an explanatory message rather than billing the whole feed as new." }, "formTypes": { "title": "Form types", "type": "array", "description": "Which Reg CF form types to include (feed and delta modes; outcomes mode always uses C-AR only). Allowed values: C (new offering), C-U (progress update), C-AR (annual report), C-TR (termination of reporting), C-W (offering withdrawal). Leave empty for all five. Amendments (e.g. C/A) are included under their base form and flagged is_amendment.", "items": { "type": "string" } }, "startDate": { "title": "Start date (YYYY-MM-DD)", "pattern": "^$|^\\d{4}-\\d{1,2}-\\d{1,2}$", "type": "string", "description": "Only include filings filed on or after this date. STRICTLY YYYY-MM-DD (e.g. 2026-08-01) — slash dates, month names and compact dates are rejected with a loud failure because they cannot be applied unambiguously. Leave blank for no lower bound (Regulation Crowdfunding began 2016-05-16)." }, "endDate": { "title": "End date (YYYY-MM-DD)", "pattern": "^$|^\\d{4}-\\d{1,2}-\\d{1,2}$", "type": "string", "description": "Only include filings filed on or before this date. STRICTLY YYYY-MM-DD. Leave blank for no upper bound (today). An unusable value fails the run loudly; nothing is billed." }, "state": { "title": "Issuer state", "type": "string", "description": "Optional 2-letter US state/territory code (e.g. TX) filtering on the issuer's principal business address. Applied server-side via the EDGAR locationCodes parameter AND re-validated on every returned row — if EDGAR ever stops applying the filter the run fails loudly instead of shipping a national feed labelled as one state." }, "portalQuery": { "title": "Funding portal name contains", "type": "string", "description": "Optional funding-portal (intermediary) name, e.g. \"Wefunder Portal\" or \"Honeycomb Portal\". Matched as an exact phrase via EDGAR full-text search against the filing documents (the portal's legal name appears in every Form C / C-U XML), so use the portal's legal name as it appears in filings. This is a document-text match, not a structured field filter." }, "cik": { "title": "Issuer CIK (issuer mode)", "type": "string", "description": "SEC CIK number of the issuer for issuer mode, with or without leading zeros (e.g. 1373217). Find it on any EDGAR filing page. issuer mode requires cik or issuerQuery." }, "issuerQuery": { "title": "Issuer name search (issuer mode)", "type": "string", "description": "Company-name phrase for issuer mode when you do not know the CIK, e.g. \"Bean Box\". Matched as a phrase via EDGAR full-text search; prefer cik for an exact match." }, "enrichXml": { "title": "Fetch filing XML details", "type": "boolean", "description": "In feed/delta modes, also fetch each filing's primary_doc.xml to add issuer website, legal status, funding portal name/CIK/CRD, offering amounts and deadline, C-U progress-update text, and the two-year financials. Adds one polite EDGAR request per row (slower). outcomes and issuer modes always enrich. When off, those columns are null with xml_status=\"not_fetched\" — null means NOT FETCHED, never \"none\".", "default": false }, "maxResults": { "title": "Max results", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Hard cap on rows emitted AND billed this run (newest filings first). Every row carries matched_total and results_truncated so a capped answer is never mistaken for a complete one." } } }, "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 } } } } } } } } } }