{ "openapi": "3.0.1", "info": { "title": "Rhode Island Secretary of State Business Search Scraper", "description": "Search Rhode Island's free public business entity database by entity name, officer name, ID number, filing number, registered agent, address, NAICS code, or purpose. Get entity type, status, formation date, address, and registered agent details.", "version": "1.0", "x-build-id": "wdgzPIOLg4t6nKgK1" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/crawlerbros~rhode-island-sos-business-search-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-crawlerbros-rhode-island-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~rhode-island-sos-business-search-scraper/runs": { "post": { "operationId": "runs-sync-crawlerbros-rhode-island-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~rhode-island-sos-business-search-scraper/run-sync": { "post": { "operationId": "run-sync-crawlerbros-rhode-island-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", "entityStatus", "proxyConfiguration" ], "properties": { "mode": { "title": "Search mode", "enum": [ "byEntityName", "byIndividual", "byIdentificationNumber", "byFilingNumber", "byAgent", "byAddress", "byNAICS", "byPurpose" ], "type": "string", "description": "Which search axis to use.", "default": "byEntityName" }, "entityStatus": { "title": "Entity status", "enum": [ "Active", "Inactive" ], "type": "string", "description": "Filter to Active or Inactive entities. Rhode Island's search form requires exactly one of these on every query.", "default": "Active" }, "entityName": { "title": "Entity name (mode=byEntityName)", "type": "string", "description": "Business entity name to search for, e.g. `AMAZON`.", "default": "AMAZON" }, "entityNameMatchType": { "title": "Entity name match type (mode=byEntityName)", "enum": [ "B", "M", "F", "S" ], "type": "string", "description": "How `entityName` is matched.", "default": "B" }, "firstName": { "title": "First name (mode=byIndividual)", "type": "string", "description": "First name of an officer, director, or manager to search for." }, "middleName": { "title": "Middle name (mode=byIndividual)", "type": "string", "description": "Middle name of an officer, director, or manager to search for." }, "lastName": { "title": "Last name (mode=byIndividual)", "type": "string", "description": "Last name of an officer, director, or manager to search for, e.g. `SMITH`.", "default": "SMITH" }, "individualMatchType": { "title": "Individual name match type (mode=byIndividual)", "enum": [ "B", "M", "F", "S" ], "type": "string", "description": "How the individual's name fields are matched.", "default": "B" }, "identificationNumber": { "title": "ID number (mode=byIdentificationNumber)", "type": "string", "description": "Exact Rhode Island entity ID number (a.k.a. Federal ID/FEIN as recorded by RI SOS), e.g. `001741304`." }, "filingNumber": { "title": "Filing number (mode=byFilingNumber)", "type": "string", "description": "Exact filing number for a specific filing document." }, "agentName": { "title": "Registered agent name (mode=byAgent)", "type": "string", "description": "Registered agent name to search for, e.g. `Corporation Service Company`." }, "agentMatchType": { "title": "Agent name match type (mode=byAgent)", "enum": [ "B", "C" ], "type": "string", "description": "How `agentName` is matched.", "default": "B" }, "address": { "title": "Address (mode=byAddress)", "type": "string", "description": "Street address (or partial address) to search for, e.g. `Main Street`." }, "naicsCode": { "title": "NAICS code (mode=byNAICS)", "type": "string", "description": "North American Industry Classification System code, e.g. `541810`." }, "purpose": { "title": "Business purpose text (mode=byPurpose)", "type": "string", "description": "Text to search for within registered entities' stated business purpose, e.g. `restaurant`." }, "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": 100, "type": "integer", "description": "Hard cap on emitted records. The source's own results grid returns at most 100 matches per search (see README), so this is capped at 100.", "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 } } } } } } } } } }