{ "openapi": "3.0.1", "info": { "title": "PropertyShark Scraper", "description": "Collect public PropertyShark property records by geography or public property page URLs. Get addresses, sale history, building and lot details, coordinates, breadcrumbs, and walkability data when available in structured dataset rows.", "version": "0.0", "x-build-id": "uho5gV5WxGkCfqo1j" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/maximedupre~propertyshark/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-maximedupre-propertyshark", "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/maximedupre~propertyshark/runs": { "post": { "operationId": "runs-sync-maximedupre-propertyshark", "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/maximedupre~propertyshark/run-sync": { "post": { "operationId": "run-sync-maximedupre-propertyshark", "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": [ "target" ], "properties": { "target": { "title": "Target", "enum": [ "search", "propertyPages" ], "type": "string", "description": "Choose what to collect from PropertyShark.", "default": "search" }, "geography": { "title": "Geography", "type": "string", "description": "Enter one place supported by PropertyShark, such as a city, county, state, or ZIP code. Used only for Property search.", "default": "New York, NY" }, "saleDateFrom": { "title": "Sale date from", "type": "string", "description": "Enter the first sale date to include. Use a calendar date or a relative date. Leave blank for no start date. Used only for Property search." }, "saleDateTo": { "title": "Sale date to", "type": "string", "description": "Enter the last sale date to include. Use a calendar date or a relative date. Leave blank for no end date. Used only for Property search." }, "salePriceMin": { "title": "Minimum sale price", "minimum": 0, "type": "number", "description": "Include sales at or above this price. Leave blank for no minimum. Used only for Property search." }, "salePriceMax": { "title": "Maximum sale price", "minimum": 0, "type": "number", "description": "Include sales at or below this price. Leave blank for no maximum. Used only for Property search." }, "buildingSizeMin": { "title": "Minimum building size", "minimum": 0, "type": "number", "description": "Include buildings at or above this size in square feet. Leave blank for no minimum. Used only for Property search." }, "buildingSizeMax": { "title": "Maximum building size", "minimum": 0, "type": "number", "description": "Include buildings at or below this size in square feet. Leave blank for no maximum. Used only for Property search." }, "propertyPageUrls": { "title": "Property page URLs", "minItems": 1, "type": "array", "description": "Add one public PropertyShark property page URL in each row. Used only for Property pages.", "items": { "type": "object", "properties": { "url": { "title": "Property page URL", "type": "string", "description": "A public PropertyShark property page URL.", "pattern": "^https://(?:www\\.)?propertyshark\\.com/" } }, "required": [ "url" ] } }, "maxItems": { "title": "Maximum number of records", "minimum": 1, "type": "integer", "description": "Stop after this many property records. Leave blank to return all available results until the source is exhausted.", "default": 1 } } }, "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 } } } } } } } } } }