Skip to content
FX-Port/Docs
GuidesAPI referenceChangelog
Get API keys
  • Overview
  • Error object

Search

  • Geo searchPOST
  • Locations and coordinatesGET
  • Name searchGET
  • Name search (JSON body)POST

Hotel content

  • Cards of many hotelsPOST
  • One hotel, for its pagePOST
  • Raw hotel documentsPOST

Rates and booking

  • Rates of a hotelPOST
  • Pre-book a ratePOST
  • BookPOST

After booking

  • VoucherGET
  • CancelPOST

Objects

  • Hotel mini
  • Hotel full

Hotels · Objects

The Hotel full object

Everything FX-Port knows about one hotel, for the hotel page before checkout: the mini fields plus the description, every room type with photos and amenities, the policies, the facts and the contact details.

It is 5 to 10 times larger than the mini card (35 KB on average, up to 130 KB). POST /hotels/search returns it by default in snake_case; get_hotel_info returns the same data in camelCase and POST /hotels/details the stored document with two more fields. See Mini and full hotel data.

Example
{
  "id": "test_hotel_do_not_book",
  "hid": 8473727,
  "name": "Test Hotel (Do Not Book) test",
  "kind": "Apartment",
  "hotel_chain": "No chain",
  "address": "Avenida Roble, Frente al Mall Multiplaza, Tegucigalpa",
  "postal_code": null,
  "latitude": 14.079872,
  "longitude": -87.21677,
  "region": {
    "id": 3421,
    "country_code": "HN",
    "iata": "TGU",
    "name": "Tegucigalpa",
    "type": "City",
    "type_v2": "city"
  },
  "star_rating": 0,
  "star_certificate": null,
  "email": "[email protected]",
  "phone": "+15555550123",
  "check_in_time": "14:00:00",
  "check_out_time": "12:00:00",
  "front_desk_time_start": "00:00:00",
  "front_desk_time_end": "00:00:00",
  "images": [
    "https://cdn.worldota.net/t/{size}/extranet/b5/d3/b5d3d33394494c68321246882c1bd93a6832dcd5.jpeg"
  ],
  "amenity_groups": [
    {
      "amenities": [
        "24-hour reception",
        "Early check-in",
        "Late check-out"
      ],
      "non_free_amenities": [],
      "group_name": "General"
    }
  ],
  "serp_filters": [
    "has_internet",
    "has_parking",
    "kitchen"
  ],
  "description_struct": [
    {
      "title": "Location",
      "paragraphs": [
        "A perfect fit for a big group of travellers: apartment «Test Hotel (Do Not Book)» ..."
      ]
    }
  ],
  "metapolicy_struct": {
    "internet": [
      {
        "inclusion": "included",
        "price": "0.00",
        "currency": null,
        "price_unit": "unspecified",
        "internet_type": "unspecified",
        "work_area": "hotel"
      }
    ],
    "meal": [
      {
        "inclusion": "not_included",
        "price": "300.00",
        "currency": "USD",
        "meal_type": "breakfast"
      }
    ],
    "children_meal": [
      {
        "inclusion": "not_included",
        "price": "200.00",
        "currency": "USD",
        "meal_type": "breakfast",
        "age_start": 0,
        "age_end": 5
      }
    ],
    "extra_bed": [
      {
        "inclusion": "not_included",
        "price": "100.00",
        "currency": "ALL",
        "price_unit": "per_guest_per_night",
        "amount": 1
      }
    ],
    "cot": [
      {
        "inclusion": "not_included",
        "price": "0.00",
        "currency": "USD",
        "price_unit": "per_room_per_night",
        "amount": 1
      }
    ],
    "pets": [
      {
        "inclusion": "not_included",
        "price": "560.00",
        "currency": "USD",
        "price_unit": "per_room_per_stay",
        "pets_type": "unspecified"
      }
    ],
    "shuttle": [
      {
        "inclusion": "not_included",
        "price": "100.00",
        "currency": "EUR",
        "shuttle_type": "one_way",
        "destination_type": "train"
      }
    ],
    "parking": [
      {
        "inclusion": "not_included",
        "price": "100.00",
        "currency": "USD",
        "price_unit": "per_car_per_night",
        "territory_type": "unspecified"
      }
    ],
    "children": [
      {
        "age_start": 0,
        "age_end": 3,
        "price": "500.00",
        "currency": "CHF",
        "extra_bed": "available"
      }
    ],
    "visa": {
      "visa_support": "support_enable"
    },
    "deposit": [
      {
        "availability": "available",
        "price": "123.00",
        "currency": "HNL",
        "price_unit": "per_room_per_stay",
        "pricing_method": "fixed",
        "payment_type": "cash",
        "deposit_type": "unspecified"
      }
    ],
    "no_show": {
      "availability": "available",
      "time": "09:00:00",
      "day_period": "after_midday"
    },
    "add_fee": [],
    "check_in_check_out": []
  },
  "metapolicy_extra_info": "Front desk is open 24/7.",
  "room_groups": [
    {
      "room_group_id": 95,
      "name": "Standard Double room full double bed",
      "name_struct": {
        "main_name": "Standard Double room",
        "bedding_type": "full double bed",
        "bathroom": "shared bathroom"
      },
      "rg_ext": {
        "class": 3,
        "quality": 2,
        "sex": 0,
        "bathroom": 1,
        "bedding": 3,
        "family": 0,
        "capacity": 2,
        "club": 0,
        "bedrooms": 0,
        "balcony": 0,
        "floor": 0,
        "view": 0
      },
      "room_amenities": [
        "bath",
        "heating"
      ],
      "images": [
        "https://cdn.worldota.net/t/{size}/extranet/b5/d3/b5d3d33394494c68321246882c1bd93a6832dcd5.jpeg"
      ]
    }
  ],
  "facts": {
    "floors_number": null,
    "rooms_number": null,
    "year_built": null,
    "year_renovated": null,
    "electricity": {
      "frequency": [
        60
      ],
      "voltage": null,
      "sockets": [
        "a",
        "b"
      ]
    },
    "register": null
  },
  "payment_methods": [
    "visa",
    "maestro",
    "cash"
  ],
  "keys_pickup": {
    "type": "lockbox",
    "phone": "+15555550123",
    "email": "[email protected]",
    "apartment_office_address": null,
    "apartment_extra_information": "The keys are in the box by the front door.",
    "is_contactless": true
  },
  "is_closed": false,
  "is_gender_specification_required": false,
  "deleted": false
}

