codingame-api-node-ts
Version:
A CodinGame API node, that permits you to access all of the endpoints of this website. Wrote in TypeScript, so you can previsualize how the response will look like by checking the code.
560 lines • 35.4 kB
HTML
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>codingame-api-node-ts</title>
<meta name="description" content="Documentation for codingame-api-node-ts">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="assets/css/main.css">
<script async src="assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="assets/js/search.json" data-base=".">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="index.html" class="title">codingame-api-node-ts</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<h1>codingame-api-node-ts</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section ">
<h3>Interfaces</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-interface"><a href="interfaces/iclashleaderboard.html" class="tsd-kind-icon">IClash<wbr>Leaderboard</a></li>
<li class="tsd-kind-interface"><a href="interfaces/igloballeaderboard.html" class="tsd-kind-icon">IGlobal<wbr>Leaderboard</a></li>
<li class="tsd-kind-interface"><a href="interfaces/ilogincodingamer.html" class="tsd-kind-icon">ILogin<wbr>Codin<wbr>Gamer</a></li>
<li class="tsd-kind-interface"><a href="interfaces/ipuzzleminimalprogress.html" class="tsd-kind-icon">IPuzzle<wbr>Minimal<wbr>Progress</a></li>
<li class="tsd-kind-interface"><a href="interfaces/ipuzzleprettyprogress.html" class="tsd-kind-icon">IPuzzle<wbr>Pretty<wbr>Progress</a></li>
<li class="tsd-kind-interface"><a href="interfaces/ipuzzleprogress.html" class="tsd-kind-icon">IPuzzle<wbr>Progress</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Variables</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-variable"><a href="modules.html#urls" class="tsd-kind-icon">urls</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Functions</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-function"><a href="modules.html#findallminimalprogress" class="tsd-kind-icon">find<wbr>All<wbr>Minimal<wbr>Progress</a></li>
<li class="tsd-kind-function"><a href="modules.html#findprogressbyids" class="tsd-kind-icon">find<wbr>Progress<wbr>ByIds</a></li>
<li class="tsd-kind-function"><a href="modules.html#findprogressbyprettyid" class="tsd-kind-icon">find<wbr>Progress<wbr>ByPretty<wbr>Id</a></li>
<li class="tsd-kind-function"><a href="modules.html#getclashleaderboard" class="tsd-kind-icon">get<wbr>Clash<wbr>Leaderboard</a></li>
<li class="tsd-kind-function"><a href="modules.html#getcookies" class="tsd-kind-icon">get<wbr>Cookies</a></li>
<li class="tsd-kind-function"><a href="modules.html#getgloballeaderboard" class="tsd-kind-icon">get<wbr>Global<wbr>Leaderboard</a></li>
<li class="tsd-kind-function"><a href="modules.html#logincodingamer" class="tsd-kind-icon">login<wbr>Codin<wbr>Gamer</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Variables</h2>
<section class="tsd-panel tsd-member tsd-kind-variable">
<a name="urls" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagConst">Const</span> urls</h3>
<div class="tsd-signature tsd-kind-icon">urls<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>achievement<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>career<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>challenge<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>coc<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>codingamer<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>comment<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>company<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>contribution<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>course<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>help<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>leaderboards<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>notification<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>puzzle<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>quest<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>school<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>testsession<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>vote<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>xp<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> = ...</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/Sigeth/codingame-api-node-ts/blob/a56fd5a/src/lib/main.ts#L4">lib/main.ts:4</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<dl class="tsd-comment-tags">
<dt>internal</dt>
<dd></dd>
</dl>
</div>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5>achievement<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
</li>
<li class="tsd-parameter">
<h5>career<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
</li>
<li class="tsd-parameter">
<h5>challenge<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
</li>
<li class="tsd-parameter">
<h5>coc<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
</li>
<li class="tsd-parameter">
<h5>codingamer<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
</li>
<li class="tsd-parameter">
<h5>comment<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
</li>
<li class="tsd-parameter">
<h5>company<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
</li>
<li class="tsd-parameter">
<h5>contribution<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
</li>
<li class="tsd-parameter">
<h5>course<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
</li>
<li class="tsd-parameter">
<h5>help<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
</li>
<li class="tsd-parameter">
<h5>leaderboards<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
</li>
<li class="tsd-parameter">
<h5>notification<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
</li>
<li class="tsd-parameter">
<h5>puzzle<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
</li>
<li class="tsd-parameter">
<h5>quest<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
</li>
<li class="tsd-parameter">
<h5>school<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
</li>
<li class="tsd-parameter">
<h5>testsession<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
</li>
<li class="tsd-parameter">
<h5>vote<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
</li>
<li class="tsd-parameter">
<h5>xp<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
</li>
</ul>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Functions</h2>
<section class="tsd-panel tsd-member tsd-kind-function">
<a name="findallminimalprogress" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagConst">Const</span> find<wbr>All<wbr>Minimal<wbr>Progress</h3>
<ul class="tsd-signatures tsd-kind-function">
<li class="tsd-signature tsd-kind-icon">find<wbr>All<wbr>Minimal<wbr>Progress<span class="tsd-signature-symbol">(</span>cookies<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, userId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="interfaces/ipuzzleminimalprogress.html" class="tsd-signature-type" data-tsd-kind="Interface">IPuzzleMinimalProgress</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/Sigeth/codingame-api-node-ts/blob/a56fd5a/src/lib/api/puzzleServices.ts#L64">lib/api/puzzleServices.ts:64</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Find every minimal puzzle progress from a user. You can also use this to get every puzzles of CodinGame</p>
</div>
<a href="#requires-to-log-in-before" id="requires-to-log-in-before" style="color: inherit; text-decoration: none;">
<h2>Requires to log in before.</h2>
</a>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>cookies: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>The cookies string that you obtain when you're loggin in with loginSite</p>
</div>
</li>
<li>
<h5>userId: <span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography">
<p>User ID you want to retrieve the completion</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="interfaces/ipuzzleminimalprogress.html" class="tsd-signature-type" data-tsd-kind="Interface">IPuzzleMinimalProgress</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function">
<a name="findprogressbyids" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagConst">Const</span> find<wbr>Progress<wbr>ByIds</h3>
<ul class="tsd-signatures tsd-kind-function">
<li class="tsd-signature tsd-kind-icon">find<wbr>Progress<wbr>ByIds<span class="tsd-signature-symbol">(</span>ids<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span>, userId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="interfaces/ipuzzleprogress.html" class="tsd-signature-type" data-tsd-kind="Interface">IPuzzleProgress</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/Sigeth/codingame-api-node-ts/blob/a56fd5a/src/lib/api/puzzleServices.ts#L13">lib/api/puzzleServices.ts:13</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Find puzzle informations and player's completion from an array of number IDs.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>ids: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span></h5>
<div class="tsd-comment tsd-typography">
<p>Every Puzzle IDs you want to inspect</p>
</div>
</li>
<li>
<h5>userId: <span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography">
<p>User ID you want to retrieve the completion</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="interfaces/ipuzzleprogress.html" class="tsd-signature-type" data-tsd-kind="Interface">IPuzzleProgress</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function">
<a name="findprogressbyprettyid" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagConst">Const</span> find<wbr>Progress<wbr>ByPretty<wbr>Id</h3>
<ul class="tsd-signatures tsd-kind-function">
<li class="tsd-signature tsd-kind-icon">find<wbr>Progress<wbr>ByPretty<wbr>Id<span class="tsd-signature-symbol">(</span>cookies<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, puzzlePrettyId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, userId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="interfaces/ipuzzleprettyprogress.html" class="tsd-signature-type" data-tsd-kind="Interface">IPuzzlePrettyProgress</a><span class="tsd-signature-symbol">></span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/Sigeth/codingame-api-node-ts/blob/a56fd5a/src/lib/api/puzzleServices.ts#L38">lib/api/puzzleServices.ts:38</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Find puzzle informations and player's completion from a "pretty ID" which is a string, found in the URL of the puzzle.</p>
</div>
<a href="#requires-to-log-in-before" id="requires-to-log-in-before" style="color: inherit; text-decoration: none;">
<h2>Requires to log in before.</h2>
</a>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>cookies: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>The cookies string that you obtain when you're loggin in with loginSite</p>
</div>
</li>
<li>
<h5>puzzlePrettyId: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>Puzzle's "pretty ID", found in its URL.</p>
</div>
</li>
<li>
<h5>userId: <span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography">
<p>User ID you want to retrieve the completion</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="interfaces/ipuzzleprettyprogress.html" class="tsd-signature-type" data-tsd-kind="Interface">IPuzzlePrettyProgress</a><span class="tsd-signature-symbol">></span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function">
<a name="getclashleaderboard" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagConst">Const</span> get<wbr>Clash<wbr>Leaderboard</h3>
<ul class="tsd-signatures tsd-kind-function">
<li class="tsd-signature tsd-kind-icon">get<wbr>Clash<wbr>Leaderboard<span class="tsd-signature-symbol">(</span>page<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, filter<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>active<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>column<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>filter<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>keyword<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span>, codinGamerPublicHandle<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="interfaces/iclashleaderboard.html" class="tsd-signature-type" data-tsd-kind="Interface">IClashLeaderboard</a><span class="tsd-signature-symbol">></span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/Sigeth/codingame-api-node-ts/blob/a56fd5a/src/lib/api/leaderboardServices.ts#L40">lib/api/leaderboardServices.ts:40</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Get the Clash Of Code Leaderboard</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>page: <span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography">
<p>Leaderboard's page</p>
</div>
</li>
<li>
<h5>filter: <span class="tsd-signature-symbol">{ </span>active<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>column<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>filter<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>keyword<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></h5>
<div class="tsd-comment tsd-typography">
<p>Leaderboar's filter</p>
</div>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5>active<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5>
</li>
<li class="tsd-parameter">
<h5>column<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
</li>
<li class="tsd-parameter">
<h5>filter<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
</li>
<li class="tsd-parameter">
<h5>keyword<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
</li>
</ul>
</li>
<li>
<h5>codinGamerPublicHandle: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>Public Handle from the CodinGamer</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="interfaces/iclashleaderboard.html" class="tsd-signature-type" data-tsd-kind="Interface">IClashLeaderboard</a><span class="tsd-signature-symbol">></span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function">
<a name="getcookies" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagConst">Const</span> get<wbr>Cookies</h3>
<ul class="tsd-signatures tsd-kind-function">
<li class="tsd-signature tsd-kind-icon">get<wbr>Cookies<span class="tsd-signature-symbol">(</span>response<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/Sigeth/codingame-api-node-ts/blob/a56fd5a/src/lib/main.ts#L26">lib/main.ts:26</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<dl class="tsd-comment-tags">
<dt>internal</dt>
<dd></dd>
</dl>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>response: <span class="tsd-signature-type">any</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function">
<a name="getgloballeaderboard" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagConst">Const</span> get<wbr>Global<wbr>Leaderboard</h3>
<ul class="tsd-signatures tsd-kind-function">
<li class="tsd-signature tsd-kind-icon">get<wbr>Global<wbr>Leaderboard<span class="tsd-signature-symbol">(</span>page<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, category<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, filter<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>active<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>column<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>filter<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>keyword<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span>, codinGamerPublicHandle<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="interfaces/igloballeaderboard.html" class="tsd-signature-type" data-tsd-kind="Interface">IGlobalLeaderboard</a><span class="tsd-signature-symbol">></span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/Sigeth/codingame-api-node-ts/blob/a56fd5a/src/lib/api/leaderboardServices.ts#L16">lib/api/leaderboardServices.ts:16</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Get the global leaderboard</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>page: <span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography">
<p>Leaderboard's Page</p>
</div>
</li>
<li>
<h5>category: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>Leaderboard's category. Can be GENERAL, CONTESTS, BOT_PROGRAMMING, OPTIM or CODEGOLF</p>
</div>
</li>
<li>
<h5>filter: <span class="tsd-signature-symbol">{ </span>active<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>column<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>filter<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>keyword<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></h5>
<div class="tsd-comment tsd-typography">
<p>Leaderboard's filter</p>
</div>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5>active<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5>
</li>
<li class="tsd-parameter">
<h5>column<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
</li>
<li class="tsd-parameter">
<h5>filter<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
</li>
<li class="tsd-parameter">
<h5>keyword<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
</li>
</ul>
</li>
<li>
<h5>codinGamerPublicHandle: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>Public Handle from the CodinGamer</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="interfaces/igloballeaderboard.html" class="tsd-signature-type" data-tsd-kind="Interface">IGlobalLeaderboard</a><span class="tsd-signature-symbol">></span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function">
<a name="logincodingamer" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagConst">Const</span> login<wbr>Codin<wbr>Gamer</h3>
<ul class="tsd-signatures tsd-kind-function">
<li class="tsd-signature tsd-kind-icon">login<wbr>Codin<wbr>Gamer<span class="tsd-signature-symbol">(</span>email<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, password<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="interfaces/ilogincodingamer.html" class="tsd-signature-type" data-tsd-kind="Interface">ILoginCodinGamer</a><span class="tsd-signature-symbol">></span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/Sigeth/codingame-api-node-ts/blob/a56fd5a/src/lib/api/auth.ts#L14">lib/api/auth.ts:14</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Login to CodinGame as a CodinGamer</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>email: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>Account Email</p>
</div>
</li>
<li>
<h5>password: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>Account Password</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="interfaces/ilogincodingamer.html" class="tsd-signature-type" data-tsd-kind="Interface">ILoginCodinGamer</a><span class="tsd-signature-symbol">></span></h4>
</li>
</ul>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class="current ">
<a href="modules.html">Exports</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
<li class=" tsd-kind-interface">
<a href="interfaces/iclashleaderboard.html" class="tsd-kind-icon">IClash<wbr>Leaderboard</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/igloballeaderboard.html" class="tsd-kind-icon">IGlobal<wbr>Leaderboard</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/ilogincodingamer.html" class="tsd-kind-icon">ILogin<wbr>Codin<wbr>Gamer</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/ipuzzleminimalprogress.html" class="tsd-kind-icon">IPuzzle<wbr>Minimal<wbr>Progress</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/ipuzzleprettyprogress.html" class="tsd-kind-icon">IPuzzle<wbr>Pretty<wbr>Progress</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/ipuzzleprogress.html" class="tsd-kind-icon">IPuzzle<wbr>Progress</a>
</li>
<li class=" tsd-kind-variable">
<a href="modules.html#urls" class="tsd-kind-icon">urls</a>
</li>
<li class=" tsd-kind-function">
<a href="modules.html#findallminimalprogress" class="tsd-kind-icon">find<wbr>All<wbr>Minimal<wbr>Progress</a>
</li>
<li class=" tsd-kind-function">
<a href="modules.html#findprogressbyids" class="tsd-kind-icon">find<wbr>Progress<wbr>ByIds</a>
</li>
<li class=" tsd-kind-function">
<a href="modules.html#findprogressbyprettyid" class="tsd-kind-icon">find<wbr>Progress<wbr>ByPretty<wbr>Id</a>
</li>
<li class=" tsd-kind-function">
<a href="modules.html#getclashleaderboard" class="tsd-kind-icon">get<wbr>Clash<wbr>Leaderboard</a>
</li>
<li class=" tsd-kind-function">
<a href="modules.html#getcookies" class="tsd-kind-icon">get<wbr>Cookies</a>
</li>
<li class=" tsd-kind-function">
<a href="modules.html#getgloballeaderboard" class="tsd-kind-icon">get<wbr>Global<wbr>Leaderboard</a>
</li>
<li class=" tsd-kind-function">
<a href="modules.html#logincodingamer" class="tsd-kind-icon">login<wbr>Codin<wbr>Gamer</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<footer class="with-border-bottom">
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
</ul>
</div>
</div>
</footer>
<div class="container tsd-generator">
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
</div>
<div class="overlay"></div>
<script src="assets/js/main.js"></script>
</body>
</html>