NimbusDocs
Dashboard

Guided tours

Local guides show you the places that never make it into guidebooks. Friendly people answer your questions quickly, by phone, chat or email.

7 min read Updated Jun 29, 2026 v3.5.0

Overview

We keep things simple, so you can focus on what matters to you. Local guides show you the places that never make it into guidebooks. Family rooms, adults-only retreats and pet-friendly stays in one search.

Installation

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

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

Configuration

Start in minutes and get help from a real person whenever you need it. Clear prices, honest advice and no surprises along the way. Create a file named nimbus.config.json in the project root:

nimbus.config.json
{
  "project": "nimbus",
  "region": "ap-south",
  "categories": ["beach", "city", "mountain"],
  "retries": 3,
  "timeoutMs": 8000,
  "webhooks": { "enabled": true }
}
OptionTypeDefaultDescription
projectstring-Your project key from the dashboard.
regionstring"us-east"Data centre closest to your travellers.
retriesnumber3How often a failed call is retried.
timeoutMsnumber10000Time before a request is cancelled.
webhooks.enabledbooleanfalseSend events to your endpoint.

Your first request

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

  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 "@nimbus/sdk";

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

// list the newest trips in one category
const page = await client.trips.list({ category: "beach", 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/tripsList trips with paging and filters.
POST/v1/tripsCreate a new trip.
PATCH/v1/trips/{id}Update some fields of a trip.
DELETE/v1/trips/{id}Archive a trip; it can be restored for 30 days.
response.json
{
  "data": [
    { "id": "trip_3445", "name": "Ocean view suite", "price": 364 }
  ],
  "has_more": true
}

Troubleshooting

Thousands of travellers already trust us, and we work hard to keep it that way. Free cancellation on most stays means you can book now and decide later.

Our travel experts are on call around the clock while you are away. We listen first, then build a plan around what you actually need.

Travel insurance and car rental can be added in a single click. Our team has done this many times, so you never have to guess.

Next steps

Every detail is handled by people who care about getting it right.

Was this page helpful?
All screens