{ "openapi": "3.0.1", "info": { "title": "Massachusetts Secretary of State Business Search Scraper", "description": "Search the Massachusetts Corporations Division (Secretary of the Commonwealth) business registry by entity name, officer/agent name, or identification number. Get entity type, status, registered agent, principal office address, and officers/directors.", "version": "1.0", "x-build-id": "yiPfu7e1WBF2qZQf5" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/crawlerbros~massachusetts-sos-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-crawlerbros-massachusetts-sos-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~massachusetts-sos-scraper/runs": { "post": { "operationId": "runs-sync-crawlerbros-massachusetts-sos-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~massachusetts-sos-scraper/run-sync": { "post": { "operationId": "run-sync-crawlerbros-massachusetts-sos-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" ], "properties": { "mode": { "title": "Search mode", "enum": [ "byEntityName", "byIndividualName", "byIdentificationNumber", "byFilingNumber" ], "type": "string", "description": "Which axis of the Massachusetts Corporations Division search to use.", "default": "byEntityName" }, "entityName": { "title": "Entity name (mode=byEntityName)", "type": "string", "description": "Business/entity name to search for.", "default": "microsoft" }, "entityMatchMode": { "title": "Entity name match mode (mode=byEntityName)", "enum": [ "B", "M", "F", "S" ], "type": "string", "description": "How `entityName` is matched against the registry.", "default": "B" }, "lastName": { "title": "Last name (mode=byIndividualName)", "type": "string", "description": "Officer/registered-agent last name to search for." }, "firstName": { "title": "First name (mode=byIndividualName)", "type": "string", "description": "Officer/registered-agent first name (optional, narrows results)." }, "middleName": { "title": "Middle name (mode=byIndividualName)", "type": "string", "description": "Officer/registered-agent middle name (optional, narrows results)." }, "individualMatchMode": { "title": "Individual name match mode (mode=byIndividualName)", "enum": [ "B", "M", "F", "S" ], "type": "string", "description": "How the individual's name fields are matched against the registry.", "default": "B" }, "identificationNumber": { "title": "Identification number (mode=byIdentificationNumber)", "type": "string", "description": "The entity's Massachusetts identification number (numeric, commonly 9 digits, e.g. `000445089`)." }, "filingNumber": { "title": "Filing/document number (mode=byFilingNumber)", "type": "string", "description": "A specific filing/document number within an entity's history (found via that entity's 'View filings' list on its detail page) -- not the entity's own identification number." }, "maxItems": { "title": "Max items", "minimum": 1, "maximum": 100, "type": "integer", "description": "Hard cap on emitted records (each record requires a separate detail-page fetch, so keep this modest).", "default": 10 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Used only as an escalation fallback if the source rate-limits the run. The free Apify AUTO (datacenter) group is used -- no paid proxy is required.", "default": { "useApifyProxy": true } } } }, "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 } } } } } } } } } }