Mortgage advice
Book viewings online and take a 3D tour before you leave the house. Thousands of buyers already trust us, and we work hard to keep it that way.
Overview
Sellers get professional photos, floor plans and a marketing plan included. Mortgage advisors help you understand what you can afford before you start. Honest advice comes first, even when it means waiting for the right home. Get a free, no-obligation valuation of your home within 48 hours.
Installation
Install the SDK with the package manager your project already uses. It needs Node 18 or newer.
$ npm install @kora/sdk$ yarn add @kora/sdk$ pnpm add @kora/sdkConfiguration
We keep things simple, so you can focus on what matters to you. Clear prices, honest advice and no surprises along the way. Create a file named kora.config.json in the project root:
{
"project": "kora",
"region": "eu-west",
"categories": ["apartments", "houses", "villas"],
"retries": 3,
"timeoutMs": 13000,
"webhooks": { "enabled": true }
}| Option | Type | Default | Description |
|---|---|---|---|
project | string | - | Your project key from the dashboard. |
region | string | "us-east" | Data centre closest to your buyers. |
retries | number | 3 | How often a failed call is retried. |
timeoutMs | number | 10000 | Time before a request is cancelled. |
webhooks.enabled | boolean | false | Send events to your endpoint. |
Your first request
Our local agents know every street, school and coffee shop in the area.
- Create an API keyOpen the dashboard, choose Settings › API keys and copy a new secret key.
- Store it safelyKeep the key in an environment variable, never in your source code.
- Make the callRun the snippet below; it prints the first page of results.
import { Client } from "@kora/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);
}API reference
Every endpoint returns JSON and uses standard HTTP status codes.
/v1/propertiesList properties with paging and filters./v1/propertiesCreate a new property./v1/properties/{id}Update some fields of a property./v1/properties/{id}Archive a property; it can be restored for 30 days.{
"data": [
{ "id": "property_2096", "name": "Family house", "price": 295 }
],
"has_more": true
}Troubleshooting
Next steps
Our team has done this many times, so you never have to guess.