Attributes

idstring

The FX-Port id of the hotel. Send it as hotel_id.

hidinteger

The supplier's numeric hotel id.

namestring

Name of the hotel.

kindstring

Type of property: Hotel, Apartment, Resort ...

hotel_chainstring

The hotel chain, or No chain.

addressstring

Street address, in English.

postal_codestringnullable

Postal code; null for a minority of hotels.

latitudenumber

Latitude of the hotel.

longitudenumber

Longitude of the hotel.

regionobject

The city or area a hotel is in.

ShowHide 6 attributes
idinteger

Supplier id of the region.

country_codestring

ISO 3166-1 alpha-2 country code, upper case.

iatastring

IATA code of the main airport or city of the region.

namestring

Name of the region, usually the city.

typestring

Kind of region as the supplier names it: City, Region, Airport ...

type_v2string

The same kind in lower case (city). Missing for a few hotels.

star_ratinginteger

Number of stars, 0 to 5. 0 means not rated.

Between 0 and 5.

star_certificateobjectnullable

The official star certificate of a hotel, when it has one.

ShowHide 2 attributes
certificate_idstring

Id of the star certificate; an empty string when the supplier has none.

valid_tostring

End of validity of the certificate; an empty string when unknown.

emailstringnullable

Contact e-mail of the hotel.

phonestring

Contact phone number of the hotel.

check_in_timestring

