{
  "openapi": "3.0.1",
  "info": {
    "title": "Airbnb Reviews Scraper: Anonymous Ratings & Texts",
    "description": "Scrape Airbnb reviews from listing URLs: rating, month, language, text and translation, stay length, trip type, room type and the listing's six category ratings. Anonymous: no author name, photo, profile or location, first names masked in texts. No personal data.",
    "version": "0.1",
    "x-build-id": "GBdwyyKMd5A2L1z08"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/myth84~airbnb-reviews-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-myth84-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/myth84~airbnb-reviews-scraper/runs": {
      "post": {
        "operationId": "runs-sync-myth84-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/myth84~airbnb-reviews-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-myth84-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": {
          "listingUrls": {
            "title": "Airbnb listing URLs",
            "type": "array",
            "description": "One Airbnb listing per line: a listing URL copied from your browser (<code>https://www.airbnb.com/rooms/21607939</code>, any Airbnb country site) or just the numeric listing id. Duplicates are read once. Up to 1,000 listings per run. Search result URLs are not accepted: use the Airbnb Listings Scraper to find listings.",
            "items": {
              "type": "string",
              "pattern": "^(https?://|\\d+$)"
            }
          },
          "maxReviewsPerListing": {
            "title": "Maximum reviews per listing",
            "minimum": 1,
            "maximum": 10000,
            "type": "integer",
            "description": "Stop reading a listing after this many reviews (in the chosen order). Airbnb gives the full history of a listing: set a high value (up to 10,000) to get every review. Default 100: two requests of 50 reviews per listing, its recent history (the form is prefilled with 20 for a quick first run).",
            "default": 100
          },
          "maxResults": {
            "title": "Maximum reviews in total",
            "minimum": 1,
            "maximum": 1000000,
            "type": "integer",
            "description": "Stop the run after this many reviews over all listings; you are never charged for more. Default 1,000: caps the bill of a long list of listings (the form is prefilled with 20 for a quick first run).",
            "default": 1000
          },
          "sortBy": {
            "title": "Sort by",
            "enum": [
              "MOST_RECENT",
              "BEST_QUALITY",
              "RATING_DESC",
              "RATING_ASC"
            ],
            "type": "string",
            "description": "Order in which Airbnb returns the reviews of each listing: most recent first, most relevant (Airbnb's own ranking), highest rating first or lowest rating first. The <code>position</code> column keeps this order. Default most recent: the newest reviews first, the only order in which Only reviews since stops reading a listing early.",
            "default": "MOST_RECENT"
          },
          "reviewsSince": {
            "title": "Only reviews since",
            "pattern": "^\\d{4}-(0[1-9]|1[0-2])(-(0[1-9]|[12]\\d|3[01]))?$",
            "type": "string",
            "description": "Optional date, <code>YYYY-MM-DD</code> or <code>YYYY-MM</code>, e.g. <code>2026-09</code>: only reviews published on or after it are kept. With the most-recent order the listing stops at the first older review, which makes incremental monitoring cheap; with another order the reviews are filtered."
          },
          "topic": {
            "title": "Topic",
            "pattern": "^[A-Za-z][A-Za-z_]{1,49}$",
            "type": "string",
            "description": "Optional Airbnb review topic: only the reviews Airbnb tags with it, e.g. <b>CLEANLINESS</b>, <b>LOCATION</b>, <b>NOISE</b>, <b>HOSPITALITY</b>. The topics of a listing are those shown above its reviews; pick one from the list or type another one in capitals."
          },
          "searchQuery": {
            "title": "Search in reviews",
            "type": "string",
            "description": "Optional word or phrase: only the reviews that contain it (Airbnb's own full-text search, e.g. <i>noise</i>, <i>parking</i>, <i>wifi</i>)."
          },
          "locale": {
            "title": "Language",
            "pattern": "^[a-z]{2}(-[A-Za-z]{2})?$",
            "type": "string",
            "description": "Airbnb language code of the translations and of the stay labels: en, fr, de, es, it, pt, nl… The original text is always kept in <code>text</code>; <code>stayLength</code> and <code>tripType</code> are filled for English and French labels. Two lowercase letters, optionally followed by a region such as en-GB. Default en: English translations, and labels that fill stayLength and tripType.",
            "default": "en"
          },
          "translate": {
            "title": "Include translations",
            "type": "boolean",
            "description": "Keep Airbnb's translation of reviews written in another language than the one above (<code>translatedText</code>). Untick to save only the original texts. Default on: every review readable in one language, the original always kept in text.",
            "default": true
          },
          "includeListingRatings": {
            "title": "Add the listing's ratings",
            "type": "boolean",
            "description": "Read each listing page once and repeat its average rating, review count and six category ratings (accuracy, check-in, cleanliness, communication, location, value) on every review row. Airbnb publishes no category rating per review. One extra request per listing, no extra charge. Default on: the listing's category ratings are the only per-aspect scores Airbnb publishes.",
            "default": true
          },
          "proxyConfiguration": {
            "title": "Proxy configuration",
            "type": "object",
            "description": "Proxies of the requests. Default: Apify datacenter proxies (automatic), enough for Airbnb reviews and included in the price. If your runs get blocked, choose another Apify proxy group or provide your own proxy URLs.",
            "default": {
              "useApifyProxy": true
            }
          },
          "maxRequests": {
            "title": "Max requests",
            "minimum": 1,
            "maximum": 50000,
            "type": "integer",
            "description": "Safety cap on the number of requests in one run (one per 50 reviews, plus one per listing for its ratings, plus up to 3 per page that Airbnb answers short). Default 2,000: room for about 100,000 reviews, far above the default total of 1,000.",
            "default": 2000
          },
          "delayMs": {
            "title": "Delay between pages",
            "minimum": 0,
            "maximum": 30000,
            "type": "integer",
            "description": "Pause between two pages of reviews of the same listing, in milliseconds. Increase it if you get blocked; 0 disables the pause. Default 250: the pacing of our validation and control runs.",
            "default": 250
          },
          "debugStoreResponses": {
            "title": "Store responses (debugging)",
            "type": "boolean",
            "description": "Debugging only: save a copy of every reviews response in the run's key-value store, without the author, host and host-reply fields (never the raw response), and the rating summary read on each listing page. Default off: no response is stored.",
            "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}