{ "openapi": "3.0.1", "info": { "title": "Airbnb Listing Extractor", "description": "Extract Airbnb listings from destination search pages, including titles, room type, location, total stay price, average nightly price, ratings, review counts, photos, and booking URLs. Filter results before writing and pay per listing returned.", "version": "0.1", "x-build-id": "rr97YIxjGSbUd6G9T" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/schnellscrapers~airbnb-listing-extractor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-schnellscrapers-airbnb-listing-extractor", "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/schnellscrapers~airbnb-listing-extractor/runs": { "post": { "operationId": "runs-sync-schnellscrapers-airbnb-listing-extractor", "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/schnellscrapers~airbnb-listing-extractor/run-sync": { "post": { "operationId": "run-sync-schnellscrapers-airbnb-listing-extractor", "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": "Airbnb search URLs", "type": "array", "description": "Paste public Airbnb search URLs such as https://www.airbnb.com/s/Paris/homes. Use search pages, not individual room URLs.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "locationQueries": { "title": "Location queries", "type": "array", "description": "Search destinations without building a URL (for example, \"Paris, France\" or \"Austin, TX\"). Each query becomes one Airbnb search.", "items": { "type": "string" } }, "maxItems": { "title": "Maximum listings", "minimum": 1, "maximum": 2000, "type": "integer", "description": "Stop after this many filtered listing records. Keep the default at 100 for a predictable run budget.", "default": 100 }, "maxPages": { "title": "Maximum search pages", "minimum": 1, "maximum": 20, "type": "integer", "description": "Follow Airbnb cursor pages up to this limit per search URL. One rendered page is the lowest-cost default.", "default": 1 }, "minRating": { "title": "Minimum rating", "minimum": 0, "maximum": 5, "type": "number", "description": "Keep listings with an average guest rating at or above this value, from 0 to 5. Filters run before dataset writes." }, "minNightlyPrice": { "title": "Minimum nightly price", "minimum": 0, "type": "number", "description": "Keep listings whose derived average nightly price is at least this amount in the page currency." }, "maxNightlyPrice": { "title": "Maximum nightly price", "minimum": 0, "type": "number", "description": "Keep listings whose derived average nightly price is no higher than this amount in the page currency. Leave empty to disable the cap." }, "roomType": { "title": "Room type filter", "type": "string", "description": "Match text such as \"entire home\", \"private room\", or \"hotel\" against the listing card's room type." }, "checkIn": { "title": "Check-in date", "pattern": "^$|^\\d{4}-\\d{2}-\\d{2}$", "type": "string", "description": "Optional date in YYYY-MM-DD format. It is added to location-query searches so Airbnb can show stay-specific prices." }, "checkOut": { "title": "Check-out date", "pattern": "^$|^\\d{4}-\\d{2}-\\d{2}$", "type": "string", "description": "Optional date in YYYY-MM-DD format. Use a date after check-in for stay-specific prices." }, "adults": { "title": "Adults", "minimum": 1, "type": "integer", "description": "Optional guest count for location-query searches. Airbnb uses it when calculating available stay prices." }, "children": { "title": "Children", "minimum": 0, "type": "integer", "description": "Optional number of children for location-query searches." }, "infants": { "title": "Infants", "minimum": 0, "type": "integer", "description": "Optional number of infants for location-query searches." }, "pets": { "title": "Pets", "minimum": 0, "type": "integer", "description": "Optional number of pets for location-query searches." }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Direct browser access is the lowest-cost default. If Airbnb presents a challenge, enable Apify Proxy with the RESIDENTIAL group; proxy transfer can affect run cost.", "default": { "useApifyProxy": false, "apifyProxyGroups": [ "RESIDENTIAL" ] } }, "dryRun": { "title": "Dry run", "type": "boolean", "description": "Fetch and filter listing cards without writing dataset records. Logs report matched versus written counts.", "default": false } } }, "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 } } } } } } } } } }