api.polsu.xyz Open in urlscan Pro
172.67.191.244  Public Scan

Form analysis
2 forms found in the DOM

<form data-v-21a1cfbf="" data-v-3bdd11a8="" data-v-9052a928="" class="card-form">
  <div data-v-2c06084d="" data-v-3bdd11a8="" class="card-form-input"><label data-v-2c06084d="" for="security-scheme-API-Key">Header API </label><input data-v-2c06084d="" placeholder="Token" id="security-scheme-API-Key" autocomplete="off"
      data-1p-ignore="" spellcheck="false" type="password" value=""><button data-v-2c06084d=""
      class="scalar-icon-button grid aspect-square cursor-pointer rounded size-10 p-3 scalar-button-ghost bg-transparent text-c-3 transition-colors active:text-c-1 hocus:text-c-1 password-mask password-mask" type="button"><svg
        xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 12 12" class="scalar-icon size-full">
        <path stroke="currentColor" stroke-linecap="round" stroke-linejoin="round" d="M6 2.7C4 2.7 2 4 .7 5.5c-.3.3-.3.8 0 1.1C2 7.9 4 9.3 6 9.3s4-1.4 5.3-2.8c.3-.3.3-.8 0-1.1C10 4 8 2.7 6 2.7"></path>
        <path stroke="currentColor" stroke-linecap="round" stroke-linejoin="round" d="M7.8 6C7.8 7 7 7.8 6 7.8S4.2 7 4.2 6 5 4.2 6 4.2 7.8 5 7.8 6"></path>
      </svg><span class="sr-only">Show Password</span></button></div>
</form>

<form>
  <div class="border-1/2 rounded mx-1 bg-b-1 overflow-visible flex-1">
    <table class="grid auto-rows-auto min-h-8 mb-0" style="grid-template-columns: 1fr;"><!---->
      <tbody>
        <tr class="group contents w-fit min-w-full">
          <th
            class="min-h-8 border-l-0 border-t-0 border-b-1/2 border-r-1/2 flex text-sm last:border-r-0 group-last:border-b-transparent p-0 m-0 truncate font-medium px-2 py-1.5 relative col-span-full cursor-pointer py-[0px] px-[0px] flex items-center"
            role="cell">
            <div class="w-full text-xs" data-headlessui-state="">
              <div class="contents"><button id="headlessui-listbox-button-8" aria-haspopup="listbox" aria-expanded="false" data-headlessui-state=""
                  class="scalar-button scalar-row cursor-pointer items-center rounded w-full text-sm scalar-button-ghost bg-transparent transition-colors active:text-c-1 hocus:text-c-1 flex gap-1.5 h-auto py-0 px-0 text-c-2 hover:text-c-1 font-normal justify-start"
                  type="button"><!---->
                  <div class="flex h-8 items-center">
                    <div class="text-c-2 flex min-w-[100px] items-center border-r-1/2 pr-0 pl-2 h-full"> Auth Type </div><span class="pl-2">Header (ApiKey)</span><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 12 12"
                      class="scalar-icon size-3 stroke-[1.4]">
                      <path stroke="currentColor" stroke-linecap="round" stroke-linejoin="round" d="M2.2 4.1 6 7.9l3.8-3.8"></path>
                    </svg>
                  </div><!---->
                </button></div><!---->
            </div>
          </th>
        </tr>
        <tr class="group contents w-fit min-w-full">
          <td data-v-8ebaeb0e="" class="min-h-8 border-l-0 border-t-0 border-b-1/2 border-r-1/2 flex text-sm last:border-r-0 group-last:border-b-transparent p-0 m-0 relative row" role="cell">
            <div data-v-8ebaeb0e="" class="text-c-2 flex min-w-[100px] items-center border-r-1/2 pl-2 pr-0"><label for="api-key-API-Key">API-Key</label></div>
            <div data-v-8ebaeb0e="" class="group row-1"><input data-v-8ebaeb0e="" placeholder="Value" id="api-key-API-Key" autocomplete="off" class="border-none focus:text-c-1 text-c-2 min-w-0 w-full px-2 py-1.5 outline-none" data-1p-ignore=""
                spellcheck="false" type="password" value=""></div><button data-v-8ebaeb0e=""
              class="scalar-icon-button grid aspect-square cursor-pointer rounded size-10 scalar-button-ghost bg-transparent text-c-3 transition-colors active:text-c-1 hocus:text-c-1 -ml-.5 mr-1 h-6 w-6 self-center p-1.5 -ml-.5 mr-1 h-6 w-6 self-center p-1.5"
              type="button"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 12 12" class="scalar-icon size-full">
                <path stroke="currentColor" stroke-linecap="round" stroke-linejoin="round" d="M6 2.7C4 2.7 2 4 .7 5.5c-.3.3-.3.8 0 1.1C2 7.9 4 9.3 6 9.3s4-1.4 5.3-2.8c.3-.3.3-.8 0-1.1C10 4 8 2.7 6 2.7"></path>
                <path stroke="currentColor" stroke-linecap="round" stroke-linejoin="round" d="M7.8 6C7.8 7 7 7.8 6 7.8S4.2 7 4.2 6 5 4.2 6 4.2 7.8 5 7.8 6"></path>
              </svg><span class="sr-only">Show Password</span></button>
            <dialog data-v-8ebaeb0e="" id="env-dialog" class="absolute left-2 top-7 z-10 w-60 rounded border bg-white p-1" tabindex="0">
              <ul>
                <li class="font-code text-3xs hover:bg-b-2 flex cursor-pointer items-center justify-between gap-1.5 rounded p-1.5 transition-colors duration-150">
                  <div class="flex items-center gap-1.5 whitespace-nowrap"><span class="h-2.5 w-2.5 min-w-2.5 rounded-full bg-blue"></span> Global Environment</div><span class="w-20 overflow-hidden text-ellipsis text-right">{ "exampleKey":
                    "exampleValue" }</span>
                </li>
              </ul>
            </dialog>
          </td>
        </tr>
      </tbody>
    </table>
  </div>
