PublicApiDocs API
Describe here all the API calls needed by your application to properly work. This document can be used to specify a formal contrat among the frontend application and the correspondent backend server, before starting any implementation.
Room ¶
Room ¶
Search roomsGET/rooms{?page}{&address}{&estateTypes}{&maxPrice}{&minPrice}{&dateFrom}{&dateTo}
Example URI
GET https://www.lodgerin.com/public/v1/rooms?page=1&address=Madrid&estateTypes=[0,1]&maxPrice=600&minPrice=100&dateFrom=2020-07-17&dateTo=2020-08-14
URI Parameters
- page
number(optional) Example: 1Requested page number
- address
string(optional) Example: MadridAddress around which perform the search
- estateTypes
array(integer)(optional) Example: [0,1]Accommodation type filter, can be filtered by more of one type at the same time
- minPrice
number(optional) Example: 100Filter by minimum monthly rental
- maxPrice
number(optional) Example: 600Filter by maximun monthly rental
- dateFrom
string(optional) Example: 2020-07-17Filter by availability within a range of dates, and the meta response will contain the information of the payment amounts (dateFrom and dateTo must be sent together to apply the filter)
- dateTo
string(optional) Example: 2020-08-14Filter by availability within a range of dates, and the meta response will contain the information of the payment amounts (dateFrom and dateTo must be sent together to apply the filter)
Request
Headers
Content-Type: application/vnd.api+json
Authorization: Bearer e9629c2a-6763-45f4-9d3a-1b2c7822febeBody
{
"data": {
"type": "rooms",
"attributes": {
"'action": "",
"url-english": "https://lodgerin.com/house/madrid/33",
"url-spanish": "https://lodgerin.com/es/alojamiento/madrid/33",
"title-english": "Nice shared flat for rent in Triana",
"title-spanish": "Simpático piso compartido para alquilar en Triana",
"house-description-english": "This student apartment has 2 rooms, 1 bath and equipped kitchen. It is a student accommodation with a modern atmosphere and where students can enjoy both a good space to study and to relax and meet other study abroad students.",
"house-description-spanish": "Este piso para estudiantes cuenta con 2 habitaciones, 1 baño y cocina equipada. Es un alojamiento para estudiantes de ambiente moderno y en el que los estudiantes podrán disfrutar tanto de un buen espacio para estudiar como para relajarse y conocer otros estudiantes.",
"room-description-english": "A lovely bedroom with a bed, study desk, chair, clothes storage and night stand. Perfect for one student who need a place to study and enjoy the study abroad experience. This bedroom have access to a shared bathroom. This room also has maintenance and cleaning of common areas.",
"room-description-spanish": "Un bonito dormitorio con cama, escritorio, silla, armario de ropa y mesa de noche. Perfecto para un estudiante que necesita un lugar para estudiar y disfrutar de la experiencia de estudiar en el extranjero. Esta habitación tiene acceso a un baño compartido. Esta habitación cuenta además con mantenimiento y limpieza de zonas comunes.",
"notes-english": "ADDITIONAL FOOD SERVICES CAN BE HIRED",
"notes-spanish": "SE PUEDE CONTRATAR SERVICIOS DE COMIDA ADICIONALES",
"latitude": -3.232343,
"longitude": 41.342423,
"start-availability": "2022-07-01T00:00:00.000Z",
"limit-availability": "2022-07-01T00:00:00.000Z",
"accommodation-type": 0,
"rooms-number": 3,
"baths": 2,
"address": "St. Colegiata",
"address-number": 9,
"door-number": "D",
"floor": "1º",
"postal-code": "'28001'",
"neighborhood": "Trafalgar",
"city": "'Madrid'",
"country-code": "'ES'",
"payment-frequency": 1,
"consumption-limit": 30,
"lift": true,
"air-conditioning": true,
"exterior-house": true,
"terrace": true,
"swimming-pool": true,
"washer": true,
"oven": true,
"microwave": true,
"kitchenware": true,
"common-areas": true,
"dishwasher": true,
"iron": true,
"house-television": true,
"mailbox-access": true,
"census": true,
"max-occupancy": 3,
"tenants-min-age": 18,
"tenants-max-age": 35,
"occupation-preferences": [],
"smoke": true,
"pets": true,
"heating-system": true,
"minimum-stay": 15,
"monthly-rent-calc": "MONTHLY",
"cancellation-policy": 3,
"checkin": 0,
"pension-type": 0,
"guest-night": 2,
"owner-langs": "[1, 2, 4]",
"video-url": "https://somevideourl.com/",
"tour-url": "``https://matterport.com/`",
"lodgerin-ref": "LOD.153.592",
"room-type": 1,
"month-price": 485,
"has-private-bath": true,
"electricity": true,
"water": true,
"heating": true,
"internet": true,
"cleaning": true,
"maintenance": true,
"penalty": 485,
"deposit": 485,
"landlord-fee": 0,
"final-cleaning-fee": 100,
"extra-costs": 50,
"study-area": true,
"bed-linen": false,
"lockable-door": true,
"bed-type": "INDIVIDUAL",
"exterior-room": false,
"private-terrace": false,
"room-television": false,
"room-air-conditioning": false,
"wardrobes": true,
"currency": "EUR"
},
"relationships": {}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"rooms"
]
},
"attributes": {
"type": "object",
"properties": {
"'action": {
"type": "string",
"description": "event': nil (object) - Ignore, it will always be empty"
},
"url-english": {
"type": "string",
"description": "URL to the english version of the room page"
},
"url-spanish": {
"type": "string",
"description": "URL to the spanish version of the room page"
},
"title-english": {
"type": "string",
"description": "Accommodation english title"
},
"title-spanish": {
"type": "string",
"description": "Accommodation spanish title"
},
"house-description-english": {
"type": "string"
},
"house-description-spanish": {
"type": "string"
},
"room-description-english": {
"type": "string"
},
"room-description-spanish": {
"type": "string"
},
"notes-english": {
"type": "string",
"description": "Text used to notify special terms or conditions"
},
"notes-spanish": {
"type": "string",
"description": "Text used to notify special terms or conditions"
},
"latitude": {
"type": "number"
},
"longitude": {
"type": "number"
},
"start-availability": {
"type": "string",
"description": "Start date of contract, bookings are not allowed before this date"
},
"limit-availability": {
"type": "string",
"description": "End date of contract, bookings are not allowed after this date"
},
"accommodation-type": {
"type": "number",
"description": "0: studio/entire flat | 1: Student residence | 2: Shared flat | 3: Host family (DEPRECATED) | 4: Coliving"
},
"rooms-number": {
"type": "number",
"description": "Number of rooms in the house, but in the case of student residences, this number represents the number of rooms of the same features, price, etc."
},
"baths": {
"type": "number"
},
"address": {
"type": "string"
},
"address-number": {
"type": "number"
},
"door-number": {
"type": "string"
},
"floor": {
"type": "string"
},
"postal-code": {
"type": "string"
},
"neighborhood": {
"type": "string"
},
"city": {
"type": "string"
},
"country-code": {
"type": "string",
"description": "Country code according to ISO 3166-1 Alpha-2 code"
},
"payment-frequency": {
"type": "number",
"enum": [
1
],
"description": "0: Monthly | 1: Bimonthly | 2: Quarterly | 3: All at once"
},
"consumption-limit": {
"type": "number",
"description": "Maximum amount in euros of the services included in the rent"
},
"lift": {
"type": "boolean",
"description": "The building has a lift"
},
"air-conditioning": {
"type": "boolean"
},
"exterior-house": {
"type": "boolean"
},
"terrace": {
"type": "boolean",
"description": "The house/property has a terrace"
},
"swimming-pool": {
"type": "boolean"
},
"washer": {
"type": "boolean",
"description": "The house/property has a washer"
},
"oven": {
"type": "boolean",
"description": "The house/property has a oven"
},
"microwave": {
"type": "boolean",
"description": "The house/property has a microwave"
},
"kitchenware": {
"type": "boolean",
"description": "The house/property has kitchenware"
},
"common-areas": {
"type": "boolean",
"description": "The house/property has common areas"
},
"dishwasher": {
"type": "boolean",
"description": "The house/property has a dishwasher"
},
"iron": {
"type": "boolean",
"description": "The house/property has a iron"
},
"house-television": {
"type": "boolean",
"description": "The house/property has television"
},
"mailbox-access": {
"type": "boolean",
"description": "Ttenants will be able to receive postal mail"
},
"census": {
"type": "boolean",
"description": "Tenants can register in the accommodation"
},
"max-occupancy": {
"type": "number",
"description": "Maximum occupancy of tenants in the house/property"
},
"tenants-min-age": {
"type": "number",
"description": "Preferred minimum age of the tenants"
},
"tenants-max-age": {
"type": "number",
"description": "Preferred maximum age of the tenants"
},
"occupation-preferences": {
"type": "array",
"description": "1: Students | 2: Professionals | 3: Families"
},
"smoke": {
"type": "boolean",
"description": "Whether it's allowed or not"
},
"pets": {
"type": "boolean",
"description": "Whether they are allowed or not"
},
"heating-system": {
"type": "boolean",
"description": "The house/property has a heating system"
},
"minimum-stay": {
"type": "number",
"description": "Minimum of number of days to booking"
},
"monthly-rent-calc": {
"type": "string",
"description": "It means if you start your stay with more than half of the month advanced, you will be charged the full month (MONTHLY), only half of the month's rent (FORTNIGHTLY) or the proportional part (DAILY)."
},
"cancellation-policy": {
"type": "number",
"description": "1: Flexible | 2: Standard | 3: Strict | See more: https:www.lodgerin.com/service-conditions"
},
"checkin": {
"type": "number",
"enum": [],
"description": "0: No specified | 1: 9:00-17:00 | 2: 24H | 3: 9:00-18:00 | 4: 10:00-19:00 | 5: 14:00-19:00"
},
"pension-type": {
"type": "number",
"description": "0: None | 1: Half board | 2: Full board"
},
"guest-night": {
"type": "number",
"description": "0: Yes | 1: No | 2: Ask owner"
},
"owner-langs": {
"type": "string",
"description": "(array[number]) - Languages spoken by the owner: 1 spanish, 2 english, 3 german, 4 italian, 5 russian, 6 chinese, 7 french, 8 arab, 9 portuguese, 10 hindi, 11 japanese"
},
"video-url": {
"type": "string",
"description": "Video tour about the house/property"
},
"tour-url": {
"type": "string",
"description": "Tour 360º about the house/property"
},
"lodgerin-ref": {
"type": "string",
"description": "Our reference"
},
"room-type": {
"type": "number",
"description": "1: Individual | 2: Double | 3: Triple | 4: Quadruple"
},
"month-price": {
"type": "number",
"description": "Monthly rental price"
},
"has-private-bath": {
"type": "boolean",
"description": "The room has private bathroom"
},
"electricity": {
"type": "boolean",
"description": "Electricity is included in the rent price"
},
"water": {
"type": "boolean",
"description": "Water is included in the rent price"
},
"heating": {
"type": "boolean",
"description": "Heating is included in the rent price"
},
"internet": {
"type": "boolean",
"description": "Internet is included in the rent price"
},
"cleaning": {
"type": "boolean",
"description": "Cleaning is included in the rent price"
},
"maintenance": {
"type": "boolean",
"description": "Maintenance is included in the rent price"
},
"penalty": {
"type": "number",
"description": "Penalty amount in case of cancellation of the booking (depending on the cancellation policy)"
},
"deposit": {
"type": "number",
"description": "Amount to be paid as deposit"
},
"landlord-fee": {
"type": "number",
"description": "Amount to be paid to the landlord as fee"
},
"final-cleaning-fee": {
"type": "number",
"description": "End-of-stay cleaning fee"
},
"extra-costs": {
"type": "number",
"description": "Amount of the extra monthly payment not included in the rent"
},
"study-area": {
"type": "boolean",
"description": "The room has at least a desk and a chair."
},
"bed-linen": {
"type": "boolean"
},
"lockable-door": {
"type": "boolean",
"description": "The door of the room has a lock"
},
"bed-type": {
"type": "string",
"description": "Bed size, options: UNKNOWN, INDIVIDUAL, DOUBLE"
},
"exterior-room": {
"type": "boolean"
},
"private-terrace": {
"type": "boolean",
"description": "The room has private terrace"
},
"room-television": {
"type": "boolean",
"description": "The room has its own television"
},
"room-air-conditioning": {
"type": "boolean",
"description": "The room is air-conditioned"
},
"wardrobes": {
"type": "boolean",
"description": "The room has at least a wardrobe"
},
"currency": {
"type": "string",
"description": "Code of the currency (ISO 4217) in which the accommodation is commercialised"
}
}
},
"relationships": {
"type": "object",
"properties": {}
}
},
"required": [
"type",
"attributes"
]
}
}
}Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"id": 1,
"type": "rooms",
"attributes": {
"'action": "",
"url-english": "https://lodgerin.com/house/madrid/33",
"url-spanish": "https://lodgerin.com/es/alojamiento/madrid/33",
"title-english": "Nice shared flat for rent in Triana",
"title-spanish": "Simpático piso compartido para alquilar en Triana",
"house-description-english": "This student apartment has 2 rooms, 1 bath and equipped kitchen. It is a student accommodation with a modern atmosphere and where students can enjoy both a good space to study and to relax and meet other study abroad students.",
"house-description-spanish": "Este piso para estudiantes cuenta con 2 habitaciones, 1 baño y cocina equipada. Es un alojamiento para estudiantes de ambiente moderno y en el que los estudiantes podrán disfrutar tanto de un buen espacio para estudiar como para relajarse y conocer otros estudiantes.",
"room-description-english": "A lovely bedroom with a bed, study desk, chair, clothes storage and night stand. Perfect for one student who need a place to study and enjoy the study abroad experience. This bedroom have access to a shared bathroom. This room also has maintenance and cleaning of common areas.",
"room-description-spanish": "Un bonito dormitorio con cama, escritorio, silla, armario de ropa y mesa de noche. Perfecto para un estudiante que necesita un lugar para estudiar y disfrutar de la experiencia de estudiar en el extranjero. Esta habitación tiene acceso a un baño compartido. Esta habitación cuenta además con mantenimiento y limpieza de zonas comunes.",
"notes-english": "ADDITIONAL FOOD SERVICES CAN BE HIRED",
"notes-spanish": "SE PUEDE CONTRATAR SERVICIOS DE COMIDA ADICIONALES",
"latitude": -3.232343,
"longitude": 41.342423,
"start-availability": "2022-07-01T00:00:00.000Z",
"limit-availability": "2022-07-01T00:00:00.000Z",
"accommodation-type": 0,
"rooms-number": 3,
"baths": 2,
"address": "St. Colegiata",
"address-number": 9,
"door-number": "D",
"floor": "1º",
"postal-code": "'28001'",
"neighborhood": "Trafalgar",
"city": "'Madrid'",
"country-code": "'ES'",
"payment-frequency": 1,
"consumption-limit": 30,
"lift": true,
"air-conditioning": true,
"exterior-house": true,
"terrace": true,
"swimming-pool": true,
"washer": true,
"oven": true,
"microwave": true,
"kitchenware": true,
"common-areas": true,
"dishwasher": true,
"iron": true,
"house-television": true,
"mailbox-access": true,
"census": true,
"max-occupancy": 3,
"tenants-min-age": 18,
"tenants-max-age": 35,
"occupation-preferences": [],
"smoke": true,
"pets": true,
"heating-system": true,
"minimum-stay": 15,
"monthly-rent-calc": "MONTHLY",
"cancellation-policy": 3,
"checkin": 0,
"pension-type": 0,
"guest-night": 2,
"owner-langs": "[1, 2, 4]",
"video-url": "https://somevideourl.com/",
"tour-url": "``https://matterport.com/`",
"lodgerin-ref": "LOD.153.592",
"room-type": 1,
"month-price": 485,
"has-private-bath": true,
"electricity": true,
"water": true,
"heating": true,
"internet": true,
"cleaning": true,
"maintenance": true,
"penalty": 485,
"deposit": 485,
"landlord-fee": 0,
"final-cleaning-fee": 100,
"extra-costs": 50,
"study-area": true,
"bed-linen": false,
"lockable-door": true,
"bed-type": "INDIVIDUAL",
"exterior-room": false,
"private-terrace": false,
"room-television": false,
"room-air-conditioning": false,
"wardrobes": true,
"currency": "EUR"
},
"relationships": {
"main-image": {
"data": {
"id": 1,
"type": "images"
}
},
"images": {
"data": [
{
"id": 1,
"type": "images"
}
]
}
},
"meta": {
"unavailable-dates": [
{
"start": "2020-07-01",
"end": "2021-07-01"
}
],
"lodgerin-fee": 224.33,
"tpv-fee": 24.5,
"total-booking-price": 680.8,
"euro-exchange-rate": 1
}
},
"meta": {
"lat": 45.245972,
"lng": 45.245972,
"swlat": 45.245972,
"swlng": -3.654688,
"nelat": 45.245972,
"nelng": -3.654688,
"current-page": 1,
"pages": 27,
"results": 810
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "number",
"description": "unique ID"
},
"type": {
"type": "string",
"enum": [
"rooms"
]
},
"attributes": {
"type": "object",
"properties": {
"'action": {
"type": "string",
"description": "event': nil (object) - Ignore, it will always be empty"
},
"url-english": {
"type": "string",
"description": "URL to the english version of the room page"
},
"url-spanish": {
"type": "string",
"description": "URL to the spanish version of the room page"
},
"title-english": {
"type": "string",
"description": "Accommodation english title"
},
"title-spanish": {
"type": "string",
"description": "Accommodation spanish title"
},
"house-description-english": {
"type": "string"
},
"house-description-spanish": {
"type": "string"
},
"room-description-english": {
"type": "string"
},
"room-description-spanish": {
"type": "string"
},
"notes-english": {
"type": "string",
"description": "Text used to notify special terms or conditions"
},
"notes-spanish": {
"type": "string",
"description": "Text used to notify special terms or conditions"
},
"latitude": {
"type": "number"
},
"longitude": {
"type": "number"
},
"start-availability": {
"type": "string",
"description": "Start date of contract, bookings are not allowed before this date"
},
"limit-availability": {
"type": "string",
"description": "End date of contract, bookings are not allowed after this date"
},
"accommodation-type": {
"type": "number",
"description": "0: studio/entire flat | 1: Student residence | 2: Shared flat | 3: Host family (DEPRECATED) | 4: Coliving"
},
"rooms-number": {
"type": "number",
"description": "Number of rooms in the house, but in the case of student residences, this number represents the number of rooms of the same features, price, etc."
},
"baths": {
"type": "number"
},
"address": {
"type": "string"
},
"address-number": {
"type": "number"
},
"door-number": {
"type": "string"
},
"floor": {
"type": "string"
},
"postal-code": {
"type": "string"
},
"neighborhood": {
"type": "string"
},
"city": {
"type": "string"
},
"country-code": {
"type": "string",
"description": "Country code according to ISO 3166-1 Alpha-2 code"
},
"payment-frequency": {
"type": "number",
"enum": [
1
],
"description": "0: Monthly | 1: Bimonthly | 2: Quarterly | 3: All at once"
},
"consumption-limit": {
"type": "number",
"description": "Maximum amount in euros of the services included in the rent"
},
"lift": {
"type": "boolean",
"description": "The building has a lift"
},
"air-conditioning": {
"type": "boolean"
},
"exterior-house": {
"type": "boolean"
},
"terrace": {
"type": "boolean",
"description": "The house/property has a terrace"
},
"swimming-pool": {
"type": "boolean"
},
"washer": {
"type": "boolean",
"description": "The house/property has a washer"
},
"oven": {
"type": "boolean",
"description": "The house/property has a oven"
},
"microwave": {
"type": "boolean",
"description": "The house/property has a microwave"
},
"kitchenware": {
"type": "boolean",
"description": "The house/property has kitchenware"
},
"common-areas": {
"type": "boolean",
"description": "The house/property has common areas"
},
"dishwasher": {
"type": "boolean",
"description": "The house/property has a dishwasher"
},
"iron": {
"type": "boolean",
"description": "The house/property has a iron"
},
"house-television": {
"type": "boolean",
"description": "The house/property has television"
},
"mailbox-access": {
"type": "boolean",
"description": "Ttenants will be able to receive postal mail"
},
"census": {
"type": "boolean",
"description": "Tenants can register in the accommodation"
},
"max-occupancy": {
"type": "number",
"description": "Maximum occupancy of tenants in the house/property"
},
"tenants-min-age": {
"type": "number",
"description": "Preferred minimum age of the tenants"
},
"tenants-max-age": {
"type": "number",
"description": "Preferred maximum age of the tenants"
},
"occupation-preferences": {
"type": "array",
"description": "1: Students | 2: Professionals | 3: Families"
},
"smoke": {
"type": "boolean",
"description": "Whether it's allowed or not"
},
"pets": {
"type": "boolean",
"description": "Whether they are allowed or not"
},
"heating-system": {
"type": "boolean",
"description": "The house/property has a heating system"
},
"minimum-stay": {
"type": "number",
"description": "Minimum of number of days to booking"
},
"monthly-rent-calc": {
"type": "string",
"description": "It means if you start your stay with more than half of the month advanced, you will be charged the full month (MONTHLY), only half of the month's rent (FORTNIGHTLY) or the proportional part (DAILY)."
},
"cancellation-policy": {
"type": "number",
"description": "1: Flexible | 2: Standard | 3: Strict | See more: https:www.lodgerin.com/service-conditions"
},
"checkin": {
"type": "number",
"enum": [],
"description": "0: No specified | 1: 9:00-17:00 | 2: 24H | 3: 9:00-18:00 | 4: 10:00-19:00 | 5: 14:00-19:00"
},
"pension-type": {
"type": "number",
"description": "0: None | 1: Half board | 2: Full board"
},
"guest-night": {
"type": "number",
"description": "0: Yes | 1: No | 2: Ask owner"
},
"owner-langs": {
"type": "string",
"description": "(array[number]) - Languages spoken by the owner: 1 spanish, 2 english, 3 german, 4 italian, 5 russian, 6 chinese, 7 french, 8 arab, 9 portuguese, 10 hindi, 11 japanese"
},
"video-url": {
"type": "string",
"description": "Video tour about the house/property"
},
"tour-url": {
"type": "string",
"description": "Tour 360º about the house/property"
},
"lodgerin-ref": {
"type": "string",
"description": "Our reference"
},
"room-type": {
"type": "number",
"description": "1: Individual | 2: Double | 3: Triple | 4: Quadruple"
},
"month-price": {
"type": "number",
"description": "Monthly rental price"
},
"has-private-bath": {
"type": "boolean",
"description": "The room has private bathroom"
},
"electricity": {
"type": "boolean",
"description": "Electricity is included in the rent price"
},
"water": {
"type": "boolean",
"description": "Water is included in the rent price"
},
"heating": {
"type": "boolean",
"description": "Heating is included in the rent price"
},
"internet": {
"type": "boolean",
"description": "Internet is included in the rent price"
},
"cleaning": {
"type": "boolean",
"description": "Cleaning is included in the rent price"
},
"maintenance": {
"type": "boolean",
"description": "Maintenance is included in the rent price"
},
"penalty": {
"type": "number",
"description": "Penalty amount in case of cancellation of the booking (depending on the cancellation policy)"
},
"deposit": {
"type": "number",
"description": "Amount to be paid as deposit"
},
"landlord-fee": {
"type": "number",
"description": "Amount to be paid to the landlord as fee"
},
"final-cleaning-fee": {
"type": "number",
"description": "End-of-stay cleaning fee"
},
"extra-costs": {
"type": "number",
"description": "Amount of the extra monthly payment not included in the rent"
},
"study-area": {
"type": "boolean",
"description": "The room has at least a desk and a chair."
},
"bed-linen": {
"type": "boolean"
},
"lockable-door": {
"type": "boolean",
"description": "The door of the room has a lock"
},
"bed-type": {
"type": "string",
"description": "Bed size, options: UNKNOWN, INDIVIDUAL, DOUBLE"
},
"exterior-room": {
"type": "boolean"
},
"private-terrace": {
"type": "boolean",
"description": "The room has private terrace"
},
"room-television": {
"type": "boolean",
"description": "The room has its own television"
},
"room-air-conditioning": {
"type": "boolean",
"description": "The room is air-conditioned"
},
"wardrobes": {
"type": "boolean",
"description": "The room has at least a wardrobe"
},
"currency": {
"type": "string",
"description": "Code of the currency (ISO 4217) in which the accommodation is commercialised"
}
}
},
"relationships": {
"type": "object",
"properties": {
"main-image": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "number",
"description": "unique ID"
},
"type": {
"type": "string",
"enum": [
"images"
]
}
},
"required": [
"id",
"type"
],
"description": "The mainImage for this Room"
}
}
},
"images": {
"type": "object",
"properties": {
"data": {
"type": "array",
"description": "All images for this Room"
}
}
}
}
},
"meta": {
"type": "object",
"properties": {
"unavailable-dates": {
"type": "array",
"description": "Array with the unavailable dates of the room"
},
"lodgerin-fee": {
"type": "number",
"description": "Amount of fee in euros charged by Lodgerin - Serialised only when sending both date parameters"
},
"tpv-fee": {
"type": "number",
"description": "Amount of fee in euros charged by the payment gateway - Serialised only when sending both date parameters"
},
"total-booking-price": {
"type": "number",
"description": "Total price in euros of the booking - Serialised only when sending both date parameters"
},
"euro-exchange-rate": {
"type": "number",
"description": "Exchange rate used to convert to euro in case the accommodation is commercialised in another currency"
}
}
}
},
"required": [
"id",
"type",
"attributes"
],
"description": "created object"
},
"meta": {
"type": "object",
"properties": {
"lat": {
"type": "number",
"description": "Latitude coordinate of the search center area"
},
"lng": {
"type": "number",
"description": "Longitude coordinate of the search center area"
},
"swlat": {
"type": "number",
"description": "South west latitude corner coordinate of the search area"
},
"swlng": {
"type": "number",
"description": "South west longitude coordinate of the search area"
},
"nelat": {
"type": "number",
"description": "North east latitude coordinate of the search area"
},
"nelng": {
"type": "number",
"description": "North east longitude coordinate of the search area"
},
"current-page": {
"type": "number",
"description": "Current page of the current search"
},
"pages": {
"type": "number",
"description": "total pages of the current search"
},
"results": {
"type": "number",
"description": "total rooms number of the current search"
}
},
"required": [
"current-page",
"pages",
"results"
]
}
},
"required": [
"meta"
]
}Response
422Headers
Content-Type: application/vnd.api+jsonBody
{
'errors': [
{
'title': 'Invalid request',
'detail': 'Request data invalid',
'source': {
'pointer': 'data/attributes/attribute-name'
}
}
]
}Room ¶
Get one roomGET/rooms/{id}{?dateFrom}{&dateTo}
Example URI
GET https://www.lodgerin.com/public/v1/rooms/1?dateFrom=2020-07-17&dateTo=2020-08-14
URI Parameters
- id
number(required) Example: 1Room uniq ID
- dateFrom
string(optional) Example: 2020-07-17According to the date parameters, the meta response will contain the information of the payment amounts (both dates are required).
- dateTo
string(optional) Example: 2020-08-14According to the date parameters, the meta response will contain the information of the payment amounts (both dates are required).
Request
Headers
Accept: application/vnd.api+json
locale: (en-us | es)Response
200Headers
Content-Type: application/vnd.api+json; charset=utf-8Body
{
"data": {
"id": 1,
"type": "rooms",
"attributes": {
"'action": "",
"url-english": "https://lodgerin.com/house/madrid/33",
"url-spanish": "https://lodgerin.com/es/alojamiento/madrid/33",
"title-english": "Nice shared flat for rent in Triana",
"title-spanish": "Simpático piso compartido para alquilar en Triana",
"house-description-english": "This student apartment has 2 rooms, 1 bath and equipped kitchen. It is a student accommodation with a modern atmosphere and where students can enjoy both a good space to study and to relax and meet other study abroad students.",
"house-description-spanish": "Este piso para estudiantes cuenta con 2 habitaciones, 1 baño y cocina equipada. Es un alojamiento para estudiantes de ambiente moderno y en el que los estudiantes podrán disfrutar tanto de un buen espacio para estudiar como para relajarse y conocer otros estudiantes.",
"room-description-english": "A lovely bedroom with a bed, study desk, chair, clothes storage and night stand. Perfect for one student who need a place to study and enjoy the study abroad experience. This bedroom have access to a shared bathroom. This room also has maintenance and cleaning of common areas.",
"room-description-spanish": "Un bonito dormitorio con cama, escritorio, silla, armario de ropa y mesa de noche. Perfecto para un estudiante que necesita un lugar para estudiar y disfrutar de la experiencia de estudiar en el extranjero. Esta habitación tiene acceso a un baño compartido. Esta habitación cuenta además con mantenimiento y limpieza de zonas comunes.",
"notes-english": "ADDITIONAL FOOD SERVICES CAN BE HIRED",
"notes-spanish": "SE PUEDE CONTRATAR SERVICIOS DE COMIDA ADICIONALES",
"latitude": -3.232343,
"longitude": 41.342423,
"start-availability": "2022-07-01T00:00:00.000Z",
"limit-availability": "2022-07-01T00:00:00.000Z",
"accommodation-type": 0,
"rooms-number": 3,
"baths": 2,
"address": "St. Colegiata",
"address-number": 9,
"door-number": "D",
"floor": "1º",
"postal-code": "'28001'",
"neighborhood": "Trafalgar",
"city": "'Madrid'",
"country-code": "'ES'",
"payment-frequency": 1,
"consumption-limit": 30,
"lift": true,
"air-conditioning": true,
"exterior-house": true,
"terrace": true,
"swimming-pool": true,
"washer": true,
"oven": true,
"microwave": true,
"kitchenware": true,
"common-areas": true,
"dishwasher": true,
"iron": true,
"house-television": true,
"mailbox-access": true,
"census": true,
"max-occupancy": 3,
"tenants-min-age": 18,
"tenants-max-age": 35,
"occupation-preferences": [],
"smoke": true,
"pets": true,
"heating-system": true,
"minimum-stay": 15,
"monthly-rent-calc": "MONTHLY",
"cancellation-policy": 3,
"checkin": 0,
"pension-type": 0,
"guest-night": 2,
"owner-langs": "[1, 2, 4]",
"video-url": "https://somevideourl.com/",
"tour-url": "``https://matterport.com/`",
"lodgerin-ref": "LOD.153.592",
"room-type": 1,
"month-price": 485,
"has-private-bath": true,
"electricity": true,
"water": true,
"heating": true,
"internet": true,
"cleaning": true,
"maintenance": true,
"penalty": 485,
"deposit": 485,
"landlord-fee": 0,
"final-cleaning-fee": 100,
"extra-costs": 50,
"study-area": true,
"bed-linen": false,
"lockable-door": true,
"bed-type": "INDIVIDUAL",
"exterior-room": false,
"private-terrace": false,
"room-television": false,
"room-air-conditioning": false,
"wardrobes": true,
"currency": "EUR"
},
"relationships": {
"main-image": {
"data": {
"id": 1,
"type": "images"
}
},
"images": {
"data": [
{
"id": 1,
"type": "images"
}
]
}
},
"meta": {
"unavailable-dates": [
{
"start": "2020-07-01",
"end": "2021-07-01"
}
],
"lodgerin-fee": 224.33,
"tpv-fee": 24.5,
"total-booking-price": 680.8,
"euro-exchange-rate": 1
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "number",
"description": "unique ID"
},
"type": {
"type": "string",
"enum": [
"rooms"
]
},
"attributes": {
"type": "object",
"properties": {
"'action": {
"type": "string",
"description": "event': nil (object) - Ignore, it will always be empty"
},
"url-english": {
"type": "string",
"description": "URL to the english version of the room page"
},
"url-spanish": {
"type": "string",
"description": "URL to the spanish version of the room page"
},
"title-english": {
"type": "string",
"description": "Accommodation english title"
},
"title-spanish": {
"type": "string",
"description": "Accommodation spanish title"
},
"house-description-english": {
"type": "string"
},
"house-description-spanish": {
"type": "string"
},
"room-description-english": {
"type": "string"
},
"room-description-spanish": {
"type": "string"
},
"notes-english": {
"type": "string",
"description": "Text used to notify special terms or conditions"
},
"notes-spanish": {
"type": "string",
"description": "Text used to notify special terms or conditions"
},
"latitude": {
"type": "number"
},
"longitude": {
"type": "number"
},
"start-availability": {
"type": "string",
"description": "Start date of contract, bookings are not allowed before this date"
},
"limit-availability": {
"type": "string",
"description": "End date of contract, bookings are not allowed after this date"
},
"accommodation-type": {
"type": "number",
"description": "0: studio/entire flat | 1: Student residence | 2: Shared flat | 3: Host family (DEPRECATED) | 4: Coliving"
},
"rooms-number": {
"type": "number",
"description": "Number of rooms in the house, but in the case of student residences, this number represents the number of rooms of the same features, price, etc."
},
"baths": {
"type": "number"
},
"address": {
"type": "string"
},
"address-number": {
"type": "number"
},
"door-number": {
"type": "string"
},
"floor": {
"type": "string"
},
"postal-code": {
"type": "string"
},
"neighborhood": {
"type": "string"
},
"city": {
"type": "string"
},
"country-code": {
"type": "string",
"description": "Country code according to ISO 3166-1 Alpha-2 code"
},
"payment-frequency": {
"type": "number",
"enum": [
1
],
"description": "0: Monthly | 1: Bimonthly | 2: Quarterly | 3: All at once"
},
"consumption-limit": {
"type": "number",
"description": "Maximum amount in euros of the services included in the rent"
},
"lift": {
"type": "boolean",
"description": "The building has a lift"
},
"air-conditioning": {
"type": "boolean"
},
"exterior-house": {
"type": "boolean"
},
"terrace": {
"type": "boolean",
"description": "The house/property has a terrace"
},
"swimming-pool": {
"type": "boolean"
},
"washer": {
"type": "boolean",
"description": "The house/property has a washer"
},
"oven": {
"type": "boolean",
"description": "The house/property has a oven"
},
"microwave": {
"type": "boolean",
"description": "The house/property has a microwave"
},
"kitchenware": {
"type": "boolean",
"description": "The house/property has kitchenware"
},
"common-areas": {
"type": "boolean",
"description": "The house/property has common areas"
},
"dishwasher": {
"type": "boolean",
"description": "The house/property has a dishwasher"
},
"iron": {
"type": "boolean",
"description": "The house/property has a iron"
},
"house-television": {
"type": "boolean",
"description": "The house/property has television"
},
"mailbox-access": {
"type": "boolean",
"description": "Ttenants will be able to receive postal mail"
},
"census": {
"type": "boolean",
"description": "Tenants can register in the accommodation"
},
"max-occupancy": {
"type": "number",
"description": "Maximum occupancy of tenants in the house/property"
},
"tenants-min-age": {
"type": "number",
"description": "Preferred minimum age of the tenants"
},
"tenants-max-age": {
"type": "number",
"description": "Preferred maximum age of the tenants"
},
"occupation-preferences": {
"type": "array",
"description": "1: Students | 2: Professionals | 3: Families"
},
"smoke": {
"type": "boolean",
"description": "Whether it's allowed or not"
},
"pets": {
"type": "boolean",
"description": "Whether they are allowed or not"
},
"heating-system": {
"type": "boolean",
"description": "The house/property has a heating system"
},
"minimum-stay": {
"type": "number",
"description": "Minimum of number of days to booking"
},
"monthly-rent-calc": {
"type": "string",
"description": "It means if you start your stay with more than half of the month advanced, you will be charged the full month (MONTHLY), only half of the month's rent (FORTNIGHTLY) or the proportional part (DAILY)."
},
"cancellation-policy": {
"type": "number",
"description": "1: Flexible | 2: Standard | 3: Strict | See more: https:www.lodgerin.com/service-conditions"
},
"checkin": {
"type": "number",
"enum": [],
"description": "0: No specified | 1: 9:00-17:00 | 2: 24H | 3: 9:00-18:00 | 4: 10:00-19:00 | 5: 14:00-19:00"
},
"pension-type": {
"type": "number",
"description": "0: None | 1: Half board | 2: Full board"
},
"guest-night": {
"type": "number",
"description": "0: Yes | 1: No | 2: Ask owner"
},
"owner-langs": {
"type": "string",
"description": "(array[number]) - Languages spoken by the owner: 1 spanish, 2 english, 3 german, 4 italian, 5 russian, 6 chinese, 7 french, 8 arab, 9 portuguese, 10 hindi, 11 japanese"
},
"video-url": {
"type": "string",
"description": "Video tour about the house/property"
},
"tour-url": {
"type": "string",
"description": "Tour 360º about the house/property"
},
"lodgerin-ref": {
"type": "string",
"description": "Our reference"
},
"room-type": {
"type": "number",
"description": "1: Individual | 2: Double | 3: Triple | 4: Quadruple"
},
"month-price": {
"type": "number",
"description": "Monthly rental price"
},
"has-private-bath": {
"type": "boolean",
"description": "The room has private bathroom"
},
"electricity": {
"type": "boolean",
"description": "Electricity is included in the rent price"
},
"water": {
"type": "boolean",
"description": "Water is included in the rent price"
},
"heating": {
"type": "boolean",
"description": "Heating is included in the rent price"
},
"internet": {
"type": "boolean",
"description": "Internet is included in the rent price"
},
"cleaning": {
"type": "boolean",
"description": "Cleaning is included in the rent price"
},
"maintenance": {
"type": "boolean",
"description": "Maintenance is included in the rent price"
},
"penalty": {
"type": "number",
"description": "Penalty amount in case of cancellation of the booking (depending on the cancellation policy)"
},
"deposit": {
"type": "number",
"description": "Amount to be paid as deposit"
},
"landlord-fee": {
"type": "number",
"description": "Amount to be paid to the landlord as fee"
},
"final-cleaning-fee": {
"type": "number",
"description": "End-of-stay cleaning fee"
},
"extra-costs": {
"type": "number",
"description": "Amount of the extra monthly payment not included in the rent"
},
"study-area": {
"type": "boolean",
"description": "The room has at least a desk and a chair."
},
"bed-linen": {
"type": "boolean"
},
"lockable-door": {
"type": "boolean",
"description": "The door of the room has a lock"
},
"bed-type": {
"type": "string",
"description": "Bed size, options: UNKNOWN, INDIVIDUAL, DOUBLE"
},
"exterior-room": {
"type": "boolean"
},
"private-terrace": {
"type": "boolean",
"description": "The room has private terrace"
},
"room-television": {
"type": "boolean",
"description": "The room has its own television"
},
"room-air-conditioning": {
"type": "boolean",
"description": "The room is air-conditioned"
},
"wardrobes": {
"type": "boolean",
"description": "The room has at least a wardrobe"
},
"currency": {
"type": "string",
"description": "Code of the currency (ISO 4217) in which the accommodation is commercialised"
}
}
},
"relationships": {
"type": "object",
"properties": {
"main-image": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "number",
"description": "unique ID"
},
"type": {
"type": "string",
"enum": [
"images"
]
}
},
"required": [
"id",
"type"
],
"description": "The mainImage for this Room"
}
}
},
"images": {
"type": "object",
"properties": {
"data": {
"type": "array",
"description": "All images for this Room"
}
}
}
}
},
"meta": {
"type": "object",
"properties": {
"unavailable-dates": {
"type": "array",
"description": "Array with the unavailable dates of the room"
},
"lodgerin-fee": {
"type": "number",
"description": "Amount of fee in euros charged by Lodgerin - Serialised only when sending both date parameters"
},
"tpv-fee": {
"type": "number",
"description": "Amount of fee in euros charged by the payment gateway - Serialised only when sending both date parameters"
},
"total-booking-price": {
"type": "number",
"description": "Total price in euros of the booking - Serialised only when sending both date parameters"
},
"euro-exchange-rate": {
"type": "number",
"description": "Exchange rate used to convert to euro in case the accommodation is commercialised in another currency"
}
}
}
},
"required": [
"id",
"type",
"attributes"
],
"description": "required object"
}
}
}Response
403Headers
Content-Type: application/vnd.api+jsonBody
{
'errors': [
{
'title': 'Access is denied',
'detail': 'You can not access the resource or your not logged in.'
}
]
}Response
404Headers
Content-Type: application/vnd.api+jsonBody
{
'errors': [
{
'title': 'Not found',
'detail': 'Resource has not been found on our system'
}
]
}Image ¶
Image ¶
Retrieve a set of imagesGET/images?{ids}
Example URI
GET https://www.lodgerin.com/public/v1/images?id[]=1&id[]=2
URI Parameters
- ids
array(required) Example: id[]=1&id[]=2Image uniq IDs array
Request
Headers
Authorization: Bearer e9629c2a-6763-45f4-9d3a-1b2c7822febeResponse
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": [
{
"id": 1,
"type": "images",
"attributes": {
"url": "https://long-url",
"thumb": "https://long-url",
"small-thumb": "https://long-url",
"tiny-thumb": "https://long-url"
},
"relationships": {}
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number",
"description": "unique ID"
},
"type": {
"type": "string",
"enum": [
"images"
]
},
"attributes": {
"type": "object",
"properties": {
"url": {
"type": "string"
},
"thumb": {
"type": "string"
},
"small-thumb": {
"type": "string"
},
"tiny-thumb": {
"type": "string"
}
}
},
"relationships": {
"type": "object",
"properties": {}
}
},
"required": [
"id",
"type",
"attributes"
]
},
"description": "required objects"
}
},
"required": [
"data"
]
}Response
403Headers
Content-Type: application/vnd.api+jsonBody
{
'errors': [
{
'title': 'Access is denied',
'detail': 'You can not access the resource or your not logged in.'
}
]
}Response
404Headers
Content-Type: application/vnd.api+jsonBody
{
'errors': [
{
'title': 'Not found',
'detail': 'One or more of the requested objects has not been found'
}
]
}Image ¶
Get one imageGET/images/{id}
Example URI
GET https://www.lodgerin.com/public/v1/images/1
URI Parameters
- id
number(required) Example: 1Image uniq ID
Request
Headers
Authorization: Bearer e9629c2a-6763-45f4-9d3a-1b2c7822febeResponse
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"id": 1,
"type": "images",
"attributes": {
"url": "https://long-url",
"thumb": "https://long-url",
"small-thumb": "https://long-url",
"tiny-thumb": "https://long-url"
},
"relationships": {}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "number",
"description": "unique ID"
},
"type": {
"type": "string",
"enum": [
"images"
]
},
"attributes": {
"type": "object",
"properties": {
"url": {
"type": "string"
},
"thumb": {
"type": "string"
},
"small-thumb": {
"type": "string"
},
"tiny-thumb": {
"type": "string"
}
}
},
"relationships": {
"type": "object",
"properties": {}
}
},
"required": [
"id",
"type",
"attributes"
],
"description": "required object"
}
}
}Response
403Headers
Content-Type: application/vnd.api+jsonBody
{
'errors': [
{
'title': 'Access is denied',
'detail': 'You can not access the resource or your not logged in.'
}
]
}Response
404Headers
Content-Type: application/vnd.api+jsonBody
{
'errors': [
{
'title': 'Not found',
'detail': 'Resource has not been found on our system'
}
]
}