Skip to main content
Welcome to the Lumira’s API Documentation! This will provide all the information you need to integrate our best features into your games and services using our API.
This Feature is Still Under BETA. Use with your own risk.
Lumira API allows you to programmatically perform actions such as:
  • Automating rank promotions within your Roblox group
  • Managing users and rank progression systems
  • Sending in-game or external notifications (e.g., logs)
  • Securely authenticating and managing API access
Important: The API is only available with a valid API key.

​
Base URL

All API requests are made to: 
https://api.lumiraranking.co.uk/
  • All requests must use HTTPS
  • Requests must include proper authentication via your API key

​
Authentication

All endpoints require an API Key to access.
Your API key acts as a secure token that identifies and authorizes your system.

​
How to get your API key

  1. Join Lumira Discord Server
  2. Generate a key using the bot command
    (example: /apikey create — may vary depending on your setup)
  3. Copy your API key and store it securely
🔐 Important: Treat your API key like a password. If it is exposed, regenerate it immediately.

​
Requirements

Before using the Lumira API, ensure you have:
  • A valid Lumira API key
  • Lumira must be fully setup in your discord server.
  • Proper permissions to execute ranking actions
  • HTTPs Services enabled in your Roblox game

​
Rate Limits & Best Practices

To ensure stability and avoid restrictions:
  • Avoid sending excessive requests in a short time
  • Batch actions when possible (e.g., ranking multiple players)
  • Always check API responses before continuing logic
The API returns standard HTTP response codes:
CodeMeaning
200Success
400Bad Request
401Unauthorized (invalid API key)
403Forbidden (missing permissions or invalid setup)
404Not Found
500Server Error (service-side issue report to us immediately)
Each response may also include additional details in the body to help with debugging.