Suggest hotel and region

ETG API V3

Hotel search

🆕

The Sandbox environment is available exclusively to new partners who begin their integration in Q4 2025.

https://api-sandbox.worldota.net/api/b2b/v3/search/multicomplete/

The call searches for a region or hotel by a part of its name.

Sandbox limitations

⚠️

Use all field values and API keys obtained from the sandbox environment only within the sandbox. Don’t mix them with test or production environments.

Request

language. Input value is ignored, the value is always en.

Response

hotels. The maximum items’ number is 5.
hotels.region_id. The possible field values:
- 2011.
- 2395.
- 2734.
- 6053839.
regions. The field is always null.

Request example

curl --user '<KEY_ID>:<API_KEY>' 'https://api-sandbox.worldota.net/api/b2b/v3/search/multicomplete/' \
--header 'Content-Type: application/json' \
--data '{
  "query": "Ber",
  "language": "en"
}'

Request body

Expand this| Collapse this

language String optional

The 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 Bokmål.
pl — Polish.
pt — Portuguese.
pt_PT — European Portuguese.
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.

query String required

The part of the hotel or region name.

Response

Expand this| Collapse this

hotels Object

The hotel list.

ℹ️

The minimum items’ number is 5.

id String

The unique hotel ID in the legacy string format.

ℹ️

Either this field or the hid field is required.

hid Int

The unique hotel ID in the new numeric format.

ℹ️

Each ID is an integer no longer than 10 digits.
We are gradually migrating all clients to use this format.

name String

Hotel’s name.

region_id Int

The region ID.

regions Object

The region list.

ℹ️

The maximum items’ number is 5.

id String

The unique region ID.

name String

The region name.

type String

The region type.

ℹ️

The possible values:
- Airport.
- Bus Station.
- City.
- Continent.
- Country.
- Multi-City.
- Multi-Railway Station.
- Multi-Region.
- Neighborhood.
- Point of Interest.
- Province.
- Railway Station.
- Street.
- Subway.

country_code String

The region country code in the ISO 3166-1 alpha-2 format.

Response example

{
  "data": {
    "hotels": [
      {
        "id": "appartement_bertandeau_",
        "hid": 6531811,
        "name": "Appartement Bertandeau",
        "region_id": 2734
      },
      {
        "id": "na_levoberezhnoj_411_apartaments",
        "hid": 8756138,
        "name": "Na Levoberezhnoj; 4-11 Apartaments",
        "region_id": 2395
      },
      {
        "id": "one_bedroom_apartment_dubai_fountain_old_town_view_by_auberge",
        "hid": 10579396,
        "name": "One Bedroom Apartment Dubai Fountain & Old Town View by Auberge",
        "region_id": 6053839
      },
      {
        "id": "lokappart_enghien_number_2",
        "hid": 8313382,
        "name": "Lokappart - Enghien Number 2",
        "region_id": 2734
      },
      {
        "id": "cmg_butte_montmartre_berthe_i",
        "hid": 9812204,
        "name": "CMG Butte Montmartre Berthe I",
        "region_id": 2734
      }
    ],
    "regions": []
  },
  "debug": {
    "api_endpoint": {
      "endpoint": "api/b2b/v3/search/multicomplete",
      "is_active": true,
      "is_limited": true,
      "remaining": 29,
      "requests_number": 30,
      "reset": "2025-09-28T10:00:00",
      "seconds_number": 60
    },
    "request": {
      "query": "Ber",
      "language": "en"
    },
    "method": "POST",
    "real_ip": "10.97.2.10",
    "request_id": "d47d04bcbb967784b348035554965255",
    "key_id": 6,
    "api_key_id": 6,
    "utcnow": "2025-09-28T09:59:51.867753"
  },
  "status": "ok",
  "error": null
}

Errors

The error field has the value specified in the headers below.

`invalid_params`

The query field is required.

`core_search_error`

An internal search error. Has 500 status code.