{ "openapi": "3.0.1", "info": { "title": "IA Business Entities - Active Iowa Registry", "description": "Iowa's active business-entity register (public open data, 344,639 entities): legal name, type, effective date, registered agent and principal office - each with a full address and latitude/longitude. Filter by name, type, city, state or date.", "version": "0.0", "x-build-id": "dFugrrvxpeFyFypLF" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/j0401~ia-business-entities/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-j0401-ia-business-entities", "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/j0401~ia-business-entities/runs": { "post": { "operationId": "runs-sync-j0401-ia-business-entities", "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/j0401~ia-business-entities/run-sync": { "post": { "operationId": "run-sync-j0401-ia-business-entities", "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": { "mode": { "title": "Mode", "enum": [ "rows", "aggregate", "profile" ], "type": "string", "description": "rows = records matching your filters (default). aggregate = one count row per group, over the whole register. profile = a single entity, by corpNumber.", "default": "rows" }, "corpNumber": { "title": "Corp number", "type": "string", "description": "The state's own unique business id (e.g. '881835'). An exact filter, or the lookup key for mode=profile. Blank = any.", "default": "" }, "name": { "title": "Business name", "type": "string", "description": "Business name or registered-agent name, substring, case-insensitive. Blank = any.", "default": "" }, "corporationType": { "title": "Corporation type", "enum": [ "", "DOMESTIC LIMITED LIABILITY COMPANY", "DOMESTIC PROFIT", "REVISED DOMESTIC NON-PROFIT", "FOREIGN LIMITED LIABILITY COMPANY", "FOREIGN PROFIT", "DOMESTIC LIMITED LIABILITY PARTNERSHIP", "REVISED FOREIGN NON-PROFIT", "DOMESTIC NON-PROFIT", "DOMESTIC LIMITED PARTNERSHIP", "FOREIGN NON-PROFIT", "REVISED DOMESTIC PROFIT", "FOREIGN LIMITED PARTNERSHIP", "DOMESTIC PROFESSIONAL CORPORATION", "DOMESTIC COOPERATIVE ASSOCIATION", "FOREIGN LIMITED LIABILITY PARTNERSHIP", "DOMESTIC PUBLIC BENEFIT CORPORATION", "DOMESTIC PROFESSIONAL LIMITED LIABILITY COMPANY", "FOREIGN COOPERATIVE ASSOCIATION", "REVISED DOMESTIC PROFESSIONAL CORPORATION", "FOREIGN PROFESSIONAL CORPORATION", "FOREIGN PUBLIC BENEFIT CORPORATION", "FOREIGN PROFESSIONAL LIMITED LIABILITY COMPANY", "DOMESTIC MUTUAL BENEFIT CORPORATION", "REVISED DOMESTIC MUTUAL BENEFIT CORPORATION", "FOREIGN MUTUAL BENEFIT CORPORATION", "REVISED DOMESTIC NONPROFIT", "REVISED FOREIGN PROFIT", "REVISED FOREIGN NONPROFIT", "REVISED DOMESTIC COOPERATIVE ASSOCIATION", "DOMESTIC BUSINESS DEVELOPMENT CORPORATION", "FOREIGN BUSINESS DEVELOPMENT CORPORATION", "REVISED FOREIGN COOPERATIVE ASSOCIATION" ], "type": "string", "description": "The source's exact entity type (32 values). Case-insensitive. Blank = any.", "default": "" }, "city": { "title": "City", "type": "string", "description": "Matches the registered-agent city OR the principal-office city. Blank = any.", "default": "" }, "state": { "title": "State", "type": "string", "description": "Two-letter code, matched on the agent state OR the office state (most are IA). Blank = any.", "default": "" }, "zip": { "title": "ZIP code", "type": "string", "description": "Five-digit ZIP, exact, matched on the agent ZIP OR the office ZIP. Blank = any.", "default": "" }, "effectiveFrom": { "title": "Effective on or after", "type": "string", "description": "Earliest effective date (YYYY-MM-DD). Blank = no lower bound.", "default": "" }, "effectiveTo": { "title": "Effective on or before", "type": "string", "description": "Latest effective date (YYYY-MM-DD). Blank = no upper bound.", "default": "" }, "groupBy": { "title": "Aggregate by", "enum": [ "", "corporationType", "agentState", "agentCity", "officeState", "officeCountry" ], "type": "string", "description": "Which dimension to aggregate over (mode=aggregate). Blank = corporationType. Counting runs over the whole register, so no group is truncated.", "default": "" }, "maxResults": { "title": "Max results", "type": "integer", "description": "Maximum records to return (mode=rows). Default 50.", "default": 50 } } }, "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 } } } } } } } } } }