Legacy RESTful API from monolith. PLEASE DO NOT USE IT, THOSE ENDPOINTS WILL NOT BE SUPPORTED ANY LONGER
Headers
As this API is working with JSON every request must add the following headers:
Accept: application/jsonAnd for requests with body:
Content-Type: application/jsonListings ¶
Listings ¶
Fetch listings by logged userGET/listings
Example URI
GET https://monolith.spotahome.com/api/listings
Request
Headers
Content-Type: application/json
Authorization: aa.bb.ccResponse
200Headers
Content-Type: application/jsonBody
[
{
"id": "120174",
"title": "Cozy studio in the heart of London",
"address": "Calle de Hartzenbusch 8, 3, 28010 Madrid",
"landlordReference": "Bedroom 1",
"type": "studio",
"price": {
"amount": 78800,
"currency": {
"isoCode": "EUR",
"symbol": "€"
}
},
"monthlyPrice": {
"type": "fixed",
"minimumPrice": 788,
"fixedPrice": 788,
"pricesByMonth": {
"jan": 100,
"feb": 200,
"mar": 300,
"apr": 400,
"may": 500,
"jun": 600,
"jul": 700,
"aug": 800,
"sep": 900,
"oct": 1000,
"nov": 1100,
"dec": 1200
},
"pricesByDay": {
"jan": [
100,
100,
100,
100,
100,
100,
100,
100,
100,
100,
100,
100,
100,
100,
100,
100,
100,
100,
100,
100,
100,
100,
100,
100,
100,
100,
100,
100,
100,
100,
100
],
"feb": [
200,
200,
200,
200,
200,
200,
200,
200,
200,
200,
200,
200,
200,
200,
200,
200,
200,
200,
200,
200,
200,
200,
200,
200,
200,
200,
200,
200,
200
],
"mar": [
300,
300,
300,
300,
300,
300,
300,
300,
300,
300,
300,
300,
300,
300,
300,
300,
300,
300,
300,
300,
300,
300,
300,
300,
300,
300,
300,
300,
300,
300,
300
],
"apr": [
400,
400,
400,
400,
400,
400,
400,
400,
400,
400,
400,
400,
400,
400,
400,
400,
400,
400,
400,
400,
400,
400,
400,
400,
400,
400,
400,
400,
400,
400
],
"may": [
500,
500,
500,
500,
500,
500,
500,
500,
500,
500,
500,
500,
500,
500,
500,
500,
500,
500,
500,
500,
500,
500,
500,
500,
500,
500,
500,
500,
500,
500,
500
],
"jun": [
600,
600,
600,
600,
600,
600,
600,
600,
600,
600,
600,
600,
600,
600,
600,
600,
600,
600,
600,
600,
600,
600,
600,
600,
600,
600,
600,
600,
600,
600
],
"jul": [
700,
700,
700,
700,
700,
700,
700,
700,
700,
700,
700,
700,
700,
700,
700,
700,
700,
700,
700,
700,
700,
700,
700,
700,
700,
700,
700,
700,
700,
700,
700
],
"aug": [
800,
800,
800,
800,
800,
800,
800,
800,
800,
800,
800,
800,
800,
800,
800,
800,
800,
800,
800,
800,
800,
800,
800,
800,
800,
800,
800,
800,
800,
800,
800
],
"sep": [
900,
900,
900,
900,
900,
900,
900,
900,
900,
900,
900,
900,
900,
900,
900,
900,
900,
900,
900,
900,
900,
900,
900,
900,
900,
900,
900,
900,
900,
900
],
"oct": [
1000,
1000,
1000,
1000,
1000,
1000,
1000,
1000,
1000,
1000,
1000,
1000,
1000,
1000,
1000,
1000,
1000,
1000,
1000,
1000,
1000,
1000,
1000,
1000,
1000,
1000,
1000,
1000,
1000,
1000,
1000
],
"nov": [
1100,
1100,
1100,
1100,
1100,
1100,
1100,
1100,
1100,
1100,
1100,
1100,
1100,
1100,
1100,
1100,
1100,
1100,
1100,
1100,
1100,
1100,
1100,
1100,
1100,
1100,
1100,
1100,
1100,
1100
],
"dec": [
1200,
1200,
1200,
1200,
1200,
1200,
1200,
1200,
1200,
1200,
1200,
1200,
1200,
1200,
1200,
1200,
1200,
1200,
1200,
1200,
1200,
1200,
1200,
1200,
1200,
1200,
1200,
1200,
1200,
1200,
1200
]
}
},
"currencyIsoCode": "EUR",
"isRentable": true,
"isBooked": true,
"isBookedWithoutMinStay": true,
"isPublished": false,
"mainPicture": "https://sah-staging-photos-resized.s3-eu-west-1.amazonaws.com/smw_288/1ededc161abbea7d2ead7a033fc2190e19617cfbd02d921f35ce9acb.jpg",
"occupancies": [
{
"from": "2019-06-01",
"to": "2019-06-30",
"note": "Note",
"source": "'Source'",
"bookingRequestId": "'7980'"
}
],
"rooms": [],
"location": {
"street": "Calle de Hartzenbusch",
"streetDoorNumber": "8",
"floor": "3",
"door": "3",
"letter": "A",
"postCode": "28010",
"city": "madrid"
},
"minStay": 30,
"maxStay": 0,
"plan": "standard",
"exclusivityDealType": "basic",
"landlordId": "aaaaaaa8-bbb4-ccc4-ddd4-eeeeeeeeee12",
"landlordCommission": {
"type": "fixed",
"value": 600
},
"refreshAvailabilitiesDate": "2016-09-14T17:54:39+00:00",
"lastUnpublishedDate": "2016-09-14T17:54:39+00:00",
"stayRules": {
"bookingTooEarlyDays": 200
},
"postalCode": "28010"
}
]Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"enum": [
"120174"
]
},
"title": {
"type": "string",
"enum": [
"Cozy studio in the heart of London"
]
},
"address": {
"type": "string",
"enum": [
"Calle de Hartzenbusch 8, 3, 28010 Madrid"
]
},
"landlordReference": {
"type": "string",
"enum": [
"Bedroom 1"
]
},
"type": {
"type": "string",
"enum": [
"studio"
]
},
"price": {
"type": "object",
"properties": {
"amount": {
"type": "number",
"enum": [
78800
]
},
"currency": {
"type": "object",
"properties": {
"isoCode": {
"type": "string",
"enum": [
"EUR"
]
},
"symbol": {
"type": "string",
"enum": [
"€"
]
}
},
"required": [
"isoCode",
"symbol"
],
"additionalProperties": false
}
},
"required": [
"amount",
"currency"
],
"additionalProperties": false
},
"monthlyPrice": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"fixed"
]
},
"minimumPrice": {
"type": "number",
"enum": [
788
]
},
"fixedPrice": {
"type": "number",
"enum": [
788
]
},
"pricesByMonth": {
"type": "object",
"properties": {
"jan": {
"type": "number",
"enum": [
100
]
},
"feb": {
"type": "number",
"enum": [
200
]
},
"mar": {
"type": "number",
"enum": [
300
]
},
"apr": {
"type": "number",
"enum": [
400
]
},
"may": {
"type": "number",
"enum": [
500
]
},
"jun": {
"type": "number",
"enum": [
600
]
},
"jul": {
"type": "number",
"enum": [
700
]
},
"aug": {
"type": "number",
"enum": [
800
]
},
"sep": {
"type": "number",
"enum": [
900
]
},
"oct": {
"type": "number",
"enum": [
1000
]
},
"nov": {
"type": "number",
"enum": [
1100
]
},
"dec": {
"type": "number",
"enum": [
1200
]
}
},
"required": [
"jan",
"feb",
"mar",
"apr",
"may",
"jun",
"jul",
"aug",
"sep",
"oct",
"nov",
"dec"
],
"additionalProperties": false
},
"pricesByDay": {
"type": "object",
"properties": {
"jan": {
"type": "array",
"items": [
{
"type": "number",
"enum": [
100
]
},
{
"type": "number",
"enum": [
100
]
},
{
"type": "number",
"enum": [
100
]
},
{
"type": "number",
"enum": [
100
]
},
{
"type": "number",
"enum": [
100
]
},
{
"type": "number",
"enum": [
100
]
},
{
"type": "number",
"enum": [
100
]
},
{
"type": "number",
"enum": [
100
]
},
{
"type": "number",
"enum": [
100
]
},
{
"type": "number",
"enum": [
100
]
},
{
"type": "number",
"enum": [
100
]
},
{
"type": "number",
"enum": [
100
]
},
{
"type": "number",
"enum": [
100
]
},
{
"type": "number",
"enum": [
100
]
},
{
"type": "number",
"enum": [
100
]
},
{
"type": "number",
"enum": [
100
]
},
{
"type": "number",
"enum": [
100
]
},
{
"type": "number",
"enum": [
100
]
},
{
"type": "number",
"enum": [
100
]
},
{
"type": "number",
"enum": [
100
]
},
{
"type": "number",
"enum": [
100
]
},
{
"type": "number",
"enum": [
100
]
},
{
"type": "number",
"enum": [
100
]
},
{
"type": "number",
"enum": [
100
]
},
{
"type": "number",
"enum": [
100
]
},
{
"type": "number",
"enum": [
100
]
},
{
"type": "number",
"enum": [
100
]
},
{
"type": "number",
"enum": [
100
]
},
{
"type": "number",
"enum": [
100
]
},
{
"type": "number",
"enum": [
100
]
},
{
"type": "number",
"enum": [
100
]
}
]
},
"feb": {
"type": "array",
"items": [
{
"type": "number",
"enum": [
200
]
},
{
"type": "number",
"enum": [
200
]
},
{
"type": "number",
"enum": [
200
]
},
{
"type": "number",
"enum": [
200
]
},
{
"type": "number",
"enum": [
200
]
},
{
"type": "number",
"enum": [
200
]
},
{
"type": "number",
"enum": [
200
]
},
{
"type": "number",
"enum": [
200
]
},
{
"type": "number",
"enum": [
200
]
},
{
"type": "number",
"enum": [
200
]
},
{
"type": "number",
"enum": [
200
]
},
{
"type": "number",
"enum": [
200
]
},
{
"type": "number",
"enum": [
200
]
},
{
"type": "number",
"enum": [
200
]
},
{
"type": "number",
"enum": [
200
]
},
{
"type": "number",
"enum": [
200
]
},
{
"type": "number",
"enum": [
200
]
},
{
"type": "number",
"enum": [
200
]
},
{
"type": "number",
"enum": [
200
]
},
{
"type": "number",
"enum": [
200
]
},
{
"type": "number",
"enum": [
200
]
},
{
"type": "number",
"enum": [
200
]
},
{
"type": "number",
"enum": [
200
]
},
{
"type": "number",
"enum": [
200
]
},
{
"type": "number",
"enum": [
200
]
},
{
"type": "number",
"enum": [
200
]
},
{
"type": "number",
"enum": [
200
]
},
{
"type": "number",
"enum": [
200
]
},
{
"type": "number",
"enum": [
200
]
}
]
},
"mar": {
"type": "array",
"items": [
{
"type": "number",
"enum": [
300
]
},
{
"type": "number",
"enum": [
300
]
},
{
"type": "number",
"enum": [
300
]
},
{
"type": "number",
"enum": [
300
]
},
{
"type": "number",
"enum": [
300
]
},
{
"type": "number",
"enum": [
300
]
},
{
"type": "number",
"enum": [
300
]
},
{
"type": "number",
"enum": [
300
]
},
{
"type": "number",
"enum": [
300
]
},
{
"type": "number",
"enum": [
300
]
},
{
"type": "number",
"enum": [
300
]
},
{
"type": "number",
"enum": [
300
]
},
{
"type": "number",
"enum": [
300
]
},
{
"type": "number",
"enum": [
300
]
},
{
"type": "number",
"enum": [
300
]
},
{
"type": "number",
"enum": [
300
]
},
{
"type": "number",
"enum": [
300
]
},
{
"type": "number",
"enum": [
300
]
},
{
"type": "number",
"enum": [
300
]
},
{
"type": "number",
"enum": [
300
]
},
{
"type": "number",
"enum": [
300
]
},
{
"type": "number",
"enum": [
300
]
},
{
"type": "number",
"enum": [
300
]
},
{
"type": "number",
"enum": [
300
]
},
{
"type": "number",
"enum": [
300
]
},
{
"type": "number",
"enum": [
300
]
},
{
"type": "number",
"enum": [
300
]
},
{
"type": "number",
"enum": [
300
]
},
{
"type": "number",
"enum": [
300
]
},
{
"type": "number",
"enum": [
300
]
},
{
"type": "number",
"enum": [
300
]
}
]
},
"apr": {
"type": "array",
"items": [
{
"type": "number",
"enum": [
400
]
},
{
"type": "number",
"enum": [
400
]
},
{
"type": "number",
"enum": [
400
]
},
{
"type": "number",
"enum": [
400
]
},
{
"type": "number",
"enum": [
400
]
},
{
"type": "number",
"enum": [
400
]
},
{
"type": "number",
"enum": [
400
]
},
{
"type": "number",
"enum": [
400
]
},
{
"type": "number",
"enum": [
400
]
},
{
"type": "number",
"enum": [
400
]
},
{
"type": "number",
"enum": [
400
]
},
{
"type": "number",
"enum": [
400
]
},
{
"type": "number",
"enum": [
400
]
},
{
"type": "number",
"enum": [
400
]
},
{
"type": "number",
"enum": [
400
]
},
{
"type": "number",
"enum": [
400
]
},
{
"type": "number",
"enum": [
400
]
},
{
"type": "number",
"enum": [
400
]
},
{
"type": "number",
"enum": [
400
]
},
{
"type": "number",
"enum": [
400
]
},
{
"type": "number",
"enum": [
400
]
},
{
"type": "number",
"enum": [
400
]
},
{
"type": "number",
"enum": [
400
]
},
{
"type": "number",
"enum": [
400
]
},
{
"type": "number",
"enum": [
400
]
},
{
"type": "number",
"enum": [
400
]
},
{
"type": "number",
"enum": [
400
]
},
{
"type": "number",
"enum": [
400
]
},
{
"type": "number",
"enum": [
400
]
},
{
"type": "number",
"enum": [
400
]
}
]
},
"may": {
"type": "array",
"items": [
{
"type": "number",
"enum": [
500
]
},
{
"type": "number",
"enum": [
500
]
},
{
"type": "number",
"enum": [
500
]
},
{
"type": "number",
"enum": [
500
]
},
{
"type": "number",
"enum": [
500
]
},
{
"type": "number",
"enum": [
500
]
},
{
"type": "number",
"enum": [
500
]
},
{
"type": "number",
"enum": [
500
]
},
{
"type": "number",
"enum": [
500
]
},
{
"type": "number",
"enum": [
500
]
},
{
"type": "number",
"enum": [
500
]
},
{
"type": "number",
"enum": [
500
]
},
{
"type": "number",
"enum": [
500
]
},
{
"type": "number",
"enum": [
500
]
},
{
"type": "number",
"enum": [
500
]
},
{
"type": "number",
"enum": [
500
]
},
{
"type": "number",
"enum": [
500
]
},
{
"type": "number",
"enum": [
500
]
},
{
"type": "number",
"enum": [
500
]
},
{
"type": "number",
"enum": [
500
]
},
{
"type": "number",
"enum": [
500
]
},
{
"type": "number",
"enum": [
500
]
},
{
"type": "number",
"enum": [
500
]
},
{
"type": "number",
"enum": [
500
]
},
{
"type": "number",
"enum": [
500
]
},
{
"type": "number",
"enum": [
500
]
},
{
"type": "number",
"enum": [
500
]
},
{
"type": "number",
"enum": [
500
]
},
{
"type": "number",
"enum": [
500
]
},
{
"type": "number",
"enum": [
500
]
},
{
"type": "number",
"enum": [
500
]
}
]
},
"jun": {
"type": "array",
"items": [
{
"type": "number",
"enum": [
600
]
},
{
"type": "number",
"enum": [
600
]
},
{
"type": "number",
"enum": [
600
]
},
{
"type": "number",
"enum": [
600
]
},
{
"type": "number",
"enum": [
600
]
},
{
"type": "number",
"enum": [
600
]
},
{
"type": "number",
"enum": [
600
]
},
{
"type": "number",
"enum": [
600
]
},
{
"type": "number",
"enum": [
600
]
},
{
"type": "number",
"enum": [
600
]
},
{
"type": "number",
"enum": [
600
]
},
{
"type": "number",
"enum": [
600
]
},
{
"type": "number",
"enum": [
600
]
},
{
"type": "number",
"enum": [
600
]
},
{
"type": "number",
"enum": [
600
]
},
{
"type": "number",
"enum": [
600
]
},
{
"type": "number",
"enum": [
600
]
},
{
"type": "number",
"enum": [
600
]
},
{
"type": "number",
"enum": [
600
]
},
{
"type": "number",
"enum": [
600
]
},
{
"type": "number",
"enum": [
600
]
},
{
"type": "number",
"enum": [
600
]
},
{
"type": "number",
"enum": [
600
]
},
{
"type": "number",
"enum": [
600
]
},
{
"type": "number",
"enum": [
600
]
},
{
"type": "number",
"enum": [
600
]
},
{
"type": "number",
"enum": [
600
]
},
{
"type": "number",
"enum": [
600
]
},
{
"type": "number",
"enum": [
600
]
},
{
"type": "number",
"enum": [
600
]
}
]
},
"jul": {
"type": "array",
"items": [
{
"type": "number",
"enum": [
700
]
},
{
"type": "number",
"enum": [
700
]
},
{
"type": "number",
"enum": [
700
]
},
{
"type": "number",
"enum": [
700
]
},
{
"type": "number",
"enum": [
700
]
},
{
"type": "number",
"enum": [
700
]
},
{
"type": "number",
"enum": [
700
]
},
{
"type": "number",
"enum": [
700
]
},
{
"type": "number",
"enum": [
700
]
},
{
"type": "number",
"enum": [
700
]
},
{
"type": "number",
"enum": [
700
]
},
{
"type": "number",
"enum": [
700
]
},
{
"type": "number",
"enum": [
700
]
},
{
"type": "number",
"enum": [
700
]
},
{
"type": "number",
"enum": [
700
]
},
{
"type": "number",
"enum": [
700
]
},
{
"type": "number",
"enum": [
700
]
},
{
"type": "number",
"enum": [
700
]
},
{
"type": "number",
"enum": [
700
]
},
{
"type": "number",
"enum": [
700
]
},
{
"type": "number",
"enum": [
700
]
},
{
"type": "number",
"enum": [
700
]
},
{
"type": "number",
"enum": [
700
]
},
{
"type": "number",
"enum": [
700
]
},
{
"type": "number",
"enum": [
700
]
},
{
"type": "number",
"enum": [
700
]
},
{
"type": "number",
"enum": [
700
]
},
{
"type": "number",
"enum": [
700
]
},
{
"type": "number",
"enum": [
700
]
},
{
"type": "number",
"enum": [
700
]
},
{
"type": "number",
"enum": [
700
]
}
]
},
"aug": {
"type": "array",
"items": [
{
"type": "number",
"enum": [
800
]
},
{
"type": "number",
"enum": [
800
]
},
{
"type": "number",
"enum": [
800
]
},
{
"type": "number",
"enum": [
800
]
},
{
"type": "number",
"enum": [
800
]
},
{
"type": "number",
"enum": [
800
]
},
{
"type": "number",
"enum": [
800
]
},
{
"type": "number",
"enum": [
800
]
},
{
"type": "number",
"enum": [
800
]
},
{
"type": "number",
"enum": [
800
]
},
{
"type": "number",
"enum": [
800
]
},
{
"type": "number",
"enum": [
800
]
},
{
"type": "number",
"enum": [
800
]
},
{
"type": "number",
"enum": [
800
]
},
{
"type": "number",
"enum": [
800
]
},
{
"type": "number",
"enum": [
800
]
},
{
"type": "number",
"enum": [
800
]
},
{
"type": "number",
"enum": [
800
]
},
{
"type": "number",
"enum": [
800
]
},
{
"type": "number",
"enum": [
800
]
},
{
"type": "number",
"enum": [
800
]
},
{
"type": "number",
"enum": [
800
]
},
{
"type": "number",
"enum": [
800
]
},
{
"type": "number",
"enum": [
800
]
},
{
"type": "number",
"enum": [
800
]
},
{
"type": "number",
"enum": [
800
]
},
{
"type": "number",
"enum": [
800
]
},
{
"type": "number",
"enum": [
800
]
},
{
"type": "number",
"enum": [
800
]
},
{
"type": "number",
"enum": [
800
]
},
{
"type": "number",
"enum": [
800
]
}
]
},
"sep": {
"type": "array",
"items": [
{
"type": "number",
"enum": [
900
]
},
{
"type": "number",
"enum": [
900
]
},
{
"type": "number",
"enum": [
900
]
},
{
"type": "number",
"enum": [
900
]
},
{
"type": "number",
"enum": [
900
]
},
{
"type": "number",
"enum": [
900
]
},
{
"type": "number",
"enum": [
900
]
},
{
"type": "number",
"enum": [
900
]
},
{
"type": "number",
"enum": [
900
]
},
{
"type": "number",
"enum": [
900
]
},
{
"type": "number",
"enum": [
900
]
},
{
"type": "number",
"enum": [
900
]
},
{
"type": "number",
"enum": [
900
]
},
{
"type": "number",
"enum": [
900
]
},
{
"type": "number",
"enum": [
900
]
},
{
"type": "number",
"enum": [
900
]
},
{
"type": "number",
"enum": [
900
]
},
{
"type": "number",
"enum": [
900
]
},
{
"type": "number",
"enum": [
900
]
},
{
"type": "number",
"enum": [
900
]
},
{
"type": "number",
"enum": [
900
]
},
{
"type": "number",
"enum": [
900
]
},
{
"type": "number",
"enum": [
900
]
},
{
"type": "number",
"enum": [
900
]
},
{
"type": "number",
"enum": [
900
]
},
{
"type": "number",
"enum": [
900
]
},
{
"type": "number",
"enum": [
900
]
},
{
"type": "number",
"enum": [
900
]
},
{
"type": "number",
"enum": [
900
]
},
{
"type": "number",
"enum": [
900
]
}
]
},
"oct": {
"type": "array",
"items": [
{
"type": "number",
"enum": [
1000
]
},
{
"type": "number",
"enum": [
1000
]
},
{
"type": "number",
"enum": [
1000
]
},
{
"type": "number",
"enum": [
1000
]
},
{
"type": "number",
"enum": [
1000
]
},
{
"type": "number",
"enum": [
1000
]
},
{
"type": "number",
"enum": [
1000
]
},
{
"type": "number",
"enum": [
1000
]
},
{
"type": "number",
"enum": [
1000
]
},
{
"type": "number",
"enum": [
1000
]
},
{
"type": "number",
"enum": [
1000
]
},
{
"type": "number",
"enum": [
1000
]
},
{
"type": "number",
"enum": [
1000
]
},
{
"type": "number",
"enum": [
1000
]
},
{
"type": "number",
"enum": [
1000
]
},
{
"type": "number",
"enum": [
1000
]
},
{
"type": "number",
"enum": [
1000
]
},
{
"type": "number",
"enum": [
1000
]
},
{
"type": "number",
"enum": [
1000
]
},
{
"type": "number",
"enum": [
1000
]
},
{
"type": "number",
"enum": [
1000
]
},
{
"type": "number",
"enum": [
1000
]
},
{
"type": "number",
"enum": [
1000
]
},
{
"type": "number",
"enum": [
1000
]
},
{
"type": "number",
"enum": [
1000
]
},
{
"type": "number",
"enum": [
1000
]
},
{
"type": "number",
"enum": [
1000
]
},
{
"type": "number",
"enum": [
1000
]
},
{
"type": "number",
"enum": [
1000
]
},
{
"type": "number",
"enum": [
1000
]
},
{
"type": "number",
"enum": [
1000
]
}
]
},
"nov": {
"type": "array",
"items": [
{
"type": "number",
"enum": [
1100
]
},
{
"type": "number",
"enum": [
1100
]
},
{
"type": "number",
"enum": [
1100
]
},
{
"type": "number",
"enum": [
1100
]
},
{
"type": "number",
"enum": [
1100
]
},
{
"type": "number",
"enum": [
1100
]
},
{
"type": "number",
"enum": [
1100
]
},
{
"type": "number",
"enum": [
1100
]
},
{
"type": "number",
"enum": [
1100
]
},
{
"type": "number",
"enum": [
1100
]
},
{
"type": "number",
"enum": [
1100
]
},
{
"type": "number",
"enum": [
1100
]
},
{
"type": "number",
"enum": [
1100
]
},
{
"type": "number",
"enum": [
1100
]
},
{
"type": "number",
"enum": [
1100
]
},
{
"type": "number",
"enum": [
1100
]
},
{
"type": "number",
"enum": [
1100
]
},
{
"type": "number",
"enum": [
1100
]
},
{
"type": "number",
"enum": [
1100
]
},
{
"type": "number",
"enum": [
1100
]
},
{
"type": "number",
"enum": [
1100
]
},
{
"type": "number",
"enum": [
1100
]
},
{
"type": "number",
"enum": [
1100
]
},
{
"type": "number",
"enum": [
1100
]
},
{
"type": "number",
"enum": [
1100
]
},
{
"type": "number",
"enum": [
1100
]
},
{
"type": "number",
"enum": [
1100
]
},
{
"type": "number",
"enum": [
1100
]
},
{
"type": "number",
"enum": [
1100
]
},
{
"type": "number",
"enum": [
1100
]
}
]
},
"dec": {
"type": "array",
"items": [
{
"type": "number",
"enum": [
1200
]
},
{
"type": "number",
"enum": [
1200
]
},
{
"type": "number",
"enum": [
1200
]
},
{
"type": "number",
"enum": [
1200
]
},
{
"type": "number",
"enum": [
1200
]
},
{
"type": "number",
"enum": [
1200
]
},
{
"type": "number",
"enum": [
1200
]
},
{
"type": "number",
"enum": [
1200
]
},
{
"type": "number",
"enum": [
1200
]
},
{
"type": "number",
"enum": [
1200
]
},
{
"type": "number",
"enum": [
1200
]
},
{
"type": "number",
"enum": [
1200
]
},
{
"type": "number",
"enum": [
1200
]
},
{
"type": "number",
"enum": [
1200
]
},
{
"type": "number",
"enum": [
1200
]
},
{
"type": "number",
"enum": [
1200
]
},
{
"type": "number",
"enum": [
1200
]
},
{
"type": "number",
"enum": [
1200
]
},
{
"type": "number",
"enum": [
1200
]
},
{
"type": "number",
"enum": [
1200
]
},
{
"type": "number",
"enum": [
1200
]
},
{
"type": "number",
"enum": [
1200
]
},
{
"type": "number",
"enum": [
1200
]
},
{
"type": "number",
"enum": [
1200
]
},
{
"type": "number",
"enum": [
1200
]
},
{
"type": "number",
"enum": [
1200
]
},
{
"type": "number",
"enum": [
1200
]
},
{
"type": "number",
"enum": [
1200
]
},
{
"type": "number",
"enum": [
1200
]
},
{
"type": "number",
"enum": [
1200
]
},
{
"type": "number",
"enum": [
1200
]
}
]
}
},
"required": [
"jan",
"feb",
"mar",
"apr",
"may",
"jun",
"jul",
"aug",
"sep",
"oct",
"nov",
"dec"
],
"additionalProperties": false
}
},
"required": [
"type",
"minimumPrice"
],
"additionalProperties": false
},
"currencyIsoCode": {
"type": "string",
"enum": [
"EUR"
]
},
"isRentable": {
"type": "boolean",
"enum": [
true
]
},
"isBooked": {
"type": "boolean",
"enum": [
true
]
},
"isBookedWithoutMinStay": {
"type": "boolean",
"enum": [
true
]
},
"isPublished": {
"type": "boolean",
"enum": [
false
]
},
"mainPicture": {
"type": "string",
"enum": [
"https://sah-staging-photos-resized.s3-eu-west-1.amazonaws.com/smw_288/1ededc161abbea7d2ead7a033fc2190e19617cfbd02d921f35ce9acb.jpg"
]
},
"occupancies": {
"type": "array",
"items": {
"type": "object",
"properties": {
"from": {
"type": "string",
"enum": [
"2019-06-01"
],
"description": "The from date in ISO8601 format"
},
"to": {
"type": "string",
"enum": [
"2019-06-30"
],
"description": "The to date in ISO8601 format"
},
"note": {
"type": "string",
"enum": [
"Note"
]
},
"source": {
"type": "string",
"enum": [
"'Source'"
]
},
"bookingRequestId": {
"type": "string",
"enum": [
"'7980'"
]
}
},
"required": [
"from",
"to"
],
"additionalProperties": false
}
},
"rooms": {},
"location": {
"type": "object",
"properties": {
"street": {
"type": "string",
"enum": [
"Calle de Hartzenbusch"
]
},
"streetDoorNumber": {
"type": "string",
"enum": [
"8"
]
},
"floor": {
"type": "string",
"enum": [
"3"
]
},
"door": {
"type": [
"string",
"null"
],
"enum": [
"3",
null
]
},
"letter": {
"type": [
"string",
"null"
],
"enum": [
"A",
null
]
},
"postCode": {
"type": "string",
"enum": [
"28010"
]
},
"city": {
"type": "string",
"enum": [
"madrid"
]
}
},
"required": [
"street",
"streetDoorNumber",
"floor",
"door",
"letter",
"postCode",
"city"
],
"additionalProperties": false
},
"minStay": {
"type": "number",
"enum": [
30
]
},
"maxStay": {
"type": "number",
"enum": [
0
]
},
"plan": {
"type": [
"string",
"null"
],
"enum": [
"standard",
null
]
},
"exclusivityDealType": {
"type": "string",
"enum": [
"basic",
"exclusive",
"guaranteed"
]
},
"landlordId": {
"type": "string",
"enum": [
"aaaaaaa8-bbb4-ccc4-ddd4-eeeeeeeeee12"
]
},
"landlordCommission": {
"type": "object",
"properties": {
"type": {
"type": [
"string",
"null"
],
"enum": [
"fixed",
"percentage",
null
]
},
"value": {
"type": [
"number",
"null"
],
"enum": [
600,
null
]
}
},
"required": [
"type",
"value"
],
"additionalProperties": false
},
"refreshAvailabilitiesDate": {
"type": "string",
"enum": [
"2016-09-14T17:54:39+00:00"
]
},
"lastUnpublishedDate": {
"type": [
"string",
"null"
],
"enum": [
"2016-09-14T17:54:39+00:00",
null
]
},
"stayRules": {
"type": "object",
"properties": {
"bookingTooEarlyDays": {
"type": "number",
"enum": [
200
]
}
},
"required": [
"bookingTooEarlyDays"
],
"additionalProperties": false
},
"postalCode": {
"type": "string",
"enum": [
"28010"
]
}
},
"required": [
"id",
"title",
"address",
"landlordReference",
"type",
"price",
"monthlyPrice",
"currencyIsoCode",
"isRentable",
"isBooked",
"isBookedWithoutMinStay",
"isPublished",
"mainPicture",
"occupancies",
"rooms",
"location",
"minStay",
"maxStay",
"plan",
"exclusivityDealType",
"landlordId",
"landlordCommission",
"refreshAvailabilitiesDate",
"lastUnpublishedDate",
"stayRules",
"postalCode"
],
"additionalProperties": false
}
}Response
401Headers
Content-Type: application/jsonBody
{
"detail": "Unauthorized user",
"status": 401,
"title": "Unauthorized",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
404Headers
Content-Type: application/jsonBody
{
"detail": "The resource was not found",
"status": 404,
"title": "Not Found",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
500Headers
Content-Type: application/jsonBody
{
"detail": "Internal Server Error",
"status": 500,
"title": "Internal Server Error",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Listing Info ¶
Obtain listing informationGET/listings/{listingId}
Example URI
GET https://monolith.spotahome.com/api/listings/12345
URI Parameters
- listingId
number(required) Example: 12345Identifier of the resource.
Request
Headers
Content-Type: application/json
Authorization: aa.bb.ccResponse
200Body
{
"id": "120174",
"title": "Cozy studio in the heart of London",
"address": "Calle de Hartzenbusch 8, 3, 28010 Madrid",
"landlordReference": "Bedroom 1",
"type": "studio",
"price": {
"amount": 78800,
"currency": {
"isoCode": "EUR",
"symbol": "€"
}
},
"monthlyPrice": {
"type": "fixed",
"minimumPrice": 788,
"fixedPrice": 788,
"pricesByMonth": {
"jan": 100,
"feb": 200,
"mar": 300,
"apr": 400,
"may": 500,
"jun": 600,
"jul": 700,
"aug": 800,
"sep": 900,
"oct": 1000,
"nov": 1100,
"dec": 1200
},
"pricesByDay": {
"jan": [
100,
100,
100,
100,
100,
100,
100,
100,
100,
100,
100,
100,
100,
100,
100,
100,
100,
100,
100,
100,
100,
100,
100,
100,
100,
100,
100,
100,
100,
100,
100
],
"feb": [
200,
200,
200,
200,
200,
200,
200,
200,
200,
200,
200,
200,
200,
200,
200,
200,
200,
200,
200,
200,
200,
200,
200,
200,
200,
200,
200,
200,
200
],
"mar": [
300,
300,
300,
300,
300,
300,
300,
300,
300,
300,
300,
300,
300,
300,
300,
300,
300,
300,
300,
300,
300,
300,
300,
300,
300,
300,
300,
300,
300,
300,
300
],
"apr": [
400,
400,
400,
400,
400,
400,
400,
400,
400,
400,
400,
400,
400,
400,
400,
400,
400,
400,
400,
400,
400,
400,
400,
400,
400,
400,
400,
400,
400,
400
],
"may": [
500,
500,
500,
500,
500,
500,
500,
500,
500,
500,
500,
500,
500,
500,
500,
500,
500,
500,
500,
500,
500,
500,
500,
500,
500,
500,
500,
500,
500,
500,
500
],
"jun": [
600,
600,
600,
600,
600,
600,
600,
600,
600,
600,
600,
600,
600,
600,
600,
600,
600,
600,
600,
600,
600,
600,
600,
600,
600,
600,
600,
600,
600,
600
],
"jul": [
700,
700,
700,
700,
700,
700,
700,
700,
700,
700,
700,
700,
700,
700,
700,
700,
700,
700,
700,
700,
700,
700,
700,
700,
700,
700,
700,
700,
700,
700,
700
],
"aug": [
800,
800,
800,
800,
800,
800,
800,
800,
800,
800,
800,
800,
800,
800,
800,
800,
800,
800,
800,
800,
800,
800,
800,
800,
800,
800,
800,
800,
800,
800,
800
],
"sep": [
900,
900,
900,
900,
900,
900,
900,
900,
900,
900,
900,
900,
900,
900,
900,
900,
900,
900,
900,
900,
900,
900,
900,
900,
900,
900,
900,
900,
900,
900
],
"oct": [
1000,
1000,
1000,
1000,
1000,
1000,
1000,
1000,
1000,
1000,
1000,
1000,
1000,
1000,
1000,
1000,
1000,
1000,
1000,
1000,
1000,
1000,
1000,
1000,
1000,
1000,
1000,
1000,
1000,
1000,
1000
],
"nov": [
1100,
1100,
1100,
1100,
1100,
1100,
1100,
1100,
1100,
1100,
1100,
1100,
1100,
1100,
1100,
1100,
1100,
1100,
1100,
1100,
1100,
1100,
1100,
1100,
1100,
1100,
1100,
1100,
1100,
1100
],
"dec": [
1200,
1200,
1200,
1200,
1200,
1200,
1200,
1200,
1200,
1200,
1200,
1200,
1200,
1200,
1200,
1200,
1200,
1200,
1200,
1200,
1200,
1200,
1200,
1200,
1200,
1200,
1200,
1200,
1200,
1200,
1200
]
}
},
"currencyIsoCode": "EUR",
"isRentable": true,
"isBooked": true,
"isBookedWithoutMinStay": true,
"isPublished": false,
"mainPicture": "https://sah-staging-photos-resized.s3-eu-west-1.amazonaws.com/smw_288/1ededc161abbea7d2ead7a033fc2190e19617cfbd02d921f35ce9acb.jpg",
"occupancies": [
{
"from": "2019-06-01",
"to": "2019-06-30",
"note": "Note",
"source": "'Source'",
"bookingRequestId": "'7980'"
}
],
"rooms": [],
"location": {
"street": "Calle de Hartzenbusch",
"streetDoorNumber": "8",
"floor": "3",
"door": "3",
"letter": "A",
"postCode": "28010",
"city": "madrid"
},
"minStay": 30,
"maxStay": 0,
"plan": "standard",
"exclusivityDealType": "basic",
"landlordId": "aaaaaaa8-bbb4-ccc4-ddd4-eeeeeeeeee12",
"landlordCommission": {
"type": "fixed",
"value": 600
},
"refreshAvailabilitiesDate": "2016-09-14T17:54:39+00:00",
"lastUnpublishedDate": "2016-09-14T17:54:39+00:00",
"stayRules": {
"bookingTooEarlyDays": 200
},
"postalCode": "28010"
}Schema
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"title": {
"type": "string"
},
"address": {
"type": "string"
},
"landlordReference": {
"type": "string"
},
"type": {
"type": "string"
},
"price": {
"type": "object",
"properties": {
"amount": {
"type": "number"
},
"currency": {
"type": "object",
"properties": {
"isoCode": {
"type": "string"
},
"symbol": {
"type": "string"
}
},
"required": [
"isoCode",
"symbol"
]
}
},
"required": [
"amount",
"currency"
]
},
"monthlyPrice": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"minimumPrice": {
"type": "number"
},
"fixedPrice": {
"type": "number"
},
"pricesByMonth": {
"type": "object",
"properties": {
"jan": {
"type": "number"
},
"feb": {
"type": "number"
},
"mar": {
"type": "number"
},
"apr": {
"type": "number"
},
"may": {
"type": "number"
},
"jun": {
"type": "number"
},
"jul": {
"type": "number"
},
"aug": {
"type": "number"
},
"sep": {
"type": "number"
},
"oct": {
"type": "number"
},
"nov": {
"type": "number"
},
"dec": {
"type": "number"
}
},
"required": [
"jan",
"feb",
"mar",
"apr",
"may",
"jun",
"jul",
"aug",
"sep",
"oct",
"nov",
"dec"
]
},
"pricesByDay": {
"type": "object",
"properties": {
"jan": {
"type": "array",
"items": {
"type": "number"
}
},
"feb": {
"type": "array",
"items": {
"type": "number"
}
},
"mar": {
"type": "array",
"items": {
"type": "number"
}
},
"apr": {
"type": "array",
"items": {
"type": "number"
}
},
"may": {
"type": "array",
"items": {
"type": "number"
}
},
"jun": {
"type": "array",
"items": {
"type": "number"
}
},
"jul": {
"type": "array",
"items": {
"type": "number"
}
},
"aug": {
"type": "array",
"items": {
"type": "number"
}
},
"sep": {
"type": "array",
"items": {
"type": "number"
}
},
"oct": {
"type": "array",
"items": {
"type": "number"
}
},
"nov": {
"type": "array",
"items": {
"type": "number"
}
},
"dec": {
"type": "array",
"items": {
"type": "number"
}
}
},
"required": [
"jan",
"feb",
"mar",
"apr",
"may",
"jun",
"jul",
"aug",
"sep",
"oct",
"nov",
"dec"
]
}
},
"required": [
"type",
"minimumPrice"
]
},
"currencyIsoCode": {
"type": "string"
},
"isRentable": {
"type": "boolean"
},
"isBooked": {
"type": "boolean"
},
"isBookedWithoutMinStay": {
"type": "boolean"
},
"isPublished": {
"type": "boolean"
},
"mainPicture": {
"type": "string"
},
"occupancies": {
"type": "array",
"items": {
"type": "object",
"properties": {
"from": {
"type": "string",
"description": "The from date in ISO8601 format"
},
"to": {
"type": "string",
"description": "The to date in ISO8601 format"
},
"note": {
"type": "string"
},
"source": {
"type": "string"
},
"bookingRequestId": {
"type": "string"
}
},
"required": [
"from",
"to"
]
}
},
"rooms": {
"type": "array"
},
"location": {
"type": "object",
"properties": {
"street": {
"type": "string"
},
"streetDoorNumber": {
"type": "string"
},
"floor": {
"type": "string"
},
"door": {
"type": [
"string",
"null"
]
},
"letter": {
"type": [
"string",
"null"
]
},
"postCode": {
"type": "string"
},
"city": {
"type": "string"
}
},
"required": [
"street",
"streetDoorNumber",
"floor",
"door",
"letter",
"postCode",
"city"
]
},
"minStay": {
"type": "number"
},
"maxStay": {
"type": "number"
},
"plan": {
"type": [
"string",
"null"
]
},
"exclusivityDealType": {
"enum": [
"basic",
"exclusive",
"guaranteed"
]
},
"landlordId": {
"type": "string"
},
"landlordCommission": {
"type": "object",
"properties": {
"type": {
"enum": [
"fixed",
"percentage"
],
"type": [
null,
"null"
]
},
"value": {
"type": [
"number",
"null"
]
}
},
"required": [
"type",
"value"
]
},
"refreshAvailabilitiesDate": {
"type": "string"
},
"lastUnpublishedDate": {
"type": [
"string",
"null"
]
},
"stayRules": {
"type": "object",
"properties": {
"bookingTooEarlyDays": {
"type": "number"
}
},
"required": [
"bookingTooEarlyDays"
]
},
"postalCode": {
"type": "string"
}
},
"required": [
"id",
"title",
"address",
"landlordReference",
"type",
"price",
"monthlyPrice",
"currencyIsoCode",
"isRentable",
"isBooked",
"isBookedWithoutMinStay",
"isPublished",
"mainPicture",
"occupancies",
"rooms",
"location",
"minStay",
"maxStay",
"plan",
"exclusivityDealType",
"landlordId",
"landlordCommission",
"refreshAvailabilitiesDate",
"lastUnpublishedDate",
"stayRules",
"postalCode"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Response
401Headers
Content-Type: application/jsonBody
{
"detail": "Unauthorized user",
"status": 401,
"title": "Unauthorized",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
404Headers
Content-Type: application/jsonBody
{
"detail": "The resource was not found",
"status": 404,
"title": "Not Found",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Change Listing InformationPUT/listings/{listingId}
If price field is set, then monthlyPrice field is ignored.
If type in monthlyPrice is fixed, the pricesByMonth field is ignored.
If type in monthlyPrice is byMonth, the fixedPrice field is ignored.
Every value of the object pricesByMonth in monthlyPrice should be an unsigned int using the the base currency unit (e.g. Euro or Pound).
The field fixedPrice is also using the base currency unit.
Example URI
PUT https://monolith.spotahome.com/api/listings/12345
URI Parameters
- listingId
number(required) Example: 12345
Request
Headers
Content-Type: application/json
Authorization: aa.bb.ccBody
{
"landlordReference": "1234",
"occupations": [
{
"from": "2019-06-01",
"to": "2019-06-30",
"note": "Note",
"source": "'Source'",
"bookingRequestId": "'7980'"
}
],
"price": 500,
"monthlyPrice": {
"type": "fixed",
"pricesByMonth": {
"jan": 500,
"feb": 500,
"mar": 500,
"apr": 700,
"may": 500,
"jun": 700,
"jul": 700,
"aug": 700,
"sep": 500,
"oct": 500,
"nov": 500,
"dec": 700
},
"fixedPrice": 500
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"landlordReference": {
"type": "string"
},
"occupations": {
"type": "array",
"items": {
"type": "object",
"properties": {
"from": {
"type": "string",
"enum": [
"2019-06-01"
],
"description": "The from date in ISO8601 format"
},
"to": {
"type": "string",
"enum": [
"2019-06-30"
],
"description": "The to date in ISO8601 format"
},
"note": {
"type": "string",
"enum": [
"Note"
]
},
"source": {
"type": "string",
"enum": [
"'Source'"
]
},
"bookingRequestId": {
"type": "string",
"enum": [
"'7980'"
]
}
},
"required": [
"from",
"to"
],
"additionalProperties": false
}
},
"price": {
"type": "number"
},
"monthlyPrice": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"fixed",
"byMonth"
]
},
"pricesByMonth": {
"type": "object",
"properties": {
"jan": {
"type": "number"
},
"feb": {
"type": "number"
},
"mar": {
"type": "number"
},
"apr": {
"type": "number"
},
"may": {
"type": "number"
},
"jun": {
"type": "number"
},
"jul": {
"type": "number"
},
"aug": {
"type": "number"
},
"sep": {
"type": "number"
},
"oct": {
"type": "number"
},
"nov": {
"type": "number"
},
"dec": {
"type": "number"
}
},
"required": [
"jan",
"feb",
"mar",
"apr",
"may",
"jun",
"jul",
"aug",
"sep",
"oct",
"nov",
"dec"
]
},
"fixedPrice": {
"type": "number"
}
}
}
},
"required": [
"landlordReference",
"occupations"
]
}Response
200Body
{
"id": "120174",
"title": "Cozy studio in the heart of London",
"address": "Calle de Hartzenbusch 8, 3, 28010 Madrid",
"landlordReference": "Bedroom 1",
"type": "studio",
"price": {
"amount": 78800,
"currency": {
"isoCode": "EUR",
"symbol": "€"
}
},
"monthlyPrice": {
"type": "fixed",
"minimumPrice": 788,
"fixedPrice": 788,
"pricesByMonth": {
"jan": 100,
"feb": 200,
"mar": 300,
"apr": 400,
"may": 500,
"jun": 600,
"jul": 700,
"aug": 800,
"sep": 900,
"oct": 1000,
"nov": 1100,
"dec": 1200
},
"pricesByDay": {
"jan": [
100,
100,
100,
100,
100,
100,
100,
100,
100,
100,
100,
100,
100,
100,
100,
100,
100,
100,
100,
100,
100,
100,
100,
100,
100,
100,
100,
100,
100,
100,
100
],
"feb": [
200,
200,
200,
200,
200,
200,
200,
200,
200,
200,
200,
200,
200,
200,
200,
200,
200,
200,
200,
200,
200,
200,
200,
200,
200,
200,
200,
200,
200
],
"mar": [
300,
300,
300,
300,
300,
300,
300,
300,
300,
300,
300,
300,
300,
300,
300,
300,
300,
300,
300,
300,
300,
300,
300,
300,
300,
300,
300,
300,
300,
300,
300
],
"apr": [
400,
400,
400,
400,
400,
400,
400,
400,
400,
400,
400,
400,
400,
400,
400,
400,
400,
400,
400,
400,
400,
400,
400,
400,
400,
400,
400,
400,
400,
400
],
"may": [
500,
500,
500,
500,
500,
500,
500,
500,
500,
500,
500,
500,
500,
500,
500,
500,
500,
500,
500,
500,
500,
500,
500,
500,
500,
500,
500,
500,
500,
500,
500
],
"jun": [
600,
600,
600,
600,
600,
600,
600,
600,
600,
600,
600,
600,
600,
600,
600,
600,
600,
600,
600,
600,
600,
600,
600,
600,
600,
600,
600,
600,
600,
600
],
"jul": [
700,
700,
700,
700,
700,
700,
700,
700,
700,
700,
700,
700,
700,
700,
700,
700,
700,
700,
700,
700,
700,
700,
700,
700,
700,
700,
700,
700,
700,
700,
700
],
"aug": [
800,
800,
800,
800,
800,
800,
800,
800,
800,
800,
800,
800,
800,
800,
800,
800,
800,
800,
800,
800,
800,
800,
800,
800,
800,
800,
800,
800,
800,
800,
800
],
"sep": [
900,
900,
900,
900,
900,
900,
900,
900,
900,
900,
900,
900,
900,
900,
900,
900,
900,
900,
900,
900,
900,
900,
900,
900,
900,
900,
900,
900,
900,
900
],
"oct": [
1000,
1000,
1000,
1000,
1000,
1000,
1000,
1000,
1000,
1000,
1000,
1000,
1000,
1000,
1000,
1000,
1000,
1000,
1000,
1000,
1000,
1000,
1000,
1000,
1000,
1000,
1000,
1000,
1000,
1000,
1000
],
"nov": [
1100,
1100,
1100,
1100,
1100,
1100,
1100,
1100,
1100,
1100,
1100,
1100,
1100,
1100,
1100,
1100,
1100,
1100,
1100,
1100,
1100,
1100,
1100,
1100,
1100,
1100,
1100,
1100,
1100,
1100
],
"dec": [
1200,
1200,
1200,
1200,
1200,
1200,
1200,
1200,
1200,
1200,
1200,
1200,
1200,
1200,
1200,
1200,
1200,
1200,
1200,
1200,
1200,
1200,
1200,
1200,
1200,
1200,
1200,
1200,
1200,
1200,
1200
]
}
},
"currencyIsoCode": "EUR",
"isRentable": true,
"isBooked": true,
"isBookedWithoutMinStay": true,
"isPublished": false,
"mainPicture": "https://sah-staging-photos-resized.s3-eu-west-1.amazonaws.com/smw_288/1ededc161abbea7d2ead7a033fc2190e19617cfbd02d921f35ce9acb.jpg",
"occupancies": [
{
"from": "2019-06-01",
"to": "2019-06-30",
"note": "Note",
"source": "'Source'",
"bookingRequestId": "'7980'"
}
],
"rooms": [],
"location": {
"street": "Calle de Hartzenbusch",
"streetDoorNumber": "8",
"floor": "3",
"door": "3",
"letter": "A",
"postCode": "28010",
"city": "madrid"
},
"minStay": 30,
"maxStay": 0,
"plan": "standard",
"exclusivityDealType": "basic",
"landlordId": "aaaaaaa8-bbb4-ccc4-ddd4-eeeeeeeeee12",
"landlordCommission": {
"type": "fixed",
"value": 600
},
"refreshAvailabilitiesDate": "2016-09-14T17:54:39+00:00",
"lastUnpublishedDate": "2016-09-14T17:54:39+00:00",
"stayRules": {
"bookingTooEarlyDays": 200
},
"postalCode": "28010"
}Schema
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"title": {
"type": "string"
},
"address": {
"type": "string"
},
"landlordReference": {
"type": "string"
},
"type": {
"type": "string"
},
"price": {
"type": "object",
"properties": {
"amount": {
"type": "number"
},
"currency": {
"type": "object",
"properties": {
"isoCode": {
"type": "string"
},
"symbol": {
"type": "string"
}
},
"required": [
"isoCode",
"symbol"
]
}
},
"required": [
"amount",
"currency"
]
},
"monthlyPrice": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"minimumPrice": {
"type": "number"
},
"fixedPrice": {
"type": "number"
},
"pricesByMonth": {
"type": "object",
"properties": {
"jan": {
"type": "number"
},
"feb": {
"type": "number"
},
"mar": {
"type": "number"
},
"apr": {
"type": "number"
},
"may": {
"type": "number"
},
"jun": {
"type": "number"
},
"jul": {
"type": "number"
},
"aug": {
"type": "number"
},
"sep": {
"type": "number"
},
"oct": {
"type": "number"
},
"nov": {
"type": "number"
},
"dec": {
"type": "number"
}
},
"required": [
"jan",
"feb",
"mar",
"apr",
"may",
"jun",
"jul",
"aug",
"sep",
"oct",
"nov",
"dec"
]
},
"pricesByDay": {
"type": "object",
"properties": {
"jan": {
"type": "array",
"items": {
"type": "number"
}
},
"feb": {
"type": "array",
"items": {
"type": "number"
}
},
"mar": {
"type": "array",
"items": {
"type": "number"
}
},
"apr": {
"type": "array",
"items": {
"type": "number"
}
},
"may": {
"type": "array",
"items": {
"type": "number"
}
},
"jun": {
"type": "array",
"items": {
"type": "number"
}
},
"jul": {
"type": "array",
"items": {
"type": "number"
}
},
"aug": {
"type": "array",
"items": {
"type": "number"
}
},
"sep": {
"type": "array",
"items": {
"type": "number"
}
},
"oct": {
"type": "array",
"items": {
"type": "number"
}
},
"nov": {
"type": "array",
"items": {
"type": "number"
}
},
"dec": {
"type": "array",
"items": {
"type": "number"
}
}
},
"required": [
"jan",
"feb",
"mar",
"apr",
"may",
"jun",
"jul",
"aug",
"sep",
"oct",
"nov",
"dec"
]
}
},
"required": [
"type",
"minimumPrice"
]
},
"currencyIsoCode": {
"type": "string"
},
"isRentable": {
"type": "boolean"
},
"isBooked": {
"type": "boolean"
},
"isBookedWithoutMinStay": {
"type": "boolean"
},
"isPublished": {
"type": "boolean"
},
"mainPicture": {
"type": "string"
},
"occupancies": {
"type": "array",
"items": {
"type": "object",
"properties": {
"from": {
"type": "string",
"description": "The from date in ISO8601 format"
},
"to": {
"type": "string",
"description": "The to date in ISO8601 format"
},
"note": {
"type": "string"
},
"source": {
"type": "string"
},
"bookingRequestId": {
"type": "string"
}
},
"required": [
"from",
"to"
]
}
},
"rooms": {
"type": "array"
},
"location": {
"type": "object",
"properties": {
"street": {
"type": "string"
},
"streetDoorNumber": {
"type": "string"
},
"floor": {
"type": "string"
},
"door": {
"type": [
"string",
"null"
]
},
"letter": {
"type": [
"string",
"null"
]
},
"postCode": {
"type": "string"
},
"city": {
"type": "string"
}
},
"required": [
"street",
"streetDoorNumber",
"floor",
"door",
"letter",
"postCode",
"city"
]
},
"minStay": {
"type": "number"
},
"maxStay": {
"type": "number"
},
"plan": {
"type": [
"string",
"null"
]
},
"exclusivityDealType": {
"enum": [
"basic",
"exclusive",
"guaranteed"
]
},
"landlordId": {
"type": "string"
},
"landlordCommission": {
"type": "object",
"properties": {
"type": {
"enum": [
"fixed",
"percentage"
],
"type": [
null,
"null"
]
},
"value": {
"type": [
"number",
"null"
]
}
},
"required": [
"type",
"value"
]
},
"refreshAvailabilitiesDate": {
"type": "string"
},
"lastUnpublishedDate": {
"type": [
"string",
"null"
]
},
"stayRules": {
"type": "object",
"properties": {
"bookingTooEarlyDays": {
"type": "number"
}
},
"required": [
"bookingTooEarlyDays"
]
},
"postalCode": {
"type": "string"
}
},
"required": [
"id",
"title",
"address",
"landlordReference",
"type",
"price",
"monthlyPrice",
"currencyIsoCode",
"isRentable",
"isBooked",
"isBookedWithoutMinStay",
"isPublished",
"mainPicture",
"occupancies",
"rooms",
"location",
"minStay",
"maxStay",
"plan",
"exclusivityDealType",
"landlordId",
"landlordCommission",
"refreshAvailabilitiesDate",
"lastUnpublishedDate",
"stayRules",
"postalCode"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Response
401Headers
Content-Type: application/jsonBody
{
"detail": "Unauthorized user",
"status": 401,
"title": "Unauthorized",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
404Headers
Content-Type: application/jsonBody
{
"detail": "The resource was not found",
"status": 404,
"title": "Not Found",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
500Headers
Content-Type: application/jsonBody
{
"detail": "Internal Server Error",
"status": 500,
"title": "Internal Server Error",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Listing Price ¶
Change Listing PricePUT/listings/{listingId}/price
If priceType is fixed, the pricesByMonth field is ignored.
If priceType is byMonth, the fixedPrice field is ignored.
If priceType is byDay, the fixedPrice and pricesByMonth field are ignored.
Every position of the field pricesByMonth should be an unsigned int using the the base currency unit (e.g. Euro or Pound).
The field fixedPrice is also using the base currency unit.
Example URI
PUT https://monolith.spotahome.com/api/listings/12345/price
URI Parameters
- listingId
number(required) Example: 12345
Request
Headers
Content-Type: application/json
Authorization: aa.bb.ccBody
{
"priceType": "fixed",
"fixedPrice": 1000,
"pricesByMonth": [
100,
200,
300,
400,
500,
600,
700,
800,
900,
1000,
1100,
1200
],
"pricesByDay": [
[
100,
100,
100,
100,
100,
100,
100,
100,
100,
100,
100,
100,
100,
100,
100,
100,
100,
100,
100,
100,
100,
100,
100,
100,
100,
100,
100,
100,
100,
100,
100
],
[
200,
200,
200,
200,
200,
200,
200,
200,
200,
200,
200,
200,
200,
200,
200,
200,
200,
200,
200,
200,
200,
200,
200,
200,
200,
200,
200,
200,
200
],
[
300,
300,
300,
300,
300,
300,
300,
300,
300,
300,
300,
300,
300,
300,
300,
300,
300,
300,
300,
300,
300,
300,
300,
300,
300,
300,
300,
300,
300,
300,
300
],
[
400,
400,
400,
400,
400,
400,
400,
400,
400,
400,
400,
400,
400,
400,
400,
400,
400,
400,
400,
400,
400,
400,
400,
400,
400,
400,
400,
400,
400,
400
],
[
500,
500,
500,
500,
500,
500,
500,
500,
500,
500,
500,
500,
500,
500,
500,
500,
500,
500,
500,
500,
500,
500,
500,
500,
500,
500,
500,
500,
500,
500,
500
],
[
600,
600,
600,
600,
600,
600,
600,
600,
600,
600,
600,
600,
600,
600,
600,
600,
600,
600,
600,
600,
600,
600,
600,
600,
600,
600,
600,
600,
600,
600
],
[
700,
700,
700,
700,
700,
700,
700,
700,
700,
700,
700,
700,
700,
700,
700,
700,
700,
700,
700,
700,
700,
700,
700,
700,
700,
700,
700,
700,
700,
700,
700
],
[
800,
800,
800,
800,
800,
800,
800,
800,
800,
800,
800,
800,
800,
800,
800,
800,
800,
800,
800,
800,
800,
800,
800,
800,
800,
800,
800,
800,
800,
800,
800
],
[
900,
900,
900,
900,
900,
900,
900,
900,
900,
900,
900,
900,
900,
900,
900,
900,
900,
900,
900,
900,
900,
900,
900,
900,
900,
900,
900,
900,
900,
900
],
[
1000,
1000,
1000,
1000,
1000,
1000,
1000,
1000,
1000,
1000,
1000,
1000,
1000,
1000,
1000,
1000,
1000,
1000,
1000,
1000,
1000,
1000,
1000,
1000,
1000,
1000,
1000,
1000,
1000,
1000,
1000
],
[
1100,
1100,
1100,
1100,
1100,
1100,
1100,
1100,
1100,
1100,
1100,
1100,
1100,
1100,
1100,
1100,
1100,
1100,
1100,
1100,
1100,
1100,
1100,
1100,
1100,
1100,
1100,
1100,
1100,
1100
],
[
1200,
1200,
1200,
1200,
1200,
1200,
1200,
1200,
1200,
1200,
1200,
1200,
1200,
1200,
1200,
1200,
1200,
1200,
1200,
1200,
1200,
1200,
1200,
1200,
1200,
1200,
1200,
1200,
1200,
1200,
1200
]
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"priceType": {
"type": "string",
"enum": [
"fixed",
"byMonth",
"byDay"
]
},
"fixedPrice": {
"type": "number"
},
"pricesByMonth": {
"type": "array",
"items": [
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
}
]
},
"pricesByDay": {
"type": "array",
"items": [
{
"type": "array",
"items": [
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
}
]
},
{
"type": "array",
"items": [
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
}
]
},
{
"type": "array",
"items": [
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
}
]
},
{
"type": "array",
"items": [
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
}
]
},
{
"type": "array",
"items": [
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
}
]
},
{
"type": "array",
"items": [
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
}
]
},
{
"type": "array",
"items": [
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
}
]
},
{
"type": "array",
"items": [
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
}
]
},
{
"type": "array",
"items": [
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
}
]
},
{
"type": "array",
"items": [
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
}
]
},
{
"type": "array",
"items": [
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
}
]
},
{
"type": "array",
"items": [
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
}
]
}
]
}
},
"required": [
"priceType"
]
}Response
204Headers
Content-Type: application/jsonResponse
401Headers
Content-Type: application/jsonBody
{
"detail": "Unauthorized user",
"status": 401,
"title": "Unauthorized",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
404Headers
Content-Type: application/jsonBody
{
"detail": "The resource was not found",
"status": 404,
"title": "Not Found",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
422Headers
Content-Type: application/jsonBody
{
"detail": "The request was well formed but was unable to be followed due to semantic errors",
"status": 422,
"title": "Unprocessable Entity",
"type": "`http://www.w3.org/Protocols/rfc2616/rfc2616",
"validationMessages": {
"field": {
"stringLength": "The input is less than 6 characters long"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string",
"description": "sec10.html (string, required)"
},
"validationMessages": {
"type": "object",
"properties": {
"field": {
"type": "object",
"properties": {
"stringLength": {
"type": "string"
}
},
"required": [
"stringLength"
]
}
},
"description": "Contains a property for each field that failed validation."
}
},
"required": [
"detail",
"status",
"title"
]
}Response
500Headers
Content-Type: application/jsonBody
{
"detail": "Internal Server Error",
"status": 500,
"title": "Internal Server Error",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Listings Price ¶
Modify Listings PricePUT/listings/price
Example URI
PUT https://monolith.spotahome.com/api/listings/price
Request
Headers
Content-Type: application/json
Authorization: aa.bb.ccBody
{
"listingIds": [
1
],
"amountType": "fixed",
"amountValue": 100
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"listingIds": {
"type": "array"
},
"amountType": {
"type": "string",
"enum": [
"fixed",
"percentage"
]
},
"amountValue": {
"type": "number"
}
},
"required": [
"listingIds",
"amountType"
]
}Response
200Headers
Content-Type: application/jsonBody
[
{
"listingId": 1,
"error": "Hello, world!"
}
]Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array"
}Response
500Headers
Content-Type: application/jsonBody
{
"detail": "Internal Server Error",
"status": 500,
"title": "Internal Server Error",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Listings Currencies ¶
GET Listings PricePOST/listings/currencies
Example URI
POST https://monolith.spotahome.com/api/listings/currencies
Request
Headers
Content-Type: application/jsonBody
{
"listingIds": [
1
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"listingIds": {
"type": "array"
}
},
"required": [
"listingIds"
]
}Response
200Headers
Content-Type: application/jsonBody
[
{
"label": "Hello, world!",
"symbol": "Hello, world!"
}
]Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array"
}Response
500Headers
Content-Type: application/jsonBody
{
"detail": "Internal Server Error",
"status": 500,
"title": "Internal Server Error",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Occupancies ¶
Change Listing OccupanciesPUT/listings/{listingId}/occupancies
Example URI
PUT https://monolith.spotahome.com/api/listings/12345/occupancies
URI Parameters
- listingId
number(required) Example: 12345
Request
Headers
Content-Type: application/json
Authorization: aa.bb.cc
Requester: requester@spotahome.comBody
[
{
"start": "2015-01-10",
"end": "2016-01-10",
"note": "Note",
"source": "'Source'",
"bookingRequestId": "'7980'"
}
]Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array",
"items": {
"type": "object",
"properties": {
"start": {
"type": "string",
"enum": [
"2015-01-10"
]
},
"end": {
"type": "string",
"enum": [
"2016-01-10"
]
},
"note": {
"type": "string",
"enum": [
"Note"
]
},
"source": {
"type": "string",
"enum": [
"'Source'"
]
},
"bookingRequestId": {
"type": "string",
"enum": [
"'7980'"
]
}
},
"required": [
"start",
"end"
],
"additionalProperties": false
}
}Response
204Headers
Content-Type: application/jsonResponse
401Headers
Content-Type: application/jsonBody
{
"detail": "Unauthorized user",
"status": 401,
"title": "Unauthorized",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
404Headers
Content-Type: application/jsonBody
{
"detail": "The resource was not found",
"status": 404,
"title": "Not Found",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
500Headers
Content-Type: application/jsonBody
{
"detail": "Internal Server Error",
"status": 500,
"title": "Internal Server Error",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Add Listing OccupancyPOST/listings/{listingId}/occupancies
Example URI
POST https://monolith.spotahome.com/api/listings/12345/occupancies
URI Parameters
- listingId
number(required) Example: 12345
Request
Headers
Content-Type: application/json
Authorization: aa.bb.cc
Requester: requester@spotahome.comBody
{
"checkIn": "2018-01-01",
"checkOut": "2018-06-30",
"source": "'bookingRequest'",
"bookingRequestId": "'123456'",
"shouldUpdateRefreshAvailabilities": true
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"checkIn": {
"type": "string"
},
"checkOut": {
"type": "string"
},
"source": {
"type": "string"
},
"bookingRequestId": {
"type": "string"
},
"shouldUpdateRefreshAvailabilities": {
"type": "boolean"
}
},
"required": [
"checkIn",
"checkOut"
]
}Response
204Response
400Headers
Content-Type: application/jsonBody
{
"detail": "The request could not be understood by the server due to malformed syntax",
"status": 400,
"title": "Bad Request",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
401Headers
Content-Type: application/jsonBody
{
"detail": "Unauthorized user",
"status": 401,
"title": "Unauthorized",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
404Headers
Content-Type: application/jsonBody
{
"detail": "The resource was not found",
"status": 404,
"title": "Not Found",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
422Headers
Content-Type: application/jsonBody
{
"detail": "The request was well formed but was unable to be followed due to semantic errors",
"status": 422,
"title": "Unprocessable Entity",
"type": "`http://www.w3.org/Protocols/rfc2616/rfc2616",
"validationMessages": {
"field": {
"stringLength": "The input is less than 6 characters long"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string",
"description": "sec10.html (string, required)"
},
"validationMessages": {
"type": "object",
"properties": {
"field": {
"type": "object",
"properties": {
"stringLength": {
"type": "string"
}
},
"required": [
"stringLength"
]
}
},
"description": "Contains a property for each field that failed validation."
}
},
"required": [
"detail",
"status",
"title"
]
}Response
500Headers
Content-Type: application/jsonBody
{
"detail": "Internal Server Error",
"status": 500,
"title": "Internal Server Error",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Booking Request Occupancy ¶
Delete Listings Occupancy by Booking Request OccupancyDELETE/api/listings/{listingId}/occupancies/booking-requests/{bookingRequestId}
Example URI
DELETE https://monolith.spotahome.com/api/api/listings/12345/occupancies/booking-requests/12345
URI Parameters
- listingId
number(required) Example: 12345- bookingRequestId
number(required) Example: 12345
Request
Headers
Content-Type: application/json
Authorization: aa.bb.cc
Requester: requester@spotahome.comBody
{
"shouldUpdateRefreshAvailabilities": true
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"shouldUpdateRefreshAvailabilities": {
"type": "boolean"
}
}
}Response
204Headers
Content-Type: application/jsonResponse
401Headers
Content-Type: application/jsonBody
{
"detail": "Unauthorized user",
"status": 401,
"title": "Unauthorized",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
404Headers
Content-Type: application/jsonBody
{
"detail": "The resource was not found",
"status": 404,
"title": "Not Found",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
500Headers
Content-Type: application/jsonBody
{
"detail": "Internal Server Error",
"status": 500,
"title": "Internal Server Error",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Public Occupancies ¶
Update Listing OccupanciesPUT/public/listings/{listingId}/occupancies
Example URI
PUT https://monolith.spotahome.com/api/public/listings/12345/occupancies
URI Parameters
- listingId
number(required) Example: 12345
Request
Headers
Content-Type: application/json
Authorization: aa.bb.cc
Requester: requester@spotahome.comBody
[
{
"start": "2015-01-10",
"end": "2016-01-10",
"note": "Note",
"source": "'Source'",
"bookingRequestId": "'7980'"
}
]Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array",
"items": {
"type": "object",
"properties": {
"start": {
"type": "string",
"enum": [
"2015-01-10"
]
},
"end": {
"type": "string",
"enum": [
"2016-01-10"
]
},
"note": {
"type": "string",
"enum": [
"Note"
]
},
"source": {
"type": "string",
"enum": [
"'Source'"
]
},
"bookingRequestId": {
"type": "string",
"enum": [
"'7980'"
]
}
},
"required": [
"start",
"end"
],
"additionalProperties": false
}
}Response
204Headers
Content-Type: application/jsonResponse
401Headers
Content-Type: application/jsonBody
{
"detail": "Unauthorized user",
"status": 401,
"title": "Unauthorized",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
404Headers
Content-Type: application/jsonBody
{
"detail": "The resource was not found",
"status": 404,
"title": "Not Found",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
500Headers
Content-Type: application/jsonBody
{
"detail": "Internal Server Error",
"status": 500,
"title": "Internal Server Error",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Listing Last Availabilities Date ¶
Refresh Availabilities DatePUT/listings/{listingId}/last-availabilities-date
Example URI
PUT https://monolith.spotahome.com/api/listings/12345/last-availabilities-date
URI Parameters
- listingId
number(required) Example: 12345
Request
Headers
Content-Type: application/json
Authorization: aa.bb.cc
Requester: user@email.comResponse
204Headers
Content-Type: application/jsonResponse
401Headers
Content-Type: application/jsonBody
{
"detail": "Unauthorized user",
"status": 401,
"title": "Unauthorized",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
404Headers
Content-Type: application/jsonBody
{
"detail": "The resource was not found",
"status": 404,
"title": "Not Found",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
500Headers
Content-Type: application/jsonBody
{
"detail": "Internal Server Error",
"status": 500,
"title": "Internal Server Error",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Listing Availabilities ¶
Get Listing AvailabilitiesGET/api/listings/{listingId}/availabilities
Retrieve the availability information for a specific listing.
Example URI
GET https://monolith.spotahome.com/api/api/listings/12345/availabilities
URI Parameters
- listingId
number(required) Example: 12345The ID of the listing to retrieve availabilities for.
Request
Headers
Content-Type: application/json
Authorization: aa.bb.ccResponse
200Headers
Content-Type: application/jsonBody
{
"listingId": 79951,
"availability": [
{
"moveInFrom": {
"date": "2024-08-02 00:00:00.000000",
"timezone_type": 3,
"timezone": "UTC"
},
"moveInTo": {
"date": "2024-09-01 00:00:00.000000",
"timezone_type": 3,
"timezone": "UTC"
},
"moveOutFrom": {
"date": "2024-09-01 00:00:00.000000",
"timezone_type": 3,
"timezone": "UTC"
},
"moveOutTo": {
"date": "2024-09-29 00:00:00.000000",
"timezone_type": 3,
"timezone": "UTC"
},
"minStay": 30,
"maxStay": 60
}
],
"firstAvailableDate": "2024-08-02"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"listingId": {
"type": "number",
"description": "The ID of the listing."
},
"availability": {
"type": "array",
"description": "Array of availability ranges."
},
"firstAvailableDate": {
"type": "string",
"description": "The first available date in `YYYY-MM-DD` format."
}
}
}Response
401Headers
Content-Type: application/jsonBody
{
"detail": "Unauthorized user",
"status": 401,
"title": "Unauthorized",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
403Headers
Content-Type: application/jsonBody
{
"detail": "Forbidden access",
"status": 403,
"title": "Forbidden",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
404Headers
Content-Type: application/jsonBody
{
"detail": "The resource was not found",
"status": 404,
"title": "Not Found",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Listing Commission ¶
Change Listing CommissionPUT/listings/{listingId}/landlord-commission
Example URI
PUT https://monolith.spotahome.com/api/listings/12345/landlord-commission
URI Parameters
- listingId
number(required) Example: 12345
Request
Headers
Content-Type: application/jsonBody
{
"type": "fixed",
"value": 10.4
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"fixed",
"percentage"
]
},
"value": {
"type": "number"
}
},
"required": [
"type"
]
}Response
204Headers
Content-Type: application/jsonResponse
401Headers
Content-Type: application/jsonBody
{
"detail": "Unauthorized user",
"status": 401,
"title": "Unauthorized",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
404Headers
Content-Type: application/jsonBody
{
"detail": "The resource was not found",
"status": 404,
"title": "Not Found",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
422Headers
Content-Type: application/jsonBody
{
"detail": "The request was well formed but was unable to be followed due to semantic errors",
"status": 422,
"title": "Unprocessable Entity",
"type": "`http://www.w3.org/Protocols/rfc2616/rfc2616",
"validationMessages": {
"field": {
"stringLength": "The input is less than 6 characters long"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string",
"description": "sec10.html (string, required)"
},
"validationMessages": {
"type": "object",
"properties": {
"field": {
"type": "object",
"properties": {
"stringLength": {
"type": "string"
}
},
"required": [
"stringLength"
]
}
},
"description": "Contains a property for each field that failed validation."
}
},
"required": [
"detail",
"status",
"title"
]
}Response
500Headers
Content-Type: application/jsonBody
{
"detail": "Internal Server Error",
"status": 500,
"title": "Internal Server Error",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Exclusivity type ¶
Update exclusivity typePUT/listings/{id}/exclusivity-type
Example URI
PUT https://monolith.spotahome.com/api/listings/200089/exclusivity-type
URI Parameters
- id
number(required) Example: 200089
Request
Headers
Authorization: aa.bb.ccBody
{
"type": "basic"
}Schema
{
"type": "object",
"properties": {
"type": {
"enum": [
"basic",
"exclusive",
"guaranteed"
]
}
},
"required": [
"type"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Response
204Response
400Headers
Content-Type: application/jsonBody
{
"detail": "The request could not be understood by the server due to malformed syntax",
"status": 400,
"title": "Bad Request",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
401Headers
Content-Type: application/jsonBody
{
"detail": "Unauthorized user",
"status": 401,
"title": "Unauthorized",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
404Headers
Content-Type: application/jsonBody
{
"detail": "The resource was not found",
"status": 404,
"title": "Not Found",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
500Headers
Content-Type: application/jsonBody
{
"detail": "Internal Server Error",
"status": 500,
"title": "Internal Server Error",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Exclusivity types ¶
Fetch all exclusivity typesGET/listings/legacy/exclusivity-types
Example URI
GET https://monolith.spotahome.com/api/listings/legacy/exclusivity-types
Request
Headers
Authorization: aa.bb.ccResponse
200Headers
Content-Type: application/jsonBody
{
"count": 1,
"total": 2,
"_links": {
"self": {
"href": "/api/listings/exclusivity-types?page=1"
},
"first": {
"href": "/api/listings/exclusivity-types?page=1"
},
"last": {
"href": "/api/listings/exclusivity-types?page=2"
},
"next": {
"href": "/api/listings/exclusivity-types?page=1"
},
"previous": {
"href": "/api/listings/exclusivity-types?page=2"
}
},
"_embedded": {
"sah:real_state:listing:exclusivity_types": [
{
"type": "basic"
}
]
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"count": {
"type": "number"
},
"total": {
"type": "number"
},
"_links": {
"type": "object",
"properties": {
"self": {
"type": "object",
"properties": {
"href": {
"type": "string"
}
},
"required": [
"href"
]
},
"first": {
"type": "object",
"properties": {
"href": {
"type": "string"
}
},
"required": [
"href"
]
},
"last": {
"type": "object",
"properties": {
"href": {
"type": "string"
}
},
"required": [
"href"
]
},
"next": {
"type": "object",
"properties": {
"href": {
"type": "string"
}
},
"required": [
"href"
]
},
"previous": {
"type": "object",
"properties": {
"href": {
"type": "string"
}
},
"required": [
"href"
]
}
},
"required": [
"self",
"first",
"last"
]
},
"_embedded": {
"type": "object",
"properties": {
"sah:real_state:listing:exclusivity_types": {
"type": "array"
}
}
}
},
"required": [
"count",
"total",
"_links"
]
}Response
401Headers
Content-Type: application/jsonBody
{
"detail": "Unauthorized user",
"status": 401,
"title": "Unauthorized",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
500Headers
Content-Type: application/jsonBody
{
"detail": "Internal Server Error",
"status": 500,
"title": "Internal Server Error",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Feed Id ¶
View feed idGET/listings/legacy/{id}/feed-id
Example URI
GET https://monolith.spotahome.com/api/listings/legacy/200089/feed-id
URI Parameters
- id
number(required) Example: 200089
Request
Headers
Authorization: aa.bb.ccResponse
200Body
{
"feedId": "http://urltointegrationfeed.com"
}Schema
{
"type": "object",
"properties": {
"feedId": {
"type": [
"string",
"null"
]
}
},
"required": [
"feedId"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Response
401Headers
Content-Type: application/jsonBody
{
"detail": "Unauthorized user",
"status": 401,
"title": "Unauthorized",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
404Headers
Content-Type: application/jsonBody
{
"detail": "The resource was not found",
"status": 404,
"title": "Not Found",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
500Headers
Content-Type: application/jsonBody
{
"detail": "Internal Server Error",
"status": 500,
"title": "Internal Server Error",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Update feed idPUT/listings/legacy/{id}/feed-id
Example URI
PUT https://monolith.spotahome.com/api/listings/legacy/200089/feed-id
URI Parameters
- id
number(required) Example: 200089
Request
Headers
Authorization: aa.bb.ccBody
{
"feedId": "Hello, world!"
}Schema
{
"type": "object",
"properties": {
"feedId": {
"type": "string"
}
},
"required": [
"feedId"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Response
204Response
400Headers
Content-Type: application/jsonBody
{
"detail": "The request could not be understood by the server due to malformed syntax",
"status": 400,
"title": "Bad Request",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
401Headers
Content-Type: application/jsonBody
{
"detail": "Unauthorized user",
"status": 401,
"title": "Unauthorized",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
404Headers
Content-Type: application/jsonBody
{
"detail": "The resource was not found",
"status": 404,
"title": "Not Found",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
500Headers
Content-Type: application/jsonBody
{
"detail": "Internal Server Error",
"status": 500,
"title": "Internal Server Error",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Properties ¶
Properties ¶
Legacy Get properties by logged userGET/listings/legacy/properties{?page,itemsPerPage,isPublished,landlordId}
Example URI
GET https://monolith.spotahome.com/api/listings/legacy/properties?page=1&itemsPerPage=100&isPublished=true&landlordId=aaaa-bbbb-cccc-dddd
URI Parameters
- page
number(optional) Example: 1- itemsPerPage
number(optional) Example: 100- isPublished
boolean(optional) Example: true- landlordId
string(optional) Example: aaaa-bbbb-cccc-dddd
Request
Headers
Content-Type: application/json
Authorization: aa.bb.cc
Requester: requester@spotahome.comResponse
200Headers
Content-Type: application/jsonBody
{
"count": 1,
"total": 2,
"_links": {
"self": {
"href": "/api/listings/legacy/properties?page=1"
},
"first": {
"href": "/api/listings/legacy/properties?page=1"
},
"last": {
"href": "/api/listings/legacy/properties?page=2"
},
"next": {
"href": "/api/listings/legacy/properties?page=1"
},
"previous": {
"href": "/api/listings/legacy/properties?page=2"
}
},
"_embedded": {
"properties": [
{
"id": 117067
}
]
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"count": {
"type": "number"
},
"total": {
"type": "number"
},
"_links": {
"type": "object",
"properties": {
"self": {
"type": "object",
"properties": {
"href": {
"type": "string"
}
},
"required": [
"href"
]
},
"first": {
"type": "object",
"properties": {
"href": {
"type": "string"
}
},
"required": [
"href"
]
},
"last": {
"type": "object",
"properties": {
"href": {
"type": "string"
}
},
"required": [
"href"
]
},
"next": {
"type": "object",
"properties": {
"href": {
"type": "string"
}
}
},
"previous": {
"type": "object",
"properties": {
"href": {
"type": "string"
}
}
}
},
"required": [
"self",
"first",
"last",
"next",
"previous"
]
},
"_embedded": {
"type": "object",
"properties": {
"properties": {
"type": "array"
}
}
}
},
"required": [
"count",
"total",
"_links"
]
}Response
401Headers
Content-Type: application/jsonBody
{
"detail": "Unauthorized user",
"status": 401,
"title": "Unauthorized",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
500Headers
Content-Type: application/jsonBody
{
"detail": "Internal Server Error",
"status": 500,
"title": "Internal Server Error",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Legacy Details ¶
Update detailsPUT/listings/legacy/properties/{id}/details
Example URI
PUT https://monolith.spotahome.com/api/listings/legacy/properties/2ae880c4-8eda-4118-86ec-ac1679ef62fe/details
URI Parameters
- id
string(required) Example: 2ae880c4-8eda-4118-86ec-ac1679ef62fe
Request
Headers
Authorization: aa.bb.ccBody
{
"landlordReference": "\"Beach house\"",
"area": 120,
"numberBathrooms": 2,
"minStay": 30,
"maxStay": 60
}Schema
{
"type": "object",
"properties": {
"landlordReference": {
"type": [
"string",
"null"
]
},
"area": {
"type": [
"number",
"null"
]
},
"numberBathrooms": {
"type": [
"number",
"null"
]
},
"minStay": {
"type": [
"number",
"null"
]
},
"maxStay": {
"type": [
"number",
"null"
]
}
},
"$schema": "http://json-schema.org/draft-04/schema#"
}Response
204Response
401Headers
Content-Type: application/jsonBody
{
"detail": "Unauthorized user",
"status": 401,
"title": "Unauthorized",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
500Headers
Content-Type: application/jsonBody
{
"detail": "Internal Server Error",
"status": 500,
"title": "Internal Server Error",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}View detailsGET/listings/legacy/properties/{id}/details
Example URI
GET https://monolith.spotahome.com/api/listings/legacy/properties/2ae880c4-8eda-4118-86ec-ac1679ef62fe/details
URI Parameters
- id
string(required) Example: 2ae880c4-8eda-4118-86ec-ac1679ef62fe
Request
Headers
Authorization: aa.bb.ccResponse
200Headers
Content-Type: application/jsonBody
[
{
"unitId": "12345",
"landlordReference": "Beach house",
"area": 120,
"numberBathrooms": 2,
"minStay": 30,
"maxStay": 60,
"floorPlanReference": 2
}
]Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array",
"items": {
"type": "object",
"properties": {
"unitId": {
"type": "string",
"enum": [
"12345"
]
},
"landlordReference": {
"type": [
"string",
"null"
],
"enum": [
"Beach house",
null
]
},
"area": {
"type": [
"number",
"null"
],
"enum": [
120,
null
]
},
"numberBathrooms": {
"type": [
"number",
"null"
],
"enum": [
2,
null
]
},
"minStay": {
"type": [
"number",
"null"
],
"enum": [
30,
null
]
},
"maxStay": {
"type": [
"number",
"null"
],
"enum": [
60,
null
]
},
"floorPlanReference": {
"type": [
"number",
"null"
],
"enum": [
2,
null
]
}
},
"required": [
"unitId",
"landlordReference",
"area",
"maxStay"
],
"additionalProperties": false
}
}Response
401Headers
Content-Type: application/jsonBody
{
"detail": "Unauthorized user",
"status": 401,
"title": "Unauthorized",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
500Headers
Content-Type: application/jsonBody
{
"detail": "Internal Server Error",
"status": 500,
"title": "Internal Server Error",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Stay rules ¶
Update stay rulesPUT/listings/legacy/properties/{id}/stay-rules
Example URI
PUT https://monolith.spotahome.com/api/listings/legacy/properties/1234/stay-rules
URI Parameters
- id
number(required) Example: 1234
Request
Headers
Authorization: aa.bb.ccBody
{
"minStay": 30,
"maxStay": 60
}Schema
{
"type": "object",
"properties": {
"minStay": {
"type": [
"number",
"null"
]
},
"maxStay": {
"type": [
"number",
"null"
]
}
},
"required": [
"minStay",
"maxStay"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Response
204Response
401Headers
Content-Type: application/jsonBody
{
"detail": "Unauthorized user",
"status": 401,
"title": "Unauthorized",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
404Headers
Content-Type: application/jsonBody
{
"detail": "The resource was not found",
"status": 404,
"title": "Not Found",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
422Headers
Content-Type: application/jsonBody
{
"detail": "The request was well formed but was unable to be followed due to semantic errors",
"status": 422,
"title": "Unprocessable Entity",
"type": "`http://www.w3.org/Protocols/rfc2616/rfc2616",
"validationMessages": {
"field": {
"stringLength": "The input is less than 6 characters long"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string",
"description": "sec10.html (string, required)"
},
"validationMessages": {
"type": "object",
"properties": {
"field": {
"type": "object",
"properties": {
"stringLength": {
"type": "string"
}
},
"required": [
"stringLength"
]
}
},
"description": "Contains a property for each field that failed validation."
}
},
"required": [
"detail",
"status",
"title"
]
}Response
500Headers
Content-Type: application/jsonBody
{
"detail": "Internal Server Error",
"status": 500,
"title": "Internal Server Error",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Floor plan reference ¶
Update floor plan referencePUT/api/listings/legacy/properties/units/{id}/floor-plan-reference
Example URI
PUT https://monolith.spotahome.com/api/api/listings/legacy/properties/units/1234/floor-plan-reference
URI Parameters
- id
number(required) Example: 1234
Request
Headers
Authorization: aa.bb.ccBody
{
"floorPlanReference": 30
}Schema
{
"type": "object",
"properties": {
"floorPlanReference": {
"type": "number",
"description": "0 means 'No reference'"
}
},
"required": [
"floorPlanReference"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Response
204Response
401Headers
Content-Type: application/jsonBody
{
"detail": "Unauthorized user",
"status": 401,
"title": "Unauthorized",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
404Headers
Content-Type: application/jsonBody
{
"detail": "The resource was not found",
"status": 404,
"title": "Not Found",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
500Headers
Content-Type: application/jsonBody
{
"detail": "Internal Server Error",
"status": 500,
"title": "Internal Server Error",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Details ¶
Bulk units details updatePUT/listings/legacy/properties/{id}/units/details
Example URI
PUT https://monolith.spotahome.com/api/listings/legacy/properties/12345/units/details
URI Parameters
- id
string(required) Example: 12345
Request
Headers
Authorization: aa.bb.ccBody
[
{
"unitId": "12346",
"landlordReference": "Beach house",
"area": 120,
"numberBathrooms": 1,
"minStay": 30,
"maxStay": 180,
"floorPlanReference": 1
}
]Schema
{
"type": "array",
"items": {
"type": "object",
"properties": {
"unitId": {
"type": "string"
},
"landlordReference": {
"type": "string"
},
"area": {
"type": [
"number",
"null"
]
},
"numberBathrooms": {
"type": "number",
"description": "Required for the unit whole"
},
"minStay": {
"type": "number",
"description": "Required for the unit whole"
},
"maxStay": {
"type": "number",
"description": "Required for the unit whole"
},
"floorPlanReference": {
"type": "number",
"description": "Required for non-whole units, 0 means 'No reference'"
}
},
"required": [
"unitId",
"landlordReference",
"area",
"numberBathrooms",
"floorPlanReference"
]
},
"$schema": "http://json-schema.org/draft-04/schema#"
}Response
204Response
401Headers
Content-Type: application/jsonBody
{
"detail": "Unauthorized user",
"status": 401,
"title": "Unauthorized",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
404Headers
Content-Type: application/jsonBody
{
"detail": "The resource was not found",
"status": 404,
"title": "Not Found",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
500Headers
Content-Type: application/jsonBody
{
"detail": "Internal Server Error",
"status": 500,
"title": "Internal Server Error",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Units Changelog ¶
View unit changelogGET/listings/legacy/units/{id}/changelog
Example URI
GET https://monolith.spotahome.com/api/listings/legacy/units/aaaa-bbbb-cccc-dddd/changelog
URI Parameters
- id
string(required) Example: aaaa-bbbb-cccc-dddd
Request
Headers
Authorization: aa.bb.ccResponse
200Headers
Content-Type: application/jsonBody
[
{
"changed_by": "user@spotahome.com",
"occurred_on": "2017-06-05T11:56:30+00:00",
"change_type": "SAH\\RealEstate\\Domain\\Ad\\AdWasUnpublished",
"before": "Hello, world!",
"after": "Hello, world!"
}
]Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array",
"items": {
"type": "object",
"properties": {
"changed_by": {
"type": "string",
"enum": [
"user@spotahome.com"
]
},
"occurred_on": {
"type": "string",
"enum": [
"2017-06-05T11:56:30+00:00"
]
},
"change_type": {
"type": "string",
"enum": [
"SAH\\RealEstate\\Domain\\Ad\\AdWasUnpublished"
]
},
"before": {
"type": "string",
"enum": [
""
],
"description": "It can be empty. Mixed type (object, string, number)"
},
"after": {
"type": "string",
"enum": [
""
],
"description": "It can be empty. Mixed type (object, string, number)"
}
},
"required": [
"changed_by",
"occurred_on",
"change_type",
"before",
"after"
],
"additionalProperties": false
}
}Response
401Headers
Content-Type: application/jsonBody
{
"detail": "Unauthorized user",
"status": 401,
"title": "Unauthorized",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
500Headers
Content-Type: application/jsonBody
{
"detail": "Internal Server Error",
"status": 500,
"title": "Internal Server Error",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Photos ¶
Taxonomies ¶
View all taxonomiesGET/listings/legacy/photos/taxonomies/{propertyType}
Example URI
GET https://monolith.spotahome.com/api/listings/legacy/photos/taxonomies/apartment
URI Parameters
- propertyType
string(required) Example: apartment-
apartment
-
studio
-
roomShared
-
residence
-
Request
Headers
Authorization: aa.bb.ccResponse
200Headers
Content-Type: application/jsonBody
[
{
"name": "Bedroom",
"key": "bedroom",
"property_type": 100
},
{
"name": "Kitchen",
"key": "kitchen",
"property_type": 100
}
]Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array",
"items": [
{
"type": "object",
"properties": {
"name": {
"type": "string",
"enum": [
"Bedroom"
]
},
"key": {
"type": "string",
"enum": [
"bedroom"
]
},
"property_type": {
"type": "number",
"enum": [
100
]
}
},
"required": [
"name",
"key",
"property_type"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"name": {
"type": "string",
"enum": [
"Kitchen"
]
},
"key": {
"type": "string",
"enum": [
"kitchen"
]
},
"property_type": {
"type": "number",
"enum": [
100
]
}
},
"required": [
"name",
"key",
"property_type"
],
"additionalProperties": false
}
]
}Response
400Headers
Content-Type: application/jsonBody
{
"detail": "The request could not be understood by the server due to malformed syntax",
"status": 400,
"title": "Bad Request",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
401Headers
Content-Type: application/jsonBody
{
"detail": "Unauthorized user",
"status": 401,
"title": "Unauthorized",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
500Headers
Content-Type: application/jsonBody
{
"detail": "Internal Server Error",
"status": 500,
"title": "Internal Server Error",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Albums ¶
View all albumsGET/listings/legacy/photos/albums{?propertyId}
Example URI
GET https://monolith.spotahome.com/api/listings/legacy/photos/albums?propertyId=79980
URI Parameters
- propertyId
number(required) Example: 79980
Request
Headers
Authorization: aa.bb.ccResponse
200Headers
Content-Type: application/jsonBody
[
{
"id": 4095,
"homeCheckerEmail": "homer@springfield.com"
}
]Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number",
"enum": [
4095
]
},
"homeCheckerEmail": {
"type": "string",
"enum": [
"homer@springfield.com"
]
}
},
"required": [
"id",
"homeCheckerEmail"
],
"additionalProperties": false
}
}Response
401Headers
Content-Type: application/jsonBody
{
"detail": "Unauthorized user",
"status": 401,
"title": "Unauthorized",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
500Headers
Content-Type: application/jsonBody
{
"detail": "Internal Server Error",
"status": 500,
"title": "Internal Server Error",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Photos ¶
View all photosGET/listings/legacy/photos{?albumId,category}
Example URI
GET https://monolith.spotahome.com/api/listings/legacy/photos?albumId=21631&category=verified
URI Parameters
- albumId
number(required) Example: 21631- category
string(optional) Example: verified-
verified -
nonVerified -
floorPlan -
theta360
-
Request
Headers
Authorization: aa.bb.ccResponse
200Headers
Content-Type: application/jsonBody
[
{
"id": "3a0483f82ee644d1a18830e018b7c15b44062b9c229f72140bc207a1",
"category": "verified",
"caption": "Living room",
"thumbnailUrl": "https://sah-dev-photos-resized.s3-eu-west-1.amazonaws.com/pt_200_100/3a0483f82ee644d1a18830e018b7c15b44062b9c229f72140bc207a1.jpg",
"detailUrl": "https://sah-dev-photos-resized.s3-eu-west-1.amazonaws.com/fsosw_960_540_verified_ur_6_50/3a0483f82ee644d1a18830e018b7c15b44062b9c229f72140bc207a1.jpg"
}
]Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"enum": [
"3a0483f82ee644d1a18830e018b7c15b44062b9c229f72140bc207a1"
]
},
"category": {
"type": "string",
"enum": [
"verified",
"nonVerified",
"floorPlan",
"theta360"
]
},
"caption": {
"type": "string",
"enum": [
"Living room"
]
},
"thumbnailUrl": {
"type": "string",
"enum": [
"https://sah-dev-photos-resized.s3-eu-west-1.amazonaws.com/pt_200_100/3a0483f82ee644d1a18830e018b7c15b44062b9c229f72140bc207a1.jpg"
]
},
"detailUrl": {
"type": "string",
"enum": [
"https://sah-dev-photos-resized.s3-eu-west-1.amazonaws.com/fsosw_960_540_verified_ur_6_50/3a0483f82ee644d1a18830e018b7c15b44062b9c229f72140bc207a1.jpg"
]
}
},
"required": [
"id",
"category",
"caption",
"thumbnailUrl",
"detailUrl"
],
"additionalProperties": false
}
}Response
401Headers
Content-Type: application/jsonBody
{
"detail": "Unauthorized user",
"status": 401,
"title": "Unauthorized",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
500Headers
Content-Type: application/jsonBody
{
"detail": "Internal Server Error",
"status": 500,
"title": "Internal Server Error",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Listing Photos ¶
Replace Property Photos AsyncPUT/listings/{propertyId}/photos
Update the photos for a specific property and replaces all previous photos.
Example URI
PUT https://monolith.spotahome.com/api/listings/12345/photos
URI Parameters
- propertyId
number(required) Example: 12345The ID of the property to update photos for.
Request
Headers
Content-Type: application/json
Authorization: aa.bb.ccBody
{
"photos": [
{
"url": "https://photos.spotahome.com/fsobscale_1600_900_nonverified_ur_15_50/0247ece1869ef745937aa44d751e53ffb2132e69a76b97a2d8de5d90.jpg",
"caption": "This is a caption",
"taxonomy": "Other",
"listingId": "33333"
},
{
"url": "https://photos.spotahome.com/fsobscale_1600_900_nonverified_ur_15_50/aa7ebaca8e5e2a154b3265611b3b44167458b0030cdb65934370d285.jpg",
"caption": "This is a caption",
"taxonomy": "Other",
"listingId": "11111",
"isPrincipal": true
}
]
}Response
202Headers
Content-Type: application/jsonResponse
401Headers
Content-Type: application/jsonBody
{
"detail": "Unauthorized user",
"status": 401,
"title": "Unauthorized",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
403Headers
Content-Type: application/jsonBody
{
"detail": "Forbidden access",
"status": 403,
"title": "Forbidden",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Property photos ¶
View property photosGET/listings/legacy/properties/{id}/photos
Example URI
GET https://monolith.spotahome.com/api/listings/legacy/properties/200089/photos
URI Parameters
- id
number(required) Example: 200089
Request
Headers
Authorization: aa.bb.ccResponse
200Body
[
{
"id": "3a0483f82ee644d1a18830e018b7c15b44062b9c229f72140bc207a1",
"category": "verified",
"caption": "Living room",
"taxonomy": "bedroom",
"principal": true,
"checkedBy": false,
"unitId": "123456",
"thumbnailUrl": "https://sah-dev-photos-resized.s3-eu-west-1.amazonaws.com/pt_200_100/3a0483f82ee644d1a18830e018b7c15b44062b9c229f72140bc207a1.jpg",
"detailUrl": "https://sah-dev-photos-resized.s3-eu-west-1.amazonaws.com/fsosw_960_540_verified_ur_6_50/3a0483f82ee644d1a18830e018b7c15b44062b9c229f72140bc207a1.jpg"
}
]Schema
{
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"category": {
"enum": [
"verified",
"nonVerified",
"floorPlan",
"theta360"
]
},
"caption": {
"type": "string"
},
"taxonomy": {
"enum": [
"bedroom",
"balcony",
"terrace",
"street-view",
"living-room",
"checked-by",
"corridor",
"kitchen",
"bathroom",
"ensuite-bathroom",
"garden",
"parking",
"building",
"guest-room",
"tenants-living-room",
"tenants-kitchen",
"tenants-bathroom",
"shower",
"toilet",
"view",
"patio-terrace",
"courtyard",
"stairs",
"loft",
"storage",
"entrance-hall",
"swimming-pool",
"other",
"uncategorized",
"residence-bedroom",
"residence-studio",
"residence-ensuite",
"residence-bathroom",
"residence-living-room",
"residence-view-from-window",
"residence-kitchen",
"residence-corridor",
"residence-entrance",
"residence-hallway",
"residence-checked-by",
"residence-restaurant",
"residence-cafeteria",
"residence-bar",
"residence-nightclub",
"residence-games-hall",
"residence-library",
"residence-swimming-pool",
"residence-gym",
"residence-library-study-area",
"residence-concierge",
"residence-reception",
"residence-common-area",
"residence-lounge",
"residence-quite-lounge",
"residence-study-room",
"residence-study-area",
"residence-tv-room",
"residence-cinema",
"residence-entertainment-zone",
"residence-outdoor-area",
"residence-garden",
"residence-laundry",
"residence-recreation-room",
"residence-first-aid-room",
"residence-other"
],
"type": [
null,
"null"
]
},
"principal": {
"type": "boolean"
},
"checkedBy": {
"type": "boolean"
},
"unitId": {
"type": "string"
},
"thumbnailUrl": {
"type": "string"
},
"detailUrl": {
"type": "string"
}
},
"required": [
"id",
"category",
"caption",
"taxonomy",
"principal",
"checkedBy",
"unitId",
"thumbnailUrl",
"detailUrl"
]
},
"$schema": "http://json-schema.org/draft-04/schema#"
}Response
401Headers
Content-Type: application/jsonBody
{
"detail": "Unauthorized user",
"status": 401,
"title": "Unauthorized",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
404Headers
Content-Type: application/jsonBody
{
"detail": "The resource was not found",
"status": 404,
"title": "Not Found",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
500Headers
Content-Type: application/jsonBody
{
"detail": "Internal Server Error",
"status": 500,
"title": "Internal Server Error",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Update property photosPUT/listings/legacy/properties/{id}/photos
Example URI
PUT https://monolith.spotahome.com/api/listings/legacy/properties/200089/photos
URI Parameters
- id
number(required) Example: 200089
Request
Headers
Authorization: aa.bb.ccBody
[
{
"category": "verified",
"photos": [
{
"id": "3a0483f82ee644d1a18830e018b7c15b44062b9c229f72140bc207a1",
"caption": "Bedroom",
"taxonomy": "bedroom",
"principal": true,
"checkedBy": false
}
]
}
]Schema
{
"type": "array",
"items": {
"type": "object",
"properties": {
"category": {
"enum": [
"verified",
"nonVerified",
"floorPlan",
"theta360"
]
},
"photos": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"caption": {
"type": [
"string",
"null"
]
},
"taxonomy": {
"enum": [
"bedroom",
"balcony",
"terrace",
"street-view",
"living-room",
"checked-by",
"corridor",
"kitchen",
"bathroom",
"ensuite-bathroom",
"garden",
"parking",
"building",
"guest-room",
"tenants-living-room",
"tenants-kitchen",
"tenants-bathroom",
"shower",
"toilet",
"view",
"patio-terrace",
"courtyard",
"stairs",
"loft",
"storage",
"entrance-hall",
"swimming-pool",
"other",
"uncategorized",
"residence-bedroom",
"residence-studio",
"residence-ensuite",
"residence-bathroom",
"residence-living-room",
"residence-view-from-window",
"residence-kitchen",
"residence-corridor",
"residence-entrance",
"residence-hallway",
"residence-checked-by",
"residence-restaurant",
"residence-cafeteria",
"residence-bar",
"residence-nightclub",
"residence-games-hall",
"residence-library",
"residence-swimming-pool",
"residence-gym",
"residence-library-study-area",
"residence-concierge",
"residence-reception",
"residence-common-area",
"residence-lounge",
"residence-quite-lounge",
"residence-study-room",
"residence-study-area",
"residence-tv-room",
"residence-cinema",
"residence-entertainment-zone",
"residence-outdoor-area",
"residence-garden",
"residence-laundry",
"residence-recreation-room",
"residence-first-aid-room",
"residence-other"
],
"type": [
null,
"null"
]
},
"principal": {
"type": "boolean"
},
"checkedBy": {
"type": "boolean"
}
},
"required": [
"id",
"caption",
"taxonomy",
"principal",
"checkedBy"
]
}
}
},
"required": [
"category",
"photos"
]
},
"$schema": "http://json-schema.org/draft-04/schema#"
}Response
204Response
401Headers
Content-Type: application/jsonBody
{
"detail": "Unauthorized user",
"status": 401,
"title": "Unauthorized",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
404Headers
Content-Type: application/jsonBody
{
"detail": "The resource was not found",
"status": 404,
"title": "Not Found",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
500Headers
Content-Type: application/jsonBody
{
"detail": "Internal Server Error",
"status": 500,
"title": "Internal Server Error",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Copy property photos ¶
Copy property photosPOST/listings/legacy/properties/photos/copy
Example URI
POST https://monolith.spotahome.com/api/listings/legacy/properties/photos/copy
Request
Headers
Authorization: aa.bb.ccBody
{
"originalPropertyId": "200000",
"destinationPropertyIds": [
"200001",
"200002"
]
}Schema
{
"type": "object",
"properties": {
"originalPropertyId": {
"type": "string"
},
"destinationPropertyIds": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"originalPropertyId",
"destinationPropertyIds"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Response
202Response
401Headers
Content-Type: application/jsonBody
{
"detail": "Unauthorized user",
"status": 401,
"title": "Unauthorized",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
404Headers
Content-Type: application/jsonBody
{
"detail": "The resource was not found",
"status": 404,
"title": "Not Found",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
500Headers
Content-Type: application/jsonBody
{
"detail": "Internal Server Error",
"status": 500,
"title": "Internal Server Error",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Unit photos ¶
Update unit photosPUT/listings/legacy/properties/{propertyId}/units/{unitId}/photos
Example URI
PUT https://monolith.spotahome.com/api/listings/legacy/properties/200089/units/200089/photos
URI Parameters
- propertyId
number(required) Example: 200089- unitId
number(required) Example: 200089
Request
Headers
Authorization: aa.bb.ccBody
{
"photos": [
"1954a8700fe80ff031e55a44a8b6e8ae417383f9a8a441c34f75f6b3"
]
}Schema
{
"type": "object",
"properties": {
"photos": {
"type": "array",
"items": {
"type": "string"
},
"description": "It can be an empty array"
}
},
"required": [
"photos"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Response
204Response
401Headers
Content-Type: application/jsonBody
{
"detail": "Unauthorized user",
"status": 401,
"title": "Unauthorized",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
404Headers
Content-Type: application/jsonBody
{
"detail": "The resource was not found",
"status": 404,
"title": "Not Found",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
500Headers
Content-Type: application/jsonBody
{
"detail": "Internal Server Error",
"status": 500,
"title": "Internal Server Error",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Send property photos ¶
Send the property photos to the authenticated userPOST/listings/legacy/property/{propertyId}/photos/notification
Example URI
POST https://monolith.spotahome.com/api/listings/legacy/property/12345/photos/notification
URI Parameters
- propertyId
string(required) Example: 12345
Request
Headers
Authorization: aa.bb.ccResponse
204Response
401Headers
Content-Type: application/jsonBody
{
"detail": "Unauthorized user",
"status": 401,
"title": "Unauthorized",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
500Headers
Content-Type: application/jsonBody
{
"detail": "Internal Server Error",
"status": 500,
"title": "Internal Server Error",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Listing photos ¶
Assign to unitPOST/public/listings/{id}/photos
Example URI
POST https://monolith.spotahome.com/api/public/listings/12345/photos
URI Parameters
- id
string(required) Example: 12345
Request
Headers
Content-Type: application/json
Authorization: aa.bb.ccBody
{
"photoId": "e6b0ae7b5a5d3bfd189cf34a991cf77f62fa11ee646519be243be5d8"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"photoId": {
"type": "string"
}
},
"required": [
"photoId"
]
}Response
204Response
400Headers
Content-Type: application/jsonBody
{
"detail": "The request could not be understood by the server due to malformed syntax",
"status": 400,
"title": "Bad Request",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
401Headers
Content-Type: application/jsonBody
{
"detail": "Unauthorized user",
"status": 401,
"title": "Unauthorized",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
404Headers
Content-Type: application/jsonBody
{
"detail": "The resource was not found",
"status": 404,
"title": "Not Found",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
500Headers
Content-Type: application/jsonBody
{
"detail": "Internal Server Error",
"status": 500,
"title": "Internal Server Error",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Listing photos multiple ¶
Assign to unitsPOST/public/listings/photos/multiple
Example URI
POST https://monolith.spotahome.com/api/public/listings/photos/multiple
Request
Headers
Content-Type: application/json
Authorization: aa.bb.ccBody
{
"photos": [
{
"listingId": "12345",
"photoId": "adf45d949a029545dcb13b5d6228c140eb54d755fba2c82b04a88424"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"photos": {
"type": "array",
"items": {
"type": "object",
"properties": {
"listingId": {
"type": "string",
"enum": [
"12345"
]
},
"photoId": {
"type": "string",
"enum": [
"adf45d949a029545dcb13b5d6228c140eb54d755fba2c82b04a88424"
]
}
},
"required": [
"listingId",
"photoId"
],
"additionalProperties": false
}
}
},
"required": [
"photos"
]
}Response
204Response
400Headers
Content-Type: application/jsonBody
{
"detail": "The request could not be understood by the server due to malformed syntax",
"status": 400,
"title": "Bad Request",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
401Headers
Content-Type: application/jsonBody
{
"detail": "Unauthorized user",
"status": 401,
"title": "Unauthorized",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
404Headers
Content-Type: application/jsonBody
{
"detail": "The resource was not found",
"status": 404,
"title": "Not Found",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
409Headers
Content-Type: application/jsonBody
{
"detail": "The request could not be completed due to a conflict with the current state of the resource",
"status": 409,
"title": "Conflict",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Select principal photo ¶
Select principal photoPUT/listings/legacy/{id}/photo-principal
Example URI
PUT https://monolith.spotahome.com/api/listings/legacy/12345/photo-principal
URI Parameters
- id
string(required) Example: 12345
Request
Headers
Content-Type: application/json
Authorization: aa.bb.ccBody
{
"photoId": "e6b0ae7b5a5d3bfd189cf34a991cf77f62fa11ee646519be243be5d8"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"photoId": {
"type": "string"
}
},
"required": [
"photoId"
]
}Response
204Response
400Headers
Content-Type: application/jsonBody
{
"detail": "The request could not be understood by the server due to malformed syntax",
"status": 400,
"title": "Bad Request",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
401Headers
Content-Type: application/jsonBody
{
"detail": "Unauthorized user",
"status": 401,
"title": "Unauthorized",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
404Headers
Content-Type: application/jsonBody
{
"detail": "The resource was not found",
"status": 404,
"title": "Not Found",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
422Headers
Content-Type: application/jsonBody
{
"detail": "The request was well formed but was unable to be followed due to semantic errors",
"status": 422,
"title": "Unprocessable Entity",
"type": "`http://www.w3.org/Protocols/rfc2616/rfc2616",
"validationMessages": {
"field": {
"stringLength": "The input is less than 6 characters long"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string",
"description": "sec10.html (string, required)"
},
"validationMessages": {
"type": "object",
"properties": {
"field": {
"type": "object",
"properties": {
"stringLength": {
"type": "string"
}
},
"required": [
"stringLength"
]
}
},
"description": "Contains a property for each field that failed validation."
}
},
"required": [
"detail",
"status",
"title"
]
}Response
500Headers
Content-Type: application/jsonBody
{
"detail": "Internal Server Error",
"status": 500,
"title": "Internal Server Error",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Videos ¶
Albums ¶
View all albumsGET/listings/legacy/videos/albums{?propertyId}
Example URI
GET https://monolith.spotahome.com/api/listings/legacy/videos/albums?propertyId=129559
URI Parameters
- propertyId
number(required) Example: 129559
Request
Headers
Authorization: aa.bb.ccResponse
200Headers
Content-Type: application/jsonBody
[
{
"id": 13859,
"title": "129559",
"categoryReference": 129559,
"category": {
"id": 0,
"name": "Ad"
},
"isDraft": false,
"deleted": false,
"videos": [
{
"name": "13859 - 129559.mp4",
"extension": "video/mp4",
"md5": "17cd9043-7ae0-4b0d-8f20-68005d0d16d3",
"state": "Published"
}
]
}
]Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number",
"enum": [
13859
]
},
"title": {
"type": "string",
"enum": [
"129559"
]
},
"categoryReference": {
"type": "number",
"enum": [
129559
]
},
"category": {
"type": "object",
"properties": {
"id": {
"type": "number",
"enum": [
0
]
},
"name": {
"type": "string",
"enum": [
"Ad"
]
}
},
"required": [
"id",
"name"
],
"additionalProperties": false
},
"isDraft": {
"type": "boolean",
"enum": [
false
]
},
"deleted": {
"type": [
"boolean",
"null"
],
"enum": [
false,
null
]
},
"videos": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"enum": [
"13859 - 129559.mp4"
]
},
"extension": {
"type": "string",
"enum": [
"video/mp4"
]
},
"md5": {
"type": "string",
"enum": [
"17cd9043-7ae0-4b0d-8f20-68005d0d16d3"
]
},
"state": {
"type": "string",
"enum": [
"Published"
]
}
},
"required": [
"name",
"extension",
"md5",
"state"
],
"additionalProperties": false
}
}
},
"required": [
"id",
"title",
"categoryReference",
"category",
"isDraft",
"deleted",
"videos"
],
"additionalProperties": false
}
}Response
401Headers
Content-Type: application/jsonBody
{
"detail": "Unauthorized user",
"status": 401,
"title": "Unauthorized",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
500Headers
Content-Type: application/jsonBody
{
"detail": "Internal Server Error",
"status": 500,
"title": "Internal Server Error",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Album ¶
View albumGET/listings/legacy/videos/albums/{id}
Example URI
GET https://monolith.spotahome.com/api/listings/legacy/videos/albums/21631
URI Parameters
- id
number(required) Example: 21631
Request
Headers
Authorization: aa.bb.ccResponse
200Headers
Content-Type: application/jsonBody
[
{
"id": "0a649e71-6797-42d3-ad32-ce0cc06ca065",
"name": "97 - spotahome-header.mp4",
"platforms": [
{
"providerName": "youtube",
"providerId": "lFqo29zVfHY",
"url": "https://youtu.be/lFqo29zVfHY"
}
]
}
]Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"enum": [
"0a649e71-6797-42d3-ad32-ce0cc06ca065"
]
},
"name": {
"type": "string",
"enum": [
"97 - spotahome-header.mp4"
]
},
"platforms": {
"type": "array",
"items": {
"type": "object",
"properties": {
"providerName": {
"type": "string",
"enum": [
"youtube"
]
},
"providerId": {
"type": "string",
"enum": [
"lFqo29zVfHY"
]
},
"url": {
"type": "string",
"enum": [
"https://youtu.be/lFqo29zVfHY"
]
}
},
"required": [
"providerName",
"providerId",
"url"
],
"additionalProperties": false
}
}
},
"required": [
"id",
"name",
"platforms"
],
"additionalProperties": false
}
}Response
401Headers
Content-Type: application/jsonBody
{
"detail": "Unauthorized user",
"status": 401,
"title": "Unauthorized",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
500Headers
Content-Type: application/jsonBody
{
"detail": "Internal Server Error",
"status": 500,
"title": "Internal Server Error",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Property videos ¶
View property videosGET/listings/legacy/properties/{id}/videos
Example URI
GET https://monolith.spotahome.com/api/listings/legacy/properties/200089/videos
URI Parameters
- id
number(required) Example: 200089
Request
Headers
Authorization: aa.bb.ccResponse
200Body
[
{
"id": "17cd9043-7ae0-4b0d-8f20-68005d0d16d3",
"externalId": "wuIiXayM0xU",
"provider": "youtube"
}
]Schema
{
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"externalId": {
"type": "string"
},
"provider": {
"enum": [
"youtube"
]
}
},
"required": [
"id",
"externalId",
"provider"
]
},
"$schema": "http://json-schema.org/draft-04/schema#"
}Response
401Headers
Content-Type: application/jsonBody
{
"detail": "Unauthorized user",
"status": 401,
"title": "Unauthorized",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
404Headers
Content-Type: application/jsonBody
{
"detail": "The resource was not found",
"status": 404,
"title": "Not Found",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
500Headers
Content-Type: application/jsonBody
{
"detail": "Internal Server Error",
"status": 500,
"title": "Internal Server Error",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Update property videosPUT/listings/legacy/properties/{id}/videos
Example URI
PUT https://monolith.spotahome.com/api/listings/legacy/properties/200089/videos
URI Parameters
- id
number(required) Example: 200089
Request
Headers
Authorization: aa.bb.ccBody
{
"videos": [
"17cd9043-7ae0-4b0d-8f20-68005d0d16d3"
]
}Schema
{
"type": "object",
"properties": {
"videos": {
"type": "array",
"items": {
"type": "string"
},
"description": "It can be an empty array"
}
},
"required": [
"videos"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Response
204Response
400Headers
Content-Type: application/jsonBody
{
"detail": "The request could not be understood by the server due to malformed syntax",
"status": 400,
"title": "Bad Request",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
401Headers
Content-Type: application/jsonBody
{
"detail": "Unauthorized user",
"status": 401,
"title": "Unauthorized",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
404Headers
Content-Type: application/jsonBody
{
"detail": "The resource was not found",
"status": 404,
"title": "Not Found",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
500Headers
Content-Type: application/jsonBody
{
"detail": "Internal Server Error",
"status": 500,
"title": "Internal Server Error",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Copy property videos ¶
Copy property videosPOST/listings/legacy/properties/videos/copy
Example URI
POST https://monolith.spotahome.com/api/listings/legacy/properties/videos/copy
Request
Headers
Authorization: aa.bb.ccBody
{
"originalPropertyId": "200000",
"destinationPropertyIds": [
"200001",
"200002"
]
}Schema
{
"type": "object",
"properties": {
"originalPropertyId": {
"type": "string"
},
"destinationPropertyIds": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"originalPropertyId",
"destinationPropertyIds"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Response
202Response
400Headers
Content-Type: application/jsonBody
{
"detail": "The request could not be understood by the server due to malformed syntax",
"status": 400,
"title": "Bad Request",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
401Headers
Content-Type: application/jsonBody
{
"detail": "Unauthorized user",
"status": 401,
"title": "Unauthorized",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
500Headers
Content-Type: application/jsonBody
{
"detail": "Internal Server Error",
"status": 500,
"title": "Internal Server Error",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Send publication notification ¶
Send publication notification for a certain PropertyIdPOST/listings/legacy/{id}/publication-notification
Example URI
POST https://monolith.spotahome.com/api/listings/legacy/200089/publication-notification
URI Parameters
- id
number(required) Example: 200089
Request
Headers
Authorization: aa.bb.ccResponse
204Response
400Headers
Content-Type: application/jsonBody
{
"detail": "The request could not be understood by the server due to malformed syntax",
"status": 400,
"title": "Bad Request",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
401Headers
Content-Type: application/jsonBody
{
"detail": "Unauthorized user",
"status": 401,
"title": "Unauthorized",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
404Headers
Content-Type: application/jsonBody
{
"detail": "The resource was not found",
"status": 404,
"title": "Not Found",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
500Headers
Content-Type: application/jsonBody
{
"detail": "Internal Server Error",
"status": 500,
"title": "Internal Server Error",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Changelog ¶
View changelogGET/listings/legacy/{id}/changelog
Example URI
GET https://monolith.spotahome.com/api/listings/legacy/200089/changelog
URI Parameters
- id
number(required) Example: 200089
Request
Headers
Authorization: aa.bb.ccResponse
204Response
401Headers
Content-Type: application/jsonBody
{
"detail": "Unauthorized user",
"status": 401,
"title": "Unauthorized",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
404Headers
Content-Type: application/jsonBody
{
"detail": "The resource was not found",
"status": 404,
"title": "Not Found",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
500Headers
Content-Type: application/jsonBody
{
"detail": "Internal Server Error",
"status": 500,
"title": "Internal Server Error",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Domain Events ¶
Legacy monolith domain events. PLEASE DO NOT USE THEM, THEY ARE DEPRECATED. USE NEW LISTINGS BC DOMAIN EVENTS INSTEAD
AdWasPublished
{
"propertyId": 1234,
"accountInfo": {
"username": "username@spotahome.com"
},
"occurredOn": "2017-07-25T14:26:17+00:00"
}-
propertyId (number, required)
-
accountInfo (object, required)
- username (string, required)
-
occurredOn (string, required)
AdDetailsWereUpdated
{
"propertyId": 1234,
"accountInfo": {
"username": "username@spotahome.com"
},
"occurredOn": "2017-07-25T14:26:17+00:00",
"valueBefore": {
"title": "Sunny 1 bedroom apartment with fantastic views, close to Serrallo Plaza shopping centre",
"splitDescription": {
"description": "Sunny 1 bedroom apartment",
"video": "![youtube ohgZSwqT8v4]",
"whatWeLiked": "just 20 minutes with a car.",
"thingsToKeepInMind": "microwave are provided.",
"details": "Monthly utilities are approximately 30\\u20ac.",
"landlordPolicies": "Rent can be paid by bank transaction.",
"transportation": "Bus service 9 is available close to the apartment.",
"neighborhoodDescription": "residential area"
},
"landlord_ref": "Calle 214",
"area": 0,
"seo": {
"metaTitle": "1 Bed Apartment with Views",
"metaDescription": "Wonderful 1 bedroom apartment for rent"
}
},
"valueAfter": {
"title": "Sunny 1 bedroom apartment with fantastic views",
"splitDescription": {
"description": "Sunny 1 bedroom apartment for rent",
"video": "![youtube ohgZSwqT8v4]",
"whatWeLiked": "You can reach the city centre in just 20 minutes with a car.",
"thingsToKeepInMind": "an electric stove and a microwave are provided.",
"details": "Monthly utilities are approximately 30\\u20ac.",
"landlordPolicies": "Rent can be paid by bank transaction.",
"transportation": "Bus service 9 is available close to the apartment.",
"neighborhoodDescription": "residential area"
},
"landlord_ref": "Calle 214",
"area": 0,
"seo": {
"metaTitle": "1 Bed Apartment with Views",
"metaDescription": "Wonderful 1 bedroom apartment for rent"
}
}
}-
propertyId (number, required)
-
accountInfo (object, required)
- username (string, required)
-
occurredOn (string, required)
-
valueBefore (object, required)
- title (string, required)
- description (string, optional)
- splitDescription (object, required)
- header (string, optional)
- description (string, optional)
- video (string, optional)
- videoTranscription (string, optional)
- whatWeLiked (string, optional)
- thingsToKeepInMind (string, optional)
- details (string, optional)
- landlordPolicies (string, optional)
- transportation (string, optional)
- neighborhoodDescription (string, optional)
- neighborhoodVideo (string, optional)
- floorPlan (string, optional)
- flatmates (string, optional)
- landlord_ref (string, required)
- area (number, required)
- seo (object, required)
- metaTitle (string, optional)
- metaDescription (string, optional)
- fplanRef (number, required)
AdCanonicalContentWasUpdated
{
"propertyId": 140677,
"occurredOn": "2017-08-18T02:12:26+00:00",
"valueBefore": {
"title": "Bedroom 1 - double bed",
"splitDescription": {
"description": "Bedroom 1 has a double bed, and a desk as well as plenty of storage including a chest of drawers, shelving, and a large wardrobe."
},
"seo": {}
},
"valueAfter": {
"title": "Bedroom 1 - double bed",
"splitDescription": {
"description": "Bedroom 1 has a double bed, and a desk as well as plenty of storage including a chest of drawers, shelving, and a large wardrobe."
},
"seo": {}
},
"accountInfo": {
"username": "bekki@spotahome.com"
}
}-
propertyId (number, required)
-
accountInfo (object, required)
- username (string, required)
-
occurredOn (string, required)
-
valueAfter (object, required) - Variable structure depending on the updated content
-
valueBefore (object, required) - Variable structure depending on the updated content
AdWasTranslated
{
"propertyId": 1234,
"accountInfo": {
"username": "username@spotahome.com"
},
"occurredOn": "2017-07-25T14:26:17+00:00"
}-
propertyId (number, required)
-
accountInfo (object, required)
- username (string, required)
-
occurredOn (string, required)
AdFeaturesWereUpdated
{
"propertyId": 128683,
"occurredOn": "2017-08-15T17:21:57+00:00",
"valueBefore": {
"1001": false,
"1002": false,
"1100": true,
"1101": false,
"1102": false,
"1103": true,
"1104": true,
"1200": false,
"1201": false,
"1202": false,
"3000": true,
"3002": false,
"3007": true,
"3008": false,
"3009": true,
"3010": false,
"3013": true,
"3015": true,
"3016": true,
"3017": false,
"3018": false,
"3019": false,
"3020": false,
"3021": false,
"3024": false,
"3027": "other",
"3100": false,
"5000": true,
"5001": true,
"5002": "na",
"5003": true,
"5004": "na",
"5005": "na",
"5006": "na",
"5007": false,
"5008": true
},
"valueAfter": {
"1001": false,
"1002": false,
"1100": true,
"1101": true,
"1102": false,
"1103": true,
"1104": true,
"1200": false,
"1201": false,
"1202": false,
"3000": true,
"3002": false,
"3007": true,
"3008": false,
"3009": true,
"3010": false,
"3013": true,
"3015": true,
"3016": true,
"3017": false,
"3018": false,
"3019": false,
"3020": false,
"3021": false,
"3024": false,
"3026": "central",
"3027": "central",
"3028": "ind_r_in",
"3100": false,
"5000": true,
"5001": true,
"5002": "na",
"5003": true,
"5004": "na",
"5005": true,
"5006": true,
"5007": true,
"5008": "na"
},
"accountInfo": {
"username": "shaheen@spotahome.com"
}
}-
propertyId (number, required)
-
accountInfo (object, required)
- username (string, required)
-
valueBefore (object, required)
- 1001: false (boolean, optional)
- 1002: false (boolean, optional)
- 1100: true (boolean, optional)
- 1101: true (boolean, optional)
- 1102: true (boolean, optional)
- 1103: false (boolean, optional)
- 1104: false (boolean, optional)
- 1200: true (boolean, optional)
- 1201: true (boolean, optional)
- 1202: false (boolean, optional)
- 3000: true (boolean, optional)
- 3002: central (enum[string], optional)
- Members
- central
- some
- false
- Members
- 3007: true (boolean, optional)
- 3008: false (boolean, optional)
- 3009: true (boolean, optional)
- 3010: false (boolean, optional)
- 3011: true (boolean, optional)
- 3012: false (boolean, optional)
- 3013: true (boolean, optional)
- 3015: true (boolean, optional)
- 3016: false (boolean, optional)
- 3017: false (boolean, optional)
- 3018: true (boolean, optional)
- 3019: true (boolean, optional)
- 3020: true (boolean, optional)
- 3021: false (boolean, optional)
- 3023: false (boolean, optional)
- 3024: true (boolean, optional)
- 3026: n_gas (enum[string], optional)
- Members
- n_gas
- b_gas
- elec
- central
- Members
- 3027: central (enum[string], optional)
- Members
- central
- s_elec
- elec_whole
- n_gas
- ac
- other
- false
- Members
- 3028: dryer (enum[string], optional)
- Members
- dryer
- ind_r_in
- ind_r_terr
- str_back
- Members
- 3100: true (boolean, optional)
- 5000: false (boolean, optional)
- 5001: false (boolean, optional)
- 5002: true (boolean, optional)
- 5003: true (boolean, optional)
- 5004: true (boolean, optional)
- 5005: false (boolean, optional)
- 5006: true (boolean, optional)
- 5007: true (boolean, optional)
- 5008: false (boolean, optional)
-
valueAfter (object, required)
- 1001: false (boolean, optional)
- 1002: false (boolean, optional)
- 1100: true (boolean, optional)
- 1101: true (boolean, optional)
- 1102: true (boolean, optional)
- 1103: false (boolean, optional)
- 1104: false (boolean, optional)
- 1200: true (boolean, optional)
- 1201: true (boolean, optional)
- 1202: false (boolean, optional)
- 3000: true (boolean, optional)
- 3002: central (enum[string], optional)
- Members
- central
- some
- false
- Members
- 3007: true (boolean, optional)
- 3008: false (boolean, optional)
- 3009: true (boolean, optional)
- 3010: false (boolean, optional)
- 3011: true (boolean, optional)
- 3012: false (boolean, optional)
- 3013: true (boolean, optional)
- 3015: true (boolean, optional)
- 3016: false (boolean, optional)
- 3017: false (boolean, optional)
- 3018: true (boolean, optional)
- 3019: true (boolean, optional)
- 3020: true (boolean, optional)
- 3021: false (boolean, optional)
- 3023: false (boolean, optional)
- 3024: true (boolean, optional)
- 3026: n_gas (enum[string], optional)
- Members
- n_gas
- b_gas
- elec
- central
- Members
- 3027: central (enum[string], optional)
- Members
- central
- s_elec
- elec_whole
- n_gas
- ac
- other
- false
- Members
- 3028: dryer (enum[string], optional)
- Members
- dryer
- ind_r_in
- ind_r_terr
- str_back
- Members
- 3100: true (boolean, optional)
- 5000: false (boolean, optional)
- 5001: false (boolean, optional)
- 5002: true (boolean, optional)
- 5003: true (boolean, optional)
- 5004: true (boolean, optional)
- 5005: false (boolean, optional)
- 5006: true (boolean, optional)
- 5007: true (boolean, optional)
- 5008: false (boolean, optional)
-
occurredOn (string, required)
AdWasUnpublished
{
"propertyId": 1234,
"accountInfo": {
"username": "username@spotahome.com"
},
"occurredOn": "2017-07-25T14:26:17+00:00"
}-
propertyId (number, required)
-
accountInfo (object, required)
- username (string, required)
-
occurredOn (string, required)
AdPriceWasUpdated
-
propertyId (number, required)
-
user (object, required)
- email (string, required)
-
valueBefore (object, required)
- price (string, optional)
- reservationPrice (object, required)
- price (object, required)
- amount (number, required)
- currency (string, required)
- numberOfWeeks (number, optional)
- price (object, required)
- monthlyPrice (object, required)
- type (object, required)
- type (string, required)
- type (object, required)
-
valueAfter (Features Resource, required)
-
occurredOn (string, required)
AdOccupanciesWereUpdated
{
"propertyId": 106473,
"valueBefore": {
"occupancies": [
{
"from": "2017-05-09T12:00:00+00:00",
"to": "2100-01-01T12:00:00+00:00"
}
]
},
"valueAfter": {
"occupancies": [
{
"from": "2017-06-16T12:00:00+00:00",
"to": "2017-07-01T12:00:00+00:00"
}
]
},
"occurredOn": "2017-06-16T12:58:32+00:00",
"user": {
"email": "unknown"
}
}-
propertyId (number, required)
-
user (object, required)
- email (string, required)
-
valueBefore (array, required)
- (object)
- from (string, required)
- to (string, required)
- (object)
-
valueAfter (array, required)
- (object)
- from (string, required)
- to (string, required)
- (object)
-
occurredOn (string, required)
AdAvailabilitiesWereRefreshed
{
"propertyId": 106473,
"valueBefore": {
"refreshAvailabilitiesDate": "2017-05-09T12:00:00+00:00"
},
"valueAfter": {
"refreshAvailabilitiesDate": "2017-06-16T12:00:00+00:00"
},
"occurredOn": "2017-06-16T12:58:32+00:00",
"user": "unknown"
}
}-
propertyId (number, required)
-
user (string, required)
-
valueBefore (array, required)
- refreshAvailabilitiesDate (string, required)
-
valueAfter (array, required)
- refreshAvailabilitiesDate (string, required)
-
occurredOn (string, required)
ListingOwnerWasChanged
{
"propertyId": 106473,
"ownerIdBefore": null,
"ownerIdAfter": "149009a3-92b0-4de8-810c-d27b43c04af6",
"occurredOn": "2017-06-16T12:58:32+00:00",
"accountInfo": {
"username": "unknown"
}
}-
propertyId (number, required)
-
accountInfo (object, required)
- username (string, required)
-
ownerIdBefore (string, required, nullable)
-
ownerIdAfter (string, required)
-
occurredOn (string, required)
ListingNumberOfBathroomsWasChanged
{
"propertyId": 106473,
"numberOfBathrooms": 2,
"occurredOn": "2022-06-01T12:58:32+00:00",
"accountInfo": {
"username": "unknown"
}
}-
propertyId (number, required)
-
numberOfBathrooms (number, required)
-
occurredOn (string, required)
-
accountInfo (object, required)
- username (string, required)
ListingExclusivityWasUpdated
{
"propertyId": 106473,
"valueBefore": {
"type": "basic"
},
"valueAfter": {
"type": "exclusive"
},
"occurredOn": "2017-06-16T12:58:32+00:00",
"user": {
"email": "one@spotahome.com"
}
}-
propertyId (number, required)
-
user (object, required)
- email (string, required)
-
valueBefore (object, required)
- type (string, required)
-
valueAfter (object, required)
- type (string, required)
-
occurredOn (string, required)
ListingWasPublished
{
"id": 105428,
"landlordId": "27cbb490-cdd4-4508-b3ac-4adbad188be0",
"monthlyPrice": [
40000,
40000,
40000,
40000,
40000,
40000,
40000,
40000,
40000,
40000,
40000,
40000
],
"cityId": "valencia",
"stayDurationMinCap": 30,
"stayDurationMaxCap": 0,
"occupancies": [
{
"start": "2017-03-01T12:00:00+00:00",
"end": "2017-06-06T12:00:00+00:00"
},
{
"start": "2017-07-03T12:00:00+00:00",
"end": "2017-09-29T12:00:00+00:00"
}
],
"occurredOn": "2017-06-16T12:40:52+00:00"
}-
id (number, required)
-
landlordId (string, required)
-
monthlyPrice (array, required)
-
cityId (string, required)
-
stayDurationMinCap (number, required)
-
stayDurationMaxCap (number, required)
-
occurredOn (string, required)
-
occupancies (array, required)
- (object)
- start (string, required)
- end (string, required)
- (object)
VideoWasUploadedToPlatform
{
"id": "fc0c466a-4f63-4353-a0c5-29871c00b200",
"videoPlatform": {
"platformName": "youTube",
"videoId": "dQw4w9WgXcQ",
"videoUrl": "https://youtu.be/dQw4w9WgXcQ"
},
"occurredOn": "2020-01-01T00:00:00+00:00"
}-
id (string, required)
-
videoPlatform (object, required)
- platformName (string, required)
- videoId (string, required)
- videoUrl (string, required)
-
occurredOn (string, required)
AdVideoInformationWasUpdated
{
"propertyId": 1234,
"videoInformation": [
{
"id": "cd226fab-482a-4833-b1df-e2cd1cd0f1fa",
"provider": "xAiVZ3Fz3Uk",
"externalId": "youtube",
"url": "https://youtu.be/xAiVZ3Fz3Uk"
}
],
"occurredOn": "2017-07-25T14:26:17+00:00"
}-
propertyId (string, required)
-
videoInformation (array, fixed, optional)
- (object, required)
- id (string, required)
- provider (string, required)
- externalId (string, required)
- url (string, required)
- (object, required)
-
occurredOn (string, required)
CopyAdPhotosWasRequested
{
"originalAdId": 200000,
"destinationAdId": 200001,
"user": "willy",
"occurredOn": "2018-08-23T13:00:00+00:00"
}-
originalAdId (string, required)
-
destinationAdId (string, required)
-
user (string, required)
-
occurredOn (string, required)
AdPhotosWereRemoved
{
"id": 200000,
"userId": "willy",
"occurredOn": "2018-08-23T13:00:00+00:00"
}-
id (string, required)
-
userId (string, required)
-
occurredOn (string, required)
BedroomPhotosWereRemoved
{
"id": 200000,
"userId": "willy",
"occurredOn": "2018-08-23T13:00:00+00:00"
}-
id (string, required)
-
userId (string, required)
-
occurredOn (string, required)