Evula Documents

Evula Documentation

Complete guide to using the Evula API

Installation

Steps to install and configure the Evula API

Requirements

  • Web server with PHP 7.4+
  • MySQL database
  • API key from Evula

Installation Steps

  1. Register on Evula website to get your API key
  2. Choose the appropriate API endpoint for your needs
  3. Implement the API calls in your application
  4. Handle the JSON responses
Important: Always secure your API keys and never expose them in client-side code. Make requests from your backend when possible.

Configuration

Essential Settings

Setting Description Required
API Key Your unique API key for authentication Yes
Endpoint URL The base URL for API requests Yes
Rate Limit Requests per minute limit Yes

Permissions

API Access Levels

Permission Description Access Level
Basic Access to public data endpoints Free tier
Standard Access to most API endpoints Paid tier
Premium Full API access with higher rate limits Enterprise tier

Discord API

The Discord API endpoints provide information about Discord servers, users, and guild members where the Evula bot is present.

Endpoints

Endpoint Description Supported Platforms
api.evula.ir/discord/guild/ GET guild information with Evula bot Unity, Website, Bots, Android app
api.evula.ir/discord/user/ GET user information with userid Unity, Website, Bots, Android app
api.evula.ir/discord/uing/ GET user information in guild with Evula bot Unity, Website, Bots, Android app

Example Request

JavaScript 

fetch('https://api.evula.ir/discord/guild/123456789', {
    headers: {
        'Authorization': 'Bearer YOUR_API_KEY'
    }
})
.then(response => response.json())
.then(data => console.log(data));

Example Response

JSON 

{
    "success": true,
    "data": {
        "id": "123456789",
        "name": "Evula Community",
        "icon": "a_abc123def456",
        "members": 1250,
        "online": 342,
        "channels": 28,
        "roles": 15,
        "created_at": "2020-05-15T14:30:00Z"
    }
}

Minecraft API

The Minecraft API endpoints provide information about Minecraft servers (both Java and Bedrock editions) and player avatars.

Endpoints

Endpoint Description Supported Platforms
api.evula.ir/mc/java/ GET Minecraft Java server information Unity, Website, Bots, Android app
api.evula.ir/mc/avatar/ GET Minecraft username skin avatar Unity, Website, Bots, Android app
api.evula.ir/mc/bedrock/ GET Minecraft Bedrock server information Unity, Website, Bots, Android app

Example Request

JavaScript 

fetch('https://api.evula.ir/mc/java/mc.hypixel.net', {
    headers: {
        'Authorization': 'Bearer YOUR_API_KEY'
    }
})
.then(response => response.json())
.then(data => console.log(data));

Example Response

JSON 

{
    "success": true,
    "data": {
        "host": "mc.hypixel.net",
        "port": 25565,
        "version": "Requires MC 1.8 / 1.20",
        "players": {
            "online": 45632,
            "max": 200000,
            "sample": [
                {"name": "Player1", "id": "uuid1"},
                {"name": "Player2", "id": "uuid2"}
            ]
        },
        "motd": "Hypixel Network - Mini Games!",
        "ping": 45,
        "icon": "data:image/png;base64,..."
    }
}

FiveM API

The FiveM API endpoint provides information about FiveM game servers.

Endpoints

Endpoint Description Supported Platforms
api.evula.ir/fivem/sv/ GET FiveM server information Unity, Website, Bots, Android app

Example Request

JavaScript 

fetch('https://api.evula.ir/fivem/sv/123.45.67.89:30120', {
    headers: {
        'Authorization': 'Bearer YOUR_API_KEY'
    }
})
.then(response => response.json())
.then(data => console.log(data));

Example Response

JSON 

{
    "success": true,
    "data": {
        "host": "123.45.67.89",
        "port": 30120,
        "name": "Awesome RP Server",
        "players": {
            "online": 32,
            "max": 64,
            "list": ["Player1", "Player2"]
        },
        "gametype": "roleplay",
        "map": "Los Santos",
        "vars": {
            "uptime": "3d 12h",
            "framework": "ESX"
        },
        "resources": 45,
        "ping": 28
    }
}

CounterStrike API

The CounterStrike API endpoint provides information about Counter Strike 2 game servers.

Endpoints

Endpoint Description Supported Platforms
api.evula.ir/cs/sv/ GET Counter Strike 2 server information Unity, Website, Bots, Android app

Example Request

JavaScript 

fetch('https://api.evula.ir/cs/sv/123.45.67.89:27015', {
    headers: {
        'Authorization': 'Bearer YOUR_API_KEY'
    }
})
.then(response => response.json())
.then(data => console.log(data));

Example Response

JSON 

{
    "success": true,
    "data": {
        "host": "123.45.67.89",
        "port": 27015,
        "name": "CS2 Competitive #1",
        "map": "de_dust2",
        "players": {
            "online": 10,
            "max": 10,
            "bots": 0,
            "list": [
                {"name": "Player1", "score": 15, "time": "45:30"},
                {"name": "Player2", "score": 12, "time": "43:15"}
            ]
        },
        "password": false,
        "vac": true,
        "version": "1.38.5.5",
        "ping": 22
    }
}

MTA API

The MTA API endpoint provides information about Multi Theft Auto game servers.

Endpoints

Endpoint Description Supported Platforms
api.evula.ir/mta/sv/ GET MTA server information Unity, Website, Bots, Android app

Example Request

JavaScript 

fetch('https://api.evula.ir/mta/sv/123.45.67.89:22003', {
    headers: {
        'Authorization': 'Bearer YOUR_API_KEY'
    }
})
.then(response => response.json())
.then(data => console.log(data));

Example Response

JSON 

{
    "success": true,
    "data": {
        "host": "123.45.67.89",
        "port": 22003,
        "name": "MTA Roleplay Server",
        "gametype": "roleplay",
        "map": "San Andreas",
        "password": false,
        "players": {
            "online": 25,
            "max": 100,
            "list": ["Player1", "Player2"]
        },
        "version": "1.5.9",
        "ping": 35,
        "resources": 78,
        "uptime": "5d 8h"
    }
}

Need help? Join our Discord Support Server