ETG API V3
Affiliate API
Hotel search
Retrieve rate info

Retrieve rate info

#affiliate

https://api.worldota.net/api/b2b/v3/search/lookuprate/

The call gets one hotel rate. The response format is as in the Retrieve hotelpage call.

⚠️
To have permission to the call with your API key, contact the API support team.

Request example 

curl --user '<KEY_ID>:<API_KEY>' 'https://api.worldota.net/api/b2b/v3/search/lookuprate/' \
--header 'Content-Type: application/json' \
--data '{
  "book_hash": "p-916eb51f-7e3c-4f7d-adde-cd2f551f173f",
  "language": "en"
}'

Request body

book_hash String required

The unique rate ID used to identify the selected rate.

ℹ️
language String optional

The hotel data language.

ℹ️
  • The default value is the contract language.
  • The possible values:
    • ar — Arabic.
    • bg — Bulgarian.
    • cs — Czech.
    • da — Danish.
    • de — German.
    • el — Greek.
    • en — English.
    • es — Spanish.
    • fi — Finnish.
    • fr — French.
    • he — Hebrew.
    • hu — Hungarian.
    • it — Italian.
    • ja — Japanese.
    • kk — Kazakh.
    • ko — Korean.
    • nl — Dutch.
    • no — Norwegian.
    • pl — Polish.
    • pt — Portuguese.
    • pt_PT — Portuguese (Portugal).
    • ro — Romanian.
    • ru — Russian.
    • sq — Albanian.
    • sr — Serbian.
    • sv — Swedish.
    • th — Thai.
    • tr — Turkish.
    • uk — Ukrainian.
    • vi — Vietnamese.
    • zh_CN — Simplified Chinese.
    • zh_TW — Traditional Chinese.

Response

original_request_params [Object]

Information about the request body from the Retrieve hotelpage call.

checkin String
The check-in date. The value must be not later than 730 days from the day when the request is made.
checkout String
The check-out date. The value must be not later than 30 days from the checkin field value.
residency String

The guests’ citizenship in the ISO 3166-1 alpha-2 format.

Use this field if there are doubts regarding the country or the hotel policy towards citizens.

ℹ️

