Skip to content
Docs

Agoda rooms

Agoda: every room type and rate plan for one stay window.

POST/v1/ota/agoda
12 creditsTry itAgoda API overview →

Request

POSThttps://api.scrapercompany.com/v1/ota/agoda

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

Run this request on your own API key from this page, with the values you type. Signed out? Sign in or get an API key.

Body

JSON object. Unknown fields are rejected with 422.

  • property_idstringrequiredmin length 1

    Numeric id returned by POST /v1/ota/agoda/search, or from the Agoda URL — the digits in agoda.com/…/hotel/…-h8795952.html, or the hotelId query parameter.

  • 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 1-8 works.

  • roomsintegerdefault 1min 1, max 8

    Rooms requested.

  • currencystringdefault USD

    One of 23 supported. Unlike Hotels.com these ARE comparable — Agoda converts one underlying rate.

    23 allowed values

    AED, AUD, BRL, CAD, CHF, CZK, EUR, GBP, HKD, IDR, INR, JPY, KRW, MYR, NZD, PHP, PLN, SEK, SGD, THB, TWD, USD, ZAR

  • tax_breakdownbooleandefault false

    Also read Agoda's "per night before taxes" view and return each offer's price_before_taxes plus the derived stay taxes_and_fees (with its own provenance). Doubles the upstream request; same credit cost.

  • probe_min_staybooleandefault true

    Agoda answers a minimum-stay restriction as "sold out" (measured: Moxy Boston 2026-10-20 is sold out at 1-4 nights and priced at 7, the minimum Booking and Expedia state). When Agoda says sold out, re-ask the same check-in at 2, 3, 4, 5 and 7 nights and report availability: min_stay with min_stay_quote if one prices. False keeps Agoda's flag as is.

  • country_marketstring | null

    Visitor country (point of sale), two letters, e.g. GB. Booking and Agoda price by the visitor's country - measured 2026-10-03, Booking showed a GB visitor 321 USD where US and CA visitors saw 276 for the same night - so this asks for the price a visitor from that country sees. The answer's point_of_sale block says whether that country was actually served; when it was not, the price is the default market's. Omit for the previous behaviour.

    251 allowed values

    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

Example request

curl -X POST "https://api.scrapercompany.com/v1/ota/agoda" \
  -H "x-api-key: $SCRAPERCOMPANY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "property_id": "8795952",
    "check_in": "2027-01-15",
    "nights": 1,
    "currency": "USD"
  }'

Response

200 — Agoda rooms and rate plans, with `tax_breakdown: true`. A stay Agoda calls sold out but prices at a longer length from the same check-in is `availability: min_stay` with `min_length_of_stay` and `min_stay_quote`. Metered responses carry x-credits-charged and x-credits-remaining headers (see credit headers).

