Virtual tours
Thousands of buyers already trust us, and we work hard to keep it that way. Neighbourhood guides cover transport, schools and things to do.
Overview
We handle the paperwork, so you can focus on planning the move. Mortgage advisors help you understand what you can afford before you start. Most of our homes sell within six weeks, often above the asking price.
Installation
Install the SDK with the package manager your project already uses. It needs Node 18 or newer.
$ npm install @fable-nest/sdk$ yarn add @fable-nest/sdk$ pnpm add @fable-nest/sdkConfiguration
Our team has done this many times, so you never have to guess. We handle the paperwork, so you can focus on planning the move. Create a file named fable-nest.config.json in the project root:
{
"project": "fable-nest",
"region": "ap-south",
"categories": ["apartments", "houses", "villas"],
"retries": 2,
"timeoutMs": 3000,
"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
Thousands of buyers already trust us, and we work hard to keep it that way.
- 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 "@fable-nest/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_5036", "name": "Studio apartment", "price": 284 }
],
"has_more": true
}Troubleshooting
Next steps
We measure success by how many buyers come back and tell their friends.