{ "openapi": "3.0.1", "info": { "title": "Cheapest Airbnb Scraper $0.50/1K - Occupancy, ADR & Revenue", "description": "The cheapest Airbnb scraper: only $0.50 per 1,000 listings, with 12-month occupancy, ADR, estimated revenue and an investment score included.", "version": "0.5", "x-build-id": "RwAQeXnRW1yq0vk5c" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/codetr~airbnb-market-intel/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-codetr-airbnb-market-intel", "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/codetr~airbnb-market-intel/runs": { "post": { "operationId": "runs-sync-codetr-airbnb-market-intel", "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/codetr~airbnb-market-intel/run-sync": { "post": { "operationId": "run-sync-codetr-airbnb-market-intel", "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": { "locations": { "title": "Locations", "type": "array", "description": "Places to analyse, e.g. \"Lisbon, Portugal\". One search is run per location.", "default": [ "Lisbon, Portugal" ], "items": { "type": "string" } }, "startUrls": { "title": "Airbnb search URLs", "type": "array", "description": "Optional full Airbnb search result URLs (https://www.airbnb.com/s/...). Filters in the URL are kept.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "maxListingsPerLocation": { "title": "Max listings per location", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Maximum number of listings collected per location / search URL.", "default": 50 }, "includeCalendar": { "title": "Include calendar analytics", "type": "boolean", "description": "Fetch the availability calendar and compute occupancy, estimated revenue and investment score.", "default": true }, "calendarMonths": { "title": "Calendar months", "minimum": 1, "maximum": 12, "type": "integer", "description": "How many months ahead (starting this month) to analyse.", "default": 12 }, "checkIn": { "title": "Sample check-in date", "type": "string", "description": "Optional YYYY-MM-DD. Together with check-out it defines the stay used to read the nightly price (ADR). Leave empty for Airbnb's default sample stay." }, "checkOut": { "title": "Sample check-out date", "type": "string", "description": "Optional YYYY-MM-DD, must be after check-in." }, "adults": { "title": "Adults", "minimum": 1, "maximum": 16, "type": "integer", "description": "Number of adult guests used for the price sample.", "default": 2 }, "currency": { "title": "Currency", "type": "string", "description": "ISO currency code for all prices (e.g. USD, EUR, TRY).", "default": "USD" }, "locale": { "title": "Locale", "type": "string", "description": "Site language. Keep \"en\" for best results.", "default": "en" }, "priceBands": { "title": "Price bands (advanced)", "type": "array", "description": "Advanced. Optional list of [min, max] nightly price bands (in the selected currency, null = open end) to control how large searches are sampled. Leave empty unless you know you need it." }, "maxConcurrency": { "title": "Max concurrency", "minimum": 1, "maximum": 30, "type": "integer", "description": "Parallel HTTP requests.", "default": 8 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Proxy settings. The defaults work for most runs.", "default": { "useApifyProxy": true } }, "escalateToResidential": { "title": "Use residential proxy when needed", "type": "boolean", "description": "Automatically retry blocked requests through residential proxies (billed per GB by Apify).", "default": true }, "residentialCountry": { "title": "Residential proxy country", "type": "string", "description": "Optional two-letter country code for residential proxies, e.g. US." }, "calendarQueryHash": { "title": "Calendar override (advanced)", "type": "string", "description": "Advanced. Leave empty unless support asks you to set it." } } }, "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 } } } } } } } } } }