The possible values:

  • ad — Andorra.
  • ae — United Arab Emirates.
  • af — Afghanistan.
  • ag — Antigua and Barbuda.
  • ai — Anguilla.
  • al — Albania.
  • am — Armenia.
  • ao — Angola.
  • aq — Antarctica.
  • ar — Argentina.
  • as — American Samoa.
  • at — Austria.
  • au — Australia.
  • aw — Aruba.
  • ax — Åland Islands.
  • az — Azerbaijan.
  • ba — Bosnia and Herzegovina.
  • bb — Barbados.
  • bd — Bangladesh.
  • be — Belgium.
  • bf — Burkina Faso.
  • bg — Bulgaria.
  • bh — Bahrain.
  • bi — Burundi.
  • bj — Benin.
  • bl — Saint Barthélemy.
  • bm — Bermuda.
  • bn — Brunei Darussalam.
  • bo — Bolivia.
  • bq — Bonaire, Sint Eustatius and Saba.
  • br — Brazil.
  • bs — Bahamas.
  • bt — Bhutan.
  • bv — Bouvet Island.
  • bw — Botswana.
  • by — Belarus.
  • bz — Belize.
  • ca — Canada.
  • cc — Cocos (Keeling) Islands.
  • cd — Democratic Republic of the Congo, also known as Congo-Kinshasa.
  • cf — Central African Republic.
  • cg — The Republic of the Congo, also known as Congo-Brazzaville.
  • ch — Switzerland.
  • ci — Côte d’Ivoire.
  • ck — Cook Islands.
  • cl — Chile.
  • cm — Cameroon.
  • cn — China.
  • co — Colombia.
  • cr — Costa Rica.
  • cu — Cuba.
  • cv — Cabo Verde.
  • cw — Curaçao.
  • cx — Christmas Island.
  • cy — Cyprus.
  • cz — Czechia.
  • de — Germany.
  • dj — Djibouti.
  • dk — Denmark.
  • dm — Dominica.
  • do — Dominican Republic.
  • dz — Algeria.
  • ec — Ecuador.
  • ee — Estonia.
  • eg — Egypt.
  • eh — Western Sahara.
  • er — Eritrea.
  • es — Spain.
  • et — Ethiopia.
  • fi — Finland.
  • fj — Fiji.
  • fk — Falkland Islands (Malvinas).
  • fm — Micronesia.
  • fo — Faroe Islands.
  • fr — France.
  • ga — Gabon.
  • gb — United Kingdom of Great Britain and Northern Ireland.
  • gd — Grenada.
  • ge — Georgia.
  • gf — French Guiana.
  • gg — Guernsey.
  • gh — Ghana.
  • gi — Gibraltar.
  • gl — Greenland.
  • gm — Gambia.
  • gn — Guinea.
  • gp — Guadeloupe.
  • gq — Equatorial Guinea.
  • gr — Greece.
  • gs — South Georgia and the South Sandwich Islands.
  • gt — Guatemala.
  • gu — Guam.
  • gw — Guinea-Bissau.
  • gy — Guyana.
  • hk — Hong Kong.
  • hm — Heard Island and McDonald Islands.
  • hn — Honduras.
  • hr — Croatia.
  • ht — Haiti.
  • hu — Hungary.
  • id — Indonesia.
  • ie — Ireland.
  • il — Israel.
  • im — Isle of Man.
  • in — India.
  • io — British Indian Ocean Territory.
  • iq — Iraq.
  • ir — Iran.
  • is — Iceland.
  • it — Italy.
  • je — Bailiwick of Jersey.
  • jm — Jamaica.
  • jo — Jordan.
  • jp — Japan.
  • ke — Kenya.
  • kg — Kyrgyzstan.
  • kh — Cambodia.
  • ki — Kiribati.
  • km — Comoros.
  • kn — Saint Kitts and Nevis.
  • kp — North Korea.
  • kr — South Korea.
  • kw — Kuwait.
  • ky — Cayman Islands.
  • kz — Kazakhstan.
  • la — Laos.
  • lb — Lebanon.
  • lc — Saint Lucia.
  • li — Liechtenstein.
  • lk — Sri Lanka.
  • lr — Liberia.
  • ls — Lesotho.
  • lt — Lithuania.
  • lu — Luxembourg.
  • lv — Latvia.
  • ly — Libya.
  • ma — Morocco.
  • mc — Monaco.
  • md — Moldova.
  • me — Montenegro.
  • mf — Saint Martin.
  • mg — Madagascar.
  • mh — Marshall Islands.
  • mk — North Macedonia.
  • ml — Mali.
  • mm — Myanmar.
  • mn — Mongolia.
  • mo — Macao.
  • mp — Northern Mariana Islands.
  • mq — Martinique.
  • mr — Mauritania.
  • ms — Montserrat.
  • mt — Malta.
  • mu — Mauritius.
  • mv — Maldives.
  • mw — Malawi.
  • mx — Mexico.
  • my — Malaysia.
  • mz — Mozambique.
  • na — Namibia.
  • nc — New Caledonia.
  • ne — Niger.
  • nf — Norfolk Island.
  • ng — Nigeria.
  • ni — Nicaragua.
  • nl — Netherlands.
  • no — Norway.
  • np — Nepal.
  • nr — Nauru.
  • nu — Niue.
  • nz — New Zealand.
  • om — Oman.
  • pa — Panama.
  • pe — Peru.
  • pf — French Polynesia.
  • pg — Papua New Guinea.
  • ph — Philippines.
  • pk — Pakistan.
  • pl — Poland.
  • pm — Saint Pierre and Miquelon.
  • pn — Pitcairn.
  • pr — Puerto Rico.
  • ps — Palestine.
  • pt — Portugal.
  • pw — Palau.
  • py — Paraguay.
  • qa — Qatar.
  • re — Réunion.
  • ro — Romania.
  • rs — Serbia.
  • ru — Russian Federation.
  • rw — Rwanda.
  • sa — Saudi Arabia.
  • sb — Solomon Islands.
  • sc — Seychelles.
  • sd — Sudan.
  • se — Sweden.
  • sg — Singapore.
  • sh — Saint Helena, Ascension and Tristan da Cunha.
  • si — Slovenia.
  • sj — Svalbard and Jan Mayen.
  • sk — Slovakia.
  • sl — Sierra Leone.
  • sm — San Marino.
  • sn — Senegal.
  • so — Somalia.
  • sr — Suriname.
  • ss — South Sudan.
  • st — Sao Tome and Principe.
  • sv — El Salvador.
  • sx — Sint Maarten.
  • sy — Syrian Arab Republic.
  • sz — Eswatini.
  • tc — Turks and Caicos Islands.
  • td — Chad.
  • tf — French Southern Territories.
  • tg — Togo.
  • th — Thailand.
  • tj — Tajikistan.
  • tk — Tokelau.
  • tl — Timor-Leste.
  • tm — Turkmenistan.
  • tn — Tunisia.
  • to — Tonga.
  • tr — Turkey.
  • tt — Trinidad and Tobago.
  • tv — Tuvalu.
  • tw — Taiwan.
  • tz — Tanzania.
  • ua — Ukraine.
  • ug — Uganda.
  • um — United States Minor Outlying Islands.
  • us — United States of America.
  • uy — Uruguay.
  • uz — Uzbekistan.
  • va — Holy See.
  • vc — Saint Vincent and the Grenadines.
  • ve — Venezuela.
  • vg — Virgin Islands (British).
  • vi — Virgin Islands (U.S.).
  • vn — Vietnam.
  • vu — Vanuatu.
  • wf — Wallis and Futuna.
  • ws — Samoa.
  • xk — Kosovo.
  • ye — Yemen.
  • yt — Mayotte.
  • za — South Africa.
  • zm — Zambia.
  • zw — Zimbabwe.
