LumireCRM

Docs · Quickstart

5-minute quickstart

From zero to first authenticated request. You will need a tenant slug, an admin login, and a terminal with curl.

1. Create your tenant

New tenants are minted by the marketing site signup or, on a self-hosted box, via the admin signup flow at POST /v1/auth/register:

curl -X POST 'http://143.110.171.125:4000/v1/auth/register' \
  -H 'Content-Type: application/json' \
  -d '{
    "email": "you@example.com",
    "password": "ChangeMe123!",
    "displayName": "You",
    "tenantName": "Acme FX"
  }'

2. Mint a personal API key

Sign in to the admin UI, open /api-keys, and click Create key. The full token is shown once — copy it immediately. Tokens look like lum_live_abcd… and are argon2id-hashed at rest.

3. First request

Verify your client can talk to the API and is matched against the right contract version:

curl -H 'X-API-Key: lum_live_REPLACE_ME' \
  http://143.110.171.125:4000/v1/_meta/version

# →
# {
#   "contract_version": "1.0.0",
#   "package_version": "...",
#   "git_sha": null,
#   "latest_change": { ... }
# }

4. Hit a real resource

curl -H 'X-API-Key: lum_live_REPLACE_ME' \
  'http://143.110.171.125:4000/v1/traders?limit=5'

5. Pick an SDK

See Python, PHP, Go, or use TypeScript via @lumirecrm/sdk.

What next?