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

Top semanal * Retorna o ranking dos jogos com melhor desempenho na última semana.

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

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: 49
access-control-allow-origin: *
 

[
    {
        "id": 12,
        "name": "Call of Duty: Warzone",
        "platform": "Battle.net",
        "active_players": 933732,
        "weekly_points": 857,
        "monthly_points": 4936,
        "yearly_points": 44623,
        "created_at": "2026-04-18T01:47:16.000000Z",
        "updated_at": "2026-04-18T01:47:16.000000Z"
    },
    {
        "id": 4,
        "name": "Helldivers 2",
        "platform": "Steam",
        "active_players": 589021,
        "weekly_points": 833,
        "monthly_points": 9947,
        "yearly_points": 78223,
        "created_at": "2026-04-18T01:47:16.000000Z",
        "updated_at": "2026-04-18T01:47:16.000000Z"
    },
    {
        "id": 6,
        "name": "Fortnite",
        "platform": "Epic Games",
        "active_players": 418738,
        "weekly_points": 813,
        "monthly_points": 6995,
        "yearly_points": 22527,
        "created_at": "2026-04-18T01:47:16.000000Z",
        "updated_at": "2026-04-18T01:47:16.000000Z"
    },
    {
        "id": 7,
        "name": "Grand Theft Auto V",
        "platform": "Steam",
        "active_players": 1509381,
        "weekly_points": 812,
        "monthly_points": 7911,
        "yearly_points": 17211,
        "created_at": "2026-04-18T01:47:16.000000Z",
        "updated_at": "2026-04-18T01:47:16.000000Z"
    },
    {
        "id": 8,
        "name": "EA SPORTS FC 24",
        "platform": "Steam",
        "active_players": 1075170,
        "weekly_points": 776,
        "monthly_points": 6337,
        "yearly_points": 70015,
        "created_at": "2026-04-18T01:47:16.000000Z",
        "updated_at": "2026-04-18T01:47:16.000000Z"
    },
    {
        "id": 13,
        "name": "Minecraft",
        "platform": "Multiplataforma",
        "active_players": 1058688,
        "weekly_points": 768,
        "monthly_points": 6013,
        "yearly_points": 97008,
        "created_at": "2026-04-18T01:47:16.000000Z",
        "updated_at": "2026-04-18T01:47:16.000000Z"
    },
    {
        "id": 15,
        "name": "Stardew Valley",
        "platform": "Steam",
        "active_players": 94038,
        "weekly_points": 682,
        "monthly_points": 5436,
        "yearly_points": 54743,
        "created_at": "2026-04-18T01:47:16.000000Z",
        "updated_at": "2026-04-18T01:47:16.000000Z"
    },
    {
        "id": 2,
        "name": "Elden Ring",
        "platform": "Steam",
        "active_players": 799796,
        "weekly_points": 647,
        "monthly_points": 8422,
        "yearly_points": 76612,
        "created_at": "2026-04-18T01:47:16.000000Z",
        "updated_at": "2026-04-18T01:47:16.000000Z"
    },
    {
        "id": 9,
        "name": "Roblox",
        "platform": "Multiplataforma",
        "active_players": 139569,
        "weekly_points": 636,
        "monthly_points": 8679,
        "yearly_points": 12637,
        "created_at": "2026-04-18T01:47:16.000000Z",
        "updated_at": "2026-04-18T01:47:16.000000Z"
    },
    {
        "id": 10,
        "name": "League of Legends",
        "platform": "Riot Launcher",
        "active_players": 1682586,
        "weekly_points": 587,
        "monthly_points": 1858,
        "yearly_points": 56745,
        "created_at": "2026-04-18T01:47:16.000000Z",
        "updated_at": "2026-04-18T01:47:16.000000Z"
    }
]

Request      

GET api/v1/rankings/weekly

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

Top mensal * Retorna o ranking dos jogos com melhor desempenho no último mês.

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

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: 48
access-control-allow-origin: *
 