guests [Object]

The list of guests in the rooms.

In the case of a multiroom search, for each room equal pax numbers are highly recommended for usage. If different pax numbers are required, we recommend that you make a separate request for each room.

ℹ️
  • One list item represents one room.
  • The maximum number of rooms per request is 9.
adults Int

The number of adult guests in one room.

ℹ️
  • The minimum value is 1.
  • The maximum value is 6.
children [Int]

The age list of the children who will stay in the room.

ℹ️
  • The maximum age per child is 17 years.
  • The maximum number of children in the room is 4.
hotels [Object]

The list of hotels and their rates.

id String

The unique hotel ID.

ℹ️
  • Either this field or the hid field is required.
hid Int

The most preferred hotel ID.

ℹ️
  • Either this field or the id field is required.
  • The maximum length is 7 characters.
rates [Object]

The list of available hotel rates.

allotment Int
The number of rooms available for the rate.
amenities_data [String]

The room amenity list.

To get all available room amenities and their definitions, use the room_amenities field from the Retrieve hotel static data call.

any_residency Boolean

Whether the rate is allowed to be booked by the guest with any kind of residency or not.

Use it if you don’t collect the guests’ residency.

book_hash String

The unique rate ID used to identify the selected rate.

ℹ️
daily_prices [String]
The list of daily rate prices breakdown in the request currency.
deposit Object

The deposit information of the order.

Has a value if the rate payment_types.type field has the hotel value.

amount String
The deposit amount.
currency_code String
The deposit amount currency code. Is the same as the charged (hotel) currency code.
is_refundable Boolean
Whether the deposit is refundable or not.
match_hash String

The match_hash field of the rate from the call made by the SERP mechanism.

Use this field if you are:

  • Showing rates to the users from the call made by the SERP mechanism.
  • Making a booking from these rates.
  • Using this call response as actual data on the rate.
  • Using this call response to actualize the exact rate from the calls made by the SERP mechanism.

Usage of this field can help the ETG collect analytics for SERP-HP matching.

meal String
deprecated
⚠️
Use the meal_data field instead.

The meal type.

If there is no meal type provided by the rate source, the nomeal value is returned.

To get all available meals and their definitions, use the meals field from the Retrieve hotel static data call.

meal_data Object

The rate meals information.

value String

The meal type in the rate.

To get all available meal types and their definitions, use the meals field from the Retrieve hotel static data call.

Has the nomeal value if no meal type is provided.

has_breakfast Boolean
Whether breakfast is included to the rate or not.
no_child_meal Boolean
Whether the children meal is absent in the rate or not.
no_show Object

The no-show penalty information.

amount String
The no-show penalty amount.
currency_code String
The no-show penalty amount currency code. Is the same as the charged (hotel) currency code.
from_time String
The time in the hotel timezone from which amount would be charged for the no-show penalty in the HH:MM:SS format.
payment_options Object

