{ "openapi": "3.0.1", "info": { "title": "SEC Market Participant Registry", "description": "Normalize reviewed SEC adviser, broker-dealer, municipal-adviser, and bounded transfer-agent registry snapshots.", "version": "0.1", "x-build-id": "jEKT0vAuOf5hELe7L" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/bb-tradetec~sec-market-participant-registry-normalizer/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-bb-tradetec-sec-market-participant-registry-normalizer", "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/bb-tradetec~sec-market-participant-registry-normalizer/runs": { "post": { "operationId": "runs-sync-bb-tradetec-sec-market-participant-registry-normalizer", "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/bb-tradetec~sec-market-participant-registry-normalizer/run-sync": { "post": { "operationId": "run-sync-bb-tradetec-sec-market-participant-registry-normalizer", "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": [ "queries" ], "properties": { "queries": { "title": "Registry queries", "minItems": 1, "maxItems": 20, "uniqueItems": true, "type": "array", "description": "One to twenty exact official-identifier or registry-snapshot requests.", "items": { "type": "object", "additionalProperties": false, "required": [ "requestId", "queryMode", "participantTypes" ], "properties": { "requestId": { "title": "Request ID", "description": "Stable caller correlation ID; never include a secret.", "type": "string", "minLength": 1, "maxLength": 128, "pattern": "^[A-Za-z0-9._:-]+$" }, "queryMode": { "title": "Query mode", "description": "Use an exact official identifier or an entire reviewed registry snapshot.", "type": "string", "enum": [ "exactIdentifier", "registrySnapshot" ], "default": "exactIdentifier" }, "participantTypes": { "title": "Participant types", "description": "Limit the request to one or more of the eleven supported public participant types.", "type": "array", "editor": "select", "minItems": 1, "maxItems": 11, "uniqueItems": true, "items": { "type": "string", "enum": [ "investmentAdviser", "exemptReportingAdviser", "brokerDealer", "municipalAdviser", "transferAgent", "nationalSecuritiesExchange", "alternativeTradingSystem", "clearingAgency", "nrsro", "securityBasedSwapEntity", "fundingPortal" ] } }, "identifierType": { "title": "Exact identifier type", "description": "Interpret identifier only as this selected official identifier type.", "type": "string", "enum": [ "secFileNumber", "crdNumber", "registrationNumber", "exactLegalName" ] }, "identifier": { "title": "Exact identifier", "description": "Exact official identifier or exact legal name; no fuzzy resolution is performed.", "type": "string", "minLength": 1, "maxLength": 256 } } } }, "registrationStatuses": { "title": "Registration statuses", "minItems": 1, "maxItems": 5, "uniqueItems": true, "type": "array", "description": "Include only these official registration statuses unless inactive records are enabled.", "items": { "type": "string", "enum": [ "active", "inactive", "withdrawn", "revoked", "unknown" ] }, "default": [ "active" ] }, "includeInactive": { "title": "Include inactive records", "type": "boolean", "description": "When true, retain all official statuses regardless of registrationStatuses.", "default": false }, "asOfDate": { "title": "Registry source date", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string", "description": "Require an exact published registry source date." }, "maxResults": { "title": "Maximum records", "minimum": 1, "maximum": 20000, "type": "integer", "description": "Hard maximum after global participant deduplication.", "default": 100 }, "maxSourceRequests": { "title": "Maximum SEC requests", "minimum": 1, "maximum": 200, "type": "integer", "description": "Hard run-wide public SEC request ceiling.", "default": 50 }, "maxDownloadBytes": { "title": "Maximum download bytes", "minimum": 1048576, "maximum": 209715200, "type": "integer", "description": "Hard run-wide public SEC download byte ceiling; the current RIA minimal example needs 6 MiB for its official ZIP/CSV roster.", "default": 52428800 }, "outputSchemaVersion": { "title": "Output schema version", "enum": [ "1.0" ], "type": "string", "description": "Supported public output contract version.", "default": "1.0" }, "outputMode": { "title": "Output mode", "enum": [ "full", "compact" ], "type": "string", "description": "Full or compact participant representation.", "default": "full" }, "cursor": { "title": "Continuation cursor", "pattern": "^secpartcur1_[A-Za-z0-9_-]+$", "minLength": 1, "maxLength": 32768, "type": "string", "description": "Stateless continuation cursor returned in SUMMARY after a bounded truncation." } } }, "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 } } } } } } } } } }