API Reference

Welcome to the Deadlock Mod Manager API documentation. This interactive API reference provides detailed information about all available endpoints, request/response schemas, and includes a built-in API playground for testing.

Quick Start

The Deadlock Mod Manager API provides public access to mod data, download information, and system status. All endpoints are RESTful and return JSON responses.

Example Request

curl "https://api.deadlockmods.app/v2/mods"

Example Response

{
  "mods": [
    {
      "id": 12345,
      "name": "Enhanced UI Pack",
      "description": "Comprehensive UI improvements",
      "downloads": 15420,
      "author": "ModAuthor",
      "updated_at": "2024-01-20T14:45:00Z"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 156
  }
}

API Categories

The API is organized into several categories:

Key Features

Interactive Documentation

• Live API Testing: Test endpoints directly in the documentation
• Request/Response Examples: See real examples for each endpoint
• Schema Validation: Automatic validation of request parameters
• Code Generation: Generate client code in multiple languages

Comprehensive Coverage

• Complete Endpoint Documentation: Every API endpoint is documented
• Parameter Details: Full parameter descriptions and validation rules
• Response Schemas: Detailed response structure documentation
• Error Handling: Complete error response documentation

API Versions

Version 2 (Current)

• Enhanced pagination and filtering
• Improved response schemas
• Better error handling
• Full backward compatibility with v1

Version 1 (Legacy)

• Still supported for existing integrations
• Basic mod listing and download functionality
• Limited filtering options

Rate Limits

All API endpoints are rate-limited to ensure fair usage:

• Standard Endpoints: 100 requests per minute per IP
• Download Endpoints: 10 concurrent downloads per IP
• Bulk Operations: 5 requests per minute per IP

Rate limit information is included in response headers:

X-RateLimit-Limit: 100
X-RateLimit-Remaining: 99
X-RateLimit-Reset: 1640995200

Error Handling

The API uses standard HTTP status codes and returns consistent error responses:

{
  "error": {
    "code": "MOD_NOT_FOUND",
    "message": "The requested mod could not be found",
    "details": {
      "mod_id": 12345,
      "timestamp": "2024-01-21T10:30:00Z"
    }
  }
}

Getting Support

Need help with the API?

Next Steps

• Browse Endpoints: Explore the interactive API documentation below
• Test in Browser: Use the built-in API playground to test endpoints
• Build Integration: Check out our integration examples and SDKs
• Join Community: Connect with other developers using the API