The accepted payment options with the specified amount to be charged.

For a booking, this amount in the requested currency should be paid.

payment_types String

The list with accepted payment options.

amount String
The amount to be charged for the booking in the contract currency code.
by String
Whether the booking can be paid by a card or not.
cancellation_penalties String

The cancellation rules and commission information.

free_cancellation_before String

The date and time when the free cancellation policy expires.

Has the null value, if there is no free cancellation.

The timezone is in UTC±0.

policies String

The cancellation policies breakdown by periods.

amount_charge String
The cancellation penalty amount in the contract currency.
amount_show String
The cancellation penalty amount in the request currency.
end_at String

The date and time when this cancellation policy expires.

Has the null value, if it is in the time from the start_at field value till check-in.

If the start_at and end_at fields have the null value, this particular cancellation policy:

  • Has no time restrictions.
  • Is in effect all the time.

The timezone is in UTC±0.

start_at String

The date and time when this cancellation policy takes effect.

Has the null value, if it is in effect till the end_at field value.

The timezone is in UTC±0.

currency_code String
The amount currency code. Is the same as the charged (contract) currency code.
is_need_credit_card_data Boolean
Whether the credit card information is needed or not.
is_need_cvc Boolean
Whether the CVC is needed or not.
perks String

The additional services’ information.

early_checkin [Object]

The early check-in information.

charge_price String
The early check-in amount in the charge (contract) currency.
commission_info [Object]

The commission information.

charge [Object]

The commission information in the charge (contract) currency.

amount_commission Float
The commission amount.
amount_gross Float
The gross price.
amount_net String
The net price.
show [Object]

The commission information in the requested currency.

amount_commission Float
The commission amount.
amount_gross Float
The gross price.
amount_net String
The net price.
is_requested Boolean
Whether the early check-in is requested or not.
show_price String
The early check-in amount in the search currency.
time String
The early check-in time.
late_checkout [Object]

The late check-out information.

charge_price String
The late check-out amount in the charge (contract) currency.
commission_info [Object]

The commission information.

charge [Object]

The commission information in the charge (contract) currency.

amount_commission Float
The commission amount.
amount_gross Float
The gross price.
amount_net String
The net price.
show [Object]

The commission information in the requested currency.

amount_commission Float
The commission amount.
amount_gross Float
The gross price.
amount_net String
The net price.
is_requested Boolean
Whether the late check-out is requested or not.
show_price String
The late check-out amount in the search currency.
time String
The late check-out time.
recommended_price String

The price below which the rate can’t be sold on B2C website.

To get this value, you have to sign an additional agreement with the ETG. Has the null value, ff the agreement isn’t signed. For more details, contact your account manager.

amount Float
The deposit amount.
currency_code String
The deposit amount currency code. Is the same as the charged (hotel) currency code.
show_amount Float

The rate price in the request currency code of this object show_currency_code field value.

Isn’t necessarily the sum in the charged or payment currency code.

show_currency_code String

The request currency code.

Isn’t necessarily in the charged or payment currency code.

show_amount Float

The rate price in the request currency code of this object show_currency_code field value.

Isn’t necessarily the sum in the charged or payment currency code.

show_currency_code String

The request currency code.

Isn’t necessarily in the charged or payment currency code.

tax_data Object

The tax information.

taxes Object

The taxes list.

amount String
The tax amount.
currency_code String

The tax amount currency code in the ISO 4217 format.

