Availability

The availability methods allow you to retrieve the latest information on what rooms and prices are available for your search.

get
Retrieve the list of available properties

https://[environment].katanox.com/v1/availability
Request
Response
Request
Headers
Authorization
required
string
Bearer <api key>
Query Parameters
check_in
required
string
Date(YYYY-MM-DD). Default today
check_out
required
string
Date(YYYY-MM-DD). Default = tomorrow
adults
required
integer
Number of adults. Default 1
children
required
integer
Number of children. Default 0
lat
required
number
The Latitude [min -90, max 90]
lng
required
number
The Longitude [min -180, max 180]
radius
required
integer
The search radius in meters(m). Default 2000
page
optional
integer
The returned page number. Default = 1.
limit
optional
integer
Number of results per page. Default = 10
include
optional
array
Optional included objects. enum(Images, Facilities)
locale
optional
string
The returned language. Default = "en"
property_ids
optional
array
List of property IDs to be included. When specified, only these properties will be included in the response
Response
200: OK
{
"data": {
"properties": [
{
"type": "Hotel",
"id": "MMMMMMM",
"name": "Grand Demo Hotel",
"description": "Grand Demo Hotel is an a hotel made for awesome examples.",
"address_line_1": "Fuencarral 15",
"address_line_2": "",
"postcode": "28004",
"city": "Madrid",
"country": "Spain",
"location": {
"latitude": 40.4210638,
"longitude": -3.703642
},
"phone_number": "+34123456789",
"email": "[email protected]",
"currency": "EUR",
"star_rating": 5,
"number_of_units": 50,
"images": [],
"translations": [],
"units": [
{
"id": "NNNNNNN",
"property_id": "MMMMMMM",
"name": "Hub",
"description": "Stay in your own Hub with a huge bed. Recharge yourself. And your phone.\r\n\r\nYour reservation is paid in full upon arrival (Mastercard / Visa / Maestro).",
"images": [],
"translations": [],
"amenities": []
}
],
"rate_plans": [
{
"id": "YYYYYYY",
"property_id": "MMMMMMM",
"name": "Fully Flexible Rate",
"description": "This rate is the most flexible rate we offer!\r\n\r\nYour booking can be cancelled free of charge until 15:00hrs on your arrival date. In case of late cancellation the first night will be charged, no show will result in a full charge. City tax is included in this rate.",
"cancellation_policy": {
"name": "",
"description": "",
"charge_type": "",
"amount": 0
},
"no_show_policy": {
"name": "",
"description": "",
"charge_type": "",
"amount": 0
},
"translations": []
},
{
"id": "XXXXXXX",
"property_id": "MMMMMMM",
"name": "Summer Promotion (free cancellation!)",
"description": "A special summer promotion rate!\r\n\r\nYour booking can be cancelled free of charge until 15:00hrs on your arrival date. In case of late cancellation the first night will be charged, no show will result in a full charge. City tax is included in this rate.",
"cancellation_policy": {
"name": "",
"description": "",
"charge_type": "",
"amount": 0
},
"no_show_policy": {
"name": "",
"description": "",
"charge_type": "",
"amount": 0
},
"translations": []
}
],
"facilities": [],
"prices": [
{
"price": 32,
"currency": "EUR",
"unit_id": "NNNNNNN",
"property_id": "MMMMMMM",
"rate_plan_id": "XXXXXXX"
},
{
"price": 40,
"currency": "EUR",
"unit_id": "NNNNNNN",
"property_id": "MMMMMMM",
"rate_plan_id": "YYYYYYY"
}
]
},
{
...
}
]
},
"links": {
"first": {
"method": "GET",
"url": "/v1/availability?include=[]&locale=nl&check_in=2021-04-08&check_out=2021-04-09&adults=1&children=0&limit=2&lat=52.359696&lng=4.802784&radius=10000&&page=0"
},
"last": {
"method": "GET",
"url": "/v1/availability?include=[]&locale=nl&check_in=2021-04-08&check_out=2021-04-09&adults=1&children=0&limit=2&lat=52.359696&lng=4.802784&radius=10000&&page=5"
},
"next": {
"method": "GET",
"url": "/v1/availability?include=[]&locale=nl&check_in=2021-04-08&check_out=2021-04-09&adults=1&children=0&limit=2&lat=52.359696&lng=4.802784&radius=10000&&page=1"
},
"previous": null
},
"meta": {
"total_pages": 6,
"total_properties": 12
}
}

Response:

Field

Type

data

Data

links

Links

meta

Meta

Objects

Data

Field

Type

properties

Array[Property]

Property

Field

Type

name

string

description

string

stars

int

address_line_1

string

address_line_2

string

city

string

postcode

string

country

string

location

Object{Location}

phone_number

string

email

string

currency

string

images

Array[Image]

translations

Array[Translation]

facilities

Array[Facility]

units

Array[Unit]

rate_plans

Array[RatePlan]

prices

Array[Price]

Image

Name

Type

tag

string

url

string

Translation

Name

Type

description

string

locale

string

Facility

Name

Type

category

string

name

string

Unit

Name

Type

id

string

name

string

description

string

images

Array[Image]

translations

Array[Translation]

amenities

Array[Facility]

RatePlan

Name

Type

id

string

name

string

description

string

cancellation_policy

Policy

no_show_policy

Policy

translations

Array[Translation]

Policy

Field

Type

name

string

description

string

charge_type

enum(percentage, fixed, nights)

amount

float

Price

Field

Type

unit_id

string

rate_plan_id

string

property_id

string

currency

string

price

float

Field

Type

next

Link

previous

Link

first

Link

last

Link

Field

Type

method

string

url

string

Meta

Field

Type

total_properties

int

time_taken

int

total_pages

int