/hoteldemand/Get Event Information
Get event information
Implementation Notes
This API retrieves hotel demand data based on an individual hotel or an entire city.
- If a hotel is provided as input, demand will be calculated for a single hotel.
- If a city is provided as input, demand will be calculated for all hotels in that city, returning an H x D matrix, where:
- H = Number of hotels in the city
- D = Number of days in the time range
Output Files:
- Absolute Demand: Estimated number of potential guests per day.
- Relative Demand: A value between 0-100, where 0 is the lowest demand and 100 is the highest.
- Events Registered: Number of events per day contributing to the demand.
- Event Records (City-Level Only): Detailed event data including event name, venue, category, date, and expected attendance.
Search Criteria:
- Either
hotelCodeorcity, countrymust be provided. horizon(days to retrieve data for) must be ≤ 365.categoryandsubCategorycan be a single number, range, or combination.
Mandatory Fields:
- hotelCode
- Or city and country
- startDate
- horizon
Once the request is processed, the results will be emailed to the registered user.
Example Input 1 (Hotel-Specific Search):
{ "hotelCode": 12345, "city": "Barcelona", "country": "Spain", "horizon": 5, "startDate": "2022-04-01", "estimatedAttendee": "500-1000", "category": "2,4", "subCategory": "1,5-7" }
Example Input 2 (City-Wide Search):
{ "hotelCode": 0, "city": "Florida", "country": "United States", "horizon": 5, "startDate": "2022-04-01", "estimatedAttendee": ">1000", "category": "2,4", "subCategory": "1,5-7" }
/hoteldemand/Parameter Details
| Name | In | Type | Required | Description |
|---|---|---|---|---|
body | body | object | Required | none |
» hotelCode | body | integer | Optional | Unique hotel identifier (0 if searching by city). |
» city | body | Optional | City for demand calculation. | |
» country | body | string | Optional | Country for demand calculation. |
» horizon | body | integer | Optional | Number of days for demand retrieval (max- 365). |
» startDate | body | string(date) | Optional | Start date for demand calculation. |
» estimatedAttendee | body | string | Optional | Estimated attendee count (range, min, max, exact). |
» category | body | string | Optional | Event category (number, range, or combination). |
» subCategory | body | string | Optional | Event subCategory (number, range, or combination). |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | |
| 400 | Bad Request | Bad Request | None |
| 401 | Unauthorized | Unauthorized | None |
| 429 | Too Many Requests | Too Many Requests | None |
| 500 | Internal Server Error | Internal Server Error | None |
Example Request
# You can also use wget
curl -X POST https://api.events.example.com/api/v1/hoteldemand/ \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
Example responses
{
"hotelCode": 12345,
"city": "Barcelona",
"country": "Spain",
"horizon": 5,
"startDate": "2022-04-01",
"estimatedAttendee": "500-1000",
"category": "2,4",
"subCategory": "1,5-7"
}Body parameter
{
"hotelCode": 0,
"city": "",
"country": "",
"horizon": 30,
"startDate": "2019-08-24",
"estimatedAttendee": "",
"category": "0",
"subCategory": "0"
}
Example responses
{
"demandId": 612
}
Need Support?
Our team is here to help you integrate and make the most of our APIs. Get in touch for technical support, custom solutions, or any questions.