ℹ️
  • The length is 3 characters.
  • The possible values:
    • AED.
    • AFN.
    • ALL.
    • AMD.
    • ANG.
    • AOA.
    • ARS.
    • AUD.
    • AWG.
    • AZN.
    • BAM.
    • BBD.
    • BDT.
    • BGN.
    • BHD.
    • BIF.
    • BMD.
    • BND.
    • BOB.
    • BOV.
    • BRL.
    • BSD.
    • BTN.
    • BWP.
    • BYR.
    • BYN.
    • BZD.
    • CAD.
    • CDF.
    • CHE.
    • CHF.
    • CHW.
    • CLF.
    • CLP.
    • CNY.
    • COP.
    • COU.
    • CRC.
    • CUC.
    • CUP.
    • CVE.
    • CZK.
    • DJF.
    • DKK.
    • DOP.
    • DZD.
    • EGP.
    • ERN.
    • ETB.
    • EUR.
    • FJD.
    • FKP.
    • GBP.
    • GEL.
    • GHS.
    • GIP.
    • GMD.
    • GNF.
    • GTQ.
    • GYD.
    • HKD.
    • HNL.
    • HRK.
    • HTG.
    • HUF.
    • IDR.
    • ILS.
    • INR.
    • IQD.
    • IRR.
    • ISK.
    • JMD.
    • JOD.
    • JPY.
    • KES.
    • KGS.
    • KHR.
    • KMF.
    • KPW.
    • KRW.
    • KWD.
    • KYD.
    • KZT.
    • LAK.
    • LBP.
    • LKR.
    • LRD.
    • LSL.
    • LTL.
    • LVL.
    • LYD.
    • MAD.
    • MDL.
    • MGA.
    • MKD.
    • MMK.
    • MNT.
    • MOP.
    • MRO.
    • MUR.
    • MVR.
    • MWK.
    • MXN.
    • MXV.
    • MYR.
    • MZN.
    • NAD.
    • NGN.
    • NIO.
    • NOK.
    • NPR.
    • NZD.
    • OMR.
    • PAB.
    • PEN.
    • PGK.
    • PHP.
    • PKR.
    • PLN.
    • PYG.
    • QAR.
    • RON.
    • RSD.
    • RUB.
    • RWF.
    • SAR.
    • SBD.
    • SCR.
    • SDG.
    • SEK.
    • SGD.
    • SHP.
    • SLL.
    • SOS.
    • SRD.
    • SSP.
    • STD.
    • SVC.
    • SYP.
    • SZL.
    • THB.
    • TJS.
    • TMT.
    • TND.
    • TOP.
    • TRY.
    • TTD.
    • TWD.
    • TZS.
    • UAH.
    • UGX.
    • USD.
    • USN.
    • USS.
    • UYI.
    • UYU.
    • UZS.
    • VEF.
    • VND.
    • VUV.
    • WST.
    • XAF.
    • XAG.
    • XAU.
    • XBA.
    • XBB.
    • XBC.
    • XBD.
    • XCD.
    • XDR.
    • XFU.
    • XOF.
    • XPD.
    • XPF.
    • XPT.
    • XSU.
    • XTS.
    • XUA.
    • YER.
    • ZAR.
    • ZMW.
    • ZWL.
included_by_supplier Boolean

Whether the tax is included by the supplier or not.

When it has:

  • The false value, the tax is supposed to be paid at the hotel in this object currency.
  • The true value, the tax is included in the price.
name String

The ETG tax ID.

To get all available tax IDs and their definitions, use the taxes field from the Retrieve hotel static data call.

type String

The payment type.

ℹ️
  • The possible values:
    • now. Use it to allow the user to pay for the booking via the ETG payment system:
      1. Request the Create booking process call and get the card details.
      2. Request the Create credit card token call with the card details.
    • hotel. Use it to allow the user to pay for the booking upon check-in at the hotel. The user won’t be charged now.
vat_data Object

The rate VAT information.

amount Float
The VAT amount.
applied Boolean
Whether the VAT is applied or not.
currency_code String

The amount currency code in the ISO 4217 format.

