Knowledge Base › Developers
How do I get started with the Nimbio API?
A REST API with official Python and TypeScript/JavaScript SDKs for building on top of Nimbio — open a latch, manage digital keys, and pull access history from your own software.
What the API can do
- Open a gate latch on demand
- Grant or revoke digital keys
- Retrieve access logs and gate-status history
- Check live gate and key status
- Group homes or units for multi-property management
- Integrate into fleet routing, parking and mobility apps, or self-storage rental workflows
These are the mechanisms that exist for building automation on top of Nimbio — there is no built-in, pre-wired integration with any specific property-management, leasing, or dispatch system. Anything beyond scheduled key expirations is something your own integration builds using this API.
Who can request access?
API access is an owner, manager, or integrator capability — not a resident-level feature.
Property owners, homeowners, and HOA boards — for a single residential gate.
Commercial property owners and businesses — gates, doors, buzzers, and call boxes.
Software companies — fleet routing, self-storage, and property-management platforms embedding Nimbio into their own product.
Individual residents and tenants do not get separate API access — that’s managed by the property owner or HOA board. Community-scoped keys are created by a community manager or admin from the portal’s API Access page.
Authentication and a quick example
- Auth is a bearer token — no OAuth, no cookies
- Sandbox testing:
nimbio_test_…keys run the full pipeline with nothing real happening (simulated results) - Real usage:
nimbio_live_…keys trigger real side effects - The raw token is shown once at creation and can’t be recovered afterward — save it immediately
Opening a latch
curl -X POST https://api.nimbio.com/v1/community/latches/{latch_id}/open \
-H "Authorization: Bearer nimbio_live_<your-key>"
from nimbio_community_api import NimbioClient client = NimbioClient(api_key="nimbio_live_<your-key>") client.open_latch(latch_id="<latch_id>")
Official SDKs: Python pip install nimbio-community-api (sync and async) and TypeScript/JavaScript npm install @nimbio/community-api (typed, zero-dependency; Node, browsers, Deno, Bun, and edge) — source on GitHub.
Getting a working key, and things to know before you build
The docs are public — explore first. No credentials are needed to browse the Swagger UI, ReDoc, or OpenAPI spec.
Request a working key. Email [email protected] with your use case (single home gate, commercial property, fleet routing, parking and mobility apps, self-storage, custom B2B integration) and support will point you at the right scopes.
Rate limits are per-key. Every response carries rate-limit headers — read your own limits from the response headers rather than assuming a fixed number, since limits are set per key at creation.
The API is pre-1.0. Everything currently lives under /v1. Note that the idempotency_key field is accepted but not yet enforced — a duplicated POST request can currently trigger a duplicate gate open, so build your own retry safeguards for now.
Pricing: residential integrations are priced per home, not per user, driver, or dispatcher — an integration can serve any number of them at the same cost. Commercial integrations use flexible per-active-user pricing.
Security model
HTTPS/TLS only, requests are routed over cellular rather than the property’s local network (so it’s immune to Wi-Fi or router-based attacks on that network), every request is credential-attributable, and a compromised integration or departed user’s access can be revoked immediately.
Full API reference: api.nimbio.com
This page is just the starting point. Swagger UI, ReDoc, the OpenAPI 3 spec, Postman and Bruno collections, and the official SDKs all live at api.nimbio.com — that’s the canonical, always-current reference for every endpoint.
Open api.nimbio.com → Request a key →