{ "openapi": "3.0.1", "info": { "title": "Mississippi SOS Business Search Scraper", "description": "Search the Mississippi Secretary of State's free public business entity database by business name or exact business ID. Get business ID, legal name, name history, entity type, status, effective date, state of incorporation, principal office address, registered agent, and officers/directors.", "version": "1.0", "x-build-id": "32W1KfYjyehjuBV6E" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/crawlerbros~mississippi-sos-business-search-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-crawlerbros-mississippi-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~mississippi-sos-business-search-scraper/runs": { "post": { "operationId": "runs-sync-crawlerbros-mississippi-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~mississippi-sos-business-search-scraper/run-sync": { "post": { "operationId": "run-sync-crawlerbros-mississippi-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": "Mode", "enum": [ "byName", "byId", "byOfficerName", "byRegisteredAgentName" ], "type": "string", "description": "What to fetch.", "default": "byName" }, "businessName": { "title": "Business name (mode=byName)", "type": "string", "description": "Name or partial name to search for, e.g. `Amazon`. Matched according to `searchBy`.", "default": "Amazon" }, "searchBy": { "title": "Name match type (mode=byName)", "enum": [ "startingwith", "matchall", "matchany", "soundslike", "exact" ], "type": "string", "description": "How `businessName` should be matched against registered business names.", "default": "startingwith" }, "businessIds": { "title": "Business IDs (mode=byId)", "type": "array", "description": "Exact Mississippi business ID(s) to look up, e.g. `1253260`.", "default": [], "items": { "type": "string" } }, "officerName": { "title": "Officer/director name (mode=byOfficerName)", "type": "string", "description": "Name (or partial name) of an officer, director, incorporator, or LLC member/manager to search for, e.g. `Smith`. Returns every Mississippi business where a matching name is on file as an officer/director. Note: because the source's own officer-search results grid does not include a business-ID column, `businessId` and `sourceUrl` are only populated when `includeDetails=true`.", "default": "Smith" }, "registeredAgentName": { "title": "Registered agent name (mode=byRegisteredAgentName)", "type": "string", "description": "Name (or partial name) of a registered agent to search for, e.g. `Registered Agents Inc`. Returns every Mississippi business that lists a matching registered agent.", "default": "Registered Agents Inc" }, "statusFilter": { "title": "Status filter (mode=byName/byOfficerName/byRegisteredAgentName)", "enum": [ "any", "Good Standing", "Dissolved", "Withdrawn", "Revoked", "Inactive", "Canceled", "Name Change", "Reserved Name", "Void-Failure to File" ], "type": "string", "description": "Only include businesses with this filing status. Leave as \"Any\" to include all. For byOfficerName/byRegisteredAgentName, this requires `includeDetails=true` (status is only known once the detail panel is fetched).", "default": "any" }, "entityTypeFilter": { "title": "Entity type filter (mode=byName/byOfficerName/byRegisteredAgentName)", "enum": [ "any", "Limited Liability Company (LLC)", "Foreign Limited Liability Company (LLC)", "Limited Liability Partnership (LLP)", "Limited Partnership (LP)", "Business Corporation", "Profit Corporation", "Foreign Corporation", "Non-Profit Corporation", "Cooperative", "Name Reservation" ], "type": "string", "description": "Only include this business filing type. Leave as \"Any\" to include all. For byOfficerName/byRegisteredAgentName, this requires `includeDetails=true` (business type is only known once the detail panel is fetched).", "default": "any" }, "includeDetails": { "title": "Include full detail (registered agent, officers, address)", "type": "boolean", "description": "When true, the actor opens each matched business's detail panel to add name history, principal office address, registered agent, and officers/directors. When false, only the search-result-row fields are returned (faster). For mode=byOfficerName specifically, `businessId`/`sourceUrl` are only available when this is true.", "default": true }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Uses Apify's free datacenter (AUTO) proxy group to get a fresh IP if a request is rate-limited by the source. Residential proxy is never used by this actor.", "default": { "useApifyProxy": true } }, "maxItems": { "title": "Max items", "minimum": 1, "maximum": 40, "type": "integer", "description": "Hard cap on emitted records.", "default": 10 } } }, "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 } } } } } } } } } }