{ "openapi": "3.0.1", "info": { "title": "Colorado Secretary of State Business Search Scraper", "description": "Search Colorado's official business entity registry by entity name, entity ID, registered agent name, or principal city. Get entity type, status, formation date, jurisdiction, address, and registered agent details.", "version": "1.0", "x-build-id": "PYQUhpyeqeEWasAhh" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/crawlerbros~colorado-sos-business-search-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-crawlerbros-colorado-sos-business-search-scraper", "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/crawlerbros~colorado-sos-business-search-scraper/runs": { "post": { "operationId": "runs-sync-crawlerbros-colorado-sos-business-search-scraper", "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/crawlerbros~colorado-sos-business-search-scraper/run-sync": { "post": { "operationId": "run-sync-crawlerbros-colorado-sos-business-search-scraper", "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", "proxyConfiguration" ], "properties": { "mode": { "title": "Search mode", "enum": [ "byEntityName", "byEntityId", "byAgentName", "byCity" ], "type": "string", "description": "Which search axis to use.", "default": "byEntityName" }, "entityName": { "title": "Entity name (mode=byEntityName)", "type": "string", "description": "Business entity name to search for (substring match), e.g. `WALMART`.", "default": "WALMART" }, "entityId": { "title": "Entity ID (mode=byEntityId)", "type": "string", "description": "Exact Colorado Secretary of State entity ID number, e.g. `19871633113`." }, "agentName": { "title": "Registered agent name (mode=byAgentName)", "type": "string", "description": "Registered agent individual or organization name to search for (substring match), e.g. `CT CORPORATION SYSTEM`." }, "principalCity": { "title": "Principal city (mode=byCity)", "type": "string", "description": "Exact principal-office city to browse entities in, e.g. `Denver`." }, "entityStatus": { "title": "Entity status filter", "enum": [ "", "Good Standing", "Exists", "Delinquent", "Noncompliant", "Administratively Dissolved", "Voluntarily Dissolved", "Judicially Dissolved", "Dissolved (Term Expired)", "Revoked", "Withdrawn", "Merged", "Consolidated", "Converted", "Registered Agent Resigned", "Effectiveness Prevented" ], "type": "string", "description": "Optionally restrict results to a single entity status.", "default": "" }, "entityType": { "title": "Entity type filter", "enum": [ "", "DLLC", "FLLC", "DPC", "FPC", "DNC", "FNC", "DLP", "FLP", "DLLP", "FLLP", "DLLLP", "FLLLP", "GP", "SP", "CU", "CS", "DC55", "DC55-PBC", "DC56", "DC56-PBC", "DLCA", "DLCA-PBC", "DLPA", "FLPA", "DPC-PBC", "DT", "FCOOP", "FLCA", "FO", "IC", "SL", "UNA", "WC" ], "type": "string", "description": "Optionally restrict results to a single entity type.", "default": "" }, "jurisdictionOfFormation": { "title": "Jurisdiction of formation filter", "type": "string", "description": "Optionally restrict results to entities whose filer-entered jurisdiction of formation contains this text, e.g. `Delaware`. Free text (not a normalized code) -- see README." }, "principalState": { "title": "Principal address state filter", "enum": [ "", "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY", "AS", "GU", "MP", "PR", "VI" ], "type": "string", "description": "Optionally restrict results to entities whose principal-office state/territory matches exactly, e.g. `CO`.", "default": "" }, "formationDateFrom": { "title": "Formation date from (YYYY-MM-DD)", "type": "string", "description": "Optionally restrict results to entities formed on or after this date." }, "formationDateTo": { "title": "Formation date to (YYYY-MM-DD)", "type": "string", "description": "Optionally restrict results to entities formed on or before this date." }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Uses Apify's free datacenter (AUTO) proxy group to get a fresh IP if a request is temporarily blocked. Residential proxy is never used by this actor.", "default": { "useApifyProxy": true } }, "maxItems": { "title": "Max items", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Hard cap on emitted records.", "default": 25 } } }, "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 } } } } } } } } } }