</form>

Text Content

Open Menu

Search⌃k


 * Introduction

 * Authentication

 * Limits

 * Rules

 * Toggle group  
   
   Notes

 * Toggle group  
   
   Services
   
   * Status
     
       GET
   
   * Stats
     
       GET

 * Toggle group  
   
   API

 * Toggle group  
   
   Polsu

 * Toggle group  
   
   Cache

 * Toggle group  
   
   Models

Dark Mode Powered by scalar.com

v2.2.4
OAS 3.0.3


POLSU'S API

Download OpenAPI Spec


INTRODUCTION

This is the official documentation for Polsu's API.


 * Polsu's Website
 * GitHub
 * Privacy Policy
 * Terms Of Service
   
   

More endpoints:

 * Assets Endpoints Documentation
 * Beta Endpoints Documentation
   
   

Have a question? Get in touch!

 * Discord Server
 * support@polsu.xyz
   
   
   


AUTHENTICATION

All requests on our API require an API Key in the headers, it can be obtained at
polsu.xyz/api/apikey.





LIMITS

API Keys have a default rate limit of 120 requests per minute.

If you require a higher limit please contact us on our Discord server with an
explanation for the increased limit.

Please note that only the owner of the key can request a higher rate limit and
that we do not give increased limits for future expansion, please only request
an increase once you need it.





RULES

While the API is free to be used in most applications and scenarios, we do have
some rules and we will not grant a limit increase for applications that violate
these rules.

 * You may not use the API for commercial use. Any features that use the API
   must be available to all users.
 * You may not use the API for heavy continuous polling of data, such as
   requesting data every minute.
 * You may not use methods such as multiple accounts to bypass the API limits.
 * Use of the API must conform to our Terms of Service.

If one of your projects uses our API you must give us credits, add a link
somewhere to this page!

Any abuse of the API will lead to your API Key being reset, or banned.





NOTES


DATE AND TIME

Timestamps are stored as a Unix Epoch times in milliseconds.


RESPONSE FORMAT

Responses are served in JSON format.


UUID PARAMETERS

All uuid parameters support both dashed and undashed versions.


DISCORD CACHE BYPASS

If you use Polsu assets such as Minecraft Server Status MOTDs, Players Graphs or
Ping Graphs for them to update on discord just add a useless unique argument at
the end of you request: t=TIMESTAMP. Where TIMESTAMP is the current Unix Epoch
timestamp. In Python you can get it with the following code:

from time import time

TIMESTAMP  = time()





CACHE

Endpoints starting with /cache require a special authentication, you can get in
by gettting in contact with us.

Base URL
https://api.polsu.xyz

Main server

API Key (ApiKey)
Header API Show Password
Client Libraries

Shell

Ruby

Node.js

PHP

