{
  "openapi": "3.0.1",
  "info": {
    "title": "Agoda Scraper: Hotel Prices, Room Types and Reviews",
    "description": "Scrape Agoda hotels by city and dates: one row per hotel with star rating, review score, nightly price with and without taxes, stay total, free cancellation, rooms left and every room type, or Agoda guest reviews per hotel. No login.",
    "version": "0.1",
    "x-build-id": "bUIkNswg5QymnYfx4"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/themineworks~agoda-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-themineworks-agoda-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/themineworks~agoda-scraper/runs": {
      "post": {
        "operationId": "runs-sync-themineworks-agoda-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/themineworks~agoda-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-themineworks-agoda-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 get",
            "enum": [
              "hotels",
              "reviews"
            ],
            "type": "string",
            "description": "Hotels: one row per hotel with prices for your dates. Reviews: one row per guest review of each hotel (hotels from hotelUrls, or the top hotels of each location).",
            "default": "hotels"
          },
          "locations": {
            "title": "Cities or places",
            "type": "array",
            "description": "City names as you would type them on agoda.com, one per line, for example Bangkok, Bali, Tokyo, Kuala Lumpur. An Agoda search link with city= in it also works. Up to 50 per run.",
            "items": {
              "type": "string"
            }
          },
          "hotelUrls": {
            "title": "Hotel links or ids (optional)",
            "type": "array",
            "description": "Agoda hotel links such as https://www.agoda.com/the-peninsula-bangkok/hotel/bangkok-th.html, or Agoda hotel ids such as 10715. In Hotels mode each gets one row with all its room types and rates; in Reviews mode, its reviews. Up to 500.",
            "items": {
              "type": "string"
            }
          },
          "checkIn": {
            "title": "Check-in date",
            "type": "string",
            "description": "Date as YYYY-MM-DD, for example 2026-12-20. Leave empty for 30 days from today."
          },
          "nights": {
            "title": "Nights",
            "minimum": 1,
            "maximum": 30,
            "type": "integer",
            "description": "Length of stay, 1 to 30. Prices per night and for the whole stay are both returned.",
            "default": 1
          },
          "adults": {
            "title": "Adults",
            "minimum": 1,
            "maximum": 36,
            "type": "integer",
            "description": "Adults in total, across all rooms.",
            "default": 2
          },
          "children": {
            "title": "Children",
            "minimum": 0,
            "maximum": 9,
            "type": "integer",
            "description": "Children in total. Their ages go in childAges (8 is used for any age not given).",
            "default": 0
          },
          "childAges": {
            "title": "Children's ages (optional)",
            "type": "array",
            "description": "One age per child, 0 to 17, for example 4 and 9.",
            "items": {
              "type": "string"
            }
          },
          "rooms": {
            "title": "Rooms",
            "minimum": 1,
            "maximum": 9,
            "type": "integer",
            "description": "Number of rooms to book.",
            "default": 1
          },
          "currency": {
            "title": "Currency",
            "type": "string",
            "description": "Three letter currency code for all prices, for example USD, EUR, THB, INR, SGD, JPY, AUD.",
            "default": "USD"
          },
          "sortBy": {
            "title": "Sort hotels by",
            "enum": [
              "recommended",
              "price_low",
              "price_high",
              "stars",
              "review_score",
              "distance"
            ],
            "type": "string",
            "description": "The order Agoda returns the city's hotels in. With maxHotels below the city size, this decides which hotels you get.",
            "default": "recommended"
          },
          "maxHotels": {
            "title": "Max hotels per location",
            "minimum": 1,
            "maximum": 2000,
            "type": "integer",
            "description": "The most hotels to return for each city, 1 to 2,000. A results page holds 45. In Reviews mode, how many hotels of each city to read reviews for.",
            "default": 50
          },
          "minStars": {
            "title": "Minimum star rating (optional)",
            "minimum": 0,
            "maximum": 5,
            "type": "integer",
            "description": "Keep only hotels with at least this many stars, 1 to 5. Hotels left out are not charged."
          },
          "minReviewScore": {
            "title": "Minimum review score (optional)",
            "minimum": 0,
            "maximum": 10,
            "type": "integer",
            "description": "Keep only hotels with at least this guest score out of 10, for example 8. Hotels left out are not charged."
          },
          "includeRoomTypes": {
            "title": "Add room types, address and facilities",
            "type": "boolean",
            "description": "On: each hotel's own page data is read too, for every room type with its cheapest rate, size, beds, view, breakfast and free cancellation options, plus the full address, description, check-in and check-out times and facilities. About 5 seconds more per 5 hotels. Same price per hotel.",
            "default": false
          },
          "maxReviewsPerHotel": {
            "title": "Max reviews per hotel (Reviews mode)",
            "minimum": 1,
            "maximum": 5000,
            "type": "integer",
            "description": "The most reviews to return for each hotel, 1 to 5,000.",
            "default": 100
          },
          "reviewSort": {
            "title": "Review order (Reviews mode)",
            "enum": [
              "newest",
              "rating_high",
              "rating_low",
              "helpful"
            ],
            "type": "string",
            "description": "Which reviews come first.",
            "default": "newest"
          },
          "reviewSource": {
            "title": "Review source (Reviews mode)",
            "enum": [
              "all",
              "agoda",
              "booking"
            ],
            "type": "string",
            "description": "Agoda shows reviews written on Agoda and on Booking.com. Pick one or both.",
            "default": "all"
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}