First steps

  1. Fill out this form to request access to the test environment
  2. Once you have received credentials, log in and create a key for your development application. Note that once you have a key, you can manage keys via API calls.
  3. Start building your application.
  4. Note that published listings are publicly available on the web.

Are you a real estate system? Request access now!

Lifecycle of a listing

Although many operations are available to you, below is a breakdown of the most common API actions, a workflow followed by most listings.

Establish a Broker Agency

Even if your integration will be used by a single Broker Agency, you need to create that first Broker Agency, or fetch the ID of one you’ve created previously.

Create a Broker Agency

List your Broker Agencies

Create a new listing

The endpoint for creating a new listing accept a long range of parameters, but many are optional. You will need to provide some basic info in order to be able to create a listing that can be published. Historically, the more informations that is provided for a listing, the better it tends to perform on the market. In the future, data completeness may also influence relevance in search results.

Create a listing

Add images

In order to be able to publish a listing, it needs at least one image. When you add an image, you provide a url at which the image can be fetched – not the data payload of the image. This means that the image you want to add must be accessible from Hemnet server IPs.

Create a listing image

Wait for images to be processed

Once you’ve created images, poll the API to find out when images have been fetched by Hemnet’s image processor. Remember to set the ‘limit’ property to include all your images if you’ve added more than 20. The status for each image is reported on the ‘state’ property, and once it changes from ‘in_progress’ to ‘completed’ you’re good to go. If an image fails to be processed, more details as to why available if you fetch the individual record (there’s even a human readable reason called ‘stateMessage’ that you can display to end users if needed).

List images belonging to a listing

Publish the listing

Publishing is a two part process, where the listing will become visible and searchable once it has been published and approved.

Publish a listing

Approve the listing

Approving is a manual step done by the Broker via Kundportalen. (The approval address is a available on the details of each listing.) This step is intended to make sure the Broker validates seller invoice information and that the seller has signed the Hemnet publication terms. Approval can happen before or after the listing is published.

Verify that the listing is visible on Hemnet

The response from the Publish action contains the property “isVisible”, and when it is ‘true’, the listing is visible on hemnet and available in searches. This property is also available when you fetch an individual listing and on enumeration of listings.

Mark the listing as sold

Once the listing is sold, you’ll mark it as sold. This automatically unpublishes the listing, and should always be used after a successful sale, and helps Brokers collect valuable leads and increases Broker exposure over time, as well as helping users understand that the listing is unavailable due to being sold.

You should also report the sale price at this time. The sale price should be reported as public or private, depending on the wishes of the parties involved in the transaction.

Mark a listing as sold

Full API documentation

You can read the full API documentation by visiting the API endpoint.