{
  "openapi": "3.0.1",
  "info": {
    "title": "Airbnb Reviews Scraper — Guest Reviews, Ratings & Replies",
    "description": "Airbnb vacation rental guest reviews by URL, id or place. One row per review: rating, text, host replies, translation, language, date, reviewer, location. Lowest rated first and minRating keep only negative reviews (complaints) and bill only those. For sentiment, reputation, competitor research.",
    "version": "1.2",
    "x-build-id": "N7d9mdER1tPcaQO8e"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/kestrel~airbnb-reviews-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-kestrel-airbnb-reviews-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/kestrel~airbnb-reviews-scraper/runs": {
      "post": {
        "operationId": "runs-sync-kestrel-airbnb-reviews-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/kestrel~airbnb-reviews-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-kestrel-airbnb-reviews-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",
        "properties": {
          "startUrls": {
            "title": "Airbnb URLs",
            "uniqueItems": true,
            "type": "array",
            "description": "Airbnb listing URLs (https://www.airbnb.com/rooms/12345678) or search URLs (https://www.airbnb.com/s/Lisbon--Portugal/homes?room_types[]=Entire home/apt): a search URL harvests the reviews of every listing it returns, up to maxListingsPerQuery, with its filters kept. Use for \"reviews of this listing\". A URL from another site is rejected before anything is charged. Default empty.",
            "default": [],
            "items": {
              "type": "string"
            }
          },
          "listingIds": {
            "title": "Listing ids",
            "uniqueItems": true,
            "type": "array",
            "description": "Numeric Airbnb listing ids, e.g. [\"11562247\", \"45307024\"] (the number in /rooms/<id>): the fastest input when the listings are known — your portfolio, a comp set. A listing named twice (id and URL, or id and place) is harvested and billed once. Default empty.",
            "default": [],
            "items": {
              "type": "string"
            }
          },
          "locationQueries": {
            "title": "Places",
            "uniqueItems": true,
            "type": "array",
            "description": "Places as typed on Airbnb, e.g. [\"Lisbon, Portugal\"], [\"Algarve\"]: the reviews of every listing Airbnb returns for the place, up to maxListingsPerQuery. A place Airbnb does not recognise is reported as an unknown_area status row and costs nothing. Use for \"Airbnb reviews for a city\", competitor and market research.",
            "default": [],
            "items": {
              "type": "string"
            }
          },
          "maxListingsPerQuery": {
            "title": "Max listings per place",
            "minimum": 1,
            "maximum": 280,
            "type": "integer",
            "description": "Listings to take from each place or search URL before harvesting their reviews, 1 to 280, e.g. 50 (default 20). The bill for a place is at most maxListingsPerQuery × maxReviewsPerListing reviews. Ignored for listingIds and listing URLs.",
            "default": 20
          },
          "maxReviewsPerListing": {
            "title": "Max reviews per listing",
            "minimum": 0,
            "maximum": 5000,
            "type": "integer",
            "description": "0 = every review the listing has (Airbnb pages them 50 at a time; 300 from one listing verified). N = the first N in reviewsSort order, e.g. 20 (default 100). The main cost control: $0.005 per review delivered. The free listing row's reviews_total says how many exist.",
            "default": 100
          },
          "reviewsSort": {
            "title": "Order",
            "enum": [
              "most_recent",
              "highest_rated",
              "lowest_rated",
              "most_relevant"
            ],
            "type": "string",
            "description": "Which reviews come first: \"most_recent\" (default, the one to schedule), \"highest_rated\", \"lowest_rated\" (complaints first), \"most_relevant\" (Airbnb's own order). Use \"lowest_rated\" with minRating for a complaints feed.",
            "default": "most_recent"
          },
          "minRating": {
            "title": "Only reviews at or below this rating",
            "minimum": 0,
            "maximum": 5,
            "type": "integer",
            "description": "0 (default) = keep every review. 1 to 5 = keep only reviews rated AT OR BELOW this star rating, e.g. 3 for \"negative reviews\" (1, 2 and 3 stars). Reviews above it are dropped before billing: a 441-review listing returned 4 rows under minRating 3. Use with reviewsSort \"lowest_rated\".",
            "default": 0
          },
          "locale": {
            "title": "Language",
            "type": "string",
            "description": "Language for Airbnb's translations (text_localized), e.g. \"en\" (default), \"es\", \"fr\", \"de\", \"pt\", \"it\", \"ja\". Every row also carries the original text and the language it was written in. Use for \"reviews translated into Spanish\".",
            "default": "en"
          },
          "includeListingRow": {
            "title": "Include a listing row",
            "type": "boolean",
            "description": "true (default) = also emit one free listing row per listing with name, URL, reviews_total and reviews_fetched, so you can see how many reviews exist. false = review and status rows only. Never charged.",
            "default": true
          },
          "proxyConfiguration": {
            "title": "Proxy",
            "type": "object",
            "description": "Apify Proxy settings; required, Airbnb blocks datacentre traffic that is not rotated. Keep the default {\"useApifyProxy\": true}.",
            "default": {
              "useApifyProxy": true
            }
          },
          "sessions": {
            "title": "Parallel sessions",
            "minimum": 1,
            "maximum": 16,
            "type": "integer",
            "description": "Parallel proxy sessions (egress IPs), 1 to 16, e.g. 4 (default 4). Each is paced at perIp requests per second; more sessions = a faster run at the same cost.",
            "default": 4
          },
          "perIp": {
            "title": "Requests per second per IP",
            "minimum": 0.1,
            "maximum": 3,
            "type": "number",
            "description": "Requests per second per session, 0.1 to 3, e.g. 1 (default 1). Airbnb tolerates about 1 per second per IP; raise it only when a run is slow and not being throttled.",
            "default": 1
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}