{ "openapi": "3.0.1", "info": { "title": "Market Velocity Tracker", "description": "Market velocity tracker for analysts and institutional investors. Measure real-time demand by extracting properties that just went under contract or are pending across any US market.", "version": "0.0", "x-build-id": "tMvn1pEQ93lWuf11u" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/kawsar~market-velocity-tracker/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-kawsar-market-velocity-tracker", "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/kawsar~market-velocity-tracker/runs": { "post": { "operationId": "runs-sync-kawsar-market-velocity-tracker", "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/kawsar~market-velocity-tracker/run-sync": { "post": { "operationId": "run-sync-kawsar-market-velocity-tracker", "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": { "postal_code": { "title": "Postal code", "type": "string", "description": "Filter properties exactly by a 5-digit US ZIP or postal code. This is the most reliable way to target a specific neighborhood. Example: '90210' for Beverly Hills, CA." }, "state_code": { "title": "State code", "type": "string", "description": "Filter properties broadly by a 2-letter US state code. Best used in combination with other filters. Example: 'CA' for California, 'NY' for New York." }, "city": { "title": "City", "type": "string", "description": "Filter properties by the exact city name. Usually best to combine with state_code. Example: 'Los Angeles' or 'Austin'." }, "street_name": { "title": "Street name", "type": "string", "description": "Target properties located on a specific street name. Example: 'Sunset Blvd' or 'Main St'." }, "address": { "title": "Address", "type": "string", "description": "Filter for a very specific property address line. Example: '123 Fake Street'." }, "propertyType": { "title": "Property type", "type": "array", "description": "Filter the results by specific property types. Supported options include: apartment, condo_townhome, condo_townhome_rowhome_coop, condo, condos, single_family, multi_family, mobile, land, farm, other.", "items": { "type": "string" } }, "keywords": { "title": "Feature keywords", "type": "array", "description": "Filter properties by specific amenities or descriptive features. Options include: basement, carport, central_air, den, hardwood_floors, pool, waterfront, ocean_view, fireplace.", "items": { "type": "string" } }, "beds_min": { "title": "Min bedrooms", "type": "integer", "description": "Minimum threshold for the number of bedrooms." }, "beds_max": { "title": "Max bedrooms", "type": "integer", "description": "Maximum threshold for the number of bedrooms." }, "baths_min": { "title": "Min bathrooms", "type": "integer", "description": "Minimum threshold for the number of bathrooms (including half-baths)." }, "baths_max": { "title": "Max bathrooms", "type": "integer", "description": "Maximum threshold for the number of bathrooms." }, "list_price_min": { "title": "Min list price", "type": "integer", "description": "Minimum active asking list price in USD." }, "list_price_max": { "title": "Max list price", "type": "integer", "description": "Maximum active asking list price in USD." }, "sold_price_min": { "title": "Min sold price", "type": "integer", "description": "Minimum sold price in USD." }, "sold_price_max": { "title": "Max sold price", "type": "integer", "description": "Maximum sold price in USD." }, "year_built_min": { "title": "Year built from", "type": "integer", "description": "Filter by the year the construction was completed." }, "year_built_max": { "title": "Year built to", "type": "integer", "description": "Set a maximum year of completion to target historic or older builds." }, "hoa_fee_max": { "title": "Max HOA fee", "type": "integer", "description": "Maximum Homeowners Association monthly fee allowed." }, "limit": { "title": "Results per pagination page", "minimum": 1, "maximum": 200, "type": "integer", "description": "The number of listings fetched in a single API call.", "default": 200 }, "offset": { "title": "Initial page offset", "minimum": 0, "type": "integer", "description": "The exact positional index the scraper starts at.", "default": 0 }, "maxItems": { "title": "Maximum total results to scrape", "minimum": 1, "maximum": 5000, "type": "integer", "description": "The hard cap on total listings the scraper will collect across all paginated API calls.", "default": 5000 }, "timeoutSecs": { "title": "Overall actor timeout (seconds)", "minimum": 30, "maximum": 3600, "type": "integer", "description": "If the scraper surpasses this runtime duration, it will safely halt and exit.", "default": 300 }, "requestTimeoutSecs": { "title": "Per-request timeout (seconds)", "minimum": 5, "maximum": 120, "type": "integer", "description": "How long the scraper waits for the server to respond per API query slice.", "default": 30 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Select proxies to obscure IP and evade blocking. Note: USA datacenter proxy is set as the default." } } }, "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 } } } } } } } } } }