871 lines
36 KiB
PHP
871 lines
36 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>Laravel 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://localhost";
|
|
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-general">
|
|
<a href="#rankings-GETapi-v1-rankings-general">Ranking Geral
|
|
* Retorna o top 10 jogos baseado no período informado.</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
|
|
* Retorna o top 10 jogos com base no número de jogadores ativos.</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
|
|
* Retorna os jogos mais bem ranqueados de uma plataforma específica.</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: April 14, 2026</li>
|
|
</ul>
|
|
</div>
|
|
|
|
<div class="page-wrapper">
|
|
<div class="dark-box"></div>
|
|
<div class="content">
|
|
<h1 id="introduction">Introduction</h1>
|
|
<aside>
|
|
<strong>Base URL</strong>: <code>http://localhost</code>
|
|
</aside>
|
|
<pre><code>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></code></pre>
|
|
|
|
<h1 id="authenticating-requests">Authenticating requests</h1>
|
|
<p>This API is not authenticated.</p>
|
|
|
|
<h1 id="rankings">Rankings</h1>
|
|
|
|
<p>APIs para visualização de rankings de jogos</p>
|
|
|
|
<h2 id="rankings-GETapi-v1-rankings-general">Ranking Geral
|
|
* Retorna o top 10 jogos baseado no período informado.</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-GETapi-v1-rankings-general">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request GET \
|
|
--get "http://localhost/api/v1/rankings/general?period=weekly" \
|
|
--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://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());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-GETapi-v1-rankings-general">
|
|
<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": 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"
|
|
}
|
|
]</code>
|
|
</pre>
|
|
</span>
|
|
<span id="execution-results-GETapi-v1-rankings-general" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-GETapi-v1-rankings-general"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-GETapi-v1-rankings-general"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-GETapi-v1-rankings-general" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-GETapi-v1-rankings-general">
|
|
|
|
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-general" data-method="GET"
|
|
data-path="api/v1/rankings/general"
|
|
data-authed="0"
|
|
data-hasfiles="0"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('GETapi-v1-rankings-general', 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-general"
|
|
onclick="tryItOut('GETapi-v1-rankings-general');">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-general"
|
|
onclick="cancelTryOut('GETapi-v1-rankings-general');" 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-general"
|
|
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/general</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>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="GETapi-v1-rankings-general"
|
|
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-general"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<h4 class="fancy-heading-panel"><b>Query Parameters</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>period</code></b>
|
|
<small>string</small>
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="period" data-endpoint="GETapi-v1-rankings-general"
|
|
value="weekly"
|
|
data-component="query">
|
|
<br>
|
|
<p>O período do ranking (weekly, monthly, yearly). Example: <code>weekly</code></p>
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="rankings-GETapi-v1-games-most-played">Jogos Mais Jogados
|
|
* Retorna o top 10 jogos com base no número de jogadores ativos.</h2>
|
|
|
|
<p>
|
|
</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://localhost/api/v1/games/most-played" \
|
|
--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://localhost/api/v1/games/most-played"
|
|
);
|
|
|
|
const headers = {
|
|
"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: 58
|
|
access-control-allow-origin: *
|
|
</code></pre></details> <pre>
|
|
|
|
<code class="language-json" style="max-height: 300px;">[
|
|
{
|
|
"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"
|
|
}
|
|
]</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="0"
|
|
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>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>
|
|
|
|
<h2 id="rankings-GETapi-v1-rankings-platforms--platform-">Ranking por Plataforma
|
|
* Retorna os jogos mais bem ranqueados de uma plataforma específica.</h2>
|
|
|
|
<p>
|
|
</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://localhost/api/v1/rankings/platforms/Steam" \
|
|
--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://localhost/api/v1/rankings/platforms/Steam"
|
|
);
|
|
|
|
const headers = {
|
|
"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: 57
|
|
access-control-allow-origin: *
|
|
</code></pre></details> <pre>
|
|
|
|
<code class="language-json" style="max-height: 300px;">[
|
|
{
|
|
"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"
|
|
}
|
|
]</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="0"
|
|
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>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>
|
|
|
|
|
|
|
|
|
|
</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>
|