EstateSync (0.1)

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

200

OK

get /account
https://api.estatesync.com/account

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
}

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

200

OK

400

Bad Request

put /account/credentials/immobilienscout-24
https://api.estatesync.com/account/credentials/immobilienscout-24

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
}

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

200

OK

400

Bad Request

put /account/credentials/immobilienscout-24-sandbox
https://api.estatesync.com/account/credentials/immobilienscout-24-sandbox

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
}

Properties

Create a property

Add a new property to your account.

Authorizations:
Request Body schema: application/json
One of
  • Apartment Rent
  • Apartment Buy
  • House Rent
  • House Buy
  • Plot Rent
  • Plot Buy
  • Office Buy
  • Office Rent
  • Gastronomy Buy
  • Gastronomy Rent
  • Retail Buy
  • Retail Rent
  • Industrial Buy
  • Industrial Rent
  • Parking Space Buy
  • Parking Space Rent
  • Commercial Plot Buy
  • Commercial Plot Rent
  • Other Commercial Buy
  • Other Commercial Rent
  • Residential Investment Buy
  • Commercial Investment Buy
type
required
any
Value: "apartmentRent"

The type of the property. Cannot be changed afterwards.

fields
required
object
attachments
Array of objects <= 150 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

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

201

Created

400

Bad Request

post /properties
https://api.estatesync.com/properties

Request samples

Content type
application/json
Example
Copy
Expand all Collapse all
{
}

Response samples

Content type
application/json
Example
Copy
Expand all Collapse all
{
}

List all properties

Return all properties of your account.

Authorizations:

Responses

200

OK

get /properties
https://api.estatesync.com/properties

Response samples

Content type
application/json
Copy
Expand all Collapse all
[
]

Get a property

Return a specific property of your account.

Authorizations:
path Parameters
id
required
string

The ID of the property.

Responses

200
404

Not Found

get /properties/{id}
https://api.estatesync.com/properties/{id}

Response samples

Content type
application/json
Example
Copy
Expand all Collapse all
{
}

Update a property

When you update the property EstateSync will automatically publish it to all targets it is currently listed on. This means that corresponding webhooks will be fired again when the listing was updated successfully.

Authorizations: