Katanox API
Search…
Katanox API
v1
Introduction
API Documentation
Availability
Bookings
Properties
Glossary
Powered By
GitBook
Availability
The availability methods allow you to retrieve the latest information on what rooms and prices are available for your search.
get
https://api.katanox.com
/v1/availability
Retrieve the list of available properties
Response:
Field
Type
data
Data
links
Links
meta
Meta
Objects
Data
Field
Type
properties
Array[
Property
]
Property
Field
Type
name
string
type
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
]
check_in_time
string
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
]
bed_types
Array[
BedType
]
class
enum( Undefined, Deluxe, Business, Luxury, Corner, Executive, Economy)
type
enum(Undefined,Suite, Apartment, Studio, King, Dorm, Triple, Twin, Single, Family, Double, Quardruple)
amenities
Array[
Facility
]
BedType
Name
Type
name
string
occupancy
int
amount
int
RatePlan
Name
Type
id
string
name
string
description
string
cancellation_policy
Policy
no_show_policy
Policy
translations
Array[
Translation
]
meals
enum(
Self-catering,
Breakfast included,
Breakfast and lunch included,
Breakfast and dinner included,
All meals included,
All-inclusive)
Policy
Field
Type
name
string
description
string
charge_type
enum(percentage, fixed, nights)
amount
float
AvailabilityPrice
Field
Type
unit_id
string
rate_plan_id
string
property_id
string
currency
string
price
Object{
Price
}
Price
Field
Type
amount
float
currency
string
Location
Field
Type
latitude
float
longitude
float
Links
Field
Type
next
Link
previous
Link
first
Link
last
Link
Link
Field
Type
method
string
url
string
Meta
Field
Type
total_properties
int
time_taken
int
total_pages
int
Previous
Introduction
Next - API Documentation
Bookings
Last modified
5mo ago
Copy link
Contents
get
Retrieve the list of available properties
Objects
Data
Property
Image
Translation
Facility
Unit
BedType
RatePlan
Policy
AvailabilityPrice
Price
Location
Links
Link
Meta