Use the EstateSync API to easily distribute real estate data to major German market places. Send your data once – publish it on all the platforms.
Please refer to the Documentation for additional information and guides. You are currently looking at the API reference.
When you sign up for an account a first API key will be automatically added. You can use it to publish and modify resources. Estate Sync uses Bearer Authentication. Just provide the header Authorization
with the value Bearer {your-api-key}
.
Security Scheme Type | HTTP |
---|---|
HTTP Authorization Scheme | Bearer |
{- "id": "string",
- "name": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
Update your consumer credentials for Immobilienscout24. Necessary to be able to create targets of type immobilienscout-24
.
key required | string |
secret required | string |
{- "key": "string",
- "secret": "string"
}
{- "statusCode": 418,
- "message": "A short description of what went wrong.",
- "error": "Error Code"
}
Update your consumer credentials for the Immobilienscout24 Sandbox. Necessary to be able to create targets of type immobilienscout-24-sandbox
.
key required | string |
secret required | string |
{- "key": "string",
- "secret": "string"
}
{- "statusCode": 418,
- "message": "A short description of what went wrong.",
- "error": "Error Code"
}
Add a new property to your account.
type required | any Value: "apartmentRent" The type of the property. Cannot be changed afterwards. |
required | object |
Array of objects <= 150 items [ items ] | |
contactId | string 20 characters References a contact. Can be left out to use the default contact of the target platform. |
externalId | string [ 1 .. 50 ] characters ^[a-zA-Z0-9/_#+:@\s\-]+$ Custom identifier for the property. Will be created automatically if not given. Cannot be changed after property creation. Check the guides in the documentation for more information. |
{- "type": "apartmentRent",
- "fields": {
- "additionalCosts": 210,
- "additionalCostsIncludeHeatingCosts": true,
- "address": {
- "street": "Example Street",
- "streetNumber": "42",
- "postalCode": "28197",
- "region": "string",
- "country": "string",
- "publish": false
}, - "apartmentType": "penthouse",
- "availableFrom": "immediately, latest in March",
- "baseRent": 830,
- "commission": "5,95% incl. 19% VAT",
- "commissionDescription": "My first commission description for a property.",
- "condition": "refurbished",
- "constructionYear": 1997,
- "deposit": "2x Cold Rent",
- "description": "My first detailed description for a property.",
- "energyCertificateStatus": "present",
- "floor": 2,
- "furnishingDescription": "My first furnishing description for a property.",
- "hasBalcony": true,
- "hasBuiltInKitchen": true,
- "hasCellar": false,
- "hasGarden": true,
- "hasGuestToilet": false,
- "hasLift": true,
- "heatingCosts": 160,
- "heatingType": "central",
- "interiorQuality": "standard",
- "isAccessible": true,
- "isSuitableAsSharedFlat": false,
- "lastRefurbished": 2016,
- "livingArea": 95.2,
- "locationDescription": "My first location description for a property.",
- "miscellaneousDescription": "My first misc description for a property.",
- "numberOfBathrooms": 1,
- "numberOfBedrooms": 2,
- "numberOfFloors": 4,
- "numberOfParkingSpaces": 2,
- "numberOfRooms": 7,
- "parkingSpaceRent": 45,
- "parkingSpaceType": "garage",
- "petsAllowed": true,
- "requiresWBS": false,
- "residentialEnergyCertificate": {
- "type": "consumption",
- "prior2014": false,
- "energySource": "solar",
- "energyNeed": 0.01,
- "energyConsumption": 0.01,
- "energyClass": "A+",
- "warmWaterIncluded": true
}, - "title": "Wonderful new Home close to large Lake",
- "totalRent": 1100,
- "usableArea": 80.5
}, - "attachments": [
- {
- "type": "image/jpeg",
- "title": "House Entrance",
- "isBlueprint": false
}
], - "contactId": "stringstringstringst",
- "externalId": "string"
}
{- "type": "apartmentRent",
- "fields": {
- "additionalCosts": 210,
- "additionalCostsIncludeHeatingCosts": true,
- "address": {
- "street": "Example Street",
- "streetNumber": "42",
- "postalCode": "28197",
- "region": "string",
- "country": "string",
- "publish": false
}, - "apartmentType": "penthouse",
- "availableFrom": "immediately, latest in March",
- "baseRent": 830,
- "commission": "5,95% incl. 19% VAT",
- "commissionDescription": "My first commission description for a property.",
- "condition": "refurbished",
- "constructionYear": 1997,
- "deposit": "2x Cold Rent",
- "description": "My first detailed description for a property.",
- "energyCertificateStatus": "present",
- "floor": 2,
- "furnishingDescription": "My first furnishing description for a property.",
- "hasBalcony": true,
- "hasBuiltInKitchen": true,
- "hasCellar": false,
- "hasGarden": true,
- "hasGuestToilet": false,
- "hasLift": true,
- "heatingCosts": 160,
- "heatingType": "central",
- "interiorQuality": "standard",
- "isAccessible": true,
- "isSuitableAsSharedFlat": false,
- "lastRefurbished": 2016,
- "livingArea": 95.2,
- "locationDescription": "My first location description for a property.",
- "miscellaneousDescription": "My first misc description for a property.",
- "numberOfBathrooms": 1,
- "numberOfBedrooms": 2,
- "numberOfFloors": 4,
- "numberOfParkingSpaces": 2,
- "numberOfRooms": 7,
- "parkingSpaceRent": 45,
- "parkingSpaceType": "garage",
- "petsAllowed": true,
- "requiresWBS": false,
- "residentialEnergyCertificate": {
- "type": "consumption",
- "prior2014": false,
- "energySource": "solar",
- "energyNeed": 0.01,
- "energyConsumption": 0.01,
- "energyClass": "A+",
- "warmWaterIncluded": true
}, - "title": "Wonderful new Home close to large Lake",
- "totalRent": 1100,
- "usableArea": 80.5
}, - "attachments": [
- {
- "type": "image/jpeg",
- "title": "House Entrance",
- "isBlueprint": false
}
], - "contactId": "stringstringstringst",
- "externalId": "string",
- "id": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "processingStatus": "successful"
}
[- {
- "type": "apartmentRent",
- "fields": {
- "additionalCosts": 210,
- "additionalCostsIncludeHeatingCosts": true,
- "address": {
- "street": "Example Street",
- "streetNumber": "42",
- "postalCode": "28197",
- "region": "string",
- "country": "string",
- "publish": false
}, - "apartmentType": "penthouse",
- "availableFrom": "immediately, latest in March",
- "baseRent": 830,
- "commission": "5,95% incl. 19% VAT",
- "commissionDescription": "My first commission description for a property.",
- "condition": "refurbished",
- "constructionYear": 1997,
- "deposit": "2x Cold Rent",
- "description": "My first detailed description for a property.",
- "energyCertificateStatus": "present",
- "floor": 2,
- "furnishingDescription": "My first furnishing description for a property.",
- "hasBalcony": true,
- "hasBuiltInKitchen": true,
- "hasCellar": false,
- "hasGarden": true,
- "hasGuestToilet": false,
- "hasLift": true,
- "heatingCosts": 160,
- "heatingType": "central",
- "interiorQuality": "standard",
- "isAccessible": true,
- "isSuitableAsSharedFlat": false,
- "lastRefurbished": 2016,
- "livingArea": 95.2,
- "locationDescription": "My first location description for a property.",
- "miscellaneousDescription": "My first misc description for a property.",
- "numberOfBathrooms": 1,
- "numberOfBedrooms": 2,
- "numberOfFloors": 4,
- "numberOfParkingSpaces": 2,
- "numberOfRooms": 7,
- "parkingSpaceRent": 45,
- "parkingSpaceType": "garage",
- "petsAllowed": true,
- "requiresWBS": false,
- "residentialEnergyCertificate": {
- "type": "consumption",
- "prior2014": false,
- "energySource": "solar",
- "energyNeed": 0.01,
- "energyConsumption": 0.01,
- "energyClass": "A+",
- "warmWaterIncluded": true
}, - "title": "Wonderful new Home close to large Lake",
- "totalRent": 1100,
- "usableArea": 80.5
}, - "attachments": [
- {
- "type": "image/jpeg",
- "title": "House Entrance",
- "isBlueprint": false
}
], - "contactId": "stringstringstringst",
- "externalId": "string",
- "id": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "processingStatus": "successful"
}
]
Return a specific property of your account.
id required | string The ID of the property. |
{- "type": "apartmentRent",
- "fields": {
- "additionalCosts": 210,
- "additionalCostsIncludeHeatingCosts": true,
- "address": {
- "street": "Example Street",
- "streetNumber": "42",
- "postalCode": "28197",
- "region": "string",
- "country": "string",
- "publish": false
}, - "apartmentType": "penthouse",
- "availableFrom": "immediately, latest in March",
- "baseRent": 830,
- "commission": "5,95% incl. 19% VAT",
- "commissionDescription": "My first commission description for a property.",
- "condition": "refurbished",
- "constructionYear": 1997,
- "deposit": "2x Cold Rent",
- "description": "My first detailed description for a property.",
- "energyCertificateStatus": "present",
- "floor": 2,
- "furnishingDescription": "My first furnishing description for a property.",
- "hasBalcony": true,
- "hasBuiltInKitchen": true,
- "hasCellar": false,
- "hasGarden": true,
- "hasGuestToilet": false,
- "hasLift": true,
- "heatingCosts": 160,
- "heatingType": "central",
- "interiorQuality": "standard",
- "isAccessible": true,
- "isSuitableAsSharedFlat": false,
- "lastRefurbished": 2016,
- "livingArea": 95.2,
- "locationDescription": "My first location description for a property.",
- "miscellaneousDescription": "My first misc description for a property.",
- "numberOfBathrooms": 1,
- "numberOfBedrooms": 2,
- "numberOfFloors": 4,
- "numberOfParkingSpaces":