This is currently an expiremental build ONLY

This is not meant to be used for production applications (yet hopefully) and may be very buggy

valorant-esports.js

API wrapper for the official valorant esports api and thespike.gg api.

Table of Contents

| Section | Details | | ------------------------------------------------------------ | ------------------------------------------------------------------- | | Official Endpoints | Endpoints for the official Valorant Esports api | | THE SPIKE Endpoints | Endpoints for thespike.gg | | Parameters | Shows valid parameters to pass into methods. <required> [optional] | | Responses | Shows response examples |

Official Endpoints (valorantesports.com)

| Method | Parameters | | --------------- | -------------------------------------------------- | | getLeagues( ) | { [language] } | | getSchedule( ) | { [language], [leagueIds: [Array]], [eventState] } | | getStandings( ) | { [language], [tournamentIds: [Array]] } |

THE SPIKE Endpoints (thespike.gg)

| Method | Parameters | Description | | ------------------ | ----------------------------------------- | ---------------------------------------------------------------------------- | | search( ) | query | Returns data from query | | getTeamStats( ) | <id> | Returns team stats from a provided team id | | getTeam( ) | { <slug>, <id>, [language] } | Returns team data from a provided slug and id | | getPlayer( ) | { <slug>, <id>, [language] } | Returns player data (stats included) from a provided slug and id | | getRankings( ) | { [region], [map], [agent], [minRounds] } | Returns team rankings (can be filtered via parameters) | | getAgents( ) | { [region], [map] } | | getMaps( ) | { [region] } | | getCompositions( ) | { [region], [map] } |

Parameter Options

Note: Some parameters are passed as an object

Official

Event State |State|String| |---|---| |In Progress|"inProgress"| |Completed|"completed"| |Upcoming|"unstarted"|

Languages |Language|Code| |---|---| |English|"en-US"|

THE SPIKE

Slugs & ID's

Use the search method to find the slug and ids for teams and players

Maps (10) |Name|ID| |---|---:| |Ascent|4| |Bind|2| |Breeze|6| |Fracture|7| |Haven|3| |Icebox|5| |Lotus|9| |Pearl|8| |Split|1| |Sunset|10|

Agents (23) |Name|ID| |---|---:| |Astra|15| |Breach|2| |Brimstone|3| |Chamber|17| |Cypher|7| |Deadlock|22| |Fade|19| |Gekko|21| |Harbor|20| |Iso|23| |Jett|10| |KAY/O|16| |Killjoy|12| |Neon|18| |Omen|6| |Phoenix|1| |Raze|5| |Reyna|11| |Sage|4| |Skye|13| |Sova|9| |Viper|8| |Yoru|14|

Languages (26) |Language|Code| |---|---| |English|"en"| |Japanese|"jp"| |Spanish|"es"| |Portuguese|"br"| |Turkish|"tr"| |German|"de"| |French|"fr"| |Polish|"pl"| |Chinese|"cn"| |Swedish|"se"| |Italian|"it"| |Indonesian|"id"| |Czech|"cz"| |Bulgarian|"bg"| |Latvian|"lv"| |Lithuanian|"lt"| |Ukrainian|"ua"| |Dutch|"nl"| |Danish|"dk"| |Estonian|"ee"| |Finnish|"fi"| |Greek|"gr"| |Romanian|"ro"| |Slovak|"sk"| |Slovenian|"si"| |Hungarian|"hu"|

Responses

Method: search( )
Parameters: "sentinels"

{
  "teams": [
    {
      "id": 12,
      "title": "Sentinels",
      "darkLogoUrl": "https://cdn.thespike.gg/Teams%2Fsentinelslogo_1595646784571.png",
      "lightLogoUrl": "https://cdn.thespike.gg/Teams%2Fsentinelslogo_1595646784571.png",
      "country": "United States",
      "countryCode": "us",
      "slug": "sentinels"
    }
  ],
  "players": [],
  "events": [
    {
      "id": 2903,
      "title": " Sentinels-Tarik Showmatch",
      "darkLogoUrl": "https://cdn.thespike.gg/logo/logo.svg",
      "lightLogoUrl": "https://cdn.thespike.gg/logo/logo.svg",
      "slug": "sentinels-tarik-showmatch"
    }
  ],
  "series": [],
  "news": [
    {
      "id": 5688,
      "title": "Zellsis joins Sentinels as sub",
      "bannerImage": "https://cdn.thespike.gg/Onur%2Fzellsis%20sentinels_1694717732975.jpg",
      "bannerImageAltText": null,
      "thumbnailImage": "https://cdn.thespike.gg/Onur%2Fzellsis%20sentinels_1694717732975.jpg",
      "publishedOn": "2023-09-14T18:56:00+00:00",
      "country": "United States",
      "countryCode": "us",
      "slug": "zellsis-joins-sentinels-as-sub"
    }
  ],
  "guides": [
    {
      "id": 595,
      "title": "Valorant Sentinels Agents",
      "publishedOn": "2023-05-01T07:38:00+00:00",
      "slug": "/agents/roles/sentinels"
    }
  ]
}