{ "openapi": "3.0.1", "info": { "title": "StreetEasy Scraper (It Work)", "description": "StreetEasy scraper that collects NYC rental and sale listings with filters for price, bedrooms, building type, neighborhood, and status, returning one clean row per property.", "version": "0.0", "x-build-id": "ExipnibgqLQ23NdXM" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/kawsar~streeteasy-scraper-it-work/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-kawsar-streeteasy-scraper-it-work", "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~streeteasy-scraper-it-work/runs": { "post": { "operationId": "runs-sync-kawsar-streeteasy-scraper-it-work", "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~streeteasy-scraper-it-work/run-sync": { "post": { "operationId": "run-sync-kawsar-streeteasy-scraper-it-work", "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": { "searchUrl": { "title": "Search URL", "type": "string", "description": "Paste any StreetEasy search URL to scrape it directly. When provided, all filter fields below are ignored. Required if Location is left empty." }, "listingType": { "title": "Listing type", "enum": [ "for-rent", "for-sale" ], "type": "string", "description": "Scrape rentals or homes for sale.", "default": "for-rent" }, "location": { "title": "Location", "type": "string", "description": "Neighborhood or area slug to search. Required if Search URL is not provided. Examples: nyc, brooklyn, manhattan, bronx, queens, soho, harlem, astoria, williamsburg, upper-east-side, central-park-south, park-slope, crown-heights.", "default": "nyc" }, "zipCode": { "title": "Zip code", "type": "string", "description": "Narrow results to a specific NYC zip code, e.g. 10001 or 11238. Leave empty to search the full location." }, "minPrice": { "title": "Minimum price ($)", "type": "integer", "description": "Minimum listing price in USD. Leave empty for no minimum." }, "maxPrice": { "title": "Maximum price ($)", "type": "integer", "description": "Maximum listing price in USD. Leave empty for no maximum." }, "minBedrooms": { "title": "Minimum bedrooms", "enum": [ "", "0", "1", "2", "3", "4" ], "type": "string", "description": "Minimum number of bedrooms. Studio = 0.", "default": "" }, "maxBedrooms": { "title": "Maximum bedrooms", "enum": [ "", "0", "1", "2", "3", "4" ], "type": "string", "description": "Maximum number of bedrooms. Studio = 0. Leave at Any for no upper limit.", "default": "" }, "minBathrooms": { "title": "Minimum bathrooms", "enum": [ "", "1", "1.5", "2", "3" ], "type": "string", "description": "Minimum number of bathrooms.", "default": "" }, "buildingTypes": { "title": "Building types", "type": "array", "description": "Filter by building type. Enter one code per line: R = Rental building, X = House, D1 = Condo, M = Multifamily, P1 = Co-op. Leave empty to include all types.", "items": { "type": "string" } }, "petsAllowed": { "title": "Pets allowed only", "type": "boolean", "description": "When enabled, only returns listings that allow pets.", "default": false }, "status": { "title": "Listing status", "enum": [ "active", "rented", "listed", "closed", "pending" ], "type": "string", "description": "Filter listings by their current status.", "default": "active" }, "byOwner": { "title": "For rent by owner only", "type": "boolean", "description": "When enabled, only returns rentals listed directly by the owner, with no broker fee. Applies to for-rent searches only.", "default": false }, "sortBy": { "title": "Sort by", "enum": [ "se_score", "listed_desc", "interesting_desc", "price_desc", "price_asc", "sqft_desc", "sqft_asc" ], "type": "string", "description": "Order to sort the results.", "default": "se_score" }, "maxResults": { "title": "Maximum results", "minimum": 1, "maximum": 1400, "type": "integer", "description": "Maximum number of listings to collect. Default is 500. Hard cap is 1,400.", "default": 500 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Select proxies to use for requests. Helps avoid IP blocking and rate limits." } } }, "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 } } } } } } } } } }