[
    {
        "id": 4,
        "name": "Helldivers 2",
        "platform": "Steam",
        "active_players": 589021,
        "weekly_points": 833,
        "monthly_points": 9947,
        "yearly_points": 78223,
        "created_at": "2026-04-18T01:47:16.000000Z",
        "updated_at": "2026-04-18T01:47:16.000000Z"
    },
    {
        "id": 9,
        "name": "Roblox",
        "platform": "Multiplataforma",
        "active_players": 139569,
        "weekly_points": 636,
        "monthly_points": 8679,
        "yearly_points": 12637,
        "created_at": "2026-04-18T01:47:16.000000Z",
        "updated_at": "2026-04-18T01:47:16.000000Z"
    },
    {
        "id": 2,
        "name": "Elden Ring",
        "platform": "Steam",
        "active_players": 799796,
        "weekly_points": 647,
        "monthly_points": 8422,
        "yearly_points": 76612,
        "created_at": "2026-04-18T01:47:16.000000Z",
        "updated_at": "2026-04-18T01:47:16.000000Z"
    },
    {
        "id": 11,
        "name": "Apex Legends",
        "platform": "Steam",
        "active_players": 558948,
        "weekly_points": 219,
        "monthly_points": 8214,
        "yearly_points": 80587,
        "created_at": "2026-04-18T01:47:16.000000Z",
        "updated_at": "2026-04-18T01:47:16.000000Z"
    },
    {
        "id": 7,
        "name": "Grand Theft Auto V",
        "platform": "Steam",
        "active_players": 1509381,
        "weekly_points": 812,
        "monthly_points": 7911,
        "yearly_points": 17211,
        "created_at": "2026-04-18T01:47:16.000000Z",
        "updated_at": "2026-04-18T01:47:16.000000Z"
    },
    {
        "id": 6,
        "name": "Fortnite",
        "platform": "Epic Games",
        "active_players": 418738,
        "weekly_points": 813,
        "monthly_points": 6995,
        "yearly_points": 22527,
        "created_at": "2026-04-18T01:47:16.000000Z",
        "updated_at": "2026-04-18T01:47:16.000000Z"
    },
    {
        "id": 8,
        "name": "EA SPORTS FC 24",
        "platform": "Steam",
        "active_players": 1075170,
        "weekly_points": 776,
        "monthly_points": 6337,
        "yearly_points": 70015,
        "created_at": "2026-04-18T01:47:16.000000Z",
        "updated_at": "2026-04-18T01:47:16.000000Z"
    },
    {
        "id": 13,
        "name": "Minecraft",
        "platform": "Multiplataforma",
        "active_players": 1058688,
        "weekly_points": 768,
        "monthly_points": 6013,
        "yearly_points": 97008,
        "created_at": "2026-04-18T01:47:16.000000Z",
        "updated_at": "2026-04-18T01:47:16.000000Z"
    },
    {
        "id": 15,
        "name": "Stardew Valley",
        "platform": "Steam",
        "active_players": 94038,
        "weekly_points": 682,
        "monthly_points": 5436,
        "yearly_points": 54743,
        "created_at": "2026-04-18T01:47:16.000000Z",
        "updated_at": "2026-04-18T01:47:16.000000Z"
    },
    {
        "id": 1,
        "name": "Counter-Strike 2",
        "platform": "Steam",
        "active_players": 564671,
        "weekly_points": 554,
        "monthly_points": 5004,
        "yearly_points": 60724,
        "created_at": "2026-04-18T01:47:16.000000Z",
        "updated_at": "2026-04-18T01:47:16.000000Z"
    }
]

Request      

GET api/v1/rankings/monthly

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

Top anual * Retorna o ranking dos jogos com melhor desempenho no último ano.

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

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: 47
access-control-allow-origin: *
 

[
    {
        "id": 3,
        "name": "Valorant",
        "platform": "Riot Launcher",
        "active_players": 1153799,
        "weekly_points": 155,
        "monthly_points": 2662,
        "yearly_points": 99544,
        "created_at": "2026-04-18T01:47:16.000000Z",
        "updated_at": "2026-04-18T01:47:16.000000Z"
    },
    {
        "id": 13,
        "name": "Minecraft",
        "platform": "Multiplataforma",
        "active_players": 1058688,
        "weekly_points": 768,
        "monthly_points": 6013,
        "yearly_points": 97008,
        "created_at": "2026-04-18T01:47:16.000000Z",
        "updated_at": "2026-04-18T01:47:16.000000Z"
    },
    {
        "id": 11,
        "name": "Apex Legends",
        "platform": "Steam",
        "active_players": 558948,
        "weekly_points": 219,
        "monthly_points": 8214,
        "yearly_points": 80587,
        "created_at": "2026-04-18T01:47:16.000000Z",
        "updated_at": "2026-04-18T01:47:16.000000Z"
    },
    {
        "id": 4,
        "name": "Helldivers 2",
        "platform": "Steam",
        "active_players": 589021,
        "weekly_points": 833,
        "monthly_points": 9947,
        "yearly_points": 78223,
        "created_at": "2026-04-18T01:47:16.000000Z",
        "updated_at": "2026-04-18T01:47:16.000000Z"
    },
    {
        "id": 2,
        "name": "Elden Ring",
        "platform": "Steam",
        "active_players": 799796,
        "weekly_points": 647,
        "monthly_points": 8422,
        "yearly_points": 76612,
        "created_at": "2026-04-18T01:47:16.000000Z",
        "updated_at": "2026-04-18T01:47:16.000000Z"
    },
    {
        "id": 8,
        "name": "EA SPORTS FC 24",
        "platform": "Steam",
        "active_players": 1075170,
        "weekly_points": 776,
        "monthly_points": 6337,
        "yearly_points": 70015,
        "created_at": "2026-04-18T01:47:16.000000Z",
        "updated_at": "2026-04-18T01:47:16.000000Z"
    },
    {
        "id": 5,
        "name": "Baldur's Gate 3",
        "platform": "Steam",
        "active_players": 847989,
        "weekly_points": 198,
        "monthly_points": 1404,
        "yearly_points": 66933,
        "created_at": "2026-04-18T01:47:16.000000Z",
        "updated_at": "2026-04-18T01:47:16.000000Z"
    },
    {
        "id": 1,
        "name": "Counter-Strike 2",
        "platform": "Steam",
        "active_players": 564671,
        "weekly_points": 554,
        "monthly_points": 5004,
        "yearly_points": 60724,
        "created_at": "2026-04-18T01:47:16.000000Z",
        "updated_at": "2026-04-18T01:47:16.000000Z"
    },
    {
        "id": 10,
        "name": "League of Legends",
        "platform": "Riot Launcher",
        "active_players": 1682586,
        "weekly_points": 587,
        "monthly_points": 1858,
        "yearly_points": 56745,
        "created_at": "2026-04-18T01:47:16.000000Z",
        "updated_at": "2026-04-18T01:47:16.000000Z"
    },
    {
        "id": 14,
        "name": "Cyberpunk 2077",
        "platform": "Steam",
        "active_players": 1700019,
        "weekly_points": 221,
        "monthly_points": 2723,
        "yearly_points": 56740,
        "created_at": "2026-04-18T01:47:16.000000Z",
        "updated_at": "2026-04-18T01:47:16.000000Z"
    }
]

Request      

GET api/v1/rankings/yearly

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

Histórico de ranking * Retorna a evolução de um jogo específico ao longo do tempo.

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

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: 46
access-control-allow-origin: *
 

{
    "game": "Counter-Strike 2",
    "history": [
        {
            "period": "Semana 1",
            "points": 554
        },
        {
            "period": "Mês Atual",
            "points": 5004
        },
        {
            "period": "Ano Atual",
            "points": 60724
        }
    ]
}

Request      

GET api/v1/rankings/history/{id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

O ID do jogo. Example: 1

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: 45
access-control-allow-origin: *
 

[
    {
        "id": 14,
        "name": "Cyberpunk 2077",
        "platform": "Steam",
        "active_players": 1700019,
        "weekly_points": 221,
        "monthly_points": 2723,
        "yearly_points": 56740,
        "created_at": "2026-04-18T01:47:16.000000Z",
        "updated_at": "2026-04-18T01:47:16.000000Z"
    },
    {
        "id": 10,
        "name": "League of Legends",
        "platform": "Riot Launcher",
        "active_players": 1682586,
        "weekly_points": 587,
        "monthly_points": 1858,
        "yearly_points": 56745,
        "created_at": "2026-04-18T01:47:16.000000Z",
        "updated_at": "2026-04-18T01:47:16.000000Z"
    },
    {
        "id": 7,
        "name": "Grand Theft Auto V",
        "platform": "Steam",
        "active_players": 1509381,
        "weekly_points": 812,
        "monthly_points": 7911,
        "yearly_points": 17211,
        "created_at": "2026-04-18T01:47:16.000000Z",
        "updated_at": "2026-04-18T01:47:16.000000Z"
    },
    {
        "id": 3,
        "name": "Valorant",
        "platform": "Riot Launcher",
        "active_players": 1153799,
        "weekly_points": 155,
        "monthly_points": 2662,
        "yearly_points": 99544,
        "created_at": "2026-04-18T01:47:16.000000Z",
        "updated_at": "2026-04-18T01:47:16.000000Z"
    },
    {
        "id": 8,
        "name": "EA SPORTS FC 24",
        "platform": "Steam",
        "active_players": 1075170,
        "weekly_points": 776,
        "monthly_points": 6337,
        "yearly_points": 70015,
        "created_at": "2026-04-18T01:47:16.000000Z",
        "updated_at": "2026-04-18T01:47:16.000000Z"
    },
    {
        "id": 13,
        "name": "Minecraft",
        "platform": "Multiplataforma",
        "active_players": 1058688,
        "weekly_points": 768,
        "monthly_points": 6013,
        "yearly_points": 97008,
        "created_at": "2026-04-18T01:47:16.000000Z",
        "updated_at": "2026-04-18T01:47:16.000000Z"
    },
    {
        "id": 12,
        "name": "Call of Duty: Warzone",
        "platform": "Battle.net",
        "active_players": 933732,
        "weekly_points": 857,
        "monthly_points": 4936,
        "yearly_points": 44623,
        "created_at": "2026-04-18T01:47:16.000000Z",
        "updated_at": "2026-04-18T01:47:16.000000Z"
    },
    {
        "id": 5,
        "name": "Baldur's Gate 3",
        "platform": "Steam",
        "active_players": 847989,
        "weekly_points": 198,
        "monthly_points": 1404,
        "yearly_points": 66933,
        "created_at": "2026-04-18T01:47:16.000000Z",
        "updated_at": "2026-04-18T01:47:16.000000Z"
    },
    {
        "id": 2,
        "name": "Elden Ring",
        "platform": "Steam",
        "active_players": 799796,
        "weekly_points": 647,
        "monthly_points": 8422,
        "yearly_points": 76612,
        "created_at": "2026-04-18T01:47:16.000000Z",
        "updated_at": "2026-04-18T01:47:16.000000Z"
    },
    {
        "id": 4,
        "name": "Helldivers 2",
        "platform": "Steam",
        "active_players": 589021,
        "weekly_points": 833,
        "monthly_points": 9947,
        "yearly_points": 78223,
        "created_at": "2026-04-18T01:47:16.000000Z",
        "updated_at": "2026-04-18T01:47:16.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: 44
access-control-allow-origin: *
 

[
    {
        "id": 14,
        "name": "Cyberpunk 2077",
        "platform": "Steam",
        "active_players": 1700019,
        "weekly_points": 221,
        "monthly_points": 2723,
        "yearly_points": 56740,
        "created_at": "2026-04-18T01:47:16.000000Z",
        "updated_at": "2026-04-18T01:47:16.000000Z"
    },
    {
        "id": 7,
        "name": "Grand Theft Auto V",
        "platform": "Steam",
        "active_players": 1509381,
        "weekly_points": 812,
        "monthly_points": 7911,
        "yearly_points": 17211,
        "created_at": "2026-04-18T01:47:16.000000Z",
        "updated_at": "2026-04-18T01:47:16.000000Z"
    },
    {
        "id": 8,
        "name": "EA SPORTS FC 24",
        "platform": "Steam",
        "active_players": 1075170,
        "weekly_points": 776,
        "monthly_points": 6337,
        "yearly_points": 70015,
        "created_at": "2026-04-18T01:47:16.000000Z",
        "updated_at": "2026-04-18T01:47:16.000000Z"
    },
    {
        "id": 5,
        "name": "Baldur's Gate 3",
        "platform": "Steam",
        "active_players": 847989,
        "weekly_points": 198,
        "monthly_points": 1404,
        "yearly_points": 66933,
        "created_at": "2026-04-18T01:47:16.000000Z",
        "updated_at": "2026-04-18T01:47:16.000000Z"
    },
    {
        "id": 2,
        "name": "Elden Ring",
        "platform": "Steam",
        "active_players": 799796,
        "weekly_points": 647,
        "monthly_points": 8422,
        "yearly_points": 76612,
        "created_at": "2026-04-18T01:47:16.000000Z",
        "updated_at": "2026-04-18T01:47:16.000000Z"
    },
    {
        "id": 4,
        "name": "Helldivers 2",
        "platform": "Steam",
        "active_players": 589021,
        "weekly_points": 833,
        "monthly_points": 9947,
        "yearly_points": 78223,
        "created_at": "2026-04-18T01:47:16.000000Z",
        "updated_at": "2026-04-18T01:47:16.000000Z"
    },
    {
        "id": 1,
        "name": "Counter-Strike 2",
        "platform": "Steam",
        "active_players": 564671,
        "weekly_points": 554,
        "monthly_points": 5004,
        "yearly_points": 60724,
        "created_at": "2026-04-18T01:47:16.000000Z",
        "updated_at": "2026-04-18T01:47:16.000000Z"
    },
    {
        "id": 11,
        "name": "Apex Legends",
        "platform": "Steam",
        "active_players": 558948,
        "weekly_points": 219,
        "monthly_points": 8214,
        "yearly_points": 80587,
        "created_at": "2026-04-18T01:47:16.000000Z",
        "updated_at": "2026-04-18T01:47:16.000000Z"
    },
    {
        "id": 15,
        "name": "Stardew Valley",
        "platform": "Steam",
        "active_players": 94038,
        "weekly_points": 682,
        "monthly_points": 5436,
        "yearly_points": 54743,
        "created_at": "2026-04-18T01:47:16.000000Z",
        "updated_at": "2026-04-18T01:47:16.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