ℹ️
  • The length is 3 characters.
  • The possible values:
    • AED.
    • AFN.
    • ALL.
    • AMD.
    • ANG.
    • AOA.
    • ARS.
    • AUD.
    • AWG.
    • AZN.
    • BAM.
    • BBD.
    • BDT.
    • BGN.
    • BHD.
    • BIF.
    • BMD.
    • BND.
    • BOB.
    • BOV.
    • BRL.
    • BSD.
    • BTN.
    • BWP.
    • BYR.
    • BYN.
    • BZD.
    • CAD.
    • CDF.
    • CHE.
    • CHF.
    • CHW.
    • CLF.
    • CLP.
    • CNY.
    • COP.
    • COU.
    • CRC.
    • CUC.
    • CUP.
    • CVE.
    • CZK.
    • DJF.
    • DKK.
    • DOP.
    • DZD.
    • EGP.
    • ERN.
    • ETB.
    • EUR.
    • FJD.
    • FKP.
    • GBP.
    • GEL.
    • GHS.
    • GIP.
    • GMD.
    • GNF.
    • GTQ.
    • GYD.
    • HKD.
    • HNL.
    • HRK.
    • HTG.
    • HUF.
    • IDR.
    • ILS.
    • INR.
    • IQD.
    • IRR.
    • ISK.
    • JMD.
    • JOD.
    • JPY.
    • KES.
    • KGS.
    • KHR.
    • KMF.
    • KPW.
    • KRW.
    • KWD.
    • KYD.
    • KZT.
    • LAK.
    • LBP.
    • LKR.
    • LRD.
    • LSL.
    • LTL.
    • LVL.
    • LYD.
    • MAD.
    • MDL.
    • MGA.
    • MKD.
    • MMK.
    • MNT.
    • MOP.
    • MRO.
    • MUR.
    • MVR.
    • MWK.
    • MXN.
    • MXV.
    • MYR.
    • MZN.
    • NAD.
    • NGN.
    • NIO.
    • NOK.
    • NPR.
    • NZD.
    • OMR.
    • PAB.
    • PEN.
    • PGK.
    • PHP.
    • PKR.
    • PLN.
    • PYG.
    • QAR.
    • RON.
    • RSD.
    • RUB.
    • RWF.
    • SAR.
    • SBD.
    • SCR.
    • SDG.
    • SEK.
    • SGD.
    • SHP.
    • SLL.
    • SOS.
    • SRD.
    • SSP.
    • STD.
    • SVC.
    • SYP.
    • SZL.
    • THB.
    • TJS.
    • TMT.
    • TND.
    • TOP.
    • TRY.
    • TTD.
    • TWD.
    • TZS.
    • UAH.
    • UGX.
    • USD.
    • USN.
    • USS.
    • UYI.
    • UYU.
    • UZS.
    • VEF.
    • VND.
    • VUV.
    • WST.
    • XAF.
    • XAG.
    • XAU.
    • XBA.
    • XBB.
    • XBC.
    • XBD.
    • XCD.
    • XDR.
    • XFU.
    • XOF.
    • XPD.
    • XPF.
    • XPT.
    • XSU.
    • XTS.
    • XUA.
    • YER.
    • ZAR.
    • ZMW.
    • ZWL.
included Boolean
Whether the VAT is included or not.
value Float
deprecated
The VAT amount in the currency of this object currency_code field value.
rg_ext Object

The hotel room type.

Use this field to get extra data on the room from the hotel static data. For example, room images, descriptions.

balcony Int

Whether there is a balcony or not.

ℹ️

The possible values:

  • 0 — no balcony.
  • 1 — a balcony.
bathroom Int

The room bathroom information.

ℹ️

The possible values:

  • 0 — undefined.
  • 1 — a shared bathroom.
  • 2 — a private bathroom.
  • 3 — an external private bathroom.
bedding Int

The room bedding information.

ℹ️

The possible values:

  • 0 — undefined.
  • 1 — a bunk bed.
  • 2 — a single bed.
  • 3 — a double bed.
  • 4 — a twin bed.
  • 7 — multiple beds.
bedrooms Int

The bedroom number.

ℹ️

The possible values:

  • 0 — undefined.
  • 1 — 1 bedroom.
  • 2 — 2 bedrooms.
  • 3 — 3 bedrooms.
  • 4 — 4 bedrooms.
  • 5 — 5 bedrooms.
  • 6 — 6 bedrooms.
capacity Int

The maximum number of main bed places without additional charges and excluding extra beds, cots, etc.

ℹ️

The possible values:

  • 0 — undefined.
  • 1 — single.
  • 2 — double.
  • 3 — triple.
  • 4 — quadruple.
  • 5 — quintuple.
  • 6 — sextuplet.
class Int

The room class information.

ℹ️

The possible values:

  • 0 — run of house.
  • 1 — dorm.
  • 2 — capsule.
  • 3 — room.
  • 4 — junior suite.
  • 5 — suite.
  • 6 — apartment.
  • 7 — studio.
  • 8 — villa.
  • 9 — cottage.
  • 17 — bungalow.
  • 18 — chalet.
  • 19 — camping.
  • 20 — tent.
club Int

Whether it is a club room or not.

ℹ️

The possible values:

  • 0 — not a club room.
  • 1 — a club room.
family Int

Whether it is a family room or not.

ℹ️

The possible values:

  • 0 — not a family room.
  • 1 — a family room.
