API Documentation

API Version: 1.0.0 | Game Version: 1.2.3

Last Update: 12/01/24 01:08

Connect with Discord

Log in with Discord

API Endpoints

Weapons

Method: GET

Example URL: https://the-coven.fr/api/hunt/weapons

Example Response:

                                {
    "ErrorCode": 0,
    "ErrorStatus": "success",
    "ErrorMessage": "Request processed successfully.",
    "Response": [
        {
            "id": "nagant_m1895",
            "name": "Nagant M1895",
            "description": "Nagant made, single-action revolver. Medium damage, with a muzzle celocity and capacity.",
            "can_be_dual": true,
            "category": "Small",
            "cost": 24
            ...
        }
    ]
}

Maps

Method: GET

Example URL: https://the-coven.fr/api/hunt/maps

Example Response:

                                {
    "ErrorCode": 404,
    "ErrorStatus": "error",
    "ErrorMessage": "Endpoint not found.",
    "Response": []
}

Hunters

Method: GET

Example URL: https://the-coven.fr/api/hunt/hunters

Example Response:

                                {
    "ErrorCode": 404,
    "ErrorStatus": "error",
    "ErrorMessage": "Endpoint not found.",
    "Response": []
}

Traits

Method: GET

Example URL: https://the-coven.fr/api/hunt/traits

Example Response:

                                {
    "ErrorCode": 404,
    "ErrorStatus": "error",
    "ErrorMessage": "Endpoint not found.",
    "Response": []
}

Consumables

Method: GET

Example URL: https://the-coven.fr/api/hunt/consumables

Example Response:

                                {
    "ErrorCode": 404,
    "ErrorStatus": "error",
    "ErrorMessage": "Endpoint not found.",
    "Response": []
}

Tools

Method: GET

Example URL: https://the-coven.fr/api/hunt/tools

Example Response:

                                {
    "ErrorCode": 404,
    "ErrorStatus": "error",
    "ErrorMessage": "Endpoint not found.",
    "Response": []
}

DLC

Method: GET

Example URL: https://the-coven.fr/api/hunt/dlc

Example Response:

                                {
    "ErrorCode": 404,
    "ErrorStatus": "error",
    "ErrorMessage": "Endpoint not found.",
    "Response": []
}

Entity

Method: GET

Example URL: https://the-coven.fr/api/hunt/entity

Example Response:

                                {
    "ErrorCode": 404,
    "ErrorStatus": "error",
    "ErrorMessage": "Endpoint not found.",
    "Response": []
}

Status

Method: GET

Example URL: https://the-coven.fr/api/hunt/status

Example Response:

                                {
    "Title": "API Status",
    "Response": {
        "api_version": "1.0.0",
        "game_version": "1.2.3",
        "status": "online",
        "total_api_keys": 1,
        "total_requests": 13,
        "total_keys": 12,
        "last_update": "01/12/24 01:08",
        "current_time": "10/12/2024 04:54"
    }
}

Frequently Asked Questions

How do query parameters work in API URLs?

Query parameters allow you to refine your API requests. These parameters are added to the URL in the format key=value, and you can use multiple parameters separated by &.

https://the-coven.fr/api/hunt/weapons?can_be_dual=true&category=Small

In this example:

  • can_be_dual=true filters the weapons to only show dual wielding.
  • category=Small filters weapons with a category value of Small.

You can use query parameters for all API endpoints to filter and modify the response based on specific criteria.

What is the rate limit?

The API imposes a limit on the number of requests that each user can make within a given time period. This ensures the stability of the API even during high demand.

{
    "ErrorCode": 429,
    "ErrorStatus": "error",
    "ErrorMessage": "Rate limit exceeded. Please wait a minute before retrying.",
    "Version": "1.0",
    "Response": []
}
How to avoid exceeding the rate limit?
  • Reduce the number of requests you make per minute.
  • Use a valid API key to increase your request limit to 50 per minute.
What should I do if I exceed the rate limit?

Wait for a minute before making another request.

Does the API key increase my rate limit?

Yes, the API key allows you to make up to 50 requests per minute.

When is the rate limit reset?

The limit resets every minute. If you reach the limit, you will need to wait until the end of the minute before making a new request.

Rate Limit Behavior?

By default: Without an API key, you can make 2 requests per minute.

With a valid API key: You are allowed 50 requests per minute.

How to get an API key?

At the top of this page, you have access to a button that will generate an API key based on your Discord ID.

Do I need a Discord account to get an API key?

Yes, a Discord account is required. It's the easiest, fastest, and most effective method for both you and me. You can create a free Discord account by clicking this button: Download Discord