{ "openapi": "3.0.1", "info": { "title": "Rhode Island Business Registry - Officers, Agents & Filings", "description": "Search Rhode Island's business register by company name, officer, registered agent, street address, NAICS code or stated purpose. Get officers with addresses, agent, principal office, NAICS, purpose, share classes, former and fictitious names, mergers and full filing history.", "version": "0.1", "x-build-id": "k8FkokJDUNEqHseYH" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scrapers_lat~rhode-island-corporations-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scrapers_lat-rhode-island-corporations-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/scrapers_lat~rhode-island-corporations-scraper/runs": { "post": { "operationId": "runs-sync-scrapers_lat-rhode-island-corporations-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/scrapers_lat~rhode-island-corporations-scraper/run-sync": { "post": { "operationId": "run-sync-scrapers_lat-rhode-island-corporations-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", "properties": { "searchMode": { "title": "Search by", "enum": [ "entityName", "individualName", "registeredAgent", "address", "naics", "purpose", "idNumber" ], "type": "string", "description": "How to look businesses up. The register can be searched by company name, by a person who is an officer or director, by registered agent, by street address, by NAICS industry code, by the stated business purpose, or by ID number.", "default": "entityName" }, "entityNames": { "title": "Company names", "type": "array", "description": "One or more company names to look up. Used when Search by = Company name.", "items": { "type": "string" } }, "nameMatchType": { "title": "Name match", "enum": [ "beginsWith", "exactMatch", "fullText", "soundex" ], "type": "string", "description": "How company or person names are matched. Begins with is the broadest useful option; Soundex finds names that sound alike.", "default": "beginsWith" }, "lastNames": { "title": "Officer / director last names", "type": "array", "description": "Last names of officers or directors to look up. Used when Search by = Officer / director name.", "items": { "type": "string" } }, "firstName": { "title": "Officer / director first name", "type": "string", "description": "Optional first name, applied to every last name searched." }, "middleName": { "title": "Officer / director middle name", "type": "string", "description": "Optional middle name, applied to every last name searched." }, "registeredAgentNames": { "title": "Registered agent names", "type": "array", "description": "Registered agent names, e.g. a law firm or a corporate agent company. Returns every business that agent represents in Rhode Island. Used when Search by = Registered agent.", "items": { "type": "string" } }, "agentMatchType": { "title": "Agent name match", "enum": [ "contains", "beginsWith" ], "type": "string", "description": "How the registered agent name is matched.", "default": "contains" }, "addresses": { "title": "Street addresses", "type": "array", "description": "Street address fragments, e.g. \"1027 NEWPORT AVE\" or \"MAIN ST\". Returns every business registered at a matching address. Used when Search by = Street address.", "items": { "type": "string" } }, "naicsCodes": { "title": "NAICS codes", "type": "array", "description": "Full six-digit NAICS industry codes, e.g. 722511 for full-service restaurants. Partial codes are not accepted by the register. Used when Search by = NAICS industry code.", "items": { "type": "string" } }, "purposeKeywords": { "title": "Business purpose keywords", "type": "array", "description": "Keywords that appear in the filed statement of purpose, e.g. CANNABIS, SOLAR, REAL ESTATE. Used when Search by = Business purpose.", "items": { "type": "string" } }, "idNumbers": { "title": "ID numbers", "type": "array", "description": "Rhode Island business ID numbers to look up directly, e.g. 000015908. Used when Search by = ID number.", "items": { "type": "string" } }, "statusScope": { "title": "Status", "enum": [ "active", "inactive", "any" ], "type": "string", "description": "Whether to return active businesses, inactive ones (dissolved, revoked, withdrawn, merged, cancelled), or both.", "default": "active" }, "includeFilingHistory": { "title": "Include filing history", "type": "boolean", "description": "Also collect every filing on record (annual reports, amendments, mergers, dissolutions) with its date, filing number and PDF link. Adds one extra request per business.", "default": false }, "maxResults": { "title": "Maximum results", "minimum": 1, "maximum": 100000, "type": "integer", "description": "How many business records to return. Free Apify plans are capped at 10 per run.", "default": 50 }, "entityCategories": { "title": "Entity category", "type": "array", "description": "Keep only these categories.", "items": { "type": "string", "enum": [ "Corporation", "LLC", "LLP", "Limited Partnership", "Nonprofit Corporation", "Trust", "Fictitious Name", "Other" ] } }, "entityTypeContains": { "title": "Entity type contains", "type": "string", "description": "Keep only businesses whose registered type contains this text, e.g. \"Foreign\" or \"Non-Profit\"." }, "domicile": { "title": "Domicile", "enum": [ "any", "domestic", "foreign" ], "type": "string", "description": "Keep only Rhode Island entities, or only out-of-state and foreign entities qualified to do business there.", "default": "any" }, "jurisdictions": { "title": "Home jurisdictions", "type": "array", "description": "For out-of-state entities, keep only these home states or countries, e.g. DE, MA, NY.", "items": { "type": "string" } }, "cities": { "title": "Cities", "type": "array", "description": "Keep only businesses whose principal office or registered agent is in one of these cities.", "items": { "type": "string" } }, "states": { "title": "States", "type": "array", "description": "Keep only businesses whose principal office is in one of these states.", "items": { "type": "string" } }, "zipCodes": { "title": "ZIP codes", "type": "array", "description": "Keep only businesses whose principal office is in one of these ZIP codes.", "items": { "type": "string" } }, "countries": { "title": "Countries", "type": "array", "description": "Keep only businesses whose principal office is in one of these countries, e.g. USA, CAN.", "items": { "type": "string" } }, "incorporatedFrom": { "title": "Incorporated / qualified from", "type": "string", "description": "Keep only businesses formed or qualified on or after this date (YYYY-MM-DD). Useful for a newly formed company feed." }, "incorporatedTo": { "title": "Incorporated / qualified to", "type": "string", "description": "Keep only businesses formed or qualified on or before this date (YYYY-MM-DD)." }, "nameContains": { "title": "Name contains", "type": "string", "description": "Keep only businesses whose name contains this text." }, "officerNameContains": { "title": "Officer name contains", "type": "string", "description": "Keep only businesses with an officer or director whose name contains this text." }, "officerTitleContains": { "title": "Officer title contains", "type": "string", "description": "Keep only businesses that list an officer with this title, e.g. CEO, TREASURER, MANAGER." }, "registeredAgentContains": { "title": "Registered agent contains", "type": "string", "description": "Keep only businesses whose registered agent name contains this text." }, "excludeCommercialAgents": { "title": "Exclude commercial agent firms", "type": "boolean", "description": "Drop businesses fronted by a commercial registered-agent company (CT Corporation, CSC, Registered Agents Inc and similar), leaving the ones whose agent is a real person at the business.", "default": false }, "purposeContains": { "title": "Purpose contains", "type": "string", "description": "Keep only businesses whose filed statement of purpose contains this text." }, "naicsPrefixes": { "title": "NAICS prefixes", "type": "array", "description": "Keep only businesses whose NAICS code starts with one of these, e.g. 72 for accommodation and food services.", "items": { "type": "string" } }, "inactiveReasons": { "title": "Inactive reasons", "type": "array", "description": "Keep only inactive businesses with these reasons, e.g. Dissolved, Revoked Entity, Withdrawn, Cancelled, Merged into an entity of record.", "items": { "type": "string" } }, "requireOfficers": { "title": "Only with named officers", "type": "boolean", "description": "Drop businesses that list no officers or directors.", "default": false }, "requireRegisteredAgent": { "title": "Only with a registered agent", "type": "boolean", "description": "Drop businesses with no registered agent on file.", "default": false }, "hasFictitiousNames": { "title": "Only with fictitious names", "type": "boolean", "description": "Keep only businesses that have filed at least one fictitious (trading / DBA) name.", "default": false }, "minAuthorizedShares": { "title": "Minimum authorised shares", "minimum": 0, "type": "integer", "description": "Keep only businesses authorised to issue at least this many shares." }, "concurrency": { "title": "Concurrency", "minimum": 1, "maximum": 6, "type": "integer", "description": "How many business files to open at once. The register throttles bursts, so the actor paces itself automatically; raising this rarely makes a run faster.", "default": 3 }, "maxDetailFetches": { "title": "Maximum files to open", "minimum": 1, "maximum": 20000, "type": "integer", "description": "Safety cap on how many business files are opened while filters are narrowing results down." }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Optional proxy. The register is reachable without one, so leaving this off is usually fastest.", "default": { "useApifyProxy": false } }, "minRequestIntervalMs": { "title": "Minimum request spacing (ms)", "minimum": 330, "maximum": 5000, "type": "integer", "description": "Slowest starting pace between requests. The actor widens this on its own whenever the register throttles, so it normally does not need changing." } } }, "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 } } } } } } } } } }