Vivid StudioDocs
Dashboard

Rental management

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.

5 min read Updated Jun 20, 2026 v5.4.10

Overview

Honest advice comes first, even when it means waiting for the right home. Price alerts tell you the moment a home that fits your search comes on the market. Every listing is checked by our team, so the photos match what you see in person.

Verified listingsSellers get professional photos, floor plans and a marketing plan included.3D toursOur local agents know every street, school and coffee shop in the area.Price alertsThousands of buyers already trust us, and we work hard to keep it that way.

Installation

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

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

Configuration

Book viewings online and take a 3D tour before you leave the house. Our team has done this many times, so you never have to guess. Create a file named vivid-studio.config.json in the project root:

vivid-studio.config.json
{
  "project": "vivid-studio",
  "region": "us-east",
  "categories": ["apartments", "houses", "villas"],
  "retries": 5,
  "timeoutMs": 6000,
  "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

Start in minutes and get help from a real person whenever you need it.

  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 "@vivid-studio/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_3306", "name": "Family house", "price": 114 }
  ],
  "has_more": true
}

Troubleshooting

Get a free, no-obligation valuation of your home within 48 hours. Neighbourhood guides cover transport, schools and things to do.

Friendly people answer your questions quickly, by phone, chat or email. Every detail is handled by people who care about getting it right.

We keep things simple, so you can focus on what matters to you. Start in minutes and get help from a real person whenever you need it.

Next steps

Every listing is checked by our team, so the photos match what you see in person.

Was this page helpful?
All screens