Time of day from which guests can check in, HH:MM:SS, local time. A time, not a date.

check_out_timestring

Time of day by which guests must check out, HH:MM:SS, local time.

check_in_time_endstring

Time of day until which guests can check in. Present only when the hotel states it.

front_desk_time_startstringnullable

Time of day the front desk opens, HH:MM:SS; null when unknown.

front_desk_time_endstringnullable

Time of day the front desk closes, HH:MM:SS; null when unknown.

imagesarray of stringnullable

URL templates of the hotel photos, best photo first. Replace {size} to get a picture: 120x120, 240x240, 640x400 and 1024x768 work, and so does x500 (500 px high); orig does not. See "Images" in Mini and full hotel data.

amenity_groupsarray of object

The amenities of the hotel by group.

ShowHide 3 attributes
group_namestring

Name of the group: General, Rooms, Services and amenities, Meals, Sports and Recreation ...

amenitiesarray of string

Every amenity of the group, free or paid.

non_free_amenitiesarray of stringnullable

The amenities of amenities that are paid at the property. null or empty when all are free.

serp_filtersarray of string

Tags to build result filters with (see HotelMini).

description_structarray of object

The description of the hotel, in titled blocks.

ShowHide 2 attributes
titlestring

Title of the block: Location, At the hotel, At the apartment, Room amenities ...

paragraphsarray of string

The paragraphs of the block, in English.

metapolicy_structobject

The policies of the hotel: internet, meals, extra beds, children, pets, parking, deposits ... The keys are the same in get_hotel_info in camelCase (childrenMeal, extraBed ...); the entries inside keep their snake_case keys.

ShowHide 14 attributes
internetarray of object

Internet access and its price.

ShowHide 20 attributes
inclusionstring

Whether the service is included in the room price.

One of included, not_included.

pricestring

The amount as a decimal string, in currency.

currencystringnullable

ISO 4217 currency of price; null when the service is free or the price is a percentage.

price_unitstring

What the price is for: per_room_per_night, per_guest_per_stay, per_car_per_night, per_hour, unspecified ...

meal_typestring

Meal of the entry: breakfast, lunch, dinner ...

internet_typestring

Kind of internet access: wifi, wired, unspecified ...

work_areastring

Where the internet works: hotel, room, public_area ...

age_startinteger

First age of a child the entry applies to.

age_endinteger

Last age of a child the entry applies to.

amountinteger

How many of the item the entry is about (extra beds, cots).

pets_typestring

Kind of pet the entry applies to: dog, cat, unspecified ...

shuttle_typestring

Kind of shuttle: one_way, round_trip.

destination_typestring

Where the shuttle goes: airport, train, bus ...

territory_typestring

Where the car park is: inside, outside, unspecified.

extra_bedstring

For a child entry: whether an extra bed is available, not_available or unspecified.

availabilitystring

Whether the service is available, not_available or unspecified.

pricing_methodstring

For a deposit: fixed or percent.

payment_typestring

For a deposit: how it is paid (cash, card, unspecified).

deposit_typestring

For a deposit: what it covers (breakage, unspecified ...).

check_in_check_out_typestring

For an early or late stay: early_checkin, late_checkout ...

mealarray of object

Meals that can be added to a rate, with prices.

ShowHide 20 attributes
inclusionstring

Whether the service is included in the room price.

One of included, not_included.

pricestring

The amount as a decimal string, in currency.

currencystringnullable

ISO 4217 currency of price; null when the service is free or the price is a percentage.

price_unitstring

What the price is for: per_room_per_night, per_guest_per_stay, per_car_per_night, per_hour, unspecified ...

meal_typestring

Meal of the entry: breakfast, lunch, dinner ...

internet_typestring

Kind of internet access: wifi, wired, unspecified ...

work_areastring

Where the internet works: hotel, room, public_area ...

age_startinteger

First age of a child the entry applies to.

age_endinteger

Last age of a child the entry applies to.

amountinteger

How many of the item the entry is about (extra beds, cots).

pets_typestring

Kind of pet the entry applies to: dog, cat, unspecified ...

shuttle_typestring

Kind of shuttle: one_way, round_trip.

destination_typestring

Where the shuttle goes: airport, train, bus ...

territory_typestring

Where the car park is: inside, outside, unspecified.

extra_bedstring

For a child entry: whether an extra bed is available, not_available or unspecified.

availabilitystring

Whether the service is available, not_available or unspecified.

pricing_methodstring

For a deposit: fixed or percent.

payment_typestring

For a deposit: how it is paid (cash, card, unspecified).

deposit_typestring

For a deposit: what it covers (breakage, unspecified ...).

check_in_check_out_typestring

For an early or late stay: early_checkin, late_checkout ...

children_mealarray of object

Meals for children, by age range.

ShowHide 20 attributes
inclusionstring

Whether the service is included in the room price.

One of included, not_included.

pricestring

The amount as a decimal string, in currency.

currencystringnullable

ISO 4217 currency of price; null when the service is free or the price is a percentage.

price_unitstring

What the price is for: per_room_per_night, per_guest_per_stay, per_car_per_night, per_hour, unspecified ...

meal_typestring

Meal of the entry: breakfast, lunch, dinner ...

internet_typestring

Kind of internet access: wifi, wired, unspecified ...

work_areastring

Where the internet works: hotel, room, public_area ...

age_startinteger

First age of a child the entry applies to.

age_endinteger

Last age of a child the entry applies to.

amountinteger

How many of the item the entry is about (extra beds, cots).

pets_typestring

Kind of pet the entry applies to: dog, cat, unspecified ...

shuttle_typestring

Kind of shuttle: one_way, round_trip.

destination_typestring

Where the shuttle goes: airport, train, bus ...

territory_typestring

Where the car park is: inside, outside, unspecified.

extra_bedstring

For a child entry: whether an extra bed is available, not_available or unspecified.

availabilitystring

Whether the service is available, not_available or unspecified.

pricing_methodstring

For a deposit: fixed or percent.

payment_typestring

For a deposit: how it is paid (cash, card, unspecified).

deposit_typestring

For a deposit: what it covers (breakage, unspecified ...).

check_in_check_out_typestring

For an early or late stay: early_checkin, late_checkout ...

extra_bedarray of object

Extra beds and their price.

ShowHide 20 attributes
inclusionstring

Whether the service is included in the room price.

One of included, not_included.

pricestring

The amount as a decimal string, in currency.

currencystringnullable

ISO 4217 currency of price; null when the service is free or the price is a percentage.

price_unitstring

What the price is for: per_room_per_night, per_guest_per_stay, per_car_per_night, per_hour, unspecified ...

meal_typestring

Meal of the entry: breakfast, lunch, dinner ...

internet_typestring

Kind of internet access: wifi, wired, unspecified ...

work_areastring

Where the internet works: hotel, room, public_area ...

age_startinteger

First age of a child the entry applies to.

age_endinteger

Last age of a child the entry applies to.

amountinteger

How many of the item the entry is about (extra beds, cots).

pets_typestring

Kind of pet the entry applies to: dog, cat, unspecified ...

shuttle_typestring

Kind of shuttle: one_way, round_trip.

destination_typestring

Where the shuttle goes: airport, train, bus ...

territory_typestring

Where the car park is: inside, outside, unspecified.

extra_bedstring

For a child entry: whether an extra bed is available, not_available or unspecified.

availabilitystring

Whether the service is available, not_available or unspecified.

pricing_methodstring

For a deposit: fixed or percent.

payment_typestring

For a deposit: how it is paid (cash, card, unspecified).

deposit_typestring

For a deposit: what it covers (breakage, unspecified ...).

check_in_check_out_typestring

For an early or late stay: early_checkin, late_checkout ...

cotarray of object

Cots and their price.

ShowHide 20 attributes
inclusionstring

Whether the service is included in the room price.

One of included, not_included.

pricestring

The amount as a decimal string, in currency.

currencystringnullable

ISO 4217 currency of price; null when the service is free or the price is a percentage.

price_unitstring

What the price is for: per_room_per_night, per_guest_per_stay, per_car_per_night, per_hour, unspecified ...

meal_typestring

Meal of the entry: breakfast, lunch, dinner ...

internet_typestring

Kind of internet access: wifi, wired, unspecified ...

work_areastring

Where the internet works: hotel, room, public_area ...

age_startinteger

First age of a child the entry applies to.

age_endinteger

Last age of a child the entry applies to.

amountinteger

How many of the item the entry is about (extra beds, cots).

pets_typestring

Kind of pet the entry applies to: dog, cat, unspecified ...

shuttle_typestring

Kind of shuttle: one_way, round_trip.

destination_typestring

Where the shuttle goes: airport, train, bus ...

territory_typestring

Where the car park is: inside, outside, unspecified.

extra_bedstring

For a child entry: whether an extra bed is available, not_available or unspecified.

availabilitystring

Whether the service is available, not_available or unspecified.

pricing_methodstring

For a deposit: fixed or percent.

payment_typestring

For a deposit: how it is paid (cash, card, unspecified).

deposit_typestring

For a deposit: what it covers (breakage, unspecified ...).

check_in_check_out_typestring

For an early or late stay: early_checkin, late_checkout ...

petsarray of object

Whether pets are allowed and what they cost.

ShowHide 20 attributes
inclusionstring

Whether the service is included in the room price.

One of included, not_included.

pricestring

The amount as a decimal string, in currency.

currencystringnullable

ISO 4217 currency of price; null when the service is free or the price is a percentage.

price_unitstring

What the price is for: per_room_per_night, per_guest_per_stay, per_car_per_night, per_hour, unspecified ...

meal_typestring

Meal of the entry: breakfast, lunch, dinner ...

internet_typestring

Kind of internet access: wifi, wired, unspecified ...

work_areastring

Where the internet works: hotel, room, public_area ...

age_startinteger

First age of a child the entry applies to.

age_endinteger

Last age of a child the entry applies to.

amountinteger

How many of the item the entry is about (extra beds, cots).

pets_typestring

Kind of pet the entry applies to: dog, cat, unspecified ...

shuttle_typestring

Kind of shuttle: one_way, round_trip.

destination_typestring

Where the shuttle goes: airport, train, bus ...

territory_typestring

Where the car park is: inside, outside, unspecified.

extra_bedstring

For a child entry: whether an extra bed is available, not_available or unspecified.

availabilitystring

Whether the service is available, not_available or unspecified.

pricing_methodstring

For a deposit: fixed or percent.

payment_typestring

For a deposit: how it is paid (cash, card, unspecified).

deposit_typestring

For a deposit: what it covers (breakage, unspecified ...).

check_in_check_out_typestring

For an early or late stay: early_checkin, late_checkout ...

shuttlearray of object

Shuttle services and their price.

ShowHide 20 attributes
inclusionstring

Whether the service is included in the room price.

One of included, not_included.

pricestring

The amount as a decimal string, in currency.

currencystringnullable

ISO 4217 currency of price; null when the service is free or the price is a percentage.

price_unitstring

What the price is for: per_room_per_night, per_guest_per_stay, per_car_per_night, per_hour, unspecified ...

meal_typestring

Meal of the entry: breakfast, lunch, dinner ...

internet_typestring

Kind of internet access: wifi, wired, unspecified ...

work_areastring

Where the internet works: hotel, room, public_area ...

age_startinteger

First age of a child the entry applies to.

age_endinteger

Last age of a child the entry applies to.

amountinteger

How many of the item the entry is about (extra beds, cots).

pets_typestring

Kind of pet the entry applies to: dog, cat, unspecified ...

shuttle_typestring

Kind of shuttle: one_way, round_trip.

destination_typestring

Where the shuttle goes: airport, train, bus ...

territory_typestring

Where the car park is: inside, outside, unspecified.

extra_bedstring

For a child entry: whether an extra bed is available, not_available or unspecified.

availabilitystring

Whether the service is available, not_available or unspecified.

pricing_methodstring

For a deposit: fixed or percent.

payment_typestring

For a deposit: how it is paid (cash, card, unspecified).

deposit_typestring

For a deposit: what it covers (breakage, unspecified ...).

check_in_check_out_typestring

For an early or late stay: early_checkin, late_checkout ...

parkingarray of object

Parking and its price.

ShowHide 20 attributes
inclusionstring

Whether the service is included in the room price.

One of included, not_included.

pricestring

The amount as a decimal string, in currency.

currencystringnullable

ISO 4217 currency of price; null when the service is free or the price is a percentage.

price_unitstring

What the price is for: per_room_per_night, per_guest_per_stay, per_car_per_night, per_hour, unspecified ...

meal_typestring

Meal of the entry: breakfast, lunch, dinner ...

internet_typestring

Kind of internet access: wifi, wired, unspecified ...

work_areastring

Where the internet works: hotel, room, public_area ...

age_startinteger

First age of a child the entry applies to.

age_endinteger

Last age of a child the entry applies to.

amountinteger

How many of the item the entry is about (extra beds, cots).

pets_typestring

Kind of pet the entry applies to: dog, cat, unspecified ...

shuttle_typestring

Kind of shuttle: one_way, round_trip.

destination_typestring

Where the shuttle goes: airport, train, bus ...

territory_typestring

Where the car park is: inside, outside, unspecified.

extra_bedstring

For a child entry: whether an extra bed is available, not_available or unspecified.

availabilitystring

Whether the service is available, not_available or unspecified.

pricing_methodstring

For a deposit: fixed or percent.

payment_typestring

For a deposit: how it is paid (cash, card, unspecified).

deposit_typestring

For a deposit: what it covers (breakage, unspecified ...).

check_in_check_out_typestring

For an early or late stay: early_checkin, late_checkout ...

childrenarray of object

What a child of each age range costs and whether an extra bed is available. Read it before you assume a child stays free.

ShowHide 20 attributes
inclusionstring

Whether the service is included in the room price.

One of included, not_included.

pricestring

The amount as a decimal string, in currency.

currencystringnullable

ISO 4217 currency of price; null when the service is free or the price is a percentage.

price_unitstring

What the price is for: per_room_per_night, per_guest_per_stay, per_car_per_night, per_hour, unspecified ...

meal_typestring

Meal of the entry: breakfast, lunch, dinner ...

internet_typestring

Kind of internet access: wifi, wired, unspecified ...

work_areastring

Where the internet works: hotel, room, public_area ...

age_startinteger

First age of a child the entry applies to.

age_endinteger

Last age of a child the entry applies to.

amountinteger

How many of the item the entry is about (extra beds, cots).

pets_typestring

Kind of pet the entry applies to: dog, cat, unspecified ...

shuttle_typestring

Kind of shuttle: one_way, round_trip.

destination_typestring

Where the shuttle goes: airport, train, bus ...

territory_typestring

Where the car park is: inside, outside, unspecified.

extra_bedstring

For a child entry: whether an extra bed is available, not_available or unspecified.

availabilitystring

Whether the service is available, not_available or unspecified.

pricing_methodstring

For a deposit: fixed or percent.

payment_typestring

For a deposit: how it is paid (cash, card, unspecified).

deposit_typestring

For a deposit: what it covers (breakage, unspecified ...).

check_in_check_out_typestring

For an early or late stay: early_checkin, late_checkout ...

visaobject

Visa support of the hotel.

ShowHide 1 attribute
visa_supportstring

support_enable when the hotel supports visa invitations, unspecified otherwise.

depositarray of object

Deposits the hotel asks for at arrival.

ShowHide 20 attributes
inclusionstring

Whether the service is included in the room price.

One of included, not_included.

pricestring

The amount as a decimal string, in currency.

currencystringnullable

ISO 4217 currency of price; null when the service is free or the price is a percentage.

price_unitstring

What the price is for: per_room_per_night, per_guest_per_stay, per_car_per_night, per_hour, unspecified ...

meal_typestring

Meal of the entry: breakfast, lunch, dinner ...

internet_typestring

Kind of internet access: wifi, wired, unspecified ...

work_areastring

Where the internet works: hotel, room, public_area ...

age_startinteger

First age of a child the entry applies to.

age_endinteger

Last age of a child the entry applies to.

amountinteger

How many of the item the entry is about (extra beds, cots).

pets_typestring

Kind of pet the entry applies to: dog, cat, unspecified ...

shuttle_typestring

Kind of shuttle: one_way, round_trip.

destination_typestring

Where the shuttle goes: airport, train, bus ...

territory_typestring

Where the car park is: inside, outside, unspecified.

extra_bedstring

For a child entry: whether an extra bed is available, not_available or unspecified.

availabilitystring

Whether the service is available, not_available or unspecified.

pricing_methodstring

For a deposit: fixed or percent.

payment_typestring

For a deposit: how it is paid (cash, card, unspecified).

deposit_typestring

For a deposit: what it covers (breakage, unspecified ...).

check_in_check_out_typestring

For an early or late stay: early_checkin, late_checkout ...

no_showobject

The no-show policy.

ShowHide 3 attributes
availabilitystring

Whether a no-show policy exists: available or unspecified.

timestringnullable

Time of day after which a guest counts as a no-show.

day_periodstring

after_midday, before_midday or unspecified.

add_feearray of object

Other fees payable at the property.

ShowHide 20 attributes
inclusionstring

Whether the service is included in the room price.

One of included, not_included.

pricestring

The amount as a decimal string, in currency.

currencystringnullable

ISO 4217 currency of price; null when the service is free or the price is a percentage.

price_unitstring

What the price is for: per_room_per_night, per_guest_per_stay, per_car_per_night, per_hour, unspecified ...

meal_typestring

Meal of the entry: breakfast, lunch, dinner ...

internet_typestring

Kind of internet access: wifi, wired, unspecified ...

work_areastring

Where the internet works: hotel, room, public_area ...

age_startinteger

First age of a child the entry applies to.

age_endinteger

Last age of a child the entry applies to.

amountinteger

How many of the item the entry is about (extra beds, cots).

pets_typestring

Kind of pet the entry applies to: dog, cat, unspecified ...

shuttle_typestring

Kind of shuttle: one_way, round_trip.

destination_typestring

Where the shuttle goes: airport, train, bus ...

territory_typestring

Where the car park is: inside, outside, unspecified.

extra_bedstring

For a child entry: whether an extra bed is available, not_available or unspecified.

availabilitystring

Whether the service is available, not_available or unspecified.

pricing_methodstring

For a deposit: fixed or percent.

payment_typestring

For a deposit: how it is paid (cash, card, unspecified).

deposit_typestring

For a deposit: what it covers (breakage, unspecified ...).

check_in_check_out_typestring

For an early or late stay: early_checkin, late_checkout ...

check_in_check_outarray of object

Early check-in and late check-out and their price.

ShowHide 20 attributes
inclusionstring

Whether the service is included in the room price.

One of included, not_included.

pricestring

The amount as a decimal string, in currency.

currencystringnullable

ISO 4217 currency of price; null when the service is free or the price is a percentage.

price_unitstring

What the price is for: per_room_per_night, per_guest_per_stay, per_car_per_night, per_hour, unspecified ...

meal_typestring

Meal of the entry: breakfast, lunch, dinner ...

internet_typestring

Kind of internet access: wifi, wired, unspecified ...

work_areastring

Where the internet works: hotel, room, public_area ...

age_startinteger

First age of a child the entry applies to.

age_endinteger

Last age of a child the entry applies to.

amountinteger

How many of the item the entry is about (extra beds, cots).

pets_typestring

Kind of pet the entry applies to: dog, cat, unspecified ...

shuttle_typestring

Kind of shuttle: one_way, round_trip.

destination_typestring

Where the shuttle goes: airport, train, bus ...

territory_typestring

Where the car park is: inside, outside, unspecified.

extra_bedstring

For a child entry: whether an extra bed is available, not_available or unspecified.

availabilitystring

Whether the service is available, not_available or unspecified.

pricing_methodstring

For a deposit: fixed or percent.

payment_typestring

For a deposit: how it is paid (cash, card, unspecified).

deposit_typestring

For a deposit: what it covers (breakage, unspecified ...).

check_in_check_out_typestring

For an early or late stay: early_checkin, late_checkout ...

metapolicy_extra_infostringnullable

Free text with the house rules of the hotel.

room_groupsarray of object

Every room type of the hotel, with photos and amenities. About 80% of the bytes of a full document.

ShowHide 7 attributes
room_group_idinteger

Id of the room group. A rate of get_rates belongs to one room group by name.

namestring

Full name of the room type.

name_structobject

The room name taken apart.

ShowHide 3 attributes
main_namestring

The room name without the bedding.

bedding_typestringnullable

The bedding of the room, when the name says it.

bathroomstringnullable

The bathroom, when the name says it.

rg_extobject

Numeric codes of the properties of a room group. They are the supplier's own; the camelCase get_hotel_info document decodes them into words (roomClass, quality, beddingType ...).

ShowHide 12 attributes
classinteger

Room class code.

qualityinteger

Room quality code.

sexinteger

Gender restriction code; 0 for none.

bathroominteger

Bathroom code.

beddinginteger

Bedding code.

familyinteger

1 for a family room, 0 otherwise.

capacityinteger

Capacity code; 0 when unknown.

clubinteger

1 for a club room, 0 otherwise.

bedroomsinteger

Number of bedrooms; 0 when unknown.

balconyinteger

1 when the room has a balcony, 0 otherwise.

floorinteger

Floor code; 0 when unknown.

viewinteger

View code; 0 when unknown.

room_amenitiesarray of string

Amenities of the room, as tags (bath, heating, shared-bathroom ...).

imagesarray of stringnullable

Photos of the room, as URL templates with {size}.

sizenumbernullable

Size of the room in square meters, when the supplier knows it.

factsobject

Facts about the building.

ShowHide 6 attributes
floors_numberintegernullable

Number of floors.

rooms_numberintegernullable

Number of rooms.

year_builtintegernullable

Year the building was built.

year_renovatedintegernullable

Year of the last renovation.

electricityobject

The electricity of the hotel.

ShowHide 3 attributes
frequencyarray of integer

Mains frequencies, for example [60].

voltagearray of numbernullable

Mains voltages, when known.

socketsarray of string

Socket types (a, b, c ...).

registerobjectnullable

Registration data of the property, for the countries that require it.

payment_methodsarray of string

Payment methods accepted at the property.

keys_pickupobject

How the guest gets the keys (mostly for apartments).

ShowHide 6 attributes
typestring

How guests collect the keys: unspecified, lockbox, reception, apartment_office ...

is_contactlessboolean

true when the keys are collected without meeting anybody.

phonestringnullable

Phone number to call for the keys.

emailstringnullable

E-mail address to write to for the keys.

apartment_office_addressstringnullable

Address of the office that hands over the keys.

apartment_extra_informationstringnullable

Free text about the key pick-up.

is_closedboolean

true when the property is closed on the supplier side: availability calls return no rates.

is_gender_specification_requiredboolean

true when the hotel needs the gender of each guest.

deletedboolean

true when the supplier removed the hotel from its catalogue.

distance_centernumbernullable

Distance to the city center, when the supplier gives it.

giata_codestring

GIATA code of the hotel. Present only for hotels that have one.

PreviousThe Hotel mini objectNext The eSIM package object

© 2026 FX-Port

TermsPrivacy[email protected]