{ "openapi": "3.0.1", "info": { "title": "Ascension Works U.S. County Research Scraper", "description": "Research up to 100 U.S. counties or county equivalents in one cross-state request and receive customer-scoped availability results. Also try the Tax Sale Listings Scraper and Tax Sale Ranking Scraper.", "version": "0.3", "x-build-id": "bRR6DkNRxhX8e10Ih" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/ascensionworks~ascension-works-jurisdiction-research-request/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-ascensionworks-ascension-works-jurisdiction-research-request", "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/ascensionworks~ascension-works-jurisdiction-research-request/runs": { "post": { "operationId": "runs-sync-ascensionworks-ascension-works-jurisdiction-research-request", "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/ascensionworks~ascension-works-jurisdiction-research-request/run-sync": { "post": { "operationId": "run-sync-ascensionworks-ascension-works-jurisdiction-research-request", "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": [ "requestReference", "requestText", "years", "businessPurpose", "customerType", "expectedVolume", "deliveryMode", "lawfulPurposeAccepted", "restrictedUseAccepted", "licenseAccepted", "jurisdictions" ], "properties": { "requestReference": { "title": "Request reference", "minLength": 8, "maxLength": 80, "type": "string", "description": "Use the reference assigned to this bounded request. This value does not authorize processing or delivery." }, "requestText": { "title": "Research need", "minLength": 20, "maxLength": 2400, "type": "string", "description": "Describe the bounded research request in plain language without including credentials, payment details, or sensitive personal information." }, "years": { "title": "Years", "minItems": 1, "maxItems": 2, "type": "array", "description": "List one or two calendar or sale years. Availability and permitted use remain subject to the displayed product limits.", "items": { "type": "integer", "minimum": 2000, "maximum": 2028 } }, "businessPurpose": { "title": "Business purpose", "minLength": 10, "maxLength": 600, "type": "string", "description": "Explain the legitimate business purpose for the requested research and how any delivered results would be used." }, "customerType": { "title": "Customer type", "enum": [ "direct_customer", "advisor", "data_reseller", "competitor", "other" ], "type": "string", "description": "Identify the requester category so reseller, competitor, and unusual-use requests can be routed to manual review." }, "expectedVolume": { "title": "Expected record volume", "enum": [ "under_500", "500_to_5000", "over_5000", "entire_collection", "unknown" ], "type": "string", "description": "Estimate the expected record volume. Large, unknown, or entire-collection requests require manual owner review." }, "deliveryMode": { "title": "Requested delivery mode", "enum": [ "portal_api", "licensed_export" ], "type": "string", "description": "Choose authenticated portal or API access unless a separately reviewed written license permits an export." }, "lawfulPurposeAccepted": { "title": "Lawful-purpose attestation", "type": "boolean", "description": "Confirm that the request is for a lawful purpose and does not seek prohibited or unauthorized use.", "default": false }, "restrictedUseAccepted": { "title": "Restricted-use attestation", "type": "boolean", "description": "Confirm that bulk extraction, mirroring, resale, redistribution, model training, and competitive database construction are prohibited unless expressly licensed.", "default": false }, "licenseAccepted": { "title": "Draft license acceptance", "type": "boolean", "description": "Confirm acceptance of the displayed draft license and policy terms, subject to final owner review. This does not create a paid order.", "default": false }, "maxResults": { "title": "Maximum results", "minimum": 1, "maximum": 500, "type": "integer", "description": "Maximum jurisdiction-classification rows for this bounded request. This is automatically raised to the number of requested jurisdictions.", "default": 100 }, "jurisdictions": { "title": "Requested jurisdictions", "minItems": 1, "maxItems": 100, "type": "array", "description": "Add 1 to 100 counties, parishes, boroughs, independent cities, census areas, municipios, or equivalent local jurisdictions. Each item carries its own state or territory code, so one request may cross state lines.", "items": { "type": "object", "additionalProperties": false, "properties": { "stateCode": { "title": "State or territory code", "description": "Two-letter U.S. state or territory code.", "type": "string", "pattern": "^[A-Z]{2}$" }, "name": { "title": "County or equivalent", "description": "Requested county, parish, borough, independent city, census area, municipio, or equivalent name.", "type": "string", "minLength": 1, "maxLength": 80 }, "jurisdictionId": { "title": "Optional jurisdiction identifier", "description": "Optional known U.S. jurisdiction identifier in the form US-XX-ID.", "type": "string", "minLength": 5, "maxLength": 64 } }, "required": [ "stateCode", "name" ] } } } }, "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 } } } } } } } } } }