EstateSync (1.0)

Download OpenAPI specification:Download

Introduction

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.

Authentication

api-key

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

Account

Get your account

Return information of your API account.

Authorizations:

Responses

Response samples

Content type
application/json
{
}

Immobilienscout24 Consumer Credentials

Update your consumer credentials for Immobilienscout24. Necessary to be able to create targets of type immobilienscout-24.

Authorizations:
Request Body schema: application/json
key
required
string
secret
required
string

Responses

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Immobilienscout24 Sandbox Consumer Credentials

Update your consumer credentials for the Immobilienscout24 Sandbox. Necessary to be able to create targets of type immobilienscout-24-sandbox.

Authorizations:
Request Body schema: application/json
key
required
string
secret
required
string

Responses

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Properties

Create a property

Add a new property to your account.

Authorizations:
Request Body schema: application/json
One of
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.

Responses

Request samples

Content type
application/json
Example
{
}

Response samples

Content type
application/json
Example
{
}

List all properties

Return all properties of your account.

Authorizations:

Responses

Response samples

Content type
application/json
[
]

Get a property

Return a specific property of your account.

Authorizations:
path Parameters
id
required
string

The ID of the property.

Responses

Response samples

Content type
application/json
Example
{