{ "openapi": "3.0.1", "info": { "title": "US Business Entity Status & Good Standing Monitor", "description": "Is this US company in good standing, and when is its annual report due? Normalized status, good standing and annual report due dates from official open data (CO, CT, DC, NY, OR, TX), plus change alerts when an entity becomes delinquent, suspended or dissolved. No login, no proxy.", "version": "0.1", "x-build-id": "477mlufID0DkojoQA" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/lautarodelgado~us-business-status-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-lautarodelgado-us-business-status-monitor", "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/lautarodelgado~us-business-status-monitor/runs": { "post": { "operationId": "runs-sync-lautarodelgado-us-business-status-monitor", "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/lautarodelgado~us-business-status-monitor/run-sync": { "post": { "operationId": "run-sync-lautarodelgado-us-business-status-monitor", "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": [ "watchlist" ], "properties": { "mode": { "title": "Mode", "enum": [ "check", "monitor" ], "type": "string", "description": "Check returns the current status once. Monitor does the same and, for entities given by id, stores a snapshot and emits a change-alert row whenever status, good standing or the annual report due date changed since the last run (schedule it daily).", "default": "check" }, "watchlist": { "title": "Watchlist", "type": "array", "description": "List of entries. Each entry needs a \"state\" (2-letter code: CO, CT, DC, NY, OR, TX) and either an \"id\" (the state's entity number, recommended and required for monitoring) or a \"name\" (returns scored candidates). Optional \"label\" is echoed back. Example: {\"state\": \"TX\", \"id\": \"32070357671\"}." }, "maxCandidates": { "title": "Max candidates per name", "minimum": 1, "maximum": 10, "type": "integer", "description": "For entries given by name: how many best-matching entities to return (each one is a charged check). Use an id for exact, single-entity checks.", "default": 3 }, "activeOnly": { "title": "Active entities only (name searches)", "type": "boolean", "description": "For name searches, skip entities that are dissolved, withdrawn or otherwise no longer registered.", "default": false }, "autoResolveExactName": { "title": "Monitor an exact name match automatically", "type": "boolean", "description": "Monitor mode only. When a name entry has exactly one candidate whose name matches exactly (ignoring punctuation), monitor that entity without asking for its id. Off by default because names are not unique identifiers.", "default": false }, "maxChecks": { "title": "Max checks per run", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Safety limit on charged entity checks in one run. Free plan runs are limited to 10 checks regardless of this value.", "default": 500 }, "snapshotStoreName": { "title": "Snapshot store name", "type": "string", "description": "Named key-value store that keeps the last snapshot of every monitored entity between runs (monitor mode). Use different names to keep separate watchlists apart. Lowercase letters, digits and hyphens.", "default": "us-business-status-snapshots" } } }, "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 }, "PROXY_UNBLOCKER_UNITS": { "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 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }