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 mini object

The compact card of a hotel, made for a list of search results: its identity, place, stars, photos and amenities in 13 snake_case fields, about 5 KB.

search_advanced returns one per hotel in hotels_details[]; POST /hotels/search?detail_level=minimal and get_hotel_info with detail_level=minimal return the same card. It has no price and no room: prices come from hotels_pricing and get_rates. Use it for lists and call the full document for the one hotel the user opens. See Mini and full hotel data.

Example
{
  "id": "test_hotel_do_not_book",
  "hid": 8473727,
  "name": "Test Hotel (Do Not Book) test",
  "kind": "Apartment",
  "address": "Avenida Roble, Frente al Mall Multiplaza, Tegucigalpa",
  "latitude": 14.079872,
  "longitude": -87.21677,
  "postal_code": null,
  "region": {
    "id": 3421,
    "country_code": "HN",
    "iata": "TGU",
    "name": "Tegucigalpa",
    "type": "City",
    "type_v2": "city"
  },
  "star_rating": 0,
  "images": [
    "https://cdn.worldota.net/t/{size}/extranet/b5/d3/b5d3d33394494c68321246882c1bd93a6832dcd5.jpeg",
    "https://cdn.worldota.net/t/{size}/extranet/15/44/15440558c952ec4c3488730d1563dc9e8d25832c.JPEG"
  ],
  "serp_filters": [
    "has_internet",
    "has_parking",
    "has_spa",
    "has_pets",
    "has_jacuzzi",
    "kitchen"
  ],
  "amenity_groups": [
    {
      "amenities": [
        "24-hour reception",
        "Early check-in",
        "Late check-out"
      ],
      "non_free_amenities": [],
      "group_name": "General"
    },
    {
      "amenities": [
        "Concierge services",
        "Dry-cleaning",
        "Shoe shine"
      ],
      "non_free_amenities": [
        "Dry-cleaning",
        "Shoe shine"
      ],
      "group_name": "Services and amenities"
    }
  ]
}

Attributes

idstring

The FX-Port id of the hotel, a lower-case slug. Send it as hotel_id to get_rates and get_hotel_info.

hidinteger

The supplier's numeric hotel id. get_hotel_info also accepts it as a lookup key.

namestring

Name of the hotel.

kindstring

Type of property as the supplier names it: Hotel, Apartment, Resort, Hostel, Guesthouse, Boutique and Design ...

addressstring

Street address, in English.

latitudenumber

Latitude of the hotel.

longitudenumber

Longitude of the hotel.

postal_codestringnullable

Postal code. null for a minority of hotels.

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 the property is not rated.

Between 0 and 5.

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.

serp_filtersarray of string

Tags to build result filters with: has_internet, has_parking, has_pool, has_spa, has_fitness, has_pets, has_kids, has_meal, has_jacuzzi, has_business, has_smoking, has_disabled_support, has_airport_transfer, air_conditioning, kitchen.

amenity_groupsarray of object

The amenities of the hotel by group. With the images it makes up about 90% of the bytes of a mini card.

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.

PreviousThe Flight booking objectNext The Hotel full object

© 2026 FX-Port

TermsPrivacy[email protected]