Link Copied to clipboard

MySquadStats API Documentation

This Documentation is a Work in Progress and is subject to changes. MySquadStats is under no obligation to prioritize the updating of this API.

If your question is not addressed, pleae visit our Discord.

🔗Table of Contents

• Changes
• Authorization
• /allTimeLeaderboards
• /ping
• /players
• /playerLink
• /playerRibbons
• /playerWeapons
• /ribbons
• /ribbonRecipients
• /seasonLeaderboards
• /seasons
• /servers

🔗Changes

Below are some of the notable recent Changes to the API:

• May 27, 2025 | The URL for the API has updated from https://mysquadstats.com/api/... to https://api.mysquadstats.com/.... The old URL is still active for the time being but will be fully shut down in the future. Exact date TBD.
• May 27, 2025 | Each endpoint on the old URL used to include in the response payload a successStatus and a successMessage. In the new API URL, the response payload has updated to instead include status and message along with the requested data if successful.
• May 27, 2025 | Most all references of dlc have been updated to mod.

🔗Authorization

All MySquadStats Endpoints require an Access Token. There are a few ways to obtain an API Access Token:

1. Have the Sq License Owner Role in the OWI Hosting Discord and apply to #send-your-stats in the MySquadStats Discord. Upon approval, you will be given an API Access Token for use in our SquadJS Plugin. This token shall only be used within the SquadJS Plugin. If you require a token for other means, please see the next options.
2. Apply for a Read Only API Access Token. This type of Access Token will be granted on a case by case basis depending on your specified use and is subject to Rate Limits of 200 Requests/Minute
3. Apply for a Read/Write API Access Token. Maybe you're creating a different way to parse the SquadGame.log instead of using SquadJS. Please DM @psg_ignis in Discord to discuss your use case.

🔗 /allTimeLeaderboards

GET /allTimeLeaderboards

Returns the All Time Leaderboards for the specified DLC/MOD.

Query Parameters:

  • accessToken (required) - String - The Access Token to use.
  • mod (required) - String - The MOD to return Leaderboards for.
    • "Vanilla", "MEE", "GE", "GC", "SD", "KOTH", "SPM", "ICM"
  • page - Number - The page number to return. Default is 1.
  • pageSize - Number - The number of entries to return per page. Default is 10. Max is 100.
  • sortColumn - String - The column to sort by. Available options are:
    • "eosID", "steamID", "lastName", "totalScore", "totalScoreRank", "totalWounds", "totalWoundsRank", "totalKills", "totalKillsRank", "totalDeaths", "totalDeathsRank", "totalRevives", "totalRevivesRank", "totalTimesRevived", "totalTimesRevivedRank", "totalKdRatio", "totalKdRatioRank", "totalTks", "totalTksRank", "totalTkd", "totalTkdRank", "highestKillstreak", "highestKillstreakRank"
  • sortDirection - String - The direction to sort.
    • "asc", "desc"
  • search - String - The search term to filter by.

Example:

/allTimeLeaderboards?accessToken=YOUR_ACCESS_TOKEN&mod=Vanilla&page=1&pageSize=10&sortColumn=totalScore&sortDirection=desc

🔗/ping

GET /ping

Returns a simple response to check if the API is online.

Query Parameters:

  • accessToken (required) - String - The Access Token to use.

Example:

/ping?accessToken=YOUR_ACCESS_TOKEN

🔗/players

GET /players

Returns data for a Player.

Query Parameters:

  • accessToken (required) - String - The Access Token to use.
  • search (required) - String - The search term to find a player. SteamID or Player Name is accepted.

Example:

/players?accessToken=YOUR_ACCESS_TOKEN&search=ignis

GET /playerLink

Returns the Player Link for a Player.

Query Parameters:

  • accessToken - Not required for this endpoint. Public Enpoint.
  • steamID (optional) - String - The SteamID to find a player.
  • eosID (optional) - String - The EOSID to find a player.
  • discordID (optional) - String - The DiscordID to find a player.

Example:

/playerLink?steamID=76561198057101411

🔗/playerRibbons

GET /playerRibbons

Returns the Ribbons for a Player.

Query Parameters:

  • accessToken (required) - String - The Access Token to use.
  • search (required) - String - The search term to find a player. SteamID is accepted.

Example:

/playerRibbons?accessToken=YOUR_ACCESS_TOKEN&search=76561198057101411