Python
Libcurlclj-httpHttpClientRestSharpNewRequestHTTP/1.1AsyncHttpjava.net.httpOkHttpUnirestXMLHttpRequestAxiosfetchjQueryOkHttpundiciHTTPRequestAxiosFetchNSURLSessionCoHTTPcURLGuzzleHTTP
v1HTTP
v2Invoke-WebRequestInvoke-RestMethodhttp.clientRequestshttrnet::httpcURLHTTPieWgetNSURLSession

More
cURL Shell


SERVICES # COPY LINK TO "SERVICES"


Endpoints

GET/services/statusGET/services/stats


STATUS # COPY LINK TO "STATUS"

Responses
 * 200
   
   Get the status of our Services

GET/services/status
Shell
cURLLibcurlclj-httpHttpClientRestSharpNewRequestHTTP/1.1AsyncHttpjava.net.httpOkHttpUnirestXMLHttpRequestAxiosfetchjQueryOkHttpundiciHTTPRequestAxiosFetchNSURLSessionCoHTTPcURLGuzzleHTTP
v1HTTP
v2Invoke-WebRequestInvoke-RestMethodhttp.clientRequestshttrnet::httpcURLHTTPieWgetNSURLSession

curl --request GET \
  --url https://api.polsu.xyz/services/status \
  --header 'Api-Key: YOUR_TOKEN'


Test Request
200
Show Schema

{
  "success": true,
  "data": {
    "api": true,
    "polsu": true,
    "launch": 1
  }
}

Get the status of our Services


STATS # COPY LINK TO "STATS"

Responses
 * 200
   
   Get the stats of our services

 * 500
   
   The endpoint isn't available at the moment.

GET/services/stats
Shell
cURLLibcurlclj-httpHttpClientRestSharpNewRequestHTTP/1.1AsyncHttpjava.net.httpOkHttpUnirestXMLHttpRequestAxiosfetchjQueryOkHttpundiciHTTPRequestAxiosFetchNSURLSessionCoHTTPcURLGuzzleHTTP
v1HTTP
v2Invoke-WebRequestInvoke-RestMethodhttp.clientRequestshttrnet::httpcURLHTTPieWgetNSURLSession

curl --request GET \
  --url https://api.polsu.xyz/services/stats \
  --header 'Api-Key: YOUR_TOKEN'


Test Request
200500
Show Schema

{
  "success": true,
  "data": {
    "polsu": {
      "servers": 0,
      "channels": 0,
      "users": 0,
      "accounts": 0,
      "commands": 0,
      "linked": 0,
      "players": 0,
      "sessions": 0,
      "code": {
        "files": 0,
        "functions": 0,
        "variables": 0,
        "characters": 0,
        "empty_lines": 0,
        "lines": 0,
        "total_lines": 0
      }
    },
    "api": {
      "accounts": 0,
      "requests": 0,
      "endpoints": 0,
      "code": {
        "files": 0,
        "functions": 0,
        "variables": 0,
        "characters": 0,
        "empty_lines": 0,
        "lines": 0,
        "total_lines": 0
      }
    }
  }
}

Get the stats of our services


API # COPY LINK TO "API"


Endpoints

GET/api/keyGET/api/ping
Show More


POLSU # COPY LINK TO "POLSU"


Endpoints

GET/polsu/accountGET/polsu/bedwars/mapGET/polsu/bedwars/mapsGET/polsu/bedwars/maps/dataGET/polsu/bedwars/statusGET/polsu/bedwars/sessionsGET/polsu/bedwars/dreamGET/polsu/bedwars/quickbuyGET/polsu/bedwars/similar/quickbuyGET/polsu/bedwars/similar/hotbarGET/polsu/bedwars/quickbuy/allGET/polsu/bedwars/formattedPOST/polsu/bedwars/formattedGET/polsu/leaderboard/bedwarsGET/polsu/leaderboard/networkGET/polsu/pingGET/polsu/formattedPOST/polsu/formattedGET/polsu/minecraft/playerGET/polsu/minecraft/apiGET/polsu/minecraft/serverGET/polsu/minecraft/player/skin/head2dGET/polsu/minecraft/player/skin/head3dGET/polsu/minecraft/player/skin/body
Show More


CACHE # COPY LINK TO "CACHE"


Endpoints

GET/cache/player/bedwars


BEDWARS PLAYER CACHE # COPY LINK TO "BEDWARS PLAYER CACHE"

Query Parameters
 * player
   required
   string
   
   Minecraft UUID or Username

