{ "openapi": "3.0.1", "info": { "title": "Nestpick Scraper", "description": "Scrape furnished mid- to long-term rental listings from Nestpick - rooms, studios and apartments across 3000+ cities, aggregated from Spotahome, Blueground, HousingAnywhere and other providers. Filter by price, size, rooms; enrich listings with their external booking URL.", "version": "1.0", "x-build-id": "8Z4tZvcsrTx5WbtbX" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/crawlerbros~nestpick-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-crawlerbros-nestpick-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/crawlerbros~nestpick-scraper/runs": { "post": { "operationId": "runs-sync-crawlerbros-nestpick-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/crawlerbros~nestpick-scraper/run-sync": { "post": { "operationId": "run-sync-crawlerbros-nestpick-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": [ "mode" ], "properties": { "mode": { "title": "Mode", "enum": [ "search", "listingDetails" ], "type": "string", "description": "What to fetch.", "default": "search" }, "city": { "title": "City (mode=search)", "type": "string", "description": "City name, e.g. `Berlin`, `London`, `New York`, `Tokyo`, `Sao Paulo`. Nestpick covers 3000+ cities worldwide — any city name accepted; it is normalized to Nestpick's URL slug automatically.", "default": "Berlin" }, "category": { "title": "Category (mode=search)", "enum": [ "rooms", "apartments" ], "type": "string", "description": "Which listing category page to search. `Rooms` covers single rooms; `Apartments` covers studios and full apartments. Not every city has both categories available.", "default": "rooms" }, "propertyType": { "title": "Property type filter", "enum": [ "any", "room", "studio", "apartment", "residence_hall" ], "type": "string", "description": "Restrict results to one property type. `Any` keeps every type returned by the chosen category.", "default": "any" }, "minPriceEur": { "title": "Min price (EUR-normalized)", "minimum": 0, "maximum": 1000000, "type": "integer", "description": "Drop listings priced below this amount. Nestpick shows prices in each city's local currency, so filtering uses the EUR-normalized price Nestpick itself computes for cross-currency sorting (see `priceEur` output field)." }, "maxPriceEur": { "title": "Max price (EUR-normalized)", "minimum": 0, "maximum": 1000000, "type": "integer", "description": "Drop listings priced above this amount (EUR-normalized, see `minPriceEur`)." }, "minRooms": { "title": "Min rooms", "minimum": 0, "maximum": 50, "type": "integer", "description": "Drop listings with fewer rooms than this." }, "minSqm": { "title": "Min size (m²)", "minimum": 0, "maximum": 10000, "type": "integer", "description": "Drop listings smaller than this size in square meters. Listings without a published size always pass through." }, "verifiedOnly": { "title": "Verified listings only", "type": "boolean", "description": "Only keep listings carrying Nestpick's \"Verified\" badge.", "default": false }, "providerName": { "title": "Provider name contains", "type": "string", "description": "Keep only listings from a partner provider whose name/code contains this text (case-insensitive), e.g. `Spotahome`, `Blueground`, `HousingAnywhere`." }, "amenity": { "title": "Required amenity", "enum": [ "any", "balcony", "couples", "dishwasher", "double_bed", "drying_rack", "elevator", "en-suite", "equipped_kitchen", "gender_allowed_female", "gender_allowed_male", "guest_toilet", "handicap", "heating", "internet", "oven", "parking", "pets", "pool", "reception", "smoking", "storage", "students-only", "tv", "washing_machine" ], "type": "string", "description": "Keep only listings that list this amenity (matches Nestpick's own amenity taxonomy, same as the `amenities` output field).", "default": "any" }, "sortBy": { "title": "Sort by", "enum": [ "relevance", "priceAsc", "priceDesc", "sqmDesc", "roomsDesc" ], "type": "string", "description": "How to order results within the fetched batch. `Relevance` keeps Nestpick's own result order.", "default": "relevance" }, "listingIds": { "title": "Listing IDs (mode=listingDetails)", "type": "array", "description": "Numeric Nestpick listing IDs, e.g. `21514575`.", "default": [], "items": { "type": "string" } }, "listingUrls": { "title": "Listing URLs (mode=listingDetails)", "type": "array", "description": "Full Nestpick listing URLs, e.g. `https://www.nestpick.com/pick/21514575/`.", "default": [], "items": { "type": "string" } }, "maxItems": { "title": "Max items", "minimum": 1, "maximum": 500, "type": "integer", "description": "Hard cap on emitted records.", "default": 30 } } }, "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 } } } } } } } } } }