1579 lines
65 KiB
PHP
1579 lines
65 KiB
PHP
<!doctype html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta content="IE=edge,chrome=1" http-equiv="X-UA-Compatible">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1">
|
|
<title>Game Ranking API Documentation</title>
|
|
|
|
<link href="https://fonts.googleapis.com/css?family=Open+Sans&display=swap" rel="stylesheet">
|
|
|
|
<link rel="stylesheet" href="{{ asset("/vendor/scribe/css/theme-default.style.css") }}" media="screen">
|
|
<link rel="stylesheet" href="{{ asset("/vendor/scribe/css/theme-default.print.css") }}" media="print">
|
|
|
|
<script src="https://cdn.jsdelivr.net/npm/lodash@4.17.10/lodash.min.js"></script>
|
|
|
|
<link rel="stylesheet"
|
|
href="https://unpkg.com/@highlightjs/cdn-assets@11.6.0/styles/obsidian.min.css">
|
|
<script src="https://unpkg.com/@highlightjs/cdn-assets@11.6.0/highlight.min.js"></script>
|
|
|
|
<script src="https://cdnjs.cloudflare.com/ajax/libs/jets/0.14.1/jets.min.js"></script>
|
|
|
|
<style id="language-style">
|
|
/* starts out as display none and is replaced with js later */
|
|
body .content .bash-example code { display: none; }
|
|
body .content .javascript-example code { display: none; }
|
|
</style>
|
|
|
|
<script>
|
|
var tryItOutBaseUrl = "http://127.0.0.1:8000";
|
|
var useCsrf = Boolean();
|
|
var csrfUrl = "/sanctum/csrf-cookie";
|
|
</script>
|
|
<script src="{{ asset("/vendor/scribe/js/tryitout-5.9.0.js") }}"></script>
|
|
|
|
<script src="{{ asset("/vendor/scribe/js/theme-default-5.9.0.js") }}"></script>
|
|
|
|
</head>
|
|
|
|
<body data-languages="["bash","javascript"]">
|
|
|
|
<a href="#" id="nav-button">
|
|
<span>
|
|
MENU
|
|
<img src="{{ asset("/vendor/scribe/images/navbar.png") }}" alt="navbar-image"/>
|
|
</span>
|
|
</a>
|
|
<div class="tocify-wrapper">
|
|
|
|
<div class="lang-selector">
|
|
<button type="button" class="lang-button" data-language-name="bash">bash</button>
|
|
<button type="button" class="lang-button" data-language-name="javascript">javascript</button>
|
|
</div>
|
|
|
|
<div class="search">
|
|
<input type="text" class="search" id="input-search" placeholder="Search">
|
|
</div>
|
|
|
|
<div id="toc">
|
|
<ul id="tocify-header-introduction" class="tocify-header">
|
|
<li class="tocify-item level-1" data-unique="introduction">
|
|
<a href="#introduction">Introduction</a>
|
|
</li>
|
|
</ul>
|
|
<ul id="tocify-header-authenticating-requests" class="tocify-header">
|
|
<li class="tocify-item level-1" data-unique="authenticating-requests">
|
|
<a href="#authenticating-requests">Authenticating requests</a>
|
|
</li>
|
|
</ul>
|
|
<ul id="tocify-header-rankings" class="tocify-header">
|
|
<li class="tocify-item level-1" data-unique="rankings">
|
|
<a href="#rankings">Rankings</a>
|
|
</li>
|
|
<ul id="tocify-subheader-rankings" class="tocify-subheader">
|
|
<li class="tocify-item level-2" data-unique="rankings-GETapi-v1-rankings-weekly">
|
|
<a href="#rankings-GETapi-v1-rankings-weekly">Top semanal</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="rankings-GETapi-v1-rankings-monthly">
|
|
<a href="#rankings-GETapi-v1-rankings-monthly">Top mensal</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="rankings-GETapi-v1-rankings-yearly">
|
|
<a href="#rankings-GETapi-v1-rankings-yearly">Top anual</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="rankings-GETapi-v1-rankings-history--id-">
|
|
<a href="#rankings-GETapi-v1-rankings-history--id-">Histórico de ranking</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="rankings-GETapi-v1-rankings-platforms--platform-">
|
|
<a href="#rankings-GETapi-v1-rankings-platforms--platform-">Ranking por Plataforma</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="rankings-GETapi-v1-games-most-played">
|
|
<a href="#rankings-GETapi-v1-games-most-played">Jogos mais jogados</a>
|
|
</li>
|
|
</ul>
|
|
</ul>
|
|
</div>
|
|
|
|
<ul class="toc-footer" id="toc-footer">
|
|
<li style="padding-bottom: 5px;"><a href="{{ route("scribe.postman") }}">View Postman collection</a></li>
|
|
<li style="padding-bottom: 5px;"><a href="{{ route("scribe.openapi") }}">View OpenAPI spec</a></li>
|
|
<li><a href="http://github.com/knuckleswtf/scribe">Documentation powered by Scribe ✍</a></li>
|
|
</ul>
|
|
|
|
<ul class="toc-footer" id="last-updated">
|
|
<li>Last updated: May 18, 2026</li>
|
|
</ul>
|
|
</div>
|
|
|
|
<div class="page-wrapper">
|
|
<div class="dark-box"></div>
|
|
<div class="content">
|
|
<h1 id="introduction">Introduction</h1>
|
|
<p>Microsserviço de rankings e métricas de jogos para integração com o ecossistema GameVerse.</p>
|
|
<aside>
|
|
<strong>Base URL</strong>: <code>http://127.0.0.1:8000</code>
|
|
</aside>
|
|
<pre><code>Esta API expõe rankings semanais, mensais e anuais, jogos mais jogados, histórico de pontuação e filtros por plataforma.
|
|
|
|
<aside>Use os exemplos da documentação para demonstrar como o frontend ou outros microsserviços podem consumir os dados de ranking.</aside></code></pre>
|
|
|
|
<h1 id="authenticating-requests">Authenticating requests</h1>
|
|
<p>To authenticate requests, include an <strong><code>Authorization</code></strong> header with the value <strong><code>"Bearer {YOUR_JWT_TOKEN}"</code></strong>.</p>
|
|
<p>All authenticated endpoints are marked with a <code>requires authentication</code> badge in the documentation below.</p>
|
|
<p>Use um token JWT RS256 emitido pelo serviço de autenticação integrado ao GameVerse.</p>
|
|
|
|
<h1 id="rankings">Rankings</h1>
|
|
|
|
|
|
|
|
<h2 id="rankings-GETapi-v1-rankings-weekly">Top semanal</h2>
|
|
|
|
<p>
|
|
<small class="badge badge-darkred">requires authentication</small>
|
|
</p>
|
|
|
|
<p>Retorna o ranking dos jogos com melhor desempenho na última semana.</p>
|
|
|
|
<span id="example-requests-GETapi-v1-rankings-weekly">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request GET \
|
|
--get "http://127.0.0.1:8000/api/v1/rankings/weekly" \
|
|
--header "Authorization: Bearer {YOUR_JWT_TOKEN}" \
|
|
--header "Content-Type: application/json" \
|
|
--header "Accept: application/json"</code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://127.0.0.1:8000/api/v1/rankings/weekly"
|
|
);
|
|
|
|
const headers = {
|
|
"Authorization": "Bearer {YOUR_JWT_TOKEN}",
|
|
"Content-Type": "application/json",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
|
|
fetch(url, {
|
|
method: "GET",
|
|
headers,
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-GETapi-v1-rankings-weekly">
|
|
<blockquote>
|
|
<p>Example response (200):</p>
|
|
</blockquote>
|
|
<details class="annotation">
|
|
<summary style="cursor: pointer;">
|
|
<small onclick="textContent = parentElement.parentElement.open ? 'Show headers' : 'Hide headers'">Show headers</small>
|
|
</summary>
|
|
<pre><code class="language-http">cache-control: no-cache, private
|
|
content-type: application/json
|
|
x-ratelimit-limit: 60
|
|
x-ratelimit-remaining: 59
|
|
access-control-allow-origin: *
|
|
</code></pre></details> <pre>
|
|
|
|
<code class="language-json" style="max-height: 300px;">[
|
|
{
|
|
"id": 11,
|
|
"name": "Apex Legends",
|
|
"platform": "Steam",
|
|
"active_players": 218457,
|
|
"weekly_points": 945,
|
|
"monthly_points": 8776,
|
|
"yearly_points": 56526,
|
|
"created_at": "2026-05-18T21:57:31.000000Z",
|
|
"updated_at": "2026-05-18T21:57:31.000000Z"
|
|
},
|
|
{
|
|
"id": 12,
|
|
"name": "Call of Duty: Warzone",
|
|
"platform": "Battle.net",
|
|
"active_players": 243114,
|
|
"weekly_points": 877,
|
|
"monthly_points": 2426,
|
|
"yearly_points": 36655,
|
|
"created_at": "2026-05-18T21:57:31.000000Z",
|
|
"updated_at": "2026-05-18T21:57:31.000000Z"
|
|
},
|
|
{
|
|
"id": 14,
|
|
"name": "Cyberpunk 2077",
|
|
"platform": "Steam",
|
|
"active_players": 1161973,
|
|
"weekly_points": 874,
|
|
"monthly_points": 4853,
|
|
"yearly_points": 27988,
|
|
"created_at": "2026-05-18T21:57:31.000000Z",
|
|
"updated_at": "2026-05-18T21:57:31.000000Z"
|
|
},
|
|
{
|
|
"id": 8,
|
|
"name": "EA SPORTS FC 24",
|
|
"platform": "Steam",
|
|
"active_players": 398998,
|
|
"weekly_points": 872,
|
|
"monthly_points": 5333,
|
|
"yearly_points": 81468,
|
|
"created_at": "2026-05-18T21:57:31.000000Z",
|
|
"updated_at": "2026-05-18T21:57:31.000000Z"
|
|
},
|
|
{
|
|
"id": 10,
|
|
"name": "League of Legends",
|
|
"platform": "Riot Launcher",
|
|
"active_players": 1166370,
|
|
"weekly_points": 786,
|
|
"monthly_points": 4506,
|
|
"yearly_points": 21445,
|
|
"created_at": "2026-05-18T21:57:31.000000Z",
|
|
"updated_at": "2026-05-18T21:57:31.000000Z"
|
|
},
|
|
{
|
|
"id": 9,
|
|
"name": "Roblox",
|
|
"platform": "Multiplataforma",
|
|
"active_players": 991415,
|
|
"weekly_points": 770,
|
|
"monthly_points": 2080,
|
|
"yearly_points": 22209,
|
|
"created_at": "2026-05-18T21:57:31.000000Z",
|
|
"updated_at": "2026-05-18T21:57:31.000000Z"
|
|
},
|
|
{
|
|
"id": 1,
|
|
"name": "Counter-Strike 2",
|
|
"platform": "Steam",
|
|
"active_players": 1086549,
|
|
"weekly_points": 729,
|
|
"monthly_points": 1215,
|
|
"yearly_points": 71182,
|
|
"created_at": "2026-05-18T21:57:31.000000Z",
|
|
"updated_at": "2026-05-18T21:57:31.000000Z"
|
|
},
|
|
{
|
|
"id": 15,
|
|
"name": "Stardew Valley",
|
|
"platform": "Steam",
|
|
"active_players": 1117483,
|
|
"weekly_points": 702,
|
|
"monthly_points": 7545,
|
|
"yearly_points": 42912,
|
|
"created_at": "2026-05-18T21:57:31.000000Z",
|
|
"updated_at": "2026-05-18T21:57:31.000000Z"
|
|
},
|
|
{
|
|
"id": 2,
|
|
"name": "Elden Ring",
|
|
"platform": "Steam",
|
|
"active_players": 715531,
|
|
"weekly_points": 697,
|
|
"monthly_points": 7369,
|
|
"yearly_points": 44291,
|
|
"created_at": "2026-05-18T21:57:31.000000Z",
|
|
"updated_at": "2026-05-18T21:57:31.000000Z"
|
|
},
|
|
{
|
|
"id": 4,
|
|
"name": "Helldivers 2",
|
|
"platform": "Steam",
|
|
"active_players": 217823,
|
|
"weekly_points": 617,
|
|
"monthly_points": 5232,
|
|
"yearly_points": 24531,
|
|
"created_at": "2026-05-18T21:57:31.000000Z",
|
|
"updated_at": "2026-05-18T21:57:31.000000Z"
|
|
}
|
|
]</code>
|
|
</pre>
|
|
</span>
|
|
<span id="execution-results-GETapi-v1-rankings-weekly" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-GETapi-v1-rankings-weekly"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-GETapi-v1-rankings-weekly"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-GETapi-v1-rankings-weekly" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-GETapi-v1-rankings-weekly">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-GETapi-v1-rankings-weekly" data-method="GET"
|
|
data-path="api/v1/rankings/weekly"
|
|
data-authed="1"
|
|
data-hasfiles="0"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('GETapi-v1-rankings-weekly', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-GETapi-v1-rankings-weekly"
|
|
onclick="tryItOut('GETapi-v1-rankings-weekly');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-GETapi-v1-rankings-weekly"
|
|
onclick="cancelTryOut('GETapi-v1-rankings-weekly');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-GETapi-v1-rankings-weekly"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-green">GET</small>
|
|
<b><code>api/v1/rankings/weekly</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Authorization</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Authorization" class="auth-value" data-endpoint="GETapi-v1-rankings-weekly"
|
|
value="Bearer {YOUR_JWT_TOKEN}"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>Bearer {YOUR_JWT_TOKEN}</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="GETapi-v1-rankings-weekly"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="GETapi-v1-rankings-weekly"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="rankings-GETapi-v1-rankings-monthly">Top mensal</h2>
|
|
|
|
<p>
|
|
<small class="badge badge-darkred">requires authentication</small>
|
|
</p>
|
|
|
|
<p>Retorna o ranking dos jogos com melhor desempenho no último mês.</p>
|
|
|
|
<span id="example-requests-GETapi-v1-rankings-monthly">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request GET \
|
|
--get "http://127.0.0.1:8000/api/v1/rankings/monthly" \
|
|
--header "Authorization: Bearer {YOUR_JWT_TOKEN}" \
|
|
--header "Content-Type: application/json" \
|
|
--header "Accept: application/json"</code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://127.0.0.1:8000/api/v1/rankings/monthly"
|
|
);
|
|
|
|
const headers = {
|
|
"Authorization": "Bearer {YOUR_JWT_TOKEN}",
|
|
"Content-Type": "application/json",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
|
|
fetch(url, {
|
|
method: "GET",
|
|
headers,
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-GETapi-v1-rankings-monthly">
|
|
<blockquote>
|
|
<p>Example response (200):</p>
|
|
</blockquote>
|
|
<details class="annotation">
|
|
<summary style="cursor: pointer;">
|
|
<small onclick="textContent = parentElement.parentElement.open ? 'Show headers' : 'Hide headers'">Show headers</small>
|
|
</summary>
|
|
<pre><code class="language-http">cache-control: no-cache, private
|
|
content-type: application/json
|
|
x-ratelimit-limit: 60
|
|
x-ratelimit-remaining: 58
|
|
access-control-allow-origin: *
|
|
</code></pre></details> <pre>
|
|
|
|
<code class="language-json" style="max-height: 300px;">[
|
|
{
|
|
"id": 13,
|
|
"name": "Minecraft",
|
|
"platform": "Multiplataforma",
|
|
"active_players": 242066,
|
|
"weekly_points": 184,
|
|
"monthly_points": 9278,
|
|
"yearly_points": 33053,
|
|
"created_at": "2026-05-18T21:57:31.000000Z",
|
|
"updated_at": "2026-05-18T21:57:31.000000Z"
|
|
},
|
|
{
|
|
"id": 11,
|
|
"name": "Apex Legends",
|
|
"platform": "Steam",
|
|
"active_players": 218457,
|
|
"weekly_points": 945,
|
|
"monthly_points": 8776,
|
|
"yearly_points": 56526,
|
|
"created_at": "2026-05-18T21:57:31.000000Z",
|
|
"updated_at": "2026-05-18T21:57:31.000000Z"
|
|
},
|
|
{
|
|
"id": 15,
|
|
"name": "Stardew Valley",
|
|
"platform": "Steam",
|
|
"active_players": 1117483,
|
|
"weekly_points": 702,
|
|
"monthly_points": 7545,
|
|
"yearly_points": 42912,
|
|
"created_at": "2026-05-18T21:57:31.000000Z",
|
|
"updated_at": "2026-05-18T21:57:31.000000Z"
|
|
},
|
|
{
|
|
"id": 2,
|
|
"name": "Elden Ring",
|
|
"platform": "Steam",
|
|
"active_players": 715531,
|
|
"weekly_points": 697,
|
|
"monthly_points": 7369,
|
|
"yearly_points": 44291,
|
|
"created_at": "2026-05-18T21:57:31.000000Z",
|
|
"updated_at": "2026-05-18T21:57:31.000000Z"
|
|
},
|
|
{
|
|
"id": 6,
|
|
"name": "Fortnite",
|
|
"platform": "Epic Games",
|
|
"active_players": 1091171,
|
|
"weekly_points": 611,
|
|
"monthly_points": 5678,
|
|
"yearly_points": 96832,
|
|
"created_at": "2026-05-18T21:57:31.000000Z",
|
|
"updated_at": "2026-05-18T21:57:31.000000Z"
|
|
},
|
|
{
|
|
"id": 8,
|
|
"name": "EA SPORTS FC 24",
|
|
"platform": "Steam",
|
|
"active_players": 398998,
|
|
"weekly_points": 872,
|
|
"monthly_points": 5333,
|
|
"yearly_points": 81468,
|
|
"created_at": "2026-05-18T21:57:31.000000Z",
|
|
"updated_at": "2026-05-18T21:57:31.000000Z"
|
|
},
|
|
{
|
|
"id": 4,
|
|
"name": "Helldivers 2",
|
|
"platform": "Steam",
|
|
"active_players": 217823,
|
|
"weekly_points": 617,
|
|
"monthly_points": 5232,
|
|
"yearly_points": 24531,
|
|
"created_at": "2026-05-18T21:57:31.000000Z",
|
|
"updated_at": "2026-05-18T21:57:31.000000Z"
|
|
},
|
|
{
|
|
"id": 14,
|
|
"name": "Cyberpunk 2077",
|
|
"platform": "Steam",
|
|
"active_players": 1161973,
|
|
"weekly_points": 874,
|
|
"monthly_points": 4853,
|
|
"yearly_points": 27988,
|
|
"created_at": "2026-05-18T21:57:31.000000Z",
|
|
"updated_at": "2026-05-18T21:57:31.000000Z"
|
|
},
|
|
{
|
|
"id": 10,
|
|
"name": "League of Legends",
|
|
"platform": "Riot Launcher",
|
|
"active_players": 1166370,
|
|
"weekly_points": 786,
|
|
"monthly_points": 4506,
|
|
"yearly_points": 21445,
|
|
"created_at": "2026-05-18T21:57:31.000000Z",
|
|
"updated_at": "2026-05-18T21:57:31.000000Z"
|
|
},
|
|
{
|
|
"id": 5,
|
|
"name": "Baldur's Gate 3",
|
|
"platform": "Steam",
|
|
"active_players": 296988,
|
|
"weekly_points": 352,
|
|
"monthly_points": 3595,
|
|
"yearly_points": 62260,
|
|
"created_at": "2026-05-18T21:57:31.000000Z",
|
|
"updated_at": "2026-05-18T21:57:31.000000Z"
|
|
}
|
|
]</code>
|
|
</pre>
|
|
</span>
|
|
<span id="execution-results-GETapi-v1-rankings-monthly" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-GETapi-v1-rankings-monthly"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-GETapi-v1-rankings-monthly"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-GETapi-v1-rankings-monthly" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-GETapi-v1-rankings-monthly">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-GETapi-v1-rankings-monthly" data-method="GET"
|
|
data-path="api/v1/rankings/monthly"
|
|
data-authed="1"
|
|
data-hasfiles="0"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('GETapi-v1-rankings-monthly', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-GETapi-v1-rankings-monthly"
|
|
onclick="tryItOut('GETapi-v1-rankings-monthly');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-GETapi-v1-rankings-monthly"
|
|
onclick="cancelTryOut('GETapi-v1-rankings-monthly');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-GETapi-v1-rankings-monthly"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-green">GET</small>
|
|
<b><code>api/v1/rankings/monthly</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Authorization</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Authorization" class="auth-value" data-endpoint="GETapi-v1-rankings-monthly"
|
|
value="Bearer {YOUR_JWT_TOKEN}"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>Bearer {YOUR_JWT_TOKEN}</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="GETapi-v1-rankings-monthly"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="GETapi-v1-rankings-monthly"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="rankings-GETapi-v1-rankings-yearly">Top anual</h2>
|
|
|
|
<p>
|
|
<small class="badge badge-darkred">requires authentication</small>
|
|
</p>
|
|
|
|
<p>Retorna o ranking dos jogos com melhor desempenho no último ano.</p>
|
|
|
|
<span id="example-requests-GETapi-v1-rankings-yearly">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request GET \
|
|
--get "http://127.0.0.1:8000/api/v1/rankings/yearly" \
|
|
--header "Authorization: Bearer {YOUR_JWT_TOKEN}" \
|
|
--header "Content-Type: application/json" \
|
|
--header "Accept: application/json"</code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://127.0.0.1:8000/api/v1/rankings/yearly"
|
|
);
|
|
|
|
const headers = {
|
|
"Authorization": "Bearer {YOUR_JWT_TOKEN}",
|
|
"Content-Type": "application/json",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
|
|
fetch(url, {
|
|
method: "GET",
|
|
headers,
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-GETapi-v1-rankings-yearly">
|
|
<blockquote>
|
|
<p>Example response (200):</p>
|
|
</blockquote>
|
|
<details class="annotation">
|
|
<summary style="cursor: pointer;">
|
|
<small onclick="textContent = parentElement.parentElement.open ? 'Show headers' : 'Hide headers'">Show headers</small>
|
|
</summary>
|
|
<pre><code class="language-http">cache-control: no-cache, private
|
|
content-type: application/json
|
|
x-ratelimit-limit: 60
|
|
x-ratelimit-remaining: 57
|
|
access-control-allow-origin: *
|
|
</code></pre></details> <pre>
|
|
|
|
<code class="language-json" style="max-height: 300px;">[
|
|
{
|
|
"id": 6,
|
|
"name": "Fortnite",
|
|
"platform": "Epic Games",
|
|
"active_players": 1091171,
|
|
"weekly_points": 611,
|
|
"monthly_points": 5678,
|
|
"yearly_points": 96832,
|
|
"created_at": "2026-05-18T21:57:31.000000Z",
|
|
"updated_at": "2026-05-18T21:57:31.000000Z"
|
|
},
|
|
{
|
|
"id": 8,
|
|
"name": "EA SPORTS FC 24",
|
|
"platform": "Steam",
|
|
"active_players": 398998,
|
|
"weekly_points": 872,
|
|
"monthly_points": 5333,
|
|
"yearly_points": 81468,
|
|
"created_at": "2026-05-18T21:57:31.000000Z",
|
|
"updated_at": "2026-05-18T21:57:31.000000Z"
|
|
},
|
|
{
|
|
"id": 1,
|
|
"name": "Counter-Strike 2",
|
|
"platform": "Steam",
|
|
"active_players": 1086549,
|
|
"weekly_points": 729,
|
|
"monthly_points": 1215,
|
|
"yearly_points": 71182,
|
|
"created_at": "2026-05-18T21:57:31.000000Z",
|
|
"updated_at": "2026-05-18T21:57:31.000000Z"
|
|
},
|
|
{
|
|
"id": 7,
|
|
"name": "Grand Theft Auto V",
|
|
"platform": "Steam",
|
|
"active_players": 262363,
|
|
"weekly_points": 199,
|
|
"monthly_points": 2257,
|
|
"yearly_points": 62350,
|
|
"created_at": "2026-05-18T21:57:31.000000Z",
|
|
"updated_at": "2026-05-18T21:57:31.000000Z"
|
|
},
|
|
{
|
|
"id": 5,
|
|
"name": "Baldur's Gate 3",
|
|
"platform": "Steam",
|
|
"active_players": 296988,
|
|
"weekly_points": 352,
|
|
"monthly_points": 3595,
|
|
"yearly_points": 62260,
|
|
"created_at": "2026-05-18T21:57:31.000000Z",
|
|
"updated_at": "2026-05-18T21:57:31.000000Z"
|
|
},
|
|
{
|
|
"id": 3,
|
|
"name": "Valorant",
|
|
"platform": "Riot Launcher",
|
|
"active_players": 821498,
|
|
"weekly_points": 241,
|
|
"monthly_points": 1030,
|
|
"yearly_points": 57266,
|
|
"created_at": "2026-05-18T21:57:31.000000Z",
|
|
"updated_at": "2026-05-18T21:57:31.000000Z"
|
|
},
|
|
{
|
|
"id": 11,
|
|
"name": "Apex Legends",
|
|
"platform": "Steam",
|
|
"active_players": 218457,
|
|
"weekly_points": 945,
|
|
"monthly_points": 8776,
|
|
"yearly_points": 56526,
|
|
"created_at": "2026-05-18T21:57:31.000000Z",
|
|
"updated_at": "2026-05-18T21:57:31.000000Z"
|
|
},
|
|
{
|
|
"id": 2,
|
|
"name": "Elden Ring",
|
|
"platform": "Steam",
|
|
"active_players": 715531,
|
|
"weekly_points": 697,
|
|
"monthly_points": 7369,
|
|
"yearly_points": 44291,
|
|
"created_at": "2026-05-18T21:57:31.000000Z",
|
|
"updated_at": "2026-05-18T21:57:31.000000Z"
|
|
},
|
|
{
|
|
"id": 15,
|
|
"name": "Stardew Valley",
|
|
"platform": "Steam",
|
|
"active_players": 1117483,
|
|
"weekly_points": 702,
|
|
"monthly_points": 7545,
|
|
"yearly_points": 42912,
|
|
"created_at": "2026-05-18T21:57:31.000000Z",
|
|
"updated_at": "2026-05-18T21:57:31.000000Z"
|
|
},
|
|
{
|
|
"id": 12,
|
|
"name": "Call of Duty: Warzone",
|
|
"platform": "Battle.net",
|
|
"active_players": 243114,
|
|
"weekly_points": 877,
|
|
"monthly_points": 2426,
|
|
"yearly_points": 36655,
|
|
"created_at": "2026-05-18T21:57:31.000000Z",
|
|
"updated_at": "2026-05-18T21:57:31.000000Z"
|
|
}
|
|
]</code>
|
|
</pre>
|
|
</span>
|
|
<span id="execution-results-GETapi-v1-rankings-yearly" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-GETapi-v1-rankings-yearly"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-GETapi-v1-rankings-yearly"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-GETapi-v1-rankings-yearly" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-GETapi-v1-rankings-yearly">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-GETapi-v1-rankings-yearly" data-method="GET"
|
|
data-path="api/v1/rankings/yearly"
|
|
data-authed="1"
|
|
data-hasfiles="0"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('GETapi-v1-rankings-yearly', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-GETapi-v1-rankings-yearly"
|
|
onclick="tryItOut('GETapi-v1-rankings-yearly');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-GETapi-v1-rankings-yearly"
|
|
onclick="cancelTryOut('GETapi-v1-rankings-yearly');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-GETapi-v1-rankings-yearly"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-green">GET</small>
|
|
<b><code>api/v1/rankings/yearly</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Authorization</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Authorization" class="auth-value" data-endpoint="GETapi-v1-rankings-yearly"
|
|
value="Bearer {YOUR_JWT_TOKEN}"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>Bearer {YOUR_JWT_TOKEN}</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="GETapi-v1-rankings-yearly"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="GETapi-v1-rankings-yearly"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="rankings-GETapi-v1-rankings-history--id-">Histórico de ranking</h2>
|
|
|
|
<p>
|
|
<small class="badge badge-darkred">requires authentication</small>
|
|
</p>
|
|
|
|
<p>Retorna a evolução de um jogo específico ao longo do tempo.</p>
|
|
|
|
<span id="example-requests-GETapi-v1-rankings-history--id-">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request GET \
|
|
--get "http://127.0.0.1:8000/api/v1/rankings/history/1" \
|
|
--header "Authorization: Bearer {YOUR_JWT_TOKEN}" \
|
|
--header "Content-Type: application/json" \
|
|
--header "Accept: application/json"</code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://127.0.0.1:8000/api/v1/rankings/history/1"
|
|
);
|
|
|
|
const headers = {
|
|
"Authorization": "Bearer {YOUR_JWT_TOKEN}",
|
|
"Content-Type": "application/json",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
|
|
fetch(url, {
|
|
method: "GET",
|
|
headers,
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-GETapi-v1-rankings-history--id-">
|
|
<blockquote>
|
|
<p>Example response (200):</p>
|
|
</blockquote>
|
|
<details class="annotation">
|
|
<summary style="cursor: pointer;">
|
|
<small onclick="textContent = parentElement.parentElement.open ? 'Show headers' : 'Hide headers'">Show headers</small>
|
|
</summary>
|
|
<pre><code class="language-http">cache-control: no-cache, private
|
|
content-type: application/json
|
|
x-ratelimit-limit: 60
|
|
x-ratelimit-remaining: 56
|
|
access-control-allow-origin: *
|
|
</code></pre></details> <pre>
|
|
|
|
<code class="language-json" style="max-height: 300px;">{
|
|
"game": "Counter-Strike 2",
|
|
"history": [
|
|
{
|
|
"period": "Semana 1",
|
|
"points": 729
|
|
},
|
|
{
|
|
"period": "Mês Atual",
|
|
"points": 1215
|
|
},
|
|
{
|
|
"period": "Ano Atual",
|
|
"points": 71182
|
|
}
|
|
]
|
|
}</code>
|
|
</pre>
|
|
</span>
|
|
<span id="execution-results-GETapi-v1-rankings-history--id-" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-GETapi-v1-rankings-history--id-"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-GETapi-v1-rankings-history--id-"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-GETapi-v1-rankings-history--id-" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-GETapi-v1-rankings-history--id-">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-GETapi-v1-rankings-history--id-" data-method="GET"
|
|
data-path="api/v1/rankings/history/{id}"
|
|
data-authed="1"
|
|
data-hasfiles="0"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('GETapi-v1-rankings-history--id-', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-GETapi-v1-rankings-history--id-"
|
|
onclick="tryItOut('GETapi-v1-rankings-history--id-');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-GETapi-v1-rankings-history--id-"
|
|
onclick="cancelTryOut('GETapi-v1-rankings-history--id-');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-GETapi-v1-rankings-history--id-"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-green">GET</small>
|
|
<b><code>api/v1/rankings/history/{id}</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Authorization</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Authorization" class="auth-value" data-endpoint="GETapi-v1-rankings-history--id-"
|
|
value="Bearer {YOUR_JWT_TOKEN}"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>Bearer {YOUR_JWT_TOKEN}</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="GETapi-v1-rankings-history--id-"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="GETapi-v1-rankings-history--id-"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<h4 class="fancy-heading-panel"><b>URL Parameters</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>id</code></b>
|
|
<small>integer</small>
|
|
|
|
|
|
<input type="number" style="display: none"
|
|
step="any" name="id" data-endpoint="GETapi-v1-rankings-history--id-"
|
|
value="1"
|
|
data-component="url">
|
|
<br>
|
|
<p>O ID do jogo. Example: <code>1</code></p>
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="rankings-GETapi-v1-rankings-platforms--platform-">Ranking por Plataforma</h2>
|
|
|
|
<p>
|
|
<small class="badge badge-darkred">requires authentication</small>
|
|
</p>
|
|
|
|
<p>Retorna os jogos mais bem ranqueados de uma plataforma específica.</p>
|
|
|
|
<span id="example-requests-GETapi-v1-rankings-platforms--platform-">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request GET \
|
|
--get "http://127.0.0.1:8000/api/v1/rankings/platforms/Steam" \
|
|
--header "Authorization: Bearer {YOUR_JWT_TOKEN}" \
|
|
--header "Content-Type: application/json" \
|
|
--header "Accept: application/json"</code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://127.0.0.1:8000/api/v1/rankings/platforms/Steam"
|
|
);
|
|
|
|
const headers = {
|
|
"Authorization": "Bearer {YOUR_JWT_TOKEN}",
|
|
"Content-Type": "application/json",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
|
|
fetch(url, {
|
|
method: "GET",
|
|
headers,
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-GETapi-v1-rankings-platforms--platform-">
|
|
<blockquote>
|
|
<p>Example response (200):</p>
|
|
</blockquote>
|
|
<details class="annotation">
|
|
<summary style="cursor: pointer;">
|
|
<small onclick="textContent = parentElement.parentElement.open ? 'Show headers' : 'Hide headers'">Show headers</small>
|
|
</summary>
|
|
<pre><code class="language-http">cache-control: no-cache, private
|
|
content-type: application/json
|
|
x-ratelimit-limit: 60
|
|
x-ratelimit-remaining: 55
|
|
access-control-allow-origin: *
|
|
</code></pre></details> <pre>
|
|
|
|
<code class="language-json" style="max-height: 300px;">[
|
|
{
|
|
"id": 14,
|
|
"name": "Cyberpunk 2077",
|
|
"platform": "Steam",
|
|
"active_players": 1161973,
|
|
"weekly_points": 874,
|
|
"monthly_points": 4853,
|
|
"yearly_points": 27988,
|
|
"created_at": "2026-05-18T21:57:31.000000Z",
|
|
"updated_at": "2026-05-18T21:57:31.000000Z"
|
|
},
|
|
{
|
|
"id": 15,
|
|
"name": "Stardew Valley",
|
|
"platform": "Steam",
|
|
"active_players": 1117483,
|
|
"weekly_points": 702,
|
|
"monthly_points": 7545,
|
|
"yearly_points": 42912,
|
|
"created_at": "2026-05-18T21:57:31.000000Z",
|
|
"updated_at": "2026-05-18T21:57:31.000000Z"
|
|
},
|
|
{
|
|
"id": 1,
|
|
"name": "Counter-Strike 2",
|
|
"platform": "Steam",
|
|
"active_players": 1086549,
|
|
"weekly_points": 729,
|
|
"monthly_points": 1215,
|
|
"yearly_points": 71182,
|
|
"created_at": "2026-05-18T21:57:31.000000Z",
|
|
"updated_at": "2026-05-18T21:57:31.000000Z"
|
|
},
|
|
{
|
|
"id": 2,
|
|
"name": "Elden Ring",
|
|
"platform": "Steam",
|
|
"active_players": 715531,
|
|
"weekly_points": 697,
|
|
"monthly_points": 7369,
|
|
"yearly_points": 44291,
|
|
"created_at": "2026-05-18T21:57:31.000000Z",
|
|
"updated_at": "2026-05-18T21:57:31.000000Z"
|
|
},
|
|
{
|
|
"id": 8,
|
|
"name": "EA SPORTS FC 24",
|
|
"platform": "Steam",
|
|
"active_players": 398998,
|
|
"weekly_points": 872,
|
|
"monthly_points": 5333,
|
|
"yearly_points": 81468,
|
|
"created_at": "2026-05-18T21:57:31.000000Z",
|
|
"updated_at": "2026-05-18T21:57:31.000000Z"
|
|
},
|
|
{
|
|
"id": 5,
|
|
"name": "Baldur's Gate 3",
|
|
"platform": "Steam",
|
|
"active_players": 296988,
|
|
"weekly_points": 352,
|
|
"monthly_points": 3595,
|
|
"yearly_points": 62260,
|
|
"created_at": "2026-05-18T21:57:31.000000Z",
|
|
"updated_at": "2026-05-18T21:57:31.000000Z"
|
|
},
|
|
{
|
|
"id": 7,
|
|
"name": "Grand Theft Auto V",
|
|
"platform": "Steam",
|
|
"active_players": 262363,
|
|
"weekly_points": 199,
|
|
"monthly_points": 2257,
|
|
"yearly_points": 62350,
|
|
"created_at": "2026-05-18T21:57:31.000000Z",
|
|
"updated_at": "2026-05-18T21:57:31.000000Z"
|
|
},
|
|
{
|
|
"id": 11,
|
|
"name": "Apex Legends",
|
|
"platform": "Steam",
|
|
"active_players": 218457,
|
|
"weekly_points": 945,
|
|
"monthly_points": 8776,
|
|
"yearly_points": 56526,
|
|
"created_at": "2026-05-18T21:57:31.000000Z",
|
|
"updated_at": "2026-05-18T21:57:31.000000Z"
|
|
},
|
|
{
|
|
"id": 4,
|
|
"name": "Helldivers 2",
|
|
"platform": "Steam",
|
|
"active_players": 217823,
|
|
"weekly_points": 617,
|
|
"monthly_points": 5232,
|
|
"yearly_points": 24531,
|
|
"created_at": "2026-05-18T21:57:31.000000Z",
|
|
"updated_at": "2026-05-18T21:57:31.000000Z"
|
|
}
|
|
]</code>
|
|
</pre>
|
|
</span>
|
|
<span id="execution-results-GETapi-v1-rankings-platforms--platform-" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-GETapi-v1-rankings-platforms--platform-"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-GETapi-v1-rankings-platforms--platform-"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-GETapi-v1-rankings-platforms--platform-" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-GETapi-v1-rankings-platforms--platform-">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-GETapi-v1-rankings-platforms--platform-" data-method="GET"
|
|
data-path="api/v1/rankings/platforms/{platform}"
|
|
data-authed="1"
|
|
data-hasfiles="0"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('GETapi-v1-rankings-platforms--platform-', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-GETapi-v1-rankings-platforms--platform-"
|
|
onclick="tryItOut('GETapi-v1-rankings-platforms--platform-');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-GETapi-v1-rankings-platforms--platform-"
|
|
onclick="cancelTryOut('GETapi-v1-rankings-platforms--platform-');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-GETapi-v1-rankings-platforms--platform-"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-green">GET</small>
|
|
<b><code>api/v1/rankings/platforms/{platform}</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Authorization</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Authorization" class="auth-value" data-endpoint="GETapi-v1-rankings-platforms--platform-"
|
|
value="Bearer {YOUR_JWT_TOKEN}"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>Bearer {YOUR_JWT_TOKEN}</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="GETapi-v1-rankings-platforms--platform-"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="GETapi-v1-rankings-platforms--platform-"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<h4 class="fancy-heading-panel"><b>URL Parameters</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>platform</code></b>
|
|
<small>string</small>
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="platform" data-endpoint="GETapi-v1-rankings-platforms--platform-"
|
|
value="Steam"
|
|
data-component="url">
|
|
<br>
|
|
<p>O nome da plataforma. Example: <code>Steam</code></p>
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="rankings-GETapi-v1-games-most-played">Jogos mais jogados</h2>
|
|
|
|
<p>
|
|
<small class="badge badge-darkred">requires authentication</small>
|
|
</p>
|
|
|
|
<p>Retorna o top 10 jogos com base no número de jogadores ativos.</p>
|
|
|
|
<span id="example-requests-GETapi-v1-games-most-played">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request GET \
|
|
--get "http://127.0.0.1:8000/api/v1/games/most-played" \
|
|
--header "Authorization: Bearer {YOUR_JWT_TOKEN}" \
|
|
--header "Content-Type: application/json" \
|
|
--header "Accept: application/json"</code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://127.0.0.1:8000/api/v1/games/most-played"
|
|
);
|
|
|
|
const headers = {
|
|
"Authorization": "Bearer {YOUR_JWT_TOKEN}",
|
|
"Content-Type": "application/json",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
|
|
fetch(url, {
|
|
method: "GET",
|
|
headers,
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-GETapi-v1-games-most-played">
|
|
<blockquote>
|
|
<p>Example response (200):</p>
|
|
</blockquote>
|
|
<details class="annotation">
|
|
<summary style="cursor: pointer;">
|
|
<small onclick="textContent = parentElement.parentElement.open ? 'Show headers' : 'Hide headers'">Show headers</small>
|
|
</summary>
|
|
<pre><code class="language-http">cache-control: no-cache, private
|
|
content-type: application/json
|
|
x-ratelimit-limit: 60
|
|
x-ratelimit-remaining: 54
|
|
access-control-allow-origin: *
|
|
</code></pre></details> <pre>
|
|
|
|
<code class="language-json" style="max-height: 300px;">[
|
|
{
|
|
"id": 10,
|
|
"name": "League of Legends",
|
|
"platform": "Riot Launcher",
|
|
"active_players": 1166370,
|
|
"weekly_points": 786,
|
|
"monthly_points": 4506,
|
|
"yearly_points": 21445,
|
|
"created_at": "2026-05-18T21:57:31.000000Z",
|
|
"updated_at": "2026-05-18T21:57:31.000000Z"
|
|
},
|
|
{
|
|
"id": 14,
|
|
"name": "Cyberpunk 2077",
|
|
"platform": "Steam",
|
|
"active_players": 1161973,
|
|
"weekly_points": 874,
|
|
"monthly_points": 4853,
|
|
"yearly_points": 27988,
|
|
"created_at": "2026-05-18T21:57:31.000000Z",
|
|
"updated_at": "2026-05-18T21:57:31.000000Z"
|
|
},
|
|
{
|
|
"id": 15,
|
|
"name": "Stardew Valley",
|
|
"platform": "Steam",
|
|
"active_players": 1117483,
|
|
"weekly_points": 702,
|
|
"monthly_points": 7545,
|
|
"yearly_points": 42912,
|
|
"created_at": "2026-05-18T21:57:31.000000Z",
|
|
"updated_at": "2026-05-18T21:57:31.000000Z"
|
|
},
|
|
{
|
|
"id": 6,
|
|
"name": "Fortnite",
|
|
"platform": "Epic Games",
|
|
"active_players": 1091171,
|
|
"weekly_points": 611,
|
|
"monthly_points": 5678,
|
|
"yearly_points": 96832,
|
|
"created_at": "2026-05-18T21:57:31.000000Z",
|
|
"updated_at": "2026-05-18T21:57:31.000000Z"
|
|
},
|
|
{
|
|
"id": 1,
|
|
"name": "Counter-Strike 2",
|
|
"platform": "Steam",
|
|
"active_players": 1086549,
|
|
"weekly_points": 729,
|
|
"monthly_points": 1215,
|
|
"yearly_points": 71182,
|
|
"created_at": "2026-05-18T21:57:31.000000Z",
|
|
"updated_at": "2026-05-18T21:57:31.000000Z"
|
|
},
|
|
{
|
|
"id": 9,
|
|
"name": "Roblox",
|
|
"platform": "Multiplataforma",
|
|
"active_players": 991415,
|
|
"weekly_points": 770,
|
|
"monthly_points": 2080,
|
|
"yearly_points": 22209,
|
|
"created_at": "2026-05-18T21:57:31.000000Z",
|
|
"updated_at": "2026-05-18T21:57:31.000000Z"
|
|
},
|
|
{
|
|
"id": 3,
|
|
"name": "Valorant",
|
|
"platform": "Riot Launcher",
|
|
"active_players": 821498,
|
|
"weekly_points": 241,
|
|
"monthly_points": 1030,
|
|
"yearly_points": 57266,
|
|
"created_at": "2026-05-18T21:57:31.000000Z",
|
|
"updated_at": "2026-05-18T21:57:31.000000Z"
|
|
},
|
|
{
|
|
"id": 2,
|
|
"name": "Elden Ring",
|
|
"platform": "Steam",
|
|
"active_players": 715531,
|
|
"weekly_points": 697,
|
|
"monthly_points": 7369,
|
|
"yearly_points": 44291,
|
|
"created_at": "2026-05-18T21:57:31.000000Z",
|
|
"updated_at": "2026-05-18T21:57:31.000000Z"
|
|
},
|
|
{
|
|
"id": 8,
|
|
"name": "EA SPORTS FC 24",
|
|
"platform": "Steam",
|
|
"active_players": 398998,
|
|
"weekly_points": 872,
|
|
"monthly_points": 5333,
|
|
"yearly_points": 81468,
|
|
"created_at": "2026-05-18T21:57:31.000000Z",
|
|
"updated_at": "2026-05-18T21:57:31.000000Z"
|
|
},
|
|
{
|
|
"id": 5,
|
|
"name": "Baldur's Gate 3",
|
|
"platform": "Steam",
|
|
"active_players": 296988,
|
|
"weekly_points": 352,
|
|
"monthly_points": 3595,
|
|
"yearly_points": 62260,
|
|
"created_at": "2026-05-18T21:57:31.000000Z",
|
|
"updated_at": "2026-05-18T21:57:31.000000Z"
|
|
}
|
|
]</code>
|
|
</pre>
|
|
</span>
|
|
<span id="execution-results-GETapi-v1-games-most-played" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-GETapi-v1-games-most-played"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-GETapi-v1-games-most-played"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-GETapi-v1-games-most-played" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-GETapi-v1-games-most-played">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-GETapi-v1-games-most-played" data-method="GET"
|
|
data-path="api/v1/games/most-played"
|
|
data-authed="1"
|
|
data-hasfiles="0"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('GETapi-v1-games-most-played', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-GETapi-v1-games-most-played"
|
|
onclick="tryItOut('GETapi-v1-games-most-played');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-GETapi-v1-games-most-played"
|
|
onclick="cancelTryOut('GETapi-v1-games-most-played');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-GETapi-v1-games-most-played"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-green">GET</small>
|
|
<b><code>api/v1/games/most-played</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Authorization</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Authorization" class="auth-value" data-endpoint="GETapi-v1-games-most-played"
|
|
value="Bearer {YOUR_JWT_TOKEN}"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>Bearer {YOUR_JWT_TOKEN}</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="GETapi-v1-games-most-played"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="GETapi-v1-games-most-played"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
</form>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<div class="dark-box">
|
|
<div class="lang-selector">
|
|
<button type="button" class="lang-button" data-language-name="bash">bash</button>
|
|
<button type="button" class="lang-button" data-language-name="javascript">javascript</button>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</body>
|
|
</html>
|