Rakuten Travel rooms

Request#

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

curl -X POST "https://api.scrapercompany.com/v1/ota/rakuten" \
  -H "x-api-key: $SCRAPERCOMPANY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "check_in": "2026-12-25",
    "hotel_no": "74637"
  }'

Response#

200 — Rakuten Travel rooms and plans (JPY, consumption tax included). Metered responses carry x-credits-charged and x-credits-remaining headers (see credit headers).

{
  "search_parameters": {
    "engine": "rakuten_property",
    "hotel_no": "74637",
    "check_in_date": "2027-02-24",
    "check_out_date": "2027-02-26",
    "adults": 2
  },
  "property": {
    "property_id": "74637",
    "name": "アパホテル＆リゾート〈東京ベイ潮見〉",
    "price_per_night": 24750,
    "total_tax_included": 49500,
    "currency": "JPY",
    "sold_out": false,
    "availability": "available",
    "is_soldout": false,
    "provenance": {
      "schema_version": 1,
      "observation_id": "rateobs_0123456789abcdef0123456789abcdef",
      "collection_id": "ratecol_0123456789abcdef0123456789abcdef",
      "observed_at": "2026-08-07T01:23:45.678Z",
      "source": "rakuten",
      "source_kind": "ota_rate_plan",
      "source_property_id": "74637",
      "requested_currency": "JPY",
      "returned_currency": "JPY",
      "price_basis": "consumption_tax_included",
      "derivation": "normalized_upstream"
    },
    "rooms": [
      {
        "name": "□ 禁煙室 □ セミダブル",
        "room_code": "w1k",
        "category": "セミダブル",
        "size_capacity": "11m²/1人〜2人",
        "available": true,
        "cheapest_price": 24750,
        "rate_plans": [
          {
            "plan_id": "5187093",
            "room_code": "w1k",
            "name": "【素泊まり・事前決済限定】1秒チェックインにおすすめ！",
            "price": 24750,
            "total_tax_included": 49500,
            "total_before_tax": 45000,
            "currency": "JPY",
            "meal": "朝食なし 夕食なし",
            "payment": "予約時オンラインカード決済",
            "cancellation": "キャンセル料 無料 前日 (2026年11月18日) 23:59まで",
            "points": 450,
            "rate_code": "5187093",
            "rate_category": "unknown",
            "refundable": true,
            "meal_plan": "room_only",
            "rate_code_scope": "property",
            "provenance": {
              "schema_version": 1,
              "observation_id": "rateobs_0123456789abcdef0123456789abcdef",
              "collection_id": "ratecol_0123456789abcdef0123456789abcdef",
              "observed_at": "2026-08-07T01:23:45.678Z",
              "source": "rakuten",
              "source_kind": "ota_rate_plan",
              "source_property_id": "74637",
              "requested_currency": "JPY",
              "returned_currency": "JPY",
              "price_basis": "consumption_tax_included",
              "derivation": "normalized_upstream"
            }
          }
        ]
      }
    ]
  },
  "meta": {
    "source": "rakuten",
    "nights": 2,
    "adults": 2,
    "elapsed_s": 2.45,
    "total_rate_plans": 52,
    "comparable_across_markets": false,
    "notes": "JPY only. Totals include consumption tax; local accommodation and bathing taxes are paid at the hotel and are never included."
  }
}

Response fields#

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

• search_parametersobjectrequired
  Show 5 child fieldsHide child fields

  • search_parameters.enginestringrequired

    One ofrakuten_property

  • search_parameters.hotel_nostringrequired
  • search_parameters.check_in_datestring (date)required
  • search_parameters.check_out_datestring (date)required
  • search_parameters.adultsintegerrequired
• propertyobjectrequired
  Show 12 child fieldsHide child fields

  • property.property_idstringrequired

    The hotel number.

  • property.namestring | nullrequired
  • property.price_per_nightnumber | nullrequired

    Cheapest plan's nightly average.

  • property.total_tax_includedinteger | nullrequired

    Cheapest plan's whole stay.

  • property.currencystringrequired

    One ofJPY

  • property.sold_outbooleanrequired
  • property.availabilitystringrequired

    One ofavailablesold_out

  • property.is_soldoutboolean | nullrequired
  • property.availability_reasonstring | nullrequired
  • property.min_length_of_stayinteger | nullrequired
  • property.provenanceobject | nullrequired

    Provenance of the cheapest priced row; null when nothing priced.

    Show 13 child fieldsHide child fields

    • property.provenance.schema_versionintegerrequired

      Provenance schema version (currently 1).

    • property.provenance.observation_idstringrequired

      Deterministic id of this price observation (rateobs_...).

    • property.provenance.collection_idstringrequired

      Id shared by every price from one upstream fetch (ratecol_...).

    • property.provenance.observed_atstringrequired

      UTC observation time, ISO-8601.

    • property.provenance.sourcestringrequired

      Upstream source, e.g. google_hotels_calendar.

    • property.provenance.source_kindstringrequired

      Kind of source, e.g. calendar, offer, ota_calendar, official.

    • property.provenance.source_property_idstringrequired

      Property identifier at the source.

    • property.provenance.requested_marketstring | nullrequired
    • property.provenance.requested_currencystring | nullrequired
    • property.provenance.returned_currencystring | nullrequired
    • property.provenance.price_basisstringrequired

      What the price represents, e.g. room_base_before_taxes_and_fees.

    • property.provenance.derivationstringrequired

      How the figure was derived, e.g. normalized_upstream.

    • property.provenance.upstream_rate_idstring | nullrequired

      Source-native rate/room id when available.

  • property.roomsarray of objectrequired
    Show 7 child fieldsHide child fields

    • property.rooms[].categorystring | nullrequired

      Room category, in Japanese.

    • property.rooms[].size_capacitystring | nullrequired

      Size and occupancy as the site states them.

    • property.rooms[].namestringrequired
    • property.rooms[].room_codestringrequired
    • property.rooms[].availablebooleanrequired
    • property.rooms[].cheapest_pricenumber | nullrequired
    • property.rooms[].rate_plansarray of objectrequired
• metaobjectrequired
  Show 9 child fieldsHide child fields

  • meta.sourcestringrequired

    One ofrakuten

  • meta.collection_idstringrequired
  • meta.observed_atstringrequired
  • meta.nightsintegerrequired
  • meta.adultsintegerrequired
  • meta.elapsed_snumberrequired
  • meta.total_rate_plansintegerrequired
  • meta.comparable_across_marketsbooleanrequired

    Always false.

  • meta.notesstringrequired

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#

Press Try it above to run this request on your own key, with the values you type (sign in first). For a no-code walkthrough, use the workspace’s guided Try it.

1. Export your key: export SCRAPERCOMPANY_API_KEY=sk_... (no key yet? start a free trial).
2. Copy the cURL example above and run it in a terminal.