{ "openapi": "3.0.1", "info": { "title": "Hotel Details & Photos Scraper - Booking, Airbnb, Google", "description": "Scrape hotel and rental content, not prices: Booking.com details, photos, facilities and review summary, Airbnb listing details and photos, Google Hotels photos and nearby places, and Tripadvisor place details. Batch many properties per run. Made by ScraperCompany.", "version": "1.0", "x-build-id": "marXUTyoXPkQTCaj0" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scrapercompany~hotel-details-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scrapercompany-hotel-details-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/scrapercompany~hotel-details-scraper/runs": { "post": { "operationId": "runs-sync-scrapercompany-hotel-details-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/scrapercompany~hotel-details-scraper/run-sync": { "post": { "operationId": "run-sync-scrapercompany-hotel-details-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": { "mode": { "title": "What to scrape", "enum": [ "booking-details", "booking-photos", "booking-facilities", "booking-review-summary", "airbnb-listing", "airbnb-photos", "google-photos", "google-nearby", "tripadvisor-details" ], "type": "string", "description": "The source and the kind of content. Each source has its own list of properties below; only the list for the selected source is used.", "default": "booking-details" }, "bookingHotels": { "title": "Booking.com hotels", "type": "array", "description": "One hotel per line: a Booking.com property URL (https://www.booking.com/hotel/gb/the-savoy.html), or the slug from that URL (the-savoy) with its Booking.com URL country.", "default": [ "newbury-guest-house" ], "items": { "type": "string" } }, "bookingCountry": { "title": "Booking.com URL country", "enum": [ "ad", "ae", "af", "ag", "ai", "al", "am", "ao", "aq", "ar", "as", "at", "au", "aw", "ax", "az", "ba", "bb", "bd", "be", "bf", "bg", "bh", "bi", "bj", "bl", "bm", "bn", "bo", "bq", "br", "bs", "bt", "bv", "bw", "by", "bz", "ca", "cc", "cd", "cf", "cg", "ch", "ci", "ck", "cl", "cm", "cn", "co", "cr", "cu", "cv", "cw", "cx", "cy", "cz", "de", "dj", "dk", "dm", "do", "dz", "ec", "ee", "eg", "eh", "er", "es", "et", "fi", "fj", "fk", "fm", "fo", "fr", "ga", "gb", "gd", "ge", "gf", "gg", "gh", "gi", "gl", "gm", "gn", "gp", "gq", "gr", "gs", "gt", "gu", "gw", "gy", "hk", "hm", "hn", "hr", "ht", "hu", "id", "ie", "il", "im", "in", "io", "iq", "ir", "is", "it", "je", "jm", "jo", "jp", "ke", "kg", "kh", "ki", "km", "kn", "kp", "kr", "kw", "ky", "kz", "la", "lb", "lc", "li", "lk", "lr", "ls", "lt", "lu", "lv", "ly", "ma", "mc", "md", "me", "mf", "mg", "mh", "mk", "ml", "mm", "mn", "mo", "mp", "mq", "mr", "ms", "mt", "mu", "mv", "mw", "mx", "my", "mz", "na", "nc", "ne", "nf", "ng", "ni", "nl", "no", "np", "nr", "nu", "nz", "om", "pa", "pe", "pf", "pg", "ph", "pk", "pl", "pm", "pn", "pr", "ps", "pt", "pw", "py", "qa", "re", "ro", "rs", "ru", "rw", "sa", "sb", "sc", "sd", "se", "sg", "sh", "si", "sj", "sk", "sl", "sm", "sn", "so", "sr", "ss", "st", "sv", "sx", "sy", "sz", "tc", "td", "tf", "tg", "th", "tj", "tk", "tl", "tm", "tn", "to", "tr", "tt", "tv", "tw", "tz", "ua", "ug", "uk", "um", "us", "uy", "uz", "va", "vc", "ve", "vg", "vi", "vn", "vu", "wf", "ws", "xk", "ye", "yt", "za", "zm", "zw" ], "type": "string", "description": "Two-letter segment before the slug in the Booking.com URL (gb in /hotel/gb/the-savoy.html). Applies to slugs; a full URL brings its own.", "default": "us" }, "includeNearby": { "title": "Include Booking.com nearby places (details)", "type": "boolean", "description": "Property details only: also return Booking.com's own list of nearby landmarks, transit, airports, restaurants and beaches with walking and driving distances. Same price.", "default": false }, "airbnbListings": { "title": "Airbnb listings", "type": "array", "description": "One listing per line: an Airbnb listing link (https://www.airbnb.com/rooms/34397368) or the numeric listing id (34397368).", "default": [ "34397368" ], "items": { "type": "string" } }, "airbnb_domain": { "title": "Airbnb site", "enum": [ "airbnb.ae", "airbnb.am", "airbnb.at", "airbnb.az", "airbnb.ba", "airbnb.be", "airbnb.ca", "airbnb.cat", "airbnb.ch", "airbnb.cl", "airbnb.cn", "airbnb.co.cr", "airbnb.co.id", "airbnb.co.in", "airbnb.co.kr", "airbnb.co.nz", "airbnb.co.uk", "airbnb.co.ve", "airbnb.com", "airbnb.com.ar", "airbnb.com.au", "airbnb.com.bo", "airbnb.com.br", "airbnb.com.bz", "airbnb.com.co", "airbnb.com.ec", "airbnb.com.ee", "airbnb.com.gt", "airbnb.com.hk", "airbnb.com.hn", "airbnb.com.my", "airbnb.com.ni", "airbnb.com.pa", "airbnb.com.pe", "airbnb.com.ph", "airbnb.com.py", "airbnb.com.ro", "airbnb.com.sg", "airbnb.com.sv", "airbnb.com.tr", "airbnb.com.tw", "airbnb.com.ua", "airbnb.com.vn", "airbnb.cz", "airbnb.de", "airbnb.dk", "airbnb.es", "airbnb.fi", "airbnb.fr", "airbnb.gr", "airbnb.gy", "airbnb.hu", "airbnb.ie", "airbnb.is", "airbnb.it", "airbnb.jp", "airbnb.lt", "airbnb.lu", "airbnb.lv", "airbnb.me", "airbnb.mx", "airbnb.nl", "airbnb.no", "airbnb.pl", "airbnb.pt", "airbnb.rs", "airbnb.ru", "airbnb.se", "airbnb.si", "ar.airbnb.com", "bg.airbnb.com", "de.airbnb.lu", "es.airbnb.com", "fr.airbnb.be", "fr.airbnb.ca", "fr.airbnb.ch", "ga.airbnb.ie", "he.airbnb.com", "hi.airbnb.co.in", "hr.airbnb.com", "it.airbnb.ch", "ka.airbnb.com", "kn.airbnb.co.in", "mk.airbnb.com", "mr.airbnb.co.in", "mt.airbnb.com.mt", "sk.airbnb.com", "sq.airbnb.com", "sw.airbnb.com", "th.airbnb.com", "xh.airbnb.co.za", "zh-t.airbnb.com", "zh.airbnb.com", "zu.airbnb.co.za" ], "type": "string", "description": "Airbnb country site. It sets the language and the default currency of the record.", "default": "airbnb.com" }, "currency": { "title": "Airbnb currency (listing)", "type": "string", "description": "Listing details only: currency for any money text in the record. Leave empty for the site's default." }, "check_in": { "title": "Stay check-in (listing cancellation policy)", "pattern": "^(\\d{4})-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01])$|^(\\d+)\\s*(day|week|month|year)s?$", "type": "string", "description": "Listing details only: Airbnb states cancellation deadlines only for a given stay. Give a check-in and check-out (YYYY-MM-DD or relative, e.g. 30 days) to get the refund milestones; leave both empty to skip." }, "check_out": { "title": "Stay check-out (listing cancellation policy)", "pattern": "^(\\d{4})-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01])$|^(\\d+)\\s*(day|week|month|year)s?$", "type": "string", "description": "Listing details only: the stay's check-out date (YYYY-MM-DD or relative, e.g. 32 days). Give both dates or neither." }, "googleProperties": { "title": "Google Hotels property tokens", "type": "array", "description": "One Google Hotels property token per line (starts with Ch, e.g. ChUIoben2Mv6-CYaCi9tLzA3czVwbjQQAQ). Get tokens from the Google Hotels Search Scraper results.", "default": [ "ChUI6IWohK-tzZFIGgkvbS8wODZjXzUQAQ" ], "items": { "type": "string" } }, "maxPages": { "title": "Photo pages per property (Google photos)", "minimum": 1, "maximum": 20, "type": "integer", "description": "Google Hotels photos only: how many gallery pages to fetch per property (1-20). Each page is a separate request and is charged separately; paging stops at the last page.", "default": 1 }, "photosPerPage": { "title": "Photos per page (Google photos)", "minimum": 1, "maximum": 100, "type": "integer", "description": "Google Hotels photos only: photos per page (1-100). The price per page is the same.", "default": 50 }, "photoCategory": { "title": "Photo category (Google photos)", "enum": [ "amenities", "at_a_glance", "bathroom", "bedroom", "exterior", "food_and_drink", "interior", "rooms" ], "type": "string", "description": "Google Hotels photos only: one photo tab. Leave empty for all photos. Use a category or a source, not both." }, "photoSource": { "title": "Photo source (Google photos)", "enum": [ "visitors", "owner" ], "type": "string", "description": "Google Hotels photos only: only visitors' photos or only the owner's. Leave empty for both." }, "gl": { "title": "Google country", "enum": [ "ad", "ae", "af", "ag", "ai", "al", "am", "ao", "aq", "ar", "as", "at", "au", "aw", "ax", "az", "ba", "bb", "bd", "be", "bf", "bg", "bh", "bi", "bj", "bl", "bm", "bn", "bo", "bq", "br", "bs", "bt", "bv", "bw", "by", "bz", "ca", "cc", "cd", "cf", "cg", "ch", "ci", "ck", "cl", "cm", "cn", "co", "cr", "cu", "cv", "cw", "cx", "cy", "cz", "de", "dj", "dk", "dm", "do", "dz", "ec", "ee", "eg", "eh", "er", "es", "et", "fi", "fj", "fk", "fm", "fo", "fr", "ga", "gb", "gd", "ge", "gf", "gg", "gh", "gi", "gl", "gm", "gn", "gp", "gq", "gr", "gs", "gt", "gu", "gw", "gy", "hk", "hm", "hn", "hr", "ht", "hu", "id", "ie", "il", "im", "in", "io", "iq", "ir", "is", "it", "je", "jm", "jo", "jp", "ke", "kg", "kh", "ki", "km", "kn", "kp", "kr", "kw", "ky", "kz", "la", "lb", "lc", "li", "lk", "lr", "ls", "lt", "lu", "lv", "ly", "ma", "mc", "md", "me", "mf", "mg", "mh", "mk", "ml", "mm", "mn", "mo", "mp", "mq", "mr", "ms", "mt", "mu", "mv", "mw", "mx", "my", "mz", "na", "nc", "ne", "nf", "ng", "ni", "nl", "no", "np", "nr", "nu", "nz", "om", "pa", "pe", "pf", "pg", "ph", "pk", "pl", "pm", "pn", "pr", "ps", "pt", "pw", "py", "qa", "re", "ro", "rs", "ru", "rw", "sa", "sb", "sc", "sd", "se", "sg", "sh", "si", "sj", "sk", "sl", "sm", "sn", "so", "sr", "ss", "st", "sv", "sx", "sy", "sz", "tc", "td", "tf", "tg", "th", "tj", "tk", "tl", "tm", "tn", "to", "tr", "tt", "tv", "tw", "tz", "ua", "ug", "uk", "um", "us", "uy", "uz", "va", "vc", "ve", "vg", "vi", "vn", "vu", "wf", "ws", "xk", "ye", "yt", "za", "zm", "zw" ], "type": "string", "description": "Two-letter Google country for the request.", "default": "us" }, "hl": { "title": "Google language", "type": "string", "description": "Language for captions and labels, e.g. en, fr.", "default": "en" }, "tripadvisorPlaces": { "title": "Tripadvisor places", "type": "array", "description": "One hotel, restaurant or attraction per line: a Tripadvisor page URL, its numeric location id (the digits after -d in the URL, e.g. 208453), or a place name such as Moxy Boston Downtown (add a City to narrow names).", "default": [ "17768161" ], "items": { "type": "string" } }, "tripadvisorCity": { "title": "City (for place names)", "type": "string", "description": "With place names only: the city, used to pick the right place when several share the name." }, "customRequests": { "title": "Custom requests (advanced)", "type": "array", "description": "Optional list of JSON objects, one request each, using the field names shown above. Each object is merged over the options above, so you only need to give what differs. Use \"mode\" to pick the mode per object, with that source's id field (pagename or url, listing_id, property_token, location_id). Example: {\"mode\":\"booking-photos\",\"url\":\"https://www.booking.com/hotel/gb/the-savoy.html\"}" }, "includeErrors": { "title": "Include failed requests in the dataset", "type": "boolean", "description": "When on, a request that fails (for example an unknown property id) is saved as a dataset item with an error message so you can see what went wrong. Failed requests are never charged.", "default": true }, "maxConcurrency": { "title": "Parallel requests", "minimum": 1, "maximum": 8, "type": "integer", "description": "How many requests run at the same time (1-8). Parallel runs share one limit, so extra requests wait for a free slot instead of failing.", "default": 3 }, "maxRetries": { "title": "Retries per request", "minimum": 0, "maximum": 5, "type": "integer", "description": "How many times a request that failed for a temporary reason is tried again. Invalid input is never retried.", "default": 2 } } }, "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 } } } } } } } } } }