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.
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.
$ npm install @nimbus/sdk$ yarn add @nimbus/sdk$ pnpm add @nimbus/sdkConfiguration
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:
{
"project": "nimbus",
"region": "ap-south",
"categories": ["beach", "city", "mountain"],
"retries": 3,
"timeoutMs": 8000,
"webhooks": { "enabled": true }
}| Option | Type | Default | Description |
|---|---|---|---|
project | string | - | Your project key from the dashboard. |
region | string | "us-east" | Data centre closest to your travellers. |
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
We measure success by how many travellers come back and tell their friends.
- 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 "@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);
}API reference
Every endpoint returns JSON and uses standard HTTP status codes.
/v1/tripsList trips with paging and filters./v1/tripsCreate a new trip./v1/trips/{id}Update some fields of a trip./v1/trips/{id}Archive a trip; it can be restored for 30 days.{
"data": [
{ "id": "trip_3445", "name": "Ocean view suite", "price": 364 }
],
"has_more": true
}Troubleshooting
Next steps
Every detail is handled by people who care about getting it right.