🔗/playerWeapons

GET /playerWeapons

Returns the Weapons for a Player.

Query Parameters:

  • accessToken (required) - String - The Access Token to use.
  • search (required) - String - The search term to find a player. SteamID is accepted.

Example:

/playerWeapons?accessToken=YOUR_ACCESS_TOKEN&search=76561198057101411

🔗/ribbons

GET /ribbons

Returns the Ribbons available.

Query Parameters:

  • accessToken (required) - String - The Access Token to use.

Example:

/ribbons?accessToken=YOUR_ACCESS_TOKEN

🔗/ribbonRecipients

GET /ribbonRecipients

Returns the Ribbon Recipients.

Query Parameters:

  • accessToken (required) - String - The Access Token to use.
  • ribbonid (required) - Number - The Ribbon ID to filter.
  • page - Number - The page number to return. Default is 1.
  • pageSize - Number - The number of entries to return per page. Default is 10. Max is 100.
  • sortColumn - String - The column to sort by. Available options are:
    • "lastName", "steamID", "timesAwarded", "firstAwarded", "lastAwarded"
  • sortDirection - String - The direction to sort.
    • "asc", "desc"

Example:

/ribbonRecipients?accessToken=YOUR_ACCESS_TOKEN&ribbonid=2&page=1&pageSize=10&sortColumn=lastName&sortDirection=asc

🔗/seasonLeaderboards

GET /seasonLeaderboards

Returns the Season Leaderboards for the specified DLC/MOD.

Query Parameters:

  • accessToken (required) - String - The Access Token to use.
  • mod (required) - String - The DLC/MOD to return Leaderboards for.
    • "Vanilla", "MEE", "GE", "GC", "SD", "KOTH", "SPM", "ICM"
  • season - String - The Season to return.
    • "Current", "Dev Season", "Season 1", etc
  • page - Number - The page number to return. Default is 1.
  • pageSize - Number - The number of entries to return per page. Default is 10. Max is 100.
  • sortColumn - String - The column to sort by. Available options are:
    • "eosID", "steamID", "lastName", "seasonScore", "seasonScoreRank", "seasonWounds", "seasonWoundsRank", "seasonKills", "seasonKillsRank", "seasonDeaths", "seasonDeathsRank", "seasonRevives", "seasonRevivesRank", "seasonTimesRevived", "seasonTimesRevivedRank", "seasonKdRatio", "seasonKdRatioRank", "seasonTks", "seasonTksRank", "seasonTkd", "seasonTkdRank", "highestKillstreak", "highestKillstreakRank"
  • sortDirection - String - The direction to sort.
    • "asc", "desc"
  • search - String - The search term to filter by.

Example:

/seasonLeaderboards?accessToken=YOUR_ACCESS_TOKEN&mod=Vanilla&season=Current&page=1&pageSize=10&sortColumn=seasonScore&sortDirection=desc

🔗/seasons

GET /seasons

Returns the Seasons available.

Query Parameters:

  • accessToken (required) - String - The Access Token to use.
  • page - Number - The page number to return. Default is 1.
  • pageSize - Number - The number of entries to return per page. Default is 10. Max is 100.
  • sortColumn - String - The column to sort by. Available options are:
    • "seasonName", "seasonStart", "seasonEnd", "totalPlayers", "totalMatches", "totalWounds", "totalKills", "totalDeaths", "totalRevives", "totalTeamkills"
  • sortDirection - String - The direction to sort.
    • "asc", "desc"
  • search - String - The search term to filter by. Season Name is accepted.

Example:

/seasons?accessToken=YOUR_ACCESS_TOKEN?page=1&pageSize=10&sortColumn=seasonName&sortDirection=asc&search=Dev

🔗/servers

GET /servers

Returns the Servers available.

Query Parameters:

  • accessToken (required) - String - The Access Token to use.
  • page - Number - The page number to return. Default is 1.
  • pageSize - Number - The number of entries to return per page. Default is 10. Max is 100.
  • sortColumn - String - The column to sort by. Available options are:
    • "id", "ordId", "name", "firstSeen", "lastUpdate", "version"
  • sortDirection - String - The direction to sort.
    • "asc", "desc"
  • search - String - The search term to filter by. Server Name is accepted.

Example:

/servers?accessToken=YOUR_ACCESS_TOKEN?page=1&pageSize=10&sortColumn=name&sortDirection=asc&search=PSG