Lolesports-js-sdk NPM

lolesports-js-sdk

LolesportsApi - JavaScript client for lolesports_api Unofficial documentation to the lolesports Api This SDK is automatically generated by the Swagger Codegen project:

API version: 1.0.0-alpha-1
Package version: 1.0.0-alpha-1
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 lolesports_api --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 LolesportsApi = require('lolesports-js-sdk');

var defaultClient = LolesportsApi.ApiClient.instance;
defaultClient.basePath = "https://esports-api.lolesports.com/persisted/gw";
defaultClient.authentications['apiKeyAuth']['apiKey'] = "0TvQnueqKa5mxJntVWt0w4LpLfEkrV1Ta8rQBb9Z";

var callback = function (error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + JSON.stringify(data));
  }
};

var api = new LolesportsApi.LeaguesApi();
api.getStandings(LolesportsApi.Locale.enUS, { tournamentId: ["105658534671026792"] }, callback);

Documentation for API Endpoints

All URIs are relative to /

Class	Method	HTTP request
LolesportsApi.EventsApi	getCompletedEvents	GET /getCompletedEvents
LolesportsApi.EventsApi	getEventDetails	GET /getEventDetails
LolesportsApi.EventsApi	getGames	GET /getGames
LolesportsApi.EventsApi	getLive	GET /getLive
LolesportsApi.EventsApi	getSchedule	GET /getSchedule
LolesportsApi.HighlanderApi	highlanderTournaments	GET /highlanderTournaments
LolesportsApi.HighlanderApi	leagues	GET /leagues
LolesportsApi.HighlanderApi	navItems	GET /navItems
LolesportsApi.HighlanderApi	players	GET /players
LolesportsApi.HighlanderApi	scheduleItems	GET /scheduleItems
LolesportsApi.HighlanderApi	teams	GET /teams
LolesportsApi.HighlanderApi	videos	GET /videos
LolesportsApi.LeaguesApi	getLeagues	GET /getLeagues
LolesportsApi.LeaguesApi	getStandings	GET /getStandings
LolesportsApi.LeaguesApi	getTournamentsForLeague	GET /getTournamentsForLeague
LolesportsApi.MatchDetailsApi	getDetails	GET /details/{gameId}
LolesportsApi.MatchDetailsApi	getWindow	GET /window/{gameId}
LolesportsApi.TeamsApi	getTeams	GET /getTeams

Documentation for Models

Documentation for Authorization

apiKeyAuth

Type: API key
API key parameter name: x-api-key
Location: HTTP header

@babel/cli superagent

@infinitebrahmanuniverse/nolb-lol @everything-registry/sub-chunk-2100 @zalastax/nolb-lol

1.0.0

4 years ago