Skip to main content
This SDK is not affiliated with or maintained by Luma.
The @alhwyn/luma package is an unofficial TypeScript client for the Luma public API. It provides typed methods for users, calendars, events, guests, ticket types, and webhooks.
You need a Luma Plus organization to use the API. See the Luma getting started guide for official setup.

​
How it works

You pass an API key to the Luma client. The SDK handles authentication and returns typed responses.

​
Get started

1

Install the package

Install @alhwyn/luma from GitHub Packages:
npm install @alhwyn/luma
See Install for GitHub Packages authentication.
2

Add your API key

Create a key at Luma API keys and set LUMA_API_KEY. See Authentication.
3

Test your setup

Follow Test your setup with a short SDK script to confirm everything works.
4

Call SDK methods

Initialize the Client and use the resource guides below.

​
Documentation

Test your setup

Smoke-test your API key with a short SDK script.

Client

Initialize the Luma client and shared types.

Users

Confirm authentication with luma.users.get().

Events

List, create, and manage events, guests, and tickets.

Webhooks

Register endpoints and verify incoming events.

​
Unofficial SDK vs official Luma docs

This sitedocs.luma.com
PurposeTypeScript client for @alhwyn/lumaOfficial Luma API reference
Authnew Luma(apiKey)x-luma-api-key header
TestingTest your setup with SDK scriptsOfficial playground
Use this site to learn the unofficial SDK. Use docs.luma.com for official API field reference.

​
Use with AI tools

Connect an AI assistant to this documentation site so it can search and cite SDK methods instead of guessing.
Open the contextual menu on any page and click Connect to Cursor or Connect to VS Code. Or add the hosted MCP server manually:
{
  "mcpServers": {
    "unofficial-luma-sdk-docs": {
      "url": "https://unofficial-luma-sdk.mintlify.app/mcp"
    }
  }
}