floor Int

The room floor Information.

ℹ️

The possible values:

  • 0 — undefined.
  • 1 — a penthouse floor.
  • 2 — a duplex floor.
  • 3 — a basement floor.
  • 4 — an attic floor.
quality Int

The room quality information.

ℹ️

The possible values:

  • 0 — undefined.
  • 1 — economy.
  • 2 — standard.
  • 3 — comfort.
  • 4 — business.
  • 5 — superior.
  • 6 — deluxe.
  • 7 — premier.
  • 8 — executive.
  • 9 — presidential.
  • 17 — premium.
  • 18 — classic.
  • 19 — ambassador.
  • 20 — grand.
  • 21 — luxury.
  • 22 — platinum.
  • 23 — prestige.
  • 24 — privilege.
  • 25 — royal.
sex Int

The room gender restrictions.

ℹ️

The possible values:

  • 0 — undefined.
  • 1 — male.
  • 2 — female.
  • 3 — mixed.
view Int

The room view information.

ℹ️

The possible values:

  • 0 — undefined.
  • 1 — bay view.
  • 2 — bosphorus view.
  • 3 — burj-khalifa view.
  • 4 — canal view.
  • 5 — city view.
  • 6 — courtyard view.
  • 7 — dubai-marina view.
  • 8 — garden view.
  • 9 — golf view.
  • 17 — harbour view.
  • 18 — inland view.
  • 19 — kremlin view.
  • 20 — lake view.
  • 21 — land view.
  • 22 — mountain view.
  • 23 — ocean view.
  • 24 — panoramic view.
  • 25 — park view.
  • 26 — partial-ocean view.
  • 27 — partial-sea view.
  • 28 — partial view.
  • 29 — pool view.
  • 30 — river view.
  • 31 — sea view.
  • 32 — sheikh-zayed view.
  • 33 — street view.
  • 34 — sunrise view.
  • 35 — sunset view.
  • 36 — water view.
  • 37 — with view.
  • 38 — beachfront.
  • 39 — ocean front.
  • 40 — sea front.
room_data_trans Object

The room information in the request language.

bathroom String

The room bathroom information.

Has the null value, if it is a private bathroom.

bedding_type String
The room bedding information.
main_name String
The room name.
main_room_type String
The room type.
misc_room_type String
The room additional information.
legal_info Object

The hotel and service provider legal information.

Has the value different from null for only countries where it is mandatory to have this information.

Has the null value for the calls made by the SERP mechanism.

hotel Object

The hotel legal information.

name String
The hotel legal name.
address String
The hotel legal address.
taxpayer_number String

The Taxpayer Personal Identification Number (INN) of the hotel.

ℹ️
  • The length is 10 characters.
state_registration_number String

The State Registration Number for Companies (OGRN) of the hotel.

ℹ️
  • The length is 13 characters.
work_time String
The hotel legal address working hours.
provider Object

The service provider legal information.

name String
The service provider legal name.
address String
The service provider legal address.
taxpayer_number String

The Taxpayer Personal Identification Number (INN) of the service provider.

ℹ️
  • The length is 10 characters.
state_registration_number String

The State Registration Number for Companies (OGRN) of the service provider.

ℹ️
  • The length is 13 characters.
room_name String
The room name in the request language.
room_name_info Object
The optional object that may help to resolve certain matching problems. To get access to the object, contact your account manager.
sell_price_limits Object

Information on the restrictions on the final selling price for the client.

If not null, the final selling price should be:

  • Within the min_price and max_price field values.
  • In the search currency.
min_price String
The minimum final selling price for the client in the search currency.
max_price String
The maximum final selling price for the client in the search currency.
serp_filters [String]
deprecated
The list of amenities at the hotel.

Response example 

