{
  "openapi": "3.0.1",
  "info": {
    "title": "Hotel Rate Monitor: Google Hotels OTA Prices & Parity",
    "description": "Track hotel prices on Google Hotels from every booking site (Booking.com, Expedia, Agoda, the hotel's own site) for your dates. Rate parity, a 12-month price calendar and, on scheduled runs, only the price changes since the last run.",
    "version": "0.1",
    "x-build-id": "uxFmmMks3P0h0Vw2Y"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/steady-scrape~hotel-rate-monitor/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-steady-scrape-hotel-rate-monitor",
        "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/steady-scrape~hotel-rate-monitor/runs": {
      "post": {
        "operationId": "runs-sync-steady-scrape-hotel-rate-monitor",
        "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/steady-scrape~hotel-rate-monitor/run-sync": {
      "post": {
        "operationId": "run-sync-steady-scrape-hotel-rate-monitor",
        "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": {
          "hotels": {
            "title": "Hotels to check",
            "type": "array",
            "description": "Hotel names (add the city for accuracy, e.g. 'Hotel Mar Rey Tamarindo'), Google Hotels URLs (the ones with /entity/ in them) or Google hotel ids (ChcI...). Up to 200 per run. A name is matched once ($0.001 per newly matched name) and remembered for 90 days; names with no match are free and remembered for 7 days. URLs and ids need no lookup.",
            "items": {
              "type": "string"
            }
          },
          "searchQuery": {
            "title": "Or find hotels with a search (optional)",
            "type": "string",
            "description": "E.g. 'hotels in Tamarindo' or 'boutique hotels near Times Square'. Adds the top results (Max hotels from search) to the list above."
          },
          "maxHotels": {
            "title": "Max hotels from search",
            "minimum": 1,
            "maximum": 140,
            "type": "integer",
            "description": "How many hotels to take from the search (organic results first).",
            "default": 10
          },
          "fetchRates": {
            "title": "Check prices from every booking site for search results",
            "type": "boolean",
            "description": "On: each hotel found by the search gets a full rate check (all booking sites). Off: you get one cheap listing row per hotel (name, stars, rating, Google's lowest price).",
            "default": true
          },
          "stars": {
            "title": "Search filter: hotel class",
            "type": "array",
            "description": "Only these star ratings in the search, e.g. 4, 5.",
            "items": {
              "type": "string"
            }
          },
          "minRating": {
            "title": "Search filter: minimum guest rating",
            "enum": [
              "",
              "3.5",
              "4",
              "4.5"
            ],
            "type": "string",
            "description": "Only hotels with at least this Google guest rating in the search.",
            "default": ""
          },
          "sortBy": {
            "title": "Search order",
            "enum": [
              "relevance",
              "lowest_price",
              "highest_rating",
              "most_reviewed"
            ],
            "type": "string",
            "description": "Order of the search results.",
            "default": "relevance"
          },
          "checkInDates": {
            "title": "Check-in dates",
            "type": "array",
            "description": "One or more check-in dates: YYYY-MM-DD or relative to the run day, e.g. +7d, +30d, +2w. Relative dates keep a schedule rolling forward. Each hotel is checked for each date.",
            "default": [
              "+30d"
            ],
            "items": {
              "type": "string"
            }
          },
          "sweepDays": {
            "title": "Date sweep (consecutive check-in days)",
            "minimum": 0,
            "maximum": 90,
            "type": "integer",
            "description": "0 = off. N = check N consecutive check-in dates starting from the first date above (e.g. 14 = the next two weeks of arrivals).",
            "default": 0
          },
          "nights": {
            "title": "Nights",
            "minimum": 1,
            "maximum": 30,
            "type": "integer",
            "description": "Length of each stay. Total price = nightly price x nights.",
            "default": 1
          },
          "adults": {
            "title": "Adults",
            "minimum": 1,
            "maximum": 6,
            "type": "integer",
            "description": "Adults per room (max 6 guests in total).",
            "default": 2
          },
          "childrenAges": {
            "title": "Children's ages",
            "type": "array",
            "description": "One age (0-17) per child, e.g. 8, 13. Max 6 guests in total.",
            "items": {
              "type": "string"
            }
          },
          "currency": {
            "title": "Currency",
            "type": "string",
            "description": "3-letter code: USD, EUR, GBP, MXN, CRC...",
            "default": "USD"
          },
          "location": {
            "title": "Market (searcher's country or city)",
            "type": "string",
            "description": "Where the traveller searches from, which changes the prices and booking sites Google shows. A country ('United States', 'United Kingdom', 'Costa Rica') or a city in Google's format ('London,England,United Kingdom'). For name lookups, use the hotel's country or city.",
            "default": "United States"
          },
          "language": {
            "title": "Language",
            "type": "string",
            "description": "Language code for hotel names and site titles, e.g. en, es, fr.",
            "default": "en"
          },
          "calendarRange": {
            "title": "Price calendar (lowest nightly price per date)",
            "enum": [
              "none",
              "month",
              "three_months",
              "six_months",
              "year"
            ],
            "type": "string",
            "description": "Adds one calendar row per hotel with Google's lowest 1-night price for every date in the range, starting at the first check-in date. Great for spotting peak dates and pricing gaps.",
            "default": "none"
          },
          "includeAds": {
            "title": "Include sponsored (ad) prices",
            "type": "boolean",
            "description": "Google shows some booking sites as ads. They are real public offers; they're marked isAd so you can filter them.",
            "default": true
          },
          "parityTolerancePct": {
            "title": "Parity tolerance (%)",
            "minimum": 0,
            "maximum": 50,
            "type": "integer",
            "description": "A booking site counts as undercutting the hotel's own site when it's cheaper by more than this percentage.",
            "default": 1
          },
          "outputFormat": {
            "title": "Output format",
            "enum": [
              "hotel",
              "source"
            ],
            "type": "string",
            "description": "Nested (one row per hotel and date) or flat (one row per booking site).",
            "default": "hotel"
          },
          "monitorId": {
            "title": "Monitor ID (turns on change tracking)",
            "type": "string",
            "description": "Any name, e.g. 'tamarindo-compset'. Runs with the same Monitor ID compare against the previous run and add change rows: price up/down per booking site, new or removed sites, new lowest site, parity breaks, sold out. Leave empty for one-off checks."
          },
          "onlyChanges": {
            "title": "Output only changes",
            "type": "boolean",
            "description": "With a Monitor ID: skip the full rate rows and output only change rows (ideal for alerts via webhooks, Slack, email). Checks are still charged.",
            "default": false
          },
          "changeThresholdPct": {
            "title": "Minimum price change to report (%)",
            "minimum": 0,
            "maximum": 100,
            "type": "integer",
            "description": "0 = report every price change.",
            "default": 0
          },
          "reportSourceChanges": {
            "title": "Report booking sites appearing / disappearing",
            "type": "boolean",
            "description": "Off: report only price moves, new lowest site, parity and sold-out changes. Sites that Google shows only as ads never count as appearing or disappearing (Google rotates ads between searches).",
            "default": true
          },
          "speed": {
            "title": "Speed",
            "enum": [
              "standard",
              "live"
            ],
            "type": "string",
            "description": "Standard is the cheapest. Live returns each check in seconds and is billed as a live check. New hotel-name lookups always use the standard queue (about 20 s), whatever the speed. Live speed needs a paid Apify plan (free-plan runs use standard).",
            "default": "standard"
          },
          "maxChecks": {
            "title": "Max checks (hotels x dates)",
            "minimum": 1,
            "maximum": 5000,
            "type": "integer",
            "description": "Safety cap on hotel/date combinations per run. On the free Apify plan, runs are capped at 50 checks and 50 new hotel-name lookups.",
            "default": 200
          },
          "maxQueueWaitMinutes": {
            "title": "Max standard queue wait (minutes)",
            "minimum": 2,
            "maximum": 20,
            "type": "integer",
            "description": "Checks still waiting in the standard queue after this are moved to the provider's priority queue automatically, at no extra charge to you (still billed as a normal standard check). Never switches to live.",
            "default": 10
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}