Ludustack API Reference

API Overview

The Ludustack API is organized around REST principles. It uses standard HTTP verbs, returns JSON-encoded responses, and uses standard HTTP response codes to indicate API errors.

All API requests must be authenticated using your API key. API keys are tied to your user account, not to specific projects. You can generate API keys in your account settings.

Authentication

The Ludustack API requires authentication using API keys for all endpoints. You can generate an API key in your dashboard.

API Key Authentication

Include your API key in the request headers using one of these methods:

Authorization: Bearer YOUR_API_KEY

X-API-Key: YOUR_API_KEY

API Key Scopes

API keys have different scopes that determine what operations they can perform:

Example API Request with Authentication

// Using fetch
fetch('https://ludustack.com/api/games', {
  method: 'GET',
  headers: {
    'Content-Type': 'application/json',
    'Authorization': 'Bearer YOUR_API_KEY'
  }
})
.then(response => response.json())
.then(data => console.log(data))
.catch(error => console.error(error));

// Using axios
import axios from 'axios';

axios.get('https://ludustack.com/api/games', {
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY'
  }
})
.then(response => console.log(response.data))
.catch(error => console.error(error));

Error Handling

The Ludustack API uses conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that failed given the information provided, and codes in the 5xx range indicate an error with Ludustack's servers.

Rate Limiting

The Ludustack API implements rate limiting to protect against abuse and ensure a reliable service for all users. Rate limits are applied on a per-API key basis.

If you exceed the rate limit, you will receive a 429 Too Many Requests response. The response will include headers that provide information about your rate limit status:

• X-RateLimit-Limit: The maximum number of requests you're permitted to make per hour.
• X-RateLimit-Remaining: The number of requests remaining in the current rate limit window.
• X-RateLimit-Reset: The time at which the current rate limit window resets in UTC epoch seconds.