{
  "openapi": "3.0.1",
  "info": {
    "title": "Hostelworld Reviews Scraper — Hostel Guest Reviews",
    "description": "Every Hostelworld review of any hostel: the 0-100 overall score with its seven sub-ratings, the guest's text, the owner's reply, group type, age band, trip type and nationality. Give Hostelworld URLs or property ids. No key, no browser, no login — Hostelworld's own public JSON API. Pay per review.",
    "version": "1.0",
    "x-build-id": "A04JzNftgPPKCZMCK"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/kestrel~hostelworld-reviews-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-kestrel-hostelworld-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~hostelworld-reviews-scraper/runs": {
      "post": {
        "operationId": "runs-sync-kestrel-hostelworld-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~hostelworld-reviews-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-kestrel-hostelworld-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": "Hostelworld property URLs",
            "uniqueItems": true,
            "type": "array",
            "description": "Hostelworld property pages, e.g. https://www.hostelworld.com/hostels/p/15529/home-lisbon-hostel/ or the older https://www.hostelworld.com/pwa/hosteldetails.php/Home-Lisbon-Hostel/Lisbon/15529 — every URL form Hostelworld serves carries the numeric property id, so no page has to be loaded first. Any query string is fine.",
            "default": [],
            "items": {
              "type": "string"
            }
          },
          "propertyIds": {
            "title": "Hostelworld property ids",
            "uniqueItems": true,
            "type": "array",
            "description": "Hostelworld's numeric property ids, e.g. 15529 — the number in /hostels/p/<id>/ and the last path segment of a hosteldetails.php URL, and what an earlier run's property_id gives you. The fastest path: no lookup at all.",
            "default": [],
            "items": {
              "type": "string"
            }
          },
          "maxReviewsPerProperty": {
            "title": "Max reviews per hostel",
            "minimum": 0,
            "maximum": 20000,
            "type": "integer",
            "description": "0 = every review the hostel has (Hostelworld pages them 50 at a time; a busy hostel runs to a few thousand). N = the first N in the order below. The main cost control.",
            "default": 100
          },
          "reviewsSort": {
            "title": "Review order",
            "enum": [
              "-date",
              "date",
              "rating",
              "-rating"
            ],
            "type": "string",
            "description": "The order Hostelworld returns reviews in. -date = newest first (the default, and the only order in which sinceDate can stop paging early), date = oldest first, rating = lowest rated first (a complaints feed), -rating = highest rated first. These four are the only values the API really honours — anything else is silently served as newest first.",
            "default": "-date"
          },
          "minRating": {
            "title": "Only reviews at or above this score",
            "minimum": 0,
            "maximum": 100,
            "type": "integer",
            "description": "Hostelworld scores each review 0-100 (100 = perfect); every row also carries the same score on the 0-5 scale as rating_5. 0 = no floor. 90 keeps only the raves. Filtered reviews are never charged.",
            "default": 0
          },
          "maxRating": {
            "title": "Only reviews at or below this score",
            "minimum": 0,
            "maximum": 100,
            "type": "integer",
            "description": "The other end of the same 0-100 overall score: 0 = no ceiling, 70 gives a complaints feed. Combine with reviewsSort = lowest rated first so the worst reviews arrive on page one. Filtered reviews are never charged.",
            "default": 0
          },
          "requireText": {
            "title": "Only reviews with a written text",
            "type": "boolean",
            "description": "Drop score-only reviews (an empty notes field) before billing. Hostelworld reviews nearly always carry a sentence or two, so this rarely removes much.",
            "default": false
          },
          "groupTypes": {
            "title": "Who was travelling",
            "uniqueItems": true,
            "type": "array",
            "description": "Keep only reviews from these group types: MALE and FEMALE (solo travellers), COUPLE, ALLFEMALEGROUP, ALLMALEGROUP, MIXEDGROUP, FAMILY. Friendly spellings work too (solo_female, female_group, mixed_group). Empty = all. Hostelworld's API has no server-side filter for this, so the filter runs here in the actor — the pages are still read, the filtered reviews are simply never charged.",
            "default": [],
            "items": {
              "type": "string"
            }
          },
          "sinceDate": {
            "title": "Only reviews published on or after",
            "type": "string",
            "description": "YYYY-MM-DD, or relative so schedules never go stale: \"30 days\", \"2 weeks\", \"6 months\". With the default newest-first order the run stops reading once a whole page predates the date, so a daily schedule reads one page per hostel. Empty = no date limit.",
            "default": ""
          },
          "includePropertyRow": {
            "title": "Include a hostel row",
            "type": "boolean",
            "description": "Also emit one free row per hostel with its name, type, city, country, address, coordinates, star rating, the aggregate 0-100 ratings, total ratings, facilities, what it is best for and its lowest nightly price. The hostel record is read either way — it is what gives review rows their hostel name and URL — and is never charged.",
            "default": true
          },
          "sessions": {
            "title": "Parallel sessions",
            "minimum": 1,
            "maximum": 16,
            "type": "integer",
            "description": "How many proxy sessions (egress IPs) run in parallel. More is faster; each is paced separately.",
            "default": 2
          },
          "perIp": {
            "title": "Requests per second per session",
            "minimum": 0.1,
            "maximum": 5,
            "type": "number",
            "description": "Pace for each session. Hostelworld's API answered 10 of 10 requests at 1 req/s from a single datacenter IP with no throttling at all; 1-2 is comfortable.",
            "default": 1
          },
          "proxyConfiguration": {
            "title": "Proxy",
            "type": "object",
            "description": "Apify Proxy with the datacenter group is enough: the API answers plain HTTP requests from datacenter ranges with no key, no auth and no bot gate. Residential works too and costs more. Keep the default.",
            "default": {
              "useApifyProxy": true
            }
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}