Responses
 * 200
   
   Get the Bedwars Player Cache

 * 400
   
   Some required data is missing, this is usually a field.

 * 403
   
   Access is forbidden, usually due to an invalid API Key being used.

 * 404
   
   The page provided does not exist or is currently unavailale.

 * 422
   
   Some data provided is invalid.

 * 429
   
   A request limit has been reached, usually this is due to the limit on the key
   being reached but can also be triggered by a global throttle.

GET/cache/player/bedwars
Shell
cURLLibcurlclj-httpHttpClientRestSharpNewRequestHTTP/1.1AsyncHttpjava.net.httpOkHttpUnirestXMLHttpRequestAxiosfetchjQueryOkHttpundiciHTTPRequestAxiosFetchNSURLSessionCoHTTPcURLGuzzleHTTP
v1HTTP
v2Invoke-WebRequestInvoke-RestMethodhttp.clientRequestshttrnet::httpcURLHTTPieWgetNSURLSession

curl --request GET \
  --url 'https://api.polsu.xyz/cache/player/bedwars?player=7f2996146af142948f9479d06f133874' \
  --header 'Api-Key: YOUR_TOKEN'


Test Request
200400403404422429
Show Schema

{
  "success": true,
  "data": {
    "player": {
      "username": "Polsulpicien",
      "uuid": "7f2996146af142948f9479d06f133874",
      "rank": "MVP+",
      "formatted": "§b[MVP§9+§b] Polsulpicien",
      "channel": "ALL",
      "level": 160
    },
    "stats": {
      "Bedwars": {
        "formatted": "§3[500✫] §b[MVP§9+§b] Polsulpicien",
        "stars": 500,
        "games_played": 4000,
        "winstreak": 100,
        "kills": 2000,
        "deaths": 2000,
        "kdr": 1,
        "fkills": 2000,
        "fdeaths": 2000,
        "fkdr": 1,
        "wins": 2000,
        "losses": 2000,
        "wlr": 1,
        "broken": 2000,
        "lost": 2000,
        "bblr": 1,
        "rqlevel": {
          "index": 12,
          "level": ", §bGreater.",
          "text": "§dTechnoblade never dies!\n§6You better ALT + F4 right now!",
          "colour": "ff4dff",
          "raw": 1335939
        },
        "core": {
          "games_played": 4000,
          "winstreak": 100,
          "kills": 2000,
          "deaths": 2000,
          "kdr": 1,
          "fkills": 2000,
          "fdeaths": 2000,
          "fkdr": 1,
          "wins": 2000,
          "losses": 2000,
          "wlr": 1,
          "broken": 2000,
          "lost": 2000,
          "bblr": 1,
          "rqlevel": {
            "index": null,
            "level": null,
            "text": null,
            "colour": null,
            "raw": null
          }
        },
        "solos": {
          "games_played": 4000,
          "winstreak": 100,
          "kills": 2000,
          "deaths": 2000,
          "kdr": 1,
          "fkills": 2000,
          "fdeaths": 2000,
          "fkdr": 1,
          "wins": 2000,
          "losses": 2000,
          "wlr": 1,
          "broken": 2000,
          "lost": 2000,
          "bblr": 1,
          "rqlevel": {
            "index": null,
            "level": null,
            "text": null,
            "colour": null,
            "raw": null
          }
        },
        "doubles": {
          "games_played": 4000,
          "winstreak": 100,
          "kills": 2000,
          "deaths": 2000,
          "kdr": 1,
          "fkills": 2000,
          "fdeaths": 2000,
          "fkdr": 1,
          "wins": 2000,
          "losses": 2000,
          "wlr": 1,
          "broken": 2000,
          "lost": 2000,
          "bblr": 1,
          "rqlevel": {
            "index": null,
            "level": null,
            "text": null,
            "colour": null,
            "raw": null
          }
        },
        "threes": {
          "games_played": 4000,
          "winstreak": 100,
          "kills": 2000,
          "deaths": 2000,
          "kdr": 1,
          "fkills": 2000,
          "fdeaths": 2000,
          "fkdr": 1,
          "wins": 2000,
          "losses": 2000,
          "wlr": 1,
          "broken": 2000,
          "lost": 2000,
          "bblr": 1,
          "rqlevel": {
            "index": null,
            "level": null,
            "text": null,
            "colour": null,
            "raw": null
          }
        },
        "fours": {
          "games_played": 4000,
          "winstreak": 100,
          "kills": 2000,
          "deaths": 2000,
          "kdr": 1,
          "fkills": 2000,
          "fdeaths": 2000,
          "fkdr": 1,
          "wins": 2000,
          "losses": 2000,
          "wlr": 1,
          "broken": 2000,
          "lost": 2000,
          "bblr": 1,
          "rqlevel": {
            "index": null,
            "level": null,
            "text": null,
            "colour": null,
            "raw": null
          }
        },
        "four_v_four": {
          "games_played": 4000,
          "winstreak": 100,
          "kills": 2000,
          "deaths": 2000,
          "kdr": 1,
          "fkills": 2000,
          "fdeaths": 2000,
          "fkdr": 1,
          "wins": 2000,
          "losses": 2000,
          "wlr": 1,
          "broken": 2000,
          "lost": 2000,
          "bblr": 1,
          "rqlevel": {
            "index": null,
            "level": null,
            "text": null,
            "colour": null,
            "raw": null
          }
        }
      }
    }
  }
}

