{ "openapi": "3.0.1", "info": { "title": "StreetEasy Scraper (Cheap)", "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": "eKhqPeBm9f4OZJpCX" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/data_api~streeteasy-scraper-cheap/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-data_api-streeteasy-scraper-cheap", "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/data_api~streeteasy-scraper-cheap/runs": { "post": { "operationId": "runs-sync-data_api-streeteasy-scraper-cheap", "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/data_api~streeteasy-scraper-cheap/run-sync": { "post": { "operationId": "run-sync-data_api-streeteasy-scraper-cheap", "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": { "searchPageUrl": { "title": "Search page URL", "type": "string", "description": "Drop in a ready-made StreetEasy search link and the scraper runs it as-is. Fill this and every filter below is skipped. You can leave it blank and build a search with the filters instead." }, "dealType": { "title": "Rent or buy", "enum": [ "for-rent", "for-sale" ], "type": "string", "description": "Choose whether to collect rentals or homes listed for sale.", "default": "for-rent" }, "areaSlug": { "title": "Area slug", "type": "string", "description": "The neighborhood or borough slug to look in. Used when no Search page URL is set. Try values like nyc, brooklyn, manhattan, bronx, queens, soho, harlem, astoria, williamsburg, upper-east-side, park-slope, or crown-heights.", "default": "nyc" }, "postalCode": { "title": "ZIP code filter", "type": "string", "description": "Restrict results to one NYC ZIP, such as 10001 or 11238. Skip it to cover the whole area." }, "priceFloor": { "title": "Lowest price ($)", "type": "integer", "description": "Smallest price in US dollars to include. Skip for no lower bound." }, "priceCeiling": { "title": "Highest price ($)", "type": "integer", "description": "Largest price in US dollars to include. Skip for no upper bound." }, "bedroomsMin": { "title": "Fewest bedrooms", "enum": [ "", "0", "1", "2", "3", "4" ], "type": "string", "description": "Lowest bedroom count to match. A studio counts as 0.", "default": "" }, "bedroomsMax": { "title": "Most bedrooms", "enum": [ "", "0", "1", "2", "3", "4" ], "type": "string", "description": "Highest bedroom count to match. A studio counts as 0. Keep on Any to leave the top end open.", "default": "" }, "bathroomsMin": { "title": "Fewest bathrooms", "enum": [ "", "1", "1.5", "2", "3" ], "type": "string", "description": "Lowest bathroom count to match.", "default": "" }, "propertyKinds": { "title": "Property kinds", "type": "array", "description": "Limit results by building category. Add one code per line: R = Rental building, X = House, D1 = Condo, M = Multifamily, P1 = Co-op. Skip it to keep every kind.", "items": { "type": "string" } }, "petFriendlyOnly": { "title": "Pet-friendly only", "type": "boolean", "description": "Turn on to keep only listings that welcome pets.", "default": false }, "listingState": { "title": "Listing state", "enum": [ "active", "rented", "listed", "closed", "pending" ], "type": "string", "description": "Restrict to listings in a given state of the market.", "default": "active" }, "ownerListedOnly": { "title": "By owner only", "type": "boolean", "description": "Turn on to keep only rentals posted by the owner with no broker fee. Has effect on for-rent searches only.", "default": false }, "orderBy": { "title": "Result order", "enum": [ "se_score", "listed_desc", "interesting_desc", "price_desc", "price_asc", "sqft_desc", "sqft_asc" ], "type": "string", "description": "How the listings should be sorted.", "default": "se_score" }, "resultsLimit": { "title": "Results cap", "minimum": 1, "maximum": 14000, "type": "integer", "description": "How many listings to gather before stopping. The ceiling is 1,400.", "default": 50 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Pick the proxies to route requests through. Helps you dodge IP blocks and rate limiting." } } }, "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 } } } } } } } } } }