IrisanDocs
Dashboard

Home valuation

We listen first, then build a plan around what you actually need. Honest advice comes first, even when it means waiting for the right home.

6 min read Updated May 13, 2026 v5.7.2

Overview

Our rental team manages repairs, payments and tenants for landlords. Thousands of buyers already trust us, and we work hard to keep it that way. Book viewings online and take a 3D tour before you leave the house. Every listing is checked by our team, so the photos match what you see in person.

Verified listingsWe handle the paperwork, so you can focus on planning the move.3D toursOur local agents know every street, school and coffee shop in the area.Price alertsFriendly people answer your questions quickly, by phone, chat or email.

Installation

Install the SDK with the package manager your project already uses. It needs Node 18 or newer.

terminal
$ npm install @irisan/sdk
terminal
$ yarn add @irisan/sdk
terminal
$ pnpm add @irisan/sdk
Using a server without Node? The same endpoints are available over plain HTTPS; see the API reference below.

Configuration

Price alerts tell you the moment a home that fits your search comes on the market. We measure success by how many buyers come back and tell their friends. Create a file named irisan.config.json in the project root:

irisan.config.json
{
  "project": "irisan",
  "region": "eu-west",
  "categories": ["apartments", "houses", "villas"],
  "retries": 4,
  "timeoutMs": 11000,
  "webhooks": { "enabled": true }
}
OptionTypeDefaultDescription
projectstring-Your project key from the dashboard.
regionstring"us-east"Data centre closest to your buyers.
retriesnumber3How often a failed call is retried.
timeoutMsnumber10000Time before a request is cancelled.
webhooks.enabledbooleanfalseSend events to your endpoint.

Your first request

Most of our homes sell within six weeks, often above the asking price.

  1. Create an API keyOpen the dashboard, choose Settings › API keys and copy a new secret key.
  2. Store it safelyKeep the key in an environment variable, never in your source code.
  3. Make the callRun the snippet below; it prints the first page of results.
index.js
import { Client } from "@irisan/sdk";

const client = new Client({ apiKey: process.env.API_KEY });

// list the newest propertys in one category
const page = await client.propertys.list({ category: "apartments", limit: 20 });

for (const item of page.data) {
  console.log(item.name, item.price);
}
Heads up: test keys only return sample data. Switch to a live key before you go to production.

API reference

Every endpoint returns JSON and uses standard HTTP status codes.

GET/v1/propertiesList properties with paging and filters.
POST/v1/propertiesCreate a new property.
PATCH/v1/properties/{id}Update some fields of a property.
DELETE/v1/properties/{id}Archive a property; it can be restored for 30 days.
response.json
{
  "data": [
    { "id": "property_3635", "name": "Family house", "price": 57 }
  ],
  "has_more": true
}

Troubleshooting

We keep things simple, so you can focus on what matters to you. Thousands of buyers already trust us, and we work hard to keep it that way.

Mortgage advisors help you understand what you can afford before you start. Sellers get professional photos, floor plans and a marketing plan included.

Most of our homes sell within six weeks, often above the asking price. Every detail is handled by people who care about getting it right.

Next steps

We measure success by how many buyers come back and tell their friends.

Was this page helpful?
All screens