Get the Bedwars Player Cache


UUIDS # COPY LINK TO "UUIDS"

UUIDs
uuids
array string[]
Example7f2996146af142948f9479d06f133874


BEDWARSPLAYERSTATS # COPY LINK TO "BEDWARSPLAYERSTATS"

{} BedwarsPlayerStats
games_played
integer

Integer numbers.

Example4000
winstreak
integer

Integer numbers.

Example100
kills
integer

Integer numbers.

Example2000
deaths
integer

Integer numbers.

Example2000
kdr
float
Example1
fkills
integer

Integer numbers.

Example2000
fdeaths
integer

Integer numbers.

Example2000
fkdr
float
Example1
wins
integer

Integer numbers.

Example2000
losses
integer

Integer numbers.

Example2000
wlr
float
Example1
broken
integer

Integer numbers.

Example2000
lost
integer

Integer numbers.

Example2000
bblr
float
Example1
rqlevel


REQUEUELEVEL # COPY LINK TO "REQUEUELEVEL"

RequeueLevel
index
integer

Integer numbers.

Example12
level
string
Example, §bGreater.
text
string
Example§dTechnoblade never dies! §6You better ALT + F4 right now!
colour
string
Exampleff4dff
raw
number
Example1335939

GET
https://api.polsu.xyz
/services/status


Send

Request Status
AllAuthCookiesHeadersQuery
Authentication

Auth Type
Header (ApiKey)
API-Key

Show Password
 * Global Environment
   { "exampleKey": "exampleValue" }

Path Variables

You can use variables in your path: /endpoint/{my_path_variable}
Cookies
Clear
 * Global Environment
   { "exampleKey": "exampleValue" }


 * Global Environment
   { "exampleKey": "exampleValue" }

Headers
Clear
 * Global Environment
   { "exampleKey": "exampleValue" }


 * Global Environment
   { "exampleKey": "exampleValue" }

Query Parameters
Clear
 * Global Environment
   { "exampleKey": "exampleValue" }


 * Global Environment
   { "exampleKey": "exampleValue" }

Body

None
No Body

Response
.,,uod8B8bou,,. ..,uod8BBBBBBBBBBBBBBBBRPFT?l!i:.
||||||||||||||!?TFPRBBBBBBBBBBBBBBB8m=, |||| '""^^!!||||||||||TFPRBBBVT!:...!
|||| '""^^!!|||||?!:.......! |||| ||||.........! |||| ||||.........! ||||
||||.........! |||| ||||.........! |||| ||||.........! |||| ||||.........! ||||,
||||.........` |||||!!-._ ||||.......;. ':!|||||||||!!-._ ||||.....bBBBBWdou,.
bBBBBB86foi!|||||||!!-..:|||!..bBBBBBBBBBBBBBBY!
::!?TFPRBBBBBB86foi!||||||||!!bBBBBBBBBBBBBBBY..!
:::::::::!?TFPRBBBBBB86ftiaabBBBBBBBBBBBBBBY....!
:::;`"^!:;::::::!?TFPRBBBBBBBBBBBBBBBBBBBY......!
;::::::...''^::::::::::!?TFPRBBBBBBBBBBY........!
.ob86foi;::::::::::::::::::::::::!?TFPRBY..........`
.b888888888886foi;:::::::::::::::::::::::..........`
.b888888888888888888886foi;::::::::::::::::...........b888888888888888888888888888886foi;:::::::::......`!Tf998888888888888888888888888888888886foi;:::....`
'"^!|Tf9988888888888888888888888888888888!::..`
'"^!|Tf998888888888888888888888889!! '` '"^!|Tf9988888888888888888!!` iBBbo.
'"^!|Tf998888888889!` WBBBBbo. '"^!|Tf9989!` YBBBP^' '"^!` `
Send Request
⌃↵