Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.nimbleway.com/llms.txt

Use this file to discover all available pages before exploring further.

Using the API directly? If you prefer HTTP requests (cURL, fetch, axios, etc.) you can skip installation and go straight to the API Reference.

Prerequisites

  • A valid Nimble API key
  • One of the following runtimes for your chosen SDK:
    • Python: 3.9+
    • Node.js: 20 LTS+
    • Go: 1.22+

Python

pip install nimble_python
View Python SDK docs →

Node.js

npm install @nimble-way/nimble-js
Works with Node.js 20+, Deno v1.28+, Bun 1.0+, and Cloudflare Workers. View Node SDK docs →

Go

go get github.com/Nimbleway/nimble-go@latest'
View Go SDK docs →

CLI

The Nimble CLI lets you interact with the API directly from your terminal (requires Go 1.22+):
npm -g i @nimble-way/nimble-cli
Add the Go bin directory to your PATH if needed:
export PATH="$PATH:$(go env GOPATH)/bin"
View CLI docs →

Authentication

All SDKs and the CLI read your API key from the NIMBLE_API_KEY environment variable:
export NIMBLE_API_KEY="your-api-key"
You can also pass it directly when initializing the client (not recommended for production):
from nimble_python import Nimble

client = Nimble(api_key="your-api-key")

Next Steps

Quickstart Guide

Make your first request in minutes

Python SDK

Sync and async Python client

Node SDK

TypeScript/JavaScript client

Go SDK

Idiomatic Go client

CLI

Use Nimble from your terminal

API Reference

Full REST API documentation