API V2 Documentation - AbracadaRoom

Responses format

The different API endpoints return JSON objects. For each object, you will find the list of corresponding data below.

  • Accommodation object: represents an accommodation
  • Property object: represents a property
  • Type object: represents an accommodation type
  • Theme object: represents a thematic
  • PropertyFacility object: equipments inside a property, outside an accommodation
  • NearbyFacility object: activities near the property
Some data are indicated as having an "internationalized value": to learn more, see the Internationalization tab.

Accommodation Object

This object representes an accommodation

An accommodation can be not published in certaines languages (see published data). In that case, the internationalized data will only use the keys corresponding to the languages in which the accommodation is published.
Data Description Internationalized value Complementary endpoints
id Unique identifier of the accommodation No
published Boolean indicating if the accommodation is published in the different languages Yes
url URL of the accommodation Yes
title Name of the accommodation Yes
property Partial object of type Property, with only the following data:
  • id
  • title
  • address
  • address2
  • address3
  • postal_code
  • city
  • country
  • area
  • region
  • lat
  • lng
  • access
 Yes, on the title, country, area, region and access data GET /properties   ou GET /properties/{id}
type Object of type Type with:
  • id
  • label
 Yes, on the labeldata GET /types
themes Table of N objects of type Theme with:
  • id
  • label
 Yes, on the labeldata GET /themes
