valorantesports-js-sdk
v1.0.0
Published
Javascript sdk for the unofficial valorantesports api (July 2022) generated using codegen.
Downloads
3
Readme
valorantesports-js-sdk
JavaScript client for Valorant Esports API Unofficial documentation to the ValorantEsports Api This SDK is automatically generated by the Swagger Codegen project:
- API version: 1.0.0
- Package version: 1.0.0
- Build package: io.swagger.codegen.v3.generators.javascript.JavaScriptClientCodegen
Installation
For Node.js
npm
To publish the library as a npm, please follow the procedure in "Publishing npm packages".
Then install it via:
npm install valorantesports-js-sdk --save
git
If the library is hosted at a git repository, e.g. https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:
npm install GIT_USER_ID/GIT_REPO_ID --save
For browser
The library also works in the browser environment via npm and browserify. After following
the above steps with Node.js and installing browserify with npm install -g browserify
,
perform the following (assuming main.js is your entry file):
browserify main.js > bundle.js
Then include bundle.js in the HTML pages.
Webpack Configuration
Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:
module: {
rules: [
{
parser: {
amd: false,
},
},
];
}
Getting Started
Please follow the installation instruction and execute the following JS code:
var ValorantEsportsOpenApiSpecification = require("valorantesports-js-sdk");
var defaultClient = ValorantEsportsOpenApiSpecification.ApiClient.instance;
// Configure API key authorization: apiKeyAuth
var apiKeyAuth = defaultClient.authentications["apiKeyAuth"];
apiKeyAuth.apiKey = "108353700612933430";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKeyAuth.apiKeyPrefix['x-api-key'] = "Token"
var api = new ValorantEsportsOpenApiSpecification.DefaultApi();
var hl = "hl_example"; // {String} hl
var id = 1.2; // {Number} id
var callback = function (error, data, response) {
if (error) {
console.error(error);
} else {
console.log("API called successfully. Returned data: " + data);
}
};
api.getEventDetails(hl, id, callback);
Documentation for API Endpoints
All URIs are relative to https://esports-api.service.valorantesports.com/persisted/val
| Class | Method | HTTP request | Description | | ------------------------------------------------ | ----------------------------------------------------------------------- | ------------------------------- | --------------------------------- | | ValorantEsportsOpenApiSpecification.DefaultApi | getEventDetails | GET /getEventDetails | Get getEventDetails record | | ValorantEsportsOpenApiSpecification.DefaultApi | getEventList | GET /getEventList | Get getEventList record | | ValorantEsportsOpenApiSpecification.DefaultApi | getLeagues | GET /getLeagues | Get getLeagues record | | ValorantEsportsOpenApiSpecification.DefaultApi | getLeaguesForStandings | GET /getLeaguesForStandings | Get getLeaguesForStandings record | | ValorantEsportsOpenApiSpecification.DefaultApi | getLiveDetails | GET /getLiveDetails | Get getLiveDetails record | | ValorantEsportsOpenApiSpecification.DefaultApi | getSchedule | GET /getSchedule | Get getSchedule record | | ValorantEsportsOpenApiSpecification.DefaultApi | getStandings | GET /getStandings | Get getStandings record | | ValorantEsportsOpenApiSpecification.DefaultApi | getVods | GET /getVods | Get getVods record |
Documentation for Models
- ValorantEsportsOpenApiSpecification.GetEventDetails
- ValorantEsportsOpenApiSpecification.GetEventDetailsData
- ValorantEsportsOpenApiSpecification.GetEventDetailsDataEvent
- ValorantEsportsOpenApiSpecification.GetEventDetailsDataEventLeague
- ValorantEsportsOpenApiSpecification.GetEventDetailsDataEventMatch
- ValorantEsportsOpenApiSpecification.GetEventDetailsDataEventMatchGames
- ValorantEsportsOpenApiSpecification.GetEventDetailsDataEventMatchMediaLocale
- ValorantEsportsOpenApiSpecification.GetEventDetailsDataEventMatchResult
- ValorantEsportsOpenApiSpecification.GetEventDetailsDataEventMatchStrategy
- ValorantEsportsOpenApiSpecification.GetEventDetailsDataEventMatchTeams
- ValorantEsportsOpenApiSpecification.GetEventDetailsDataEventMatchTeams1
- ValorantEsportsOpenApiSpecification.GetEventDetailsDataEventMatchVods
- ValorantEsportsOpenApiSpecification.GetEventDetailsDataEventTournament
- ValorantEsportsOpenApiSpecification.GetEventList
- ValorantEsportsOpenApiSpecification.GetEventListData
- ValorantEsportsOpenApiSpecification.GetEventListDataInProgress
- ValorantEsportsOpenApiSpecification.GetEventListDataUnstarted
- ValorantEsportsOpenApiSpecification.GetEventListDataUnstartedEvents
- ValorantEsportsOpenApiSpecification.GetEventListDataUnstartedMatch
- ValorantEsportsOpenApiSpecification.GetEventListDataUnstartedMatchTeams
- ValorantEsportsOpenApiSpecification.GetLeagues
- ValorantEsportsOpenApiSpecification.GetLeaguesData
- ValorantEsportsOpenApiSpecification.GetLeaguesDataDisplayPriority
- ValorantEsportsOpenApiSpecification.GetLeaguesDataLeagues
- ValorantEsportsOpenApiSpecification.GetLeaguesForStandings
- ValorantEsportsOpenApiSpecification.GetLeaguesForStandingsData
- ValorantEsportsOpenApiSpecification.GetLeaguesForStandingsDataLeagues
- ValorantEsportsOpenApiSpecification.GetLeaguesForStandingsDataSeason
- ValorantEsportsOpenApiSpecification.GetLeaguesForStandingsDataSeasonSplits
- ValorantEsportsOpenApiSpecification.GetLeaguesForStandingsDataTournaments
- ValorantEsportsOpenApiSpecification.GetLiveDetails
- ValorantEsportsOpenApiSpecification.GetLiveDetailsData
- ValorantEsportsOpenApiSpecification.GetSchedule
- ValorantEsportsOpenApiSpecification.GetScheduleData
- ValorantEsportsOpenApiSpecification.GetScheduleDataSchedule
- ValorantEsportsOpenApiSpecification.GetScheduleDataScheduleEvents
- ValorantEsportsOpenApiSpecification.GetScheduleDataScheduleLeague
- ValorantEsportsOpenApiSpecification.GetScheduleDataScheduleMatch
- ValorantEsportsOpenApiSpecification.GetScheduleDataScheduleMatchRecord
- ValorantEsportsOpenApiSpecification.GetScheduleDataScheduleMatchResult
- ValorantEsportsOpenApiSpecification.GetScheduleDataScheduleMatchStrategy
- ValorantEsportsOpenApiSpecification.GetScheduleDataScheduleMatchTeams
- ValorantEsportsOpenApiSpecification.GetScheduleDataSchedulePages
- ValorantEsportsOpenApiSpecification.GetScheduleDataScheduleTournament
- ValorantEsportsOpenApiSpecification.GetScheduleDataScheduleTournamentSplit
- ValorantEsportsOpenApiSpecification.GetStandings
- ValorantEsportsOpenApiSpecification.GetStandingsData
- ValorantEsportsOpenApiSpecification.GetStandingsDataCells
- ValorantEsportsOpenApiSpecification.GetStandingsDataColumns
- ValorantEsportsOpenApiSpecification.GetStandingsDataMatches
- ValorantEsportsOpenApiSpecification.GetStandingsDataOrigin
- ValorantEsportsOpenApiSpecification.GetStandingsDataSeason
- ValorantEsportsOpenApiSpecification.GetStandingsDataSeasonSplits
- ValorantEsportsOpenApiSpecification.GetStandingsDataSections
- ValorantEsportsOpenApiSpecification.GetStandingsDataStages
- ValorantEsportsOpenApiSpecification.GetStandingsDataStandings
- ValorantEsportsOpenApiSpecification.GetStandingsDataTeams
- ValorantEsportsOpenApiSpecification.GetVods
- ValorantEsportsOpenApiSpecification.GetVodsData
- ValorantEsportsOpenApiSpecification.GetVodsDataSchedule
- ValorantEsportsOpenApiSpecification.GetVodsDataScheduleEvents
- ValorantEsportsOpenApiSpecification.GetVodsDataScheduleGames
- ValorantEsportsOpenApiSpecification.GetVodsDataScheduleLeague
- ValorantEsportsOpenApiSpecification.GetVodsDataScheduleMatch
- ValorantEsportsOpenApiSpecification.GetVodsDataScheduleMatchTeams
- ValorantEsportsOpenApiSpecification.GetVodsDataScheduleVods
- ValorantEsportsOpenApiSpecification.Locale
- ValorantEsportsOpenApiSpecification.State
Documentation for Authorization
apiKeyAuth
- Type: API key
- API key parameter name: x-api-key
- Location: HTTP header