{
"openapi": "3.0.1",
"info": {
"title": "Airbnb Listings & Stay Prices — Independent Scraper",
"description": "Collect public Airbnb search results with detailed listings, amenities, photos and displayed stay prices. Track observed dates, currency and rounded-total flags. No exact nightly or tax guarantee.",
"version": "0.5",
"x-build-id": "jGMU6ChMx3KO4bGiC"
},
"servers": [
{
"url": "https://api.apify.com/v2"
}
],
"paths": {
"/acts/peerless_columbine~airbnb-public-listings-round29/run-sync-get-dataset-items": {
"post": {
"operationId": "run-sync-get-dataset-items-peerless_columbine-airbnb-public-listings-round29",
"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/peerless_columbine~airbnb-public-listings-round29/runs": {
"post": {
"operationId": "runs-sync-peerless_columbine-airbnb-public-listings-round29",
"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/peerless_columbine~airbnb-public-listings-round29/run-sync": {
"post": {
"operationId": "run-sync-peerless_columbine-airbnb-public-listings-round29",
"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": {
"locationQueries": {
"title": "Location Queries",
"maxItems": 100,
"type": "array",
"description": "List of location queries to scrape. Example: London, Manchester, Birmingham, etc.",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 300
}
},
"maxResults": {
"title": "Maximum results",
"minimum": 1,
"type": "integer",
"description": "Maximum results to return from this run"
},
"startUrls": {
"title": "Start URLs",
"maxItems": 100,
"type": "array",
"description": "Airbnb search URLs only; direct property URLs are not supported. Use objects such as {\"url\": \"https://www.airbnb.com/s/London/homes\"}. Explicit top-level filters override matching URL parameters.",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"title": "Search URL",
"description": "An HTTPS Airbnb search URL. Direct room URLs and private or credential-bearing URLs are rejected."
}
},
"required": [
"url"
],
"additionalProperties": false
},
"default": []
},
"enrichUserProfiles": {
"title": "Enrich User Profiles",
"type": "boolean",
"description": "If enabled, the actor makes extra requests for each host/co-host in every listing to get more detailed user info. This increases cost and runtime. If a profile is private or there's an unexpected error, it will be skipped and won't appear in the output.",
"default": false
},
"checkIn": {
"title": "Check-In Date",
"pattern": "^\\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01])$",
"type": "string",
"description": "Date must be in YYYY-MM-DD format with zero-padded month and day, e.g., 2022-02-20."
},
"checkOut": {
"title": "Check-Out Date",
"pattern": "^\\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01])$",
"type": "string",
"description": "Date must be in YYYY-MM-DD format with zero-padded month and day, e.g., 2022-02-20."
},
"locale": {
"title": "Locale",
"enum": [
"en-US",
"az-AZ",
"id-ID",
"bs-BA",
"ca-ES",
"cs-CZ",
"sr-ME",
"da-DK",
"de-DE",
"de-AT",
"de-CH",
"de-LU",
"et-EE",
"en-AU",
"en-CA",
"en-GB",
"en-GY",
"en-IN",
"en-IE",
"en-NZ",
"en-SG",
"en-AE",
"es-AR",
"es-BZ",
"es-BO",
"es-CL",
"es-CO",
"es-CR",
"es-EC",
"es-SV",
"es-ES",
"es-US",
"es-GT",
"es-HN",
"es-419",
"es-MX",
"es-NI",
"es-PA",
"es-PY",
"es-PE",
"es-VE",
"fr-BE",
"fr-CA",
"fr-FR",
"fr-CH",
"fr-LU",
"ga-IE",
"hr-HR",
"xh-ZA",
"zu-ZA",
"is-IS",
"it-IT",
"it-CH",
"sw-XX",
"lv-LV",
"lt-LT",
"hu-HU",
"mt-MT",
"ms-MY",
"nl-BE",
"nl-NL",
"no-NO",
"pl-PL",
"pt-BR",
"pt-PT",
"ro-RO",
"sq-AL",
"sk-SK",
"sl-SI",
"sr-RS",
"fi-FI",
"sv-SE",
"tl-PH",
"vi-VN",
"tr-TR",
"el-GR",
"bg-BG",
"mk-MK",
"ru-RU",
"uk-UA",
"ka-GE",
"hy-AM",
"he-IL",
"ar-XX",
"hi-IN",
"th-TH",
"ko-KR",
"ja-JP",
"zh-US",
"zh-TW-US",
"zh-CN",
"zh-HK",
"zh-TW"
],
"type": "string",
"description": "Localized results in this locale will be extracted (language and region).",
"default": "en-US"
},
"priceMin": {
"title": "Minimum Price",
"minimum": 0,
"type": "integer",
"description": "Minimum Airbnb search price in the selected currency. The verified source uses trip price including fees; nightly-filter parity remains unverified."
},
"currency": {
"title": "Currency",
"enum": [
"USD",
"CZK",
"AUD",
"BRL",
"BGN",
"CAD",
"CLP",
"CNY",
"COP",
"CRC",
"HRK",
"DKK",
"EGP",
"AED",
"EUR",
"GHS",
"HKD",
"HUF",
"INR",
"IDR",
"ILS",
"JPY",
"KZT",
"KES",
"MYR",
"MXN",
"MAD",
"TWD",
"NZD",
"NOK",
"PEN",
"PHP",
"PLN",
"GBP",
"QAR",
"RON",
"SAR",
"SGD",
"ZAR",
"KRW",
"SEK",
"CHF",
"THB",
"TRY",
"UGX",
"UAH",
"UYU",
"VND"
],
"type": "string",
"description": "Currency that will be extracted for prices.",
"default": "USD"
},
"priceMax": {
"title": "Maximum Price",
"minimum": 0,
"type": "integer",
"description": "Maximum Airbnb search price in the selected currency. The verified source uses trip price including fees; nightly-filter parity remains unverified."
},
"minBeds": {
"title": "Minimum Beds",
"minimum": 0,
"type": "integer",
"description": "Minimum number of beds requested through Airbnb's public search filter."
},
"minBedrooms": {
"title": "Minimum Bedrooms",
"minimum": 0,
"type": "integer",
"description": "Minimum number of bedrooms. If Airbnb clamps this value, collection reports an unconfirmed filter instead of a successful empty result."
},
"minBathrooms": {
"title": "Minimum Bathrooms",
"minimum": 0,
"type": "integer",
"description": "Minimum number of bathrooms requested through Airbnb's public search filter."
},
"adults": {
"title": "Adults",
"minimum": 1,
"type": "integer",
"description": "Number of adults in the search party; forwarded to dated search and listing-detail requests."
},
"children": {
"title": "Children",
"minimum": 0,
"type": "integer",
"description": "Number of children in the search party. Positive values have not yet completed source acceptance."
},
"infants": {
"title": "Infants",
"minimum": 0,
"type": "integer",
"description": "Number of infants in the search party. Positive values have not yet completed source acceptance."
},
"pets": {
"title": "Pets",
"minimum": 0,
"type": "integer",
"description": "Number of pets in the search party. Positive values have not yet completed source acceptance."
},
"maxPages": {
"title": "Maximum pages per target",
"minimum": 1,
"maximum": 100,
"type": "integer",
"description": "A safety bound. Hitting the limit is recorded as incomplete; no completeness guarantee.",
"default": 15
},
"maxRequests": {
"title": "HTTP request limit",
"minimum": 1,
"maximum": 10000,
"type": "integer",
"description": "A safety bound. Hitting the limit is recorded as incomplete; no completeness guarantee.",
"default": 100
},
"maxRunSeconds": {
"title": "Collection deadline in seconds",
"minimum": 1,
"maximum": 110,
"type": "integer",
"description": "A safety bound. Hitting the limit is recorded as incomplete; no completeness guarantee.",
"default": 100
},
"requestTimeoutSeconds": {
"title": "Timeout per request",
"minimum": 1,
"maximum": 30,
"type": "integer",
"description": "A safety bound. Hitting the limit is recorded as incomplete; no completeness guarantee.",
"default": 15
},
"maxRetries": {
"title": "Retries for transient errors",
"minimum": 0,
"maximum": 2,
"type": "integer",
"description": "A safety bound. Hitting the limit is recorded as incomplete; no completeness guarantee.",
"default": 1
},
"maxConcurrency": {
"title": "Concurrent detail requests",
"minimum": 1,
"maximum": 20,
"type": "integer",
"description": "A safety bound. Hitting the limit is recorded as incomplete; no completeness guarantee.",
"default": 2
},
"requestDelaySeconds": {
"title": "Minimum request spacing",
"minimum": 0.05,
"maximum": 10,
"type": "number",
"description": "Minimum delay between HTTP request starts, in seconds; applied together with the concurrency and request limits.",
"default": 0.2
},
"dnsResolver": {
"title": "DNS resolver",
"enum": [
"system",
"google-doh"
],
"type": "string",
"description": "Explicit local Google DoH mode for fake-IP networks; TLS and public IP checks remain enabled.",
"default": "system"
},
"useProxy": {
"title": "Use your proxy configuration",
"type": "boolean",
"description": "Opt in. No paid proxy is enabled by default.",
"default": false
},
"proxyConfiguration": {
"title": "Your Apify proxy configuration",
"type": "object",
"description": "Optional existing Apify entitlement or user-owned proxyUrls. Configuration failures are fatal. Paid proxy route is mock tested only.",
"properties": {
"useApifyProxy": {
"type": "boolean",
"title": "Use Apify Proxy",
"description": "Use your existing Apify Proxy entitlement only when explicitly enabled."
},
"apifyProxyGroups": {
"type": "array",
"title": "Apify Proxy groups",
"description": "Proxy groups available under your existing Apify entitlement.",
"items": {
"type": "string"
}
},
"apifyProxyCountry": {
"type": "string",
"title": "Apify Proxy country",
"description": "Optional country code for your configured Apify Proxy group."
},
"proxyUrls": {
"type": "array",
"title": "Your proxy URLs",
"description": "User-owned proxy endpoints, limited to 20 at runtime. These are not used in this package's live validation.",
"items": {
"type": "string"
}
}
},
"default": {
"useApifyProxy": false
},
"additionalProperties": false
},
"calendarMonths": {
"title": "Availability calendar months",
"minimum": 0,
"maximum": 12,
"type": "integer",
"description": "0 keeps the original output and request count. 1–12 adds anonymous day-by-day availability to each detailed listing, starting in the check-in month or the run month. Calendar prices stay null when the source hides them. This calendar is not party-specific and does not guarantee a reservation.",
"default": 0
},
"includeBookingQuote": {
"title": "Public stay quote",
"type": "boolean",
"description": "Add one anonymous frontend BookIt query for the requested dates/party. Keeps the existing search price unchanged and returns actual source price details, availability and selected guest options separately. Source amounts, unknown currency/taxes/fees and unavailable-stay messages are preserved; this is not per-date nightly pricing.",
"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
},
"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
}
}
}
}
}
}
}
}
}
}