{ "openapi": "3.0.1", "info": { "title": "StreetEasy Scraper [$1.50/1KšŸ’°] | NYC Rentals | Broker Data", "description": "Scrape StreetEasy NYC rental listings into structured data: price, net-effective rent, beds, baths, sqft, neighborhood, broker, no-fee status and price history. Ideal for NYC rental market research, price monitoring and lead generation.", "version": "0.1", "x-build-id": "rVCsrOIXljrjYm98f" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/ahmed_jasarevic~streeteasy-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-ahmed_jasarevic-streeteasy-scraper", "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/ahmed_jasarevic~streeteasy-scraper/runs": { "post": { "operationId": "runs-sync-ahmed_jasarevic-streeteasy-scraper", "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/ahmed_jasarevic~streeteasy-scraper/run-sync": { "post": { "operationId": "run-sync-ahmed_jasarevic-streeteasy-scraper", "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": [ "areas" ], "properties": { "areas": { "title": "Areas (neighborhoods / boroughs)", "type": "array", "description": "StreetEasy neighborhoods or boroughs to search, e.g. Manhattan, Williamsburg, Chelsea, Astoria, Park Slope. Numeric area ids are also accepted.", "items": { "type": "string" } }, "listingType": { "title": "Listing type", "enum": [ "rentals", "sales", "both" ], "type": "string", "description": "Rentals are fully supported via the internal API. Sales is a best-effort probe of a mirrored endpoint; if unsupported the run continues rentals-only.", "default": "rentals" }, "maxItems": { "title": "Max items", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Maximum listings to return. Free users are capped at 10 items per run.", "default": 100 }, "minPrice": { "title": "Min price ($)", "minimum": 0, "type": "integer", "description": "Minimum monthly rent (or sale price) filter." }, "maxPrice": { "title": "Max price ($)", "minimum": 0, "type": "integer", "description": "Maximum monthly rent (or sale price) filter." }, "minBeds": { "title": "Min bedrooms", "minimum": 0, "type": "integer", "description": "Minimum bedroom count (0 = studio)." }, "maxBeds": { "title": "Max bedrooms", "minimum": 0, "type": "integer", "description": "Maximum bedroom count." }, "minBaths": { "title": "Min bathrooms", "minimum": 0, "type": "integer", "description": "Minimum bathroom count." }, "maxBaths": { "title": "Max bathrooms", "minimum": 0, "type": "integer", "description": "Maximum bathroom count." }, "enrichDetails": { "title": "Enrich with listing details", "type": "boolean", "description": "Fetch each listing's detail record (ZIP code, description, amenities, all photos, floor plans, price history). Uses one extra request per listing and roughly triples run time. Leave off for fast basic rows.", "default": false }, "listingIds": { "title": "Listing IDs / URLs", "type": "array", "description": "Optional: specific rental IDs or URLs (e.g. 4808197 or https://streeteasy.com/rental/4808197) to enrich directly.", "items": { "type": "string" } }, "maxRequestsPerCrawl": { "title": "Max requests per crawl", "minimum": 1, "type": "integer", "description": "Safety cap on total API requests (search pages + detail fetches).", "default": 500 }, "maxRequestRetries": { "title": "Max request retries", "minimum": 0, "maximum": 100, "type": "integer", "description": "Retries per request. StreetEasy's PerimeterX rate-limits aggressively ā€” each retry rotates to a fresh proxy session/IP and re-acquires PX cookies. Raise (up to 100) if runs return little data.", "default": 10 }, "cookies": { "title": "Browser cookies (optional)", "type": "string", "description": "Optional: paste the full Cookie header from a working streeteasy.com browser session (DevTools ā†’ Network ā†’ any request ā†’ Request Headers ā†’ cookie). The actor normally self-bootstraps PX cookies per proxy IP; paste cookies only as a fallback." }, "proxy": { "title": "Proxy configuration", "type": "object", "description": "Residential proxy strongly recommended ā€” PerimeterX blocks datacenter IPs regardless of cookies." } } }, "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 }, "PROXY_UNBLOCKER_UNITS": { "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 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }