Official site rates

Request#

Authenticate with your API key in the x-api-key header (see Authentication).

Body#

JSON object. Unknown fields are rejected with 422.

• urlstringrequiredmin length 8

  The hotel's public homepage or property page. The API finds its booking link and detects the booking engine automatically; a direct booking URL is also accepted.

• check_instring (date)required

  First night of the stay, YYYY-MM-DD.

• check_outstring (date) | null

  Departure date. An alternative to nights — if both are given, this wins.

• nightsintegerdefault 1min 1, max 30

  Length of stay. Ignored when check_out is supplied.

• adultsintegerdefault 2min 1, max 8

  Adults in the room. Two is the hotel default; pass one for a hostel, which is priced per bed. Any value from 1 to 8 is accepted.

• roomsintegerdefault 1min 1, max 8

  Rooms requested.

• currencystringdefault USD

  ISO 4217 code for the returned prices. Major currencies include AED, AUD, BRL, CAD, CHF, CNY, EUR, GBP, HKD, INR, JPY, KRW, MXN, NZD, SGD, USD; all 39 supported codes are listed in the enum.

  39 allowed values

  AED, ARS, AUD, BRL, CAD, CHF, CLP, CNY, COP, CZK, DKK, EGP, EUR, GBP, HKD, HUF, IDR, ILS, INR, JPY, KRW, MXN, MYR, NOK, NZD, PEN, PHP, PLN, QAR, RON, SAR, SEK, SGD, THB, TRY, TWD, USD, VND, ZAR

Example request#

curl -X POST "https://api.scrapercompany.com/v1/official" \
  -H "x-api-key: $SCRAPERCOMPANY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://www.marriott.com/en-us/hotels/yyzrz-the-ritz-carlton-toronto/overview/",
    "check_in": "2026-11-30",
    "nights": 1,
    "currency": "USD"
  }'

Response#

200 — Normalised public and member rates from the detected booking engine. Metered responses carry x-credits-charged and x-credits-remaining headers (see credit headers).

{
  "search_parameters": {
    "engine": "official_marriott",
    "source_url": "https://www.marriott.com/en-us/hotels/yyzrz-the-ritz-carlton-toronto/overview/",
    "booking_url": "https://www.marriott.com/en-us/hotels/yyzrz-the-ritz-carlton-toronto/overview/",
    "check_in_date": "2029-02-05",
    "check_out_date": "2029-02-06",
    "adults": 2,
    "currency": "CAD"
  },
  "engine": "marriott",
  "source_url": "https://www.marriott.com/en-us/hotels/yyzrz-the-ritz-carlton-toronto/overview/",
  "booking_url": "https://www.marriott.com/en-us/hotels/yyzrz-the-ritz-carlton-toronto/overview/",
  "detected_by": "url",
  "discovery_pages": 0,
  "wrapper_resolutions": 0,
  "discovery_cache_hit": false,
  "discovery_elapsed_s": 0.001,
  "collection_id": "ratecol_0123456789abcdef0123456789abcdef",
  "observed_at": "2026-08-07T01:23:45.678Z",
  "property_ref": "YYZRZ",
  "check_in": "2029-02-05",
  "check_out": "2029-02-06",
  "nights": 1,
  "currency": "CAD",
  "sold_out": false,
  "cheapest_rate": 690,
  "cheapest_member_rate": 655.5,
  "member_rates_returned": 1,
  "rooms_returned": 1,
  "used_browser": false,
  "elapsed_s": 0.71,
  "rooms": [
    {
      "name": "Deluxe King",
      "code": "GENR",
      "max_occupancy": 2,
      "quantity": 3,
      "available": true,
      "cheapest_rate": 690,
      "rates": [
        {
          "price": 690,
          "price_total": 779.7,
          "currency": "CAD",
          "rate_plan": "Flexible",
          "tax_inclusive": true,
          "access_type": "public",
          "is_discounted": false,
          "provenance": {
            "schema_version": 1,
            "observation_id": "rateobs_0123456789abcdef0123456789abcdef",
            "collection_id": "ratecol_0123456789abcdef0123456789abcdef",
            "observed_at": "2026-08-07T01:23:45.678Z",
            "source": "official_marriott",
            "source_kind": "official",
            "collector": "scrapingme.official.marriott",
            "source_property_id": "YYZRZ",
            "requested_market": "US",
            "requested_currency": "USD",
            "returned_currency": "USD",
            "egress_mode": "direct",
            "price_basis": "room_base_before_taxes_and_fees",
            "derivation": "normalized_upstream"
          }
        },
        {
          "price": 655.5,
          "price_total": 740.72,
          "original_price": 690,
          "currency": "CAD",
          "rate_plan": "Marriott Bonvoy Member",
          "tax_inclusive": false,
          "access_type": "member",
          "is_discounted": true
        }
      ]
    }
  ]
}

