The Nimbio API
Programmatic REST access to Nimbio community access control — keys, latches, members, opens, access logs and messaging. Turn any gate into software.
Programmatic REST access to Nimbio community access control — keys, latches, members, opens, access logs and messaging. Turn any gate into software.
The Nimbio API is a REST API for programmatic access to Nimbio's cellular smart-gate access control platform — opening gate latches, granting and revoking community member keys, sending community messages, and reading access logs, all authenticated with a scoped API key over HTTPS. The Nimbio API is served from api.nimbio.com and is documented with an interactive OpenAPI reference, downloadable Postman and Bruno collections, and an official Python SDK.
Every endpoint takes a bearer token. Use a nimbio_test_… key to explore safely — it runs the full pipeline (auth, rate limit, scope, validation) but never fires a gate or mutates data. Switch to nimbio_live_… for real side effects.
/v1/community/*) need a community-scoped key from a community manager.429 with a Retry-After header. Limit headers are returned on every response.request_id for support.Interactive references generated from the live OpenAPI schema, plus official SDKs for Python and TypeScript/JavaScript.
Interactive reference. Click Authorize, paste a key, and call endpoints live from the browser.
A clean, readable three-panel view of the same reference — good for skimming the whole API.
Official Python client, synchronous and asynchronous. Install with pip install nimbio-community-api.
Official TypeScript/JavaScript client — zero dependencies, runs in Node, the browser, Deno, Bun, and edge. Install with npm install @nimbio/community-api.
Kept in sync with the live API. Import a collection, or codegen straight from the OpenAPI spec.
The full machine-readable OpenAPI 3 spec — import into any client or codegen tool.
Ready-to-run Postman collection with every endpoint, plus dev / prod / local environments.
The same requests as a Bruno collection (open-source API client) — download and open the folder.
Yes. Every endpoint accepts test keys (prefixed nimbio_test_) that run the full request pipeline — authentication, rate limiting, scope checks, and validation — but never fire a gate or mutate data; writes come back simulated. Switch to a live key (nimbio_live_) only when you want real side effects.
Two official clients with matching endpoint coverage: a Python client (nimbio-community-api on PyPI, pip install nimbio-community-api) with synchronous and asynchronous interfaces, and a TypeScript/JavaScript client (@nimbio/community-api on npm) that runs in Node, the browser, Deno, Bun, and edge runtimes. Every endpoint is also reachable directly over HTTPS, and importable Postman and Bruno collections are available on this page.
Yes. Requests are limited per minute and per month, with separate counters for test and live keys. When you exceed a limit the API returns HTTP 429 with a Retry-After header telling you how long to wait, and the current usage is returned on every response in X-RateLimit headers.
No. The interactive documentation at /docs and /redoc, and the raw OpenAPI specification at /openapi.json, are public — you can browse the entire API reference without a key. An API key is only needed to actually call an endpoint.