MENU navbar-image

Introduction

This documentation aims to provide all the information you need to work with our API.

<aside>As you scroll, you'll see code examples for working with the API in different programming languages in the dark area to the right (or as part of the content on mobile).
You can switch the language used with the tabs at the top right (or from the nav menu at the top left on mobile).</aside>

Authenticating requests

This API is not authenticated.

Rankings

APIs para visualização de rankings de jogos

Ranking Geral * Retorna o top 10 jogos baseado no período informado.

Example request:
curl --request GET \
    --get "http://localhost/api/v1/rankings/general?period=weekly" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/api/v1/rankings/general"
);

const params = {
    "period": "weekly",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 59
access-control-allow-origin: *
 

[
    {
        "id": 4,
        "name": "League of Legends",
        "platform": "Riot Launcher",
        "active_players": 871182,
        "weekly_points": 973,
        "monthly_points": 1984,
        "yearly_points": 80768,
        "created_at": "2026-04-14T02:35:43.000000Z",
        "updated_at": "2026-04-14T02:35:43.000000Z"
    },
    {
        "id": 12,
        "name": "Baldur's Gate 3",
        "platform": "Steam",
        "active_players": 1275998,
        "weekly_points": 915,
        "monthly_points": 5889,
        "yearly_points": 52943,
        "created_at": "2026-04-14T02:35:43.000000Z",
        "updated_at": "2026-04-14T02:35:43.000000Z"
    },
    {
        "id": 15,
        "name": "Stardew Valley",
        "platform": "Steam",
        "active_players": 376396,
        "weekly_points": 876,
        "monthly_points": 2187,
        "yearly_points": 35250,
        "created_at": "2026-04-14T02:35:43.000000Z",
        "updated_at": "2026-04-14T02:35:43.000000Z"
    },
    {
        "id": 1,
        "name": "Counter-Strike 2",
        "platform": "Steam",
        "active_players": 929392,
        "weekly_points": 823,
        "monthly_points": 1188,
        "yearly_points": 81765,
        "created_at": "2026-04-14T02:35:43.000000Z",
        "updated_at": "2026-04-14T02:35:43.000000Z"
    },
    {
        "id": 9,
        "name": "Fortnite",
        "platform": "Epic Games",
        "active_players": 1114470,
        "weekly_points": 797,
        "monthly_points": 7803,
        "yearly_points": 40254,
        "created_at": "2026-04-14T02:35:43.000000Z",
        "updated_at": "2026-04-14T02:35:43.000000Z"
    },
    {
        "id": 6,
        "name": "EA SPORTS FC 24",
        "platform": "Steam",
        "active_players": 921786,
        "weekly_points": 696,
        "monthly_points": 3010,
        "yearly_points": 87627,
        "created_at": "2026-04-14T02:35:43.000000Z",
        "updated_at": "2026-04-14T02:35:43.000000Z"
    },
    {
        "id": 3,
        "name": "Valorant",
        "platform": "Riot Launcher",
        "active_players": 870657,
        "weekly_points": 604,
        "monthly_points": 3181,
        "yearly_points": 51833,
        "created_at": "2026-04-14T02:35:43.000000Z",
        "updated_at": "2026-04-14T02:35:43.000000Z"
    },
    {
        "id": 10,
        "name": "Grand Theft Auto V",
        "platform": "Steam",
        "active_players": 219252,
        "weekly_points": 603,
        "monthly_points": 8711,
        "yearly_points": 55435,
        "created_at": "2026-04-14T02:35:43.000000Z",
        "updated_at": "2026-04-14T02:35:43.000000Z"
    },
    {
        "id": 5,
        "name": "Helldivers 2",
        "platform": "Steam",
        "active_players": 740974,
        "weekly_points": 591,
        "monthly_points": 7606,
        "yearly_points": 20462,
        "created_at": "2026-04-14T02:35:43.000000Z",
        "updated_at": "2026-04-14T02:35:43.000000Z"
    },
    {
        "id": 13,
        "name": "Warzone",
        "platform": "Battle.net",
        "active_players": 1362862,
        "weekly_points": 415,
        "monthly_points": 1747,
        "yearly_points": 22846,
        "created_at": "2026-04-14T02:35:43.000000Z",
        "updated_at": "2026-04-14T02:35:43.000000Z"
    }
]

Request      

GET api/v1/rankings/general

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

Query Parameters

period   string     

O período do ranking (weekly, monthly, yearly). Example: weekly

Jogos Mais Jogados * Retorna o top 10 jogos com base no número de jogadores ativos.

Example request:
curl --request GET \
    --get "http://localhost/api/v1/games/most-played" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/api/v1/games/most-played"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 58
access-control-allow-origin: *
 

[
    {
        "id": 11,
        "name": "Cyberpunk 2077",
        "platform": "Steam",
        "active_players": 1395488,
        "weekly_points": 131,
        "monthly_points": 8565,
        "yearly_points": 96534,
        "created_at": "2026-04-14T02:35:43.000000Z",
        "updated_at": "2026-04-14T02:35:43.000000Z"
    },
    {
        "id": 13,
        "name": "Warzone",
        "platform": "Battle.net",
        "active_players": 1362862,
        "weekly_points": 415,
        "monthly_points": 1747,
        "yearly_points": 22846,
        "created_at": "2026-04-14T02:35:43.000000Z",
        "updated_at": "2026-04-14T02:35:43.000000Z"
    },
    {
        "id": 14,
        "name": "Apex Legends",
        "platform": "Steam",
        "active_players": 1301140,
        "weekly_points": 378,
        "monthly_points": 7466,
        "yearly_points": 49160,
        "created_at": "2026-04-14T02:35:43.000000Z",
        "updated_at": "2026-04-14T02:35:43.000000Z"
    },
    {
        "id": 12,
        "name": "Baldur's Gate 3",
        "platform": "Steam",
        "active_players": 1275998,
        "weekly_points": 915,
        "monthly_points": 5889,
        "yearly_points": 52943,
        "created_at": "2026-04-14T02:35:43.000000Z",
        "updated_at": "2026-04-14T02:35:43.000000Z"
    },
    {
        "id": 9,
        "name": "Fortnite",
        "platform": "Epic Games",
        "active_players": 1114470,
        "weekly_points": 797,
        "monthly_points": 7803,
        "yearly_points": 40254,
        "created_at": "2026-04-14T02:35:43.000000Z",
        "updated_at": "2026-04-14T02:35:43.000000Z"
    },
    {
        "id": 2,
        "name": "Elden Ring",
        "platform": "Steam",
        "active_players": 1041606,
        "weekly_points": 240,
        "monthly_points": 4402,
        "yearly_points": 77492,
        "created_at": "2026-04-14T02:35:43.000000Z",
        "updated_at": "2026-04-14T02:35:43.000000Z"
    },
    {
        "id": 1,
        "name": "Counter-Strike 2",
        "platform": "Steam",
        "active_players": 929392,
        "weekly_points": 823,
        "monthly_points": 1188,
        "yearly_points": 81765,
        "created_at": "2026-04-14T02:35:43.000000Z",
        "updated_at": "2026-04-14T02:35:43.000000Z"
    },
    {
        "id": 6,
        "name": "EA SPORTS FC 24",
        "platform": "Steam",
        "active_players": 921786,
        "weekly_points": 696,
        "monthly_points": 3010,
        "yearly_points": 87627,
        "created_at": "2026-04-14T02:35:43.000000Z",
        "updated_at": "2026-04-14T02:35:43.000000Z"
    },
    {
        "id": 4,
        "name": "League of Legends",
        "platform": "Riot Launcher",
        "active_players": 871182,
        "weekly_points": 973,
        "monthly_points": 1984,
        "yearly_points": 80768,
        "created_at": "2026-04-14T02:35:43.000000Z",
        "updated_at": "2026-04-14T02:35:43.000000Z"
    },
    {
        "id": 3,
        "name": "Valorant",
        "platform": "Riot Launcher",
        "active_players": 870657,
        "weekly_points": 604,
        "monthly_points": 3181,
        "yearly_points": 51833,
        "created_at": "2026-04-14T02:35:43.000000Z",
        "updated_at": "2026-04-14T02:35:43.000000Z"
    }
]

Request      

GET api/v1/games/most-played

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

Ranking por Plataforma * Retorna os jogos mais bem ranqueados de uma plataforma específica.

Example request:
curl --request GET \
    --get "http://localhost/api/v1/rankings/platforms/Steam" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/api/v1/rankings/platforms/Steam"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 57
access-control-allow-origin: *
 

[
    {
        "id": 11,
        "name": "Cyberpunk 2077",
        "platform": "Steam",
        "active_players": 1395488,
        "weekly_points": 131,
        "monthly_points": 8565,
        "yearly_points": 96534,
        "created_at": "2026-04-14T02:35:43.000000Z",
        "updated_at": "2026-04-14T02:35:43.000000Z"
    },
    {
        "id": 14,
        "name": "Apex Legends",
        "platform": "Steam",
        "active_players": 1301140,
        "weekly_points": 378,
        "monthly_points": 7466,
        "yearly_points": 49160,
        "created_at": "2026-04-14T02:35:43.000000Z",
        "updated_at": "2026-04-14T02:35:43.000000Z"
    },
    {
        "id": 12,
        "name": "Baldur's Gate 3",
        "platform": "Steam",
        "active_players": 1275998,
        "weekly_points": 915,
        "monthly_points": 5889,
        "yearly_points": 52943,
        "created_at": "2026-04-14T02:35:43.000000Z",
        "updated_at": "2026-04-14T02:35:43.000000Z"
    },
    {
        "id": 2,
        "name": "Elden Ring",
        "platform": "Steam",
        "active_players": 1041606,
        "weekly_points": 240,
        "monthly_points": 4402,
        "yearly_points": 77492,
        "created_at": "2026-04-14T02:35:43.000000Z",
        "updated_at": "2026-04-14T02:35:43.000000Z"
    },
    {
        "id": 1,
        "name": "Counter-Strike 2",
        "platform": "Steam",
        "active_players": 929392,
        "weekly_points": 823,
        "monthly_points": 1188,
        "yearly_points": 81765,
        "created_at": "2026-04-14T02:35:43.000000Z",
        "updated_at": "2026-04-14T02:35:43.000000Z"
    },
    {
        "id": 6,
        "name": "EA SPORTS FC 24",
        "platform": "Steam",
        "active_players": 921786,
        "weekly_points": 696,
        "monthly_points": 3010,
        "yearly_points": 87627,
        "created_at": "2026-04-14T02:35:43.000000Z",
        "updated_at": "2026-04-14T02:35:43.000000Z"
    },
    {
        "id": 5,
        "name": "Helldivers 2",
        "platform": "Steam",
        "active_players": 740974,
        "weekly_points": 591,
        "monthly_points": 7606,
        "yearly_points": 20462,
        "created_at": "2026-04-14T02:35:43.000000Z",
        "updated_at": "2026-04-14T02:35:43.000000Z"
    },
    {
        "id": 15,
        "name": "Stardew Valley",
        "platform": "Steam",
        "active_players": 376396,
        "weekly_points": 876,
        "monthly_points": 2187,
        "yearly_points": 35250,
        "created_at": "2026-04-14T02:35:43.000000Z",
        "updated_at": "2026-04-14T02:35:43.000000Z"
    },
    {
        "id": 10,
        "name": "Grand Theft Auto V",
        "platform": "Steam",
        "active_players": 219252,
        "weekly_points": 603,
        "monthly_points": 8711,
        "yearly_points": 55435,
        "created_at": "2026-04-14T02:35:43.000000Z",
        "updated_at": "2026-04-14T02:35:43.000000Z"
    }
]

Request      

GET api/v1/rankings/platforms/{platform}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

platform   string     

O nome da plataforma. Example: Steam