{ "openapi": "3.0.1", "info": { "title": "West Virginia Secretary of State Business Search Scraper", "description": "Search West Virginia's free public business entity database by organization name, agent/officer name, or exact record ID. Get entity type, status, formation/filing dates, addresses, registered agent, officers, and annual report history.", "version": "1.0", "x-build-id": "iOy93CBwXnthb7b6m" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/crawlerbros~west-virginia-sos-business-search-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-crawlerbros-west-virginia-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~west-virginia-sos-business-search-scraper/runs": { "post": { "operationId": "runs-sync-crawlerbros-west-virginia-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~west-virginia-sos-business-search-scraper/run-sync": { "post": { "operationId": "run-sync-crawlerbros-west-virginia-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": [ "byOrgName", "byAgent", "byRecordId" ], "type": "string", "description": "Which search axis to use.", "default": "byOrgName" }, "organizationName": { "title": "Organization name (mode=byOrgName)", "type": "string", "description": "Business organization name to search for (substring match), e.g. `AMAZON`.", "default": "AMAZON" }, "agentName": { "title": "Agent/officer name (mode=byAgent)", "type": "string", "description": "Registered agent, officer, or manager name to search for (substring match), e.g. `CORPORATION SERVICE COMPANY`." }, "recordId": { "title": "Record ID (mode=byRecordId)", "type": "string", "description": "Exact internal numeric record ID, as shown in search results or in an `organization.aspx?org=` URL, e.g. `325449`." }, "activeStatus": { "title": "Status filter", "enum": [ "", "Active", "Inactive" ], "type": "string", "description": "Optional: restrict results to Active or Inactive (terminated) entities. Leave unset for both.", "default": "" }, "businessClass": { "title": "Business class filter", "enum": [ "", "Profit", "Non-Profit" ], "type": "string", "description": "Optional: restrict results to Profit or Non-Profit entities.", "default": "" }, "charterType": { "title": "Charter type filter", "enum": [ "", "Domestic", "Foreign" ], "type": "string", "description": "Optional: restrict results to Domestic (formed in West Virginia) or Foreign (formed elsewhere, registered in WV) entities.", "default": "" }, "entityTypes": { "title": "Organization type filter", "type": "array", "description": "Optional: restrict results to one or more organization types. Leave empty for all types.", "items": { "type": "string", "enum": [ "Benefit Corporation", "Business Trust", "Conservation Districts", "Cooperative Association", "Corporation", "Credit Service Organization", "Debt Collector", "Decentralized UNA", "Emblem", "Exempt Corporation", "Exempt CSO", "Exempt LLC", "Exempt LP", "Fictitious Name", "General Partnership", "Insurance Company", "Land Reuse Agency", "Limited Liability Company", "Limited Liability Partnership", "Limited Partnership", "Litigation Financier", "Not Processed", "Professional Limited Liability Company", "Protected Series", "Public Corporation", "Purchaser of Future Payments", "Series LLC", "Sole Proprietor", "Trademark Holder", "Unincorporated Non-profit Organization", "Voluntary Association" ] }, "default": [] }, "womanOwned": { "title": "Woman-owned filter", "enum": [ "", "Yes", "No" ], "type": "string", "description": "Optional: restrict to businesses self-reported as woman-owned.", "default": "" }, "minorityOwned": { "title": "Minority-owned filter", "enum": [ "", "Yes", "No" ], "type": "string", "description": "Optional: restrict to businesses self-reported as minority-owned.", "default": "" }, "veteranOwned": { "title": "Veteran-owned filter", "enum": [ "", "Yes", "No" ], "type": "string", "description": "Optional: restrict to businesses self-reported as veteran-owned.", "default": "" }, "ownerMilitary": { "title": "Owner active military filter", "enum": [ "", "Yes", "No" ], "type": "string", "description": "Optional: restrict to businesses whose owner self-reported as active military.", "default": "" }, "youngEntrepreneur": { "title": "Young entrepreneur filter", "enum": [ "", "Yes", "No" ], "type": "string", "description": "Optional: restrict to businesses whose owner self-reported as a young entrepreneur.", "default": "" }, "secTypes": { "title": "Secondary organization type filter", "type": "array", "description": "Optional: restrict results to one or more of West Virginia's secondary organization types (a narrower classification than the main organization type, e.g. Trademark Holder). Leave empty for all.", "items": { "type": "string", "enum": [ "Credit Service Organization", "Emblem", "Litigation Financier", "Purchaser of Future Payments", "Trademark Holder" ] }, "default": [] }, "effectiveDateFrom": { "title": "Effective date from (mm/dd/yyyy)", "type": "string", "description": "Optional: only include entities with an effective/formation date on or after this date, e.g. `1/1/2020`." }, "effectiveDateTo": { "title": "Effective date to (mm/dd/yyyy)", "type": "string", "description": "Optional: only include entities with an effective/formation date on or before this date, e.g. `12/31/2020`." }, "terminationDateFrom": { "title": "Termination date from (mm/dd/yyyy)", "type": "string", "description": "Optional: only include entities terminated/cancelled on or after this date, e.g. `1/1/2020`." }, "terminationDateTo": { "title": "Termination date to (mm/dd/yyyy)", "type": "string", "description": "Optional: only include entities terminated/cancelled on or before this date, e.g. `12/31/2020`." }, "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": 200, "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 } } } } } } } } } }