{ "openapi": "3.0.1", "info": { "title": "Ascension Works Tax Sale Listings Scraper", "description": "Clean, filter, and organize authorized delinquent-property listings across up to 100 counties. Also try the U.S. County Research Scraper and Tax Sale Ranking Scraper.", "version": "0.3", "x-build-id": "liL4J6TsdxVERdLrU" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/ascensionworks~ascension-works-current-listing-research-request/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-ascensionworks-ascension-works-current-listing-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-current-listing-research-request/runs": { "post": { "operationId": "runs-sync-ascensionworks-ascension-works-current-listing-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-current-listing-research-request/run-sync": { "post": { "operationId": "run-sync-ascensionworks-ascension-works-current-listing-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": "Listings per page", "minimum": 1, "maximum": 500, "type": "integer", "description": "Maximum listing rows returned on each page. When more records qualify, the summary supplies a signed continuation cursor and exact remaining count.", "default": 100 }, "maxSourceAgeDays": { "title": "Maximum data age", "minimum": 1, "maximum": 3650, "type": "integer", "description": "Exclude records older than this many days.", "default": 45 }, "maxTargetCost": { "title": "Maximum target cost (USD)", "minimum": 0.01, "maximum": 1000000000, "type": "number", "description": "Maximum known starting amount for screening. Auction amounts are not predicted final prices.", "default": 50000 }, "minAssessedValue": { "title": "Minimum assessed value (USD)", "minimum": 0, "maximum": 10000000000, "type": "number", "description": "Optional minimum assessed value. Records without the required value are excluded.", "default": 0 }, "minMarketValue": { "title": "Minimum market value (USD)", "minimum": 0, "maximum": 10000000000, "type": "number", "description": "Optional minimum market value. Records without the required value are excluded.", "default": 0 }, "minValueToCostRatio": { "title": "Minimum value-to-cost ratio", "minimum": 0, "maximum": 1000, "type": "number", "description": "Optional minimum available value divided by the known starting amount.", "default": 0 }, "preferredPropertyTypes": { "title": "Property types", "maxItems": 20, "type": "array", "description": "Optional allowlist of property-type words, such as land or residential.", "items": { "type": "string", "minLength": 1, "maxLength": 80 }, "default": [] }, "preferredSaleMethods": { "title": "Sale methods", "maxItems": 20, "type": "array", "description": "Optional allowlist of sale-method words, such as auction or non auction.", "items": { "type": "string", "minLength": 1, "maxLength": 80 }, "default": [] }, "sortPreference": { "title": "Ranking preference", "enum": [ "best_value", "lowest_cost", "soonest_sale", "highest_value", "most_complete" ], "type": "string", "description": "Choose the deterministic ordering profile for matching records.", "default": "soonest_sale" }, "customerDataRightsAccepted": { "title": "Rights to use supplied records", "type": "boolean", "description": "Required when you supply records. Confirm that you are authorized to use those records for this screening request. Do not include source URLs, credentials, personal owner/contact data, or raw page content.", "default": false }, "customerRecords": { "title": "Customer-supplied listing records", "maxItems": 500, "type": "array", "description": "Optional bounded records that you are authorized to use. Only the listed factual fields are accepted; unknown and private fields fail closed.", "items": { "type": "object", "additionalProperties": false, "properties": { "recordReference": { "title": "Record reference", "description": "Your non-person reference for this supplied record.", "type": "string", "minLength": 1, "maxLength": 80 }, "stateCode": { "title": "State code", "description": "Two-letter U.S. state or territory code for this record.", "type": "string", "minLength": 2, "maxLength": 2 }, "county": { "title": "County or equivalent", "description": "County, parish, borough, independent city, census area, municipio, or equivalent jurisdiction.", "type": "string", "minLength": 1, "maxLength": 80 }, "recordYear": { "title": "Record year", "description": "Calendar or sale year represented by the record.", "type": "integer", "minimum": 2000, "maximum": 2100 }, "listingStatus": { "title": "Listing status", "description": "Current factual status from the authorized supplied record.", "type": "string", "enum": [ "ACTIVE", "AVAILABLE", "OPEN", "UPCOMING" ] }, "dataAsOf": { "title": "Data as of", "description": "Date the supplied facts were current, formatted YYYY-MM-DD.", "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "saleDate": { "title": "Sale date", "description": "Known scheduled sale date, formatted YYYY-MM-DD. Omit when unavailable.", "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "bidDeadline": { "title": "Bid deadline", "description": "Known bid deadline, formatted YYYY-MM-DD. Omit when unavailable.", "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "parcelId": { "title": "Parcel ID", "description": "Public parcel identifier. Omit when unavailable.", "type": "string", "maxLength": 100 }, "propertyAddress": { "title": "Property address", "description": "Property location from the supplied record. Omit when unavailable.", "type": "string", "maxLength": 200 }, "propertyType": { "title": "Property type", "description": "Property classification from the supplied record. Omit when unavailable.", "type": "string", "maxLength": 80 }, "acreage": { "title": "Acreage", "description": "Known acreage. Omit when unavailable.", "type": "number", "minimum": 0, "maximum": 100000000 }, "saleMethod": { "title": "Sale method", "description": "Known sale method. Omit when unavailable.", "type": "string", "maxLength": 80 }, "minimumBidUsd": { "title": "Minimum bid (USD)", "description": "Known minimum bid in U.S. dollars. Omit when unavailable.", "type": "number", "minimum": 0, "maximum": 10000000000 }, "openingBidUsd": { "title": "Opening bid (USD)", "description": "Known opening bid in U.S. dollars. Omit when unavailable.", "type": "number", "minimum": 0, "maximum": 10000000000 }, "currentBidUsd": { "title": "Current bid (USD)", "description": "Known current bid in U.S. dollars. Omit when unavailable.", "type": "number", "minimum": 0, "maximum": 10000000000 }, "backTaxesUsd": { "title": "Back taxes (USD)", "description": "Known delinquent tax amount in U.S. dollars. Omit when unavailable.", "type": "number", "minimum": 0, "maximum": 10000000000 }, "assessedValueUsd": { "title": "Assessed value (USD)", "description": "Known assessed value in U.S. dollars. Omit when unavailable.", "type": "number", "minimum": 0, "maximum": 10000000000 }, "marketValueUsd": { "title": "Market value (USD)", "description": "Known market-value context in U.S. dollars. Omit when unavailable.", "type": "number", "minimum": 0, "maximum": 10000000000 } }, "required": [ "recordReference", "stateCode", "county", "recordYear", "listingStatus", "dataAsOf" ] } }, "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" ] } }, "continuationCursor": { "title": "Continuation cursor", "minLength": 80, "maxLength": 4096, "type": "string", "description": "For page 2 or later, paste the signed cursor returned by the immediately preceding page and resubmit the same customer records, scope, and criteria." } } }, "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 } } } } } } } } } }