{ "openapi": "3.0.1", "info": { "title": "StreetEasy Scraper: NYC Rentals & Sales Listings", "description": "Scrape StreetEasy rentals and sales from any search URL or NYC neighborhood. Price, net-effective rent, months free, beds/baths, sqft, address, GPS, photos, brokerage, status, plus optional nearby transit, schools and parks. US residential proxy handled. $2.5/1K listings.", "version": "1.0", "x-build-id": "gbpGpglOcKsA5xj9e" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/dltik~streeteasy-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-dltik-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/dltik~streeteasy-scraper/runs": { "post": { "operationId": "runs-sync-dltik-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/dltik~streeteasy-scraper/run-sync": { "post": { "operationId": "run-sync-dltik-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", "properties": { "startUrls": { "title": "Start URLs", "type": "array", "description": "StreetEasy URLs to scrape. Accepts search pages (https://streeteasy.com/for-rent/nyc, https://streeteasy.com/for-sale/brooklyn), filtered searches (https://streeteasy.com/for-rent/area:302/price:-4000) and individual building/unit pages (https://streeteasy.com/building//). Use this OR `areas` + `listingType`.", "items": { "type": "string" } }, "listingType": { "title": "Listing type", "enum": [ "rent", "sale" ], "type": "string", "description": "Whether `areas` are turned into for-rent or for-sale search URLs. Ignored for URLs you pass in `startUrls` (their type is detected automatically).", "default": "rent" }, "areas": { "title": "Areas / neighborhoods", "type": "array", "description": "NYC areas or neighborhoods (e.g. 'nyc', 'brooklyn', 'manhattan', 'Williamsburg, Brooklyn', 'Kips Bay'). Each is converted to a StreetEasy search URL for the chosen `listingType`. Alternative to `startUrls`.", "default": [], "items": { "type": "string" } }, "maxItems": { "title": "Max listings", "minimum": 1, "maximum": 20000, "type": "integer", "description": "Maximum number of listings to deliver across all searches. Caps your spend — you pay per listing actually delivered.", "default": 100 }, "maxPages": { "title": "Max pages per search", "minimum": 1, "maximum": 50, "type": "integer", "description": "How many result pages to page through per search URL. StreetEasy caps a single search at roughly 1,050 results; raise this to go deeper, lower it to spend less.", "default": 20 }, "includeDetails": { "title": "Fetch per-listing details", "type": "boolean", "description": "When true, opens each listing's page to add nearby transit stations, schools and parks, the full unit address, year built and confirmed price. Charged as a separate `listing-details` event ($0.008/listing) on top of the base listing event.", "default": false }, "maxConcurrency": { "title": "Max concurrency", "minimum": 1, "maximum": 15, "type": "integer", "description": "Parallel requests for detail pages. Keep moderate (3-8) — StreetEasy is behind PerimeterX and aggressive concurrency raises the block rate.", "default": 5 }, "customProxyUrl": { "title": "Custom residential proxy / unblocker URL (optional)", "type": "string", "description": "Optional. By default this actor ships with its own US residential proxy, so you do NOT need to provide anything here. Set this only if you prefer to route through your own pool or unblocker (IPRoyal, Bright Data, Oxylabs, ScraperAPI) as http://user:pass@host:port. When set, it is used for every request." }, "proxyConfiguration": { "title": "Apify proxy (fallback only)", "type": "object", "description": "Fallback only. The actor already uses a bundled US residential proxy by default. This Apify proxy is used only if the bundled proxy is unavailable. StreetEasy is behind PerimeterX, so US RESIDENTIAL is required here." } } }, "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 } } } } } } } } } }