{
  "data": {
    "hotels": [
      {
        "id": "test_hotel_do_not_book",
        "hid": 8473727,
        "rates": [
          {
            "book_hash": "p-a47bf922-b7d2-4c2a-a193-4799bed33cf1",
            "match_hash": "m-07c72d75-fc0e-55fd-b9b4-4b2ea2cd2cec",
            "daily_prices": [
              "0.80"
            ],
            "meal": "nomeal",
            "meal_data": {
              "value": "nomeal",
              "has_breakfast": false,
              "no_child_meal": true
            },
            "payment_options": {
              "payment_types": [
                {
                  "amount": "30.40",
                  "show_amount": "0.80",
                  "currency_code": "EUR",
                  "show_currency_code": "EUR",
                  "by": null,
                  "is_need_credit_card_data": false,
                  "is_need_cvc": false,
                  "type": "deposit",
                  "vat_data": {
                    "included": false,
                    "applied": false,
                    "amount": "0.00",
                    "currency_code": "USD",
                    "value": "0.00"
                  },
                  "tax_data": {
                    "taxes": [
                      {
                        "name": "city_tax",
                        "included_by_supplier": false,
                        "amount": "767.51",
                        "currency_code": "HNL"
                      },
                      {
                        "name": "electricity_fee",
                        "included_by_supplier": true,
                        "amount": "0.02",
                        "currency_code": "EUR"
                      },
                      {
                        "name": "service_fee",
                        "included_by_supplier": false,
                        "amount": "1.89",
                        "currency_code": "HNL"
                      },
                      {
                        "name": "vat",
                        "included_by_supplier": false,
                        "amount": "346.23",
                        "currency_code": "HNL"
                      }
                    ]
                  },
                  "perks": {},
                  "commission_info": {
                    "show": {
                      "amount_gross": "1.00",
                      "amount_net": "0.80",
                      "amount_commission": "0.20"
                    },
                    "charge": {
                      "amount_gross": "38.00",
                      "amount_net": "30.40",
                      "amount_commission": "7.60"
                    }
                  },
                  "cancellation_penalties": {
                    "policies": [
                      {
                        "start_at": null,
                        "end_at": null,
                        "amount_charge": "30.40",
                        "amount_show": "0.80",
                        "commission_info": {
                          "show": {
                            "amount_gross": "1.00",
                            "amount_net": "0.80",
                            "amount_commission": "0.20"
                          },
                          "charge": {
                            "amount_gross": "38.00",
                            "amount_net": "30.40",
                            "amount_commission": "7.60"
                          }
                        }
                      }
                    ],
                    "free_cancellation_before": null
                  },
                  "recommended_price": null
                }
              ]
            },
            "bar_rate_price_data": {
              "amount": "2.48",
              "currency_code": "EUR"
            },
            "rg_ext": {
              "class": 8,
              "quality": 0,
              "sex": 0,
              "bathroom": 2,
              "bedding": 0,
              "family": 0,
              "capacity": 0,
              "club": 0,
              "bedrooms": 6,
              "balcony": 0,
              "view": 0,
              "floor": 0
            },
            "room_name": "6 Bedrooms Villa",
            "room_name_info": {
              "original_rate_name": "Villa 6 bedrooms"
            },
            "serp_filters": [
              "has_bathroom"
            ],
            "sell_price_limits": null,
            "allotment": 3,
            "amenities_data": [
              "non-smoking",
              "6-bedrooms"
            ],
            "any_residency": true,
            "deposit": null,
            "no_show": {
              "amount": "0.00",
              "currency_code": "USD",
              "from_time": "12:00:00"
            },
            "room_data_trans": {
              "main_room_type": "6 Bedrooms Villa",
              "main_name": "6 Bedrooms Villa",
              "bathroom": null,
              "bedding_type": null,
              "misc_room_type": null
            },
            "legal_info": {
              "provider": {
                "name": "",
                "address": "",
                "taxpayer_number": "0000000000",
                "state_registration_number": "0000000000000"
              },
              "hotel": {
                "name": "Test Hotel (Do not book) test",
                "address": "Avenida Roble, Frente al Mall Multiplaza, Tegucigalpa",
                "taxpayer_number": "0000000000",
                "state_registration_number": "0000000000000",
                "work_time": "from 9-18 local time"
              }
            }
          }
        ],
        "bar_price_data": null
      }
    ],
    "original_request_params": {
      "checkin": "2025-04-25",
      "checkout": "2025-04-26",
      "guests": [
        {
          "adults": 2,
          "children": []
        }
      ],
      "residency": "gb"
    }
  },
  "debug": {
    "request": {
      "book_hash": "p-a47bf922-b7d2-4c2a-a193-4799bed33cf1",
      "language": "en"
    },
    "key_id": 7705,
    "validation_error": null
  },
  "status": "ok",
  "error": null
}