SDKs
Official client libraries for the Lumeo API.
Official SDKs are thin, type-safe wrappers around the REST API with built-in retry logic and typed request/response shapes. All SDKs are versioned alongside the API.
Choosing an SDK vs. the raw REST API
Start with the SDK if you're on Node/TypeScript — it saves you from re-implementing idempotency key generation, webhook signature verification, and retry backoff by hand. Reach for the raw REST API directly if you're on a language without an SDK yet, or if you need behavior the SDK doesn't expose.
SDK (@lumeo/sdk) | Raw REST API | |
|---|---|---|
| Type safety | Full TypeScript types for every request/response | None — you define your own types |
| Idempotency keys | Generated automatically per mutating call | You must generate and pass Idempotency-Key yourself |
| Webhook verification | lumeo.webhooks.verify(...) helper | Implement HMAC-SHA256 verification yourself — see Webhooks |
Retry on 5xx | Automatic, exponential backoff | You implement retry logic |
| Language support | TypeScript / Node.js only, today | Any language that can make HTTPS requests |
Package names
| Language | Package | Status |
|---|---|---|
| TypeScript / Node.js | @lumeo/sdk | Stable |
| Python | lumeo-python | Coming soon |
| Go | github.com/lumeo/lumeo-go | Coming soon |
Building in Python or Go today? Use the raw REST API — every example in this documentation includes a cURL variant, and most also include Python. The request/response shapes are identical to what the SDKs wrap.
Versioning
SDK versions track the API version they were built against. The API version is set in the apiVersion field of every webhook payload. Breaking changes are introduced only with a new major SDK version and announced in the Changelog.
Pin your SDK version in production rather than tracking latest — check the Changelog before upgrading across a major version.
Using the REST API directly
All endpoints are also available without an SDK. See the API Reference for full endpoint documentation and request/response shapes. Use the Authorization: Bearer YOUR_KEY header on every request.
Next steps
- TypeScript / Node SDK — install and initialize.
- Quickstart — your first payout, with SDK and cURL examples side by side.
- Error handling — what the SDK does (and doesn't) handle for you around retries and idempotency.