Response fields#

Fields marked required are always present; others appear when they apply.

• search_parametersobjectrequired
  Show 7 child fieldsHide child fields

  • search_parameters.enginestringrequired

    official_ + engine id.

  • search_parameters.source_urlstringrequired
  • search_parameters.booking_urlstringrequired
  • search_parameters.check_in_datestring (date)required
  • search_parameters.check_out_datestring (date)required
  • search_parameters.adultsintegerrequired
  • search_parameters.currencystringrequired
• enginestringrequired

  Detected engine id.

• source_urlstringrequired
• booking_urlstringrequired
• detected_bystringrequired

  How the engine was detected, e.g. url, redirect, booking_link, html_fingerprint.

• discovery_pagesintegerrequired
• wrapper_resolutionsintegerrequired
• discovery_cache_hitbooleanrequired
• discovery_elapsed_snumberrequired
• collection_idstringrequired
• observed_atstringrequired
• property_refstringrequired

  Engine-native property id (may be empty).

• check_instring (date)required
• check_outstring (date)required
• nightsintegerrequired
• currencystringrequired
• sold_outbooleanrequired
• cheapest_ratenumber | nullrequired

  Cheapest public rate across available rooms.

• cheapest_member_ratenumber | nullrequired
• member_rates_returnedintegerrequired
• rooms_returnedintegerrequired
• used_browserbooleanrequired
• elapsed_snumberrequired
• roomsarray of objectrequired
  Show 7 child fieldsHide child fields

  • rooms[].namestringrequired
  • rooms[].codestringrequired
  • rooms[].max_occupancyinteger | nullrequired
  • rooms[].quantityinteger | nullrequired
  • rooms[].availablebooleanrequired
  • rooms[].cheapest_ratenumber | nullrequired

    Cheapest PUBLIC rate in rates.

  • rooms[].ratesarray of objectrequired
    Show 14 child fieldsHide child fields

    • rooms[].rates[].pricenumber | nullrequired

      Headline price for the stay on the engine's own basis.

    • rooms[].rates[].price_totalnumber | nullrequired
    • rooms[].rates[].reference_pricenumber | nullrequired
    • rooms[].rates[].taxnumber | nullrequired
    • rooms[].rates[].feesnumber | nullrequired
    • rooms[].rates[].original_pricenumber | nullrequired
    • rooms[].rates[].currencystringrequired
    • rooms[].rates[].rate_planstringrequired
    • rooms[].rates[].tax_inclusiveboolean | nullrequired

      Null means the engine did not state a basis, not that tax is excluded.

    • rooms[].rates[].access_typestringrequired

      public, member, points_and_cash or points.

    • rooms[].rates[].loyalty_pointsinteger | nullrequired
    • rooms[].rates[].loyalty_cashnumber | nullrequired
    • rooms[].rates[].is_discountedbooleanrequired
    • rooms[].rates[].provenanceobjectrequired

      Where, when and how one normalized price was observed.

Errors#

Errors return a JSON body with a detail field. Failed requests are not charged. See Errors for the full list and retry advice.

Try it#

1. Export your key: export SCRAPERCOMPANY_API_KEY=sk_... (no key yet? request access).
2. Copy the cURL example above and run it in a terminal.
3. Or open the interactive playground on api.scrapercompany.com, paste your key and pick this endpoint.