Athena (Zumata Hotel Static Data) (1.0.0)

Download OpenAPI specification:Download

Static Files

  • Active hotel list (NOTE: This list is the file you should use for hotel mapping. Do not use translations available via static data for mapping in alternate languages, English should be considered the canonical information for operations where accuracy is required.)

    zumata_active_properties_list-20190823.csv.tar.gz

  • Region/Location list

    • code - Region code
    • region_type - Region type
    • name - Short name version of the region
    • name_long - Long name version of the region
    • parent_code - Parent region code
    • searchable - Indicate whether this region can be used with region search

    zumata-region-list-20190618.csv

  • Point of interest list

    zumata_pois_20190312.csv.zip

Hotel

Retrieves hotel by hotel ID.

NOTE: Translations provided for supported languages are provided on an as-is basis, with no guarantee as to complete accuracy. When there is a discrepancy between the English and translated text for fields such as Hotel Name, Description, etc., the English is to be considered canonical.

path Parameters
hotel_id
required
string <string> (HotelID) \w{4}

Unique ID of the property returned. Every property has a unique ID.

lang
required
string <string> (Lang)
Enum:"en_US" "ar_SA" "cs_CZ" "da_DK" "de_DE" "el_GR" "es_ES" "es_MX" "fi_FI" "fr_FR" "fr_CA" "in_ID" "it_IT" "ja_JP" "ko_KR" "ms_MY" "nl_NL" "no_NO" "pl_PL" "pt_BR" "pt_PT" "ru_RU" "sv_SE" "th_TH" "tr_TR" "vi_VN" "zh_CN" "zh_TW"
Example: "en_US"

The language of the returned content.

format
required
string <string> (Format)
Enum:"long" "short"

The format of the returned content.

Responses

200

The response body is in JSON format and it is similar to hotels objects but with two additional fields.

get /hotels/{hotel_id}/{lang}/{format}.json

Live server

http://data.zumata.com/hotels/{hotel_id}/{lang}/{format}.json

Response samples

application/json
Copy
Expand all Collapse all
{
  • "address": "43A Jalan Besar",
  • "city": "Singapore",
  • "country": "Singapore",
  • "country_code": "SG",
  • "approximate_cost": 0,
  • "id": "JzFX",
  • "image_details":
    {},
  • "latitude": 1.305,
  • "longitude": 103.855,
  • "name": "Grand U",
  • "rating": 1,
  • "chain_code": 0,
  • "original_name": "Grand U",
  • "destination_ids":
    [
    ],
  • "region_ids":
    [
    ],
  • "amenities":
    {
    },
  • "meta_image_details":
    {
    },
  • "category_id": 2,
  • "airport_code": "SIN",
  • "check_in_time": "",
  • "check_out_time": "",
  • "description": "This 1 star hotel is located in the city centre of Singapore.",
  • "postal_code": 208804,
  • "state_province": "",
  • "phone": "65-6-2948850",
  • "fax": "",
  • "email": "",
  • "website": "",
  • "payments": [ ]
}

Hotels

Retrieves all hotels.

path Parameters
country_code
string <string> (CountryCode) \w{2}

Country code params.

category_id
number <integer> (CategoryID)

Category ID params.

query Parameters
page
integer <integer> (Page)

Pagination page params.

Responses

200

The response body is in JSON format and it is an array contains a list of hotels objects.

get /hotels

Live server

http://data.zumata.com/hotels

Response samples

application/json
Copy
Expand all Collapse all
{
  • "data":
    {
    }
}

Hotels

Retrieves hotels by hotel IDs.

NOTE: Translations provided for supported languages are provided on an as-is basis, with no guarantee as to complete accuracy. When there is a discrepancy between the English and translated text for fields such as Hotel Name, Description, etc., the English is to be considered canonical.

path Parameters
lang
required
string <string> (Lang)
Enum:"en_US" "ar_SA" "cs_CZ" "da_DK" "de_DE" "el_GR" "es_ES" "es_MX" "fi_FI" "fr_FR" "fr_CA" "in_ID" "it_IT" "ja_JP" "ko_KR" "ms_MY" "nl_NL" "no_NO" "pl_PL" "pt_BR" "pt_PT" "ru_RU" "sv_SE" "th_TH" "tr_TR" "vi_VN" "zh_CN" "zh_TW"
Example: "en_US"

The language of the returned content.

format
required
string <string> (Format)
Enum:"long" "short"

The format of the returned content.

Request Body schema: application/json
hotel_list
required
Array of string <string> (HotelID)

The list of hotel-ids.

Responses

200

The response body is in JSON format and it contains a list of hotel id key and hotels objects value pairs. The full list of hotel ids is available here. The fields of hotels objects are controlled by the [FORMAT] provided in the URL.

post /hotels/{lang}/{format}.json

Live server

http://data.zumata.com/hotels/{lang}/{format}.json

Request samples

application/json
Copy
Expand all Collapse all
{
  • "hotel_list":
    [
    ]
}

Response samples

application/json
Copy
Expand all Collapse all
[
  • {
    }
]

Hotels changelog

Retrieves hotels that updated after the input timestamp.

query Parameters
updated_at
required
integer <datetime> (UpdatedAt)

Date time with ISO8601 format. example 2019-01-01 00:00:00

Responses

200

The response body is in JSON format and it is an array contains a list of hotel codes.

400

The response body is in JSON format and it is an error object.

get /hotels-changelog

Live server

http://data.zumata.com/hotels-changelog

Response samples

application/json
Copy
Expand all Collapse all
{
  • "data":
    {
    }
}

Hotels categories

Retrieves all the categories of hotels.

query Parameters
page
integer <integer> (Page)

Pagination page params.

Responses

200

The response body is in JSON format and it is an array contains a list of category objects.

get /hotels-categories

Live server

http://data.zumata.com/hotels-categories

Response samples

application/json
Copy
Expand all Collapse all
{
  • "data":
    {
    }
}

Autosuggest

Retrieves the destination auto suggestions based on the types and term in the parameters.

query Parameters
term
required
string

The phrase that you wish to search for.

types[]
required
Array of string

The destination type that you wish to search for. Use city_en_us.

limit
integer

Limit the results for each destination types.

Responses

200

Autosuggest responses

get /autosuggest

Live server

http://data.zumata.com/autosuggest

Response samples

application/json
Copy
Expand all Collapse all
{
  • "term": "Singapore",
  • "results":
    {
    }
}

Geo Radius

Retrieves the Zumata hotel ids found within a specified radius of a latitude and longitude location. To be used in conjunction with the hotel_list search endpoint.

path Parameters
latitude
required
float

Specifies the latitude geo-coordinate in decimal format.

longitude
required
any

Specifies the longitude geo-coordinate in decimal format.

radius_in_meters
required
float

Specifies the radius in meters to search around the coordinates specified.

Responses

200

Geo Radius Response

get /geo-radius/hotels/{latitude}/{longitude}/{radius_in_meters}

Live server

http://data.zumata.com/geo-radius/hotels/{latitude}/{longitude}/{radius_in_meters}

Response samples

application/json
Copy
Expand all Collapse all
[
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    }
]

Region

Retrieves the Zumata hotel id’s associated with a region_id.

path Parameters
region_id
required
string

Specifies the region_id requested to search for hotel_ids.

Responses

200

Region Responses

get /region/{region_id}/zumata_hotels

Live server

http://data.zumata.com/region/{region_id}/zumata_hotels

Response samples

application/json
Copy
Expand all Collapse all
[
  • "4PXS",
  • "fAkN",
  • "4yAU",
  • "XFQ9",
  • "4QJD",
  • "5CCH",
  • "j5IN"
]