200 response
{
  "search_parameters": {
    "engine": "agoda_property",
    "property_id": "8795952",
    "check_in_date": "2027-02-10",
    "check_out_date": "2027-02-11",
    "adults": 2,
    "rooms": 1,
    "currency": "USD",
    "tax_breakdown": true
  },
  "property": {
    "property_id": "8795952",
    "name": "Moxy Boston Downtown",
    "price_per_night": 527,
    "total": 527.4,
    "price_before_taxes": 412,
    "taxes_and_fees": 115.4,
    "strikeout_price": 742,
    "meal_plan": "room_only",
    "free_cancellation": false,
    "cancellation_policy": "Non-refundable (Low price!)",
    "currency": "USD",
    "tax_inclusive": true,
    "sold_out": false,
    "availability": "available",
    "is_soldout": false,
    "rooms": [
      {
        "name": "Center Stage, Guest room, 1 Queen, City view",
        "offers": [
          {
            "price": 527,
            "currency": "USD",
            "currency_code": "USD",
            "price_text": "USD 527",
            "tax_inclusive": true,
            "discount": "-29%",
            "free_cancellation": false,
            "total": 527.4,
            "strikeout_price": 742,
            "price_before_taxes": 412,
            "taxes_and_fees": 115.4,
            "breakfast_included": false,
            "meal_plan": "room_only",
            "cancellation_policy": "Non-refundable (Low price!)",
            "cancellation_policy_code": "365D100P_100P",
            "pay_later": false,
            "pay_at_hotel": false,
            "room_type_id": "3082196",
            "rate_plan_id": "2844033",
            "benefits": [
              "Free WiFi"
            ],
            "rate_code": "2844033",
            "rate_category": "advance_purchase",
            "rate_category_source": "brand_flag",
            "refundable": false,
            "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": "agoda",
              "source_kind": "ota_rate_plan",
              "source_property_id": "ChUIoben2Mv6-CYaCi9tLzA3czVwbjQQAQ",
              "requested_market": "US",
              "requested_currency": "USD",
              "returned_currency": "USD",
              "price_basis": "room_base_before_taxes_and_fees",
              "derivation": "normalized_upstream"
            }
          }
        ]
      }
    ]
  },
  "meta": {
    "source": "agoda",
    "nights": 1,
    "elapsed_s": 0.361,
    "room_types": 5,
    "offers": 9,
    "tax_breakdown": true,
    "comparable_across_markets": true
  },
  "point_of_sale": {}
}

Response fields

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

  • search_parametersobjectrequired
    Show 7 child fields
    • search_parameters.enginestringrequired

      One ofagoda_property

    • search_parameters.property_idstringrequired
    • search_parameters.check_in_datestring (date)required
    • search_parameters.check_out_datestring (date)required
    • search_parameters.adultsintegerrequired
    • search_parameters.roomsintegerrequired
    • search_parameters.currencystringrequired
  • propertyobjectrequired
    Show 9 child fields
    • property.property_idstringrequired
    • property.namestringrequired
    • property.price_per_nightnumber | nullrequired

      Cheapest priced offer.

    • property.currencystringrequired

      ISO code of the cheapest offer (the requested currency when nothing priced).

    • property.currency_displaystring | nullrequired
    • property.tax_inclusiveboolean | nullrequired
    • property.sold_outbooleanrequired
    • property.provenanceobject | nullrequired

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

      Show 13 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 2 child fields
      • property.rooms[].namestringrequired
      • property.rooms[].offersarray of objectrequired
  • metaobjectrequired
    Show 8 child fields
    • meta.sourcestringrequired

      One ofagoda

    • meta.collection_idstringrequired
    • meta.observed_atstringrequired
    • meta.nightsintegerrequired
    • meta.elapsed_snumberrequired
    • meta.room_typesintegerrequired
    • meta.offersintegerrequired
    • meta.comparable_across_marketsbooleanrequired

      Always true.

Errors

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

StatusMeaningRetry?
401Unauthorized

Missing or invalid API key.

{"detail":"missing or invalid API key"}
No, fix the request
402Payment Required

Not enough credits for this request: the account's credits mode is enforce (mode in GET /v1/billing) and the request costs more than the available credits. Nothing is run or charged.

{"detail":"insufficient credits: this request costs 5, 0 available. Credits renew 2026-11-01."}
No, fix the request
422Unprocessable Content

Request validation failed. detail is a list of problems for schema errors, or a string for semantic checks performed by the endpoint.

{"detail":[{"loc":["body","name"],"msg":"Field required","type":"missing"}]}
No, fix the request
429Too Many Requests

Too many requests: the key's requests-per-minute limit was exceeded, or (in enforce credits mode) the plan's concurrent-request limit. No rate-limit or Retry-After headers are sent; back off and retry.

{"detail":"rate limit 60/min exceeded"}
Yes, with backoff
502Bad Gateway

The upstream source failed, blocked the request or returned an unusable answer. Safe to retry later; failed requests are not charged.

{"detail":"RuntimeError"}
Yes, with backoff

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.

Credits

12 credits per successful call. Failed, blocked and empty results are free.

Questions about this page?

Send the page link and your question, and the team will answer.

Email support