description Description of the accommodation (up to 50 characters) Yes
customers_rating Clients ratings (0 to 5). Decimal value, can be equal to null if there is no rating No
main_photo Main picture, 1920x1440 resolution, JPEG format. No
photos Table of all the pictures, 900x600 maximum resolution, in JPEG. The table can be empty. No
capacity Accommodation's capacity No
minimum_age Minimum age of the occupants (can be equal to null if open to all) No
rooms Number of rooms No
height Height (in meters). No
access Access type (can be equal to null) Yes
surface Surface area in m² No
wheelchair_friendly Adapted to persons with reduced mobility (boolean) No
forbidden_for_pregnant Forbidden to pregnant women (boolean) No
pets_friendly Animals accepted (boolean) No
pets_friendly_details Eventual comment regarding accepted animals Yes
restrooms Eventual information regarding the presence of toilets Yes
bathroom Eventual information regarding the presence of a bathroom or sanitary facilities Yes
sanitary_distance Distance in meters between sanitary facilities and the accommodation. Can be equal to null. No
towel_set Information regarding toilet linen Yes
hair_dryer Presence of a hair dryer in the accommodation (boolean) No
bedrooms Number of bedrooms No
double_beds Number of double beds No
single_beds Number of single beds No
bunk_beds Number of bunk beds No
sofa_beds Number of sofa beds No
baby_beds Number of baby beds No
extra_beds Number of extra beds No
baby_bed_extra_charge Supplement for baby beds (boolean) No
bedding_set Eventual comment regarding bedding set Yes
coffee_maker Presence of a coffee maker in the accommodation (boolean) No
kettle Presence of a kettle in the accommodation (boolean) No
microwave Presence of a microwave in the accommodation (boolean) No
cooking_plate Presence of cooking plates in the accommodation (boolean) No
fridge Presence of a fridge in the accommodation (boolean) No
oven Presence of an oven in the accommodation (boolean) No
dishwasher Presence of a dishwasher in the accommodation (boolean) No
dishes Presence of dished in the accommodation (boolean) No
baby_chair Presence of a baby chair in the accommodation (boolean) No
terrace Presence of a terrace outside the accommodation (boolean) No
terrace_surface Surface of the terrace in m². Can be equal to null if not filled out or if no terrace. No
garden_lounge Presence of a garden lougne outside the accommodation (boolean) No
barbecue Presence of a barbecue outside the accommodation (boolean) No
hammock Presence of a hammock outside the accommodation (boolean) No
electricity Electricity inside the accommodation (boolean) No
water Water inside the accommodation (boolean) No
water_details Eventual information on the water availability in the accommodation Yes
spa Presence of a spa (boolean) No
spa_details Eventual comment about the spa Yes
table_and_chairs Presence of a table and chairs in the accommodation (boolean) No
air_conditioner Air conditioner in the accommodation (boolean) No
heating Heating in the accommodation (boolean) No
wood_stove Wood stove in the accommodation (boolean) No
chimney Chimney in the accommodation (boolean) No
firewood_included Firewood included in the rental price (boolean) No
wifi Wifi in the accommodation (boolean) No
tv TV in the accommodation (boolean) No
washing_machine Washing machine in the accommodation (boolean) No
iron Ironer in the accommodation (boolean) No
hoover Hoover in the accommodation (boolean) No
property_facilities Table of objects of PropertyFacility type (property's equipments, outside the accommodation) with:
  • id
  • label
 Yes, on the label data GET /property_facilities
nearby_facilities Table of objects of NearbyFacility type (Activities near the accommodation, outside the property) with:
  • id
  • label
 Yes, on the label data GET /nearby_facilities
breakfast Eventual information about breakfast Yes
other_meals Eventual information about other meals Yes
checkin_start Arriving time (start of the time slot), 24h format (H:MM or HH:MM). Can be empty. No
checkin_end Arriving time (end of the time slot), 24h format (H:MM or HH:MM). Can be empty. No
checkout Maximum departure time, 24h format (H:MM or HH:MM). Can be empty. No
opening_date Annual opening date of the accommodation, YYYY-MM-DD format. Can be empty. No
closing_date Annual closing date of the accommodation, YYYY-MM-DD format. Can be empty. No
base_night_price

Base price per night (for a maximum number of people equal to the price_scope value)

Since the real price can vary depending on the period, the base price only allows to calculate a "starting from" price. To know the real price for a given date, you need to call the /availabilities endpoint
No For the real price: GET /availabilities
currency Currency (example : EUR) No
price_scope Number of people included in the price per night (if 0, the price is valid no matter the number of persons, up to the maximum capacity of the accommodation) No
price_per_additional_person Price per additional person, above the price_scope No
price_per_additional_person_details Eventual information regarding the price per additional person. Yes
included Eventual information regarding what's included in the price Yes
not_included Eventual information regarding what's not included in the price Yes
additional_services Eventual information indicating additional services (options) Yes
special_offers Eventual information indicating special offers Yes
minimum_stay Eventual information regarding the minimum stay duration Yes
booking_conditions Eventual information about the booking conditions Yes
distance_parking Distance between the parking and the accommodation, in meters. Can be equal to null. No
unavailabilities Table of unavailabilities (not real-time) with the start date (start) and the end date (end), YYYY-MM-DD format. No For real-time availabilities: GET /availabilities

Property Object

This object represents a property. A property offers one or several accommodations.

Date Description Internationalized value Complementary endpoints
id Unique identifier of the property No
url URL of the property Yes
title Namer of the property Yes
description Description of the property (up to 50 characters) Yes
accommodations Partial object of type Accommodation, with only the following data:
  • id
 No GET /accommodations   ou GET /accommodations/{id}
main_photo Main picture, 1920x1440 resolution, JPEG format. No
photos Table of all the pictures, 900x600 maximum resolution, in JPEG. The table can be empty. No
property_facilities Table of objects of PropertyFacility type (equipments of the property, outside of the accommodation) with:
  • id
  • label
 Yes, on the label data GET /property_facilities
nearby_facilities Table of objects of NearbyFacility type (activities near the accommodation, outside the property) with:
  • id
  • label
 Yes, on the label data GET /nearby_facilities
address Address line n°1 No
address2 Address line n°2 No
address3 Address line n°3 No
postal_code Postal code No
city City No
country Country Yes
area Department or reduced geographical area Yes
region Region or extended geographical area Yes
lat Latitude No
lng Longitude No
access Access to the property Yes

Type Object

This object represents an accommodation type.

Data Description Internationalized value Complementary endpoints
id Unique identifier of the type No
label Name of the type Yes

Theme Object

This objects represents a thematic.

Data Description Internationalized value Complementary endpoints
id Unique identifier of the thematic No
label Name of the thematic Yes

PropertyFacility Object

This object represents an equipment offered inside the property, outside the accommodation.

Data Description Internationalized value Complementary endpoints
id Unique identifier of the equipment No
label Name of the equipment Yes

NearbyFacility Object

This object represents an activity offered near the property.

Data Description Internationalized value Complementary endpoints
id Unique identifier of the activity No
label Name of the activity Yes