1.0.2 • Published 6 years ago

sportmonks-api v1.0.2

Weekly downloads
4
License
ISC
Repository
-
Last release
6 years ago

sportmonks-api

Sportmonks API (Formerly known as Soccerama). The package is only for Version 2.0

installation

npm install sportmonks-api

usage

var sportmonks = new SportsMonks(__YOUR_API_TOKEN__);

sportmonks.get(endpoint,params,includes,extra).then( function(data){
    /* endpoint - you can get it from sportmonks's site
     * params - parameter to map the dynamic value in endpoint
     * includes - argument to show the additional data in response. It is added as includes=param1,param2,param3... in sportmonks
     * extra - additional data like grouping, or sorting, possibly everything except includes.
     */
    console.log(data);
},function(error){
	console.log(error);
});

endpoint

you can get the endpoint from the official sportmonks documentation Note that the base URL here is not needed. Only endpoint, parameters, and other data can be used.

sportmonks.get('seasons').then( function(data){
    console.log(data)
});

params

if you need to specify parameters you can set the params field as follow

sportmonks.get('seasons/{id}', { id: 599 }, { competitions: true, matches: true, rounds: true }, {} ).then( function(data){
    //id in the params field will replace {id} in the endpoint
    //competitions: true, will add include=competitions in query string, and same with other keys
});

For last parameter, demo can be seen for standings route

sportmonks.get('standings/season/{id}', { id: 599 }, null, {sort=group} ).then( function(data){
    // id in the params field will replace {id} in the endpoint
    // sort=group will sort the result based on the group
});

If you want to use the pagination, you can send the argument in last parameter as follows:

sportmonks.get('standings/season/{id}', { id: 599 }, null, {sort:'group',page:'2'} ).then( function(data){
    console.log(data)
});

SportMonks paginate the response. This means you only get to see limited amount of data in first try. You can either do some recursive work and paginate the result, or you can use following snippets:

sportmonks.getAll('standings/season/{id}', { id: 599 }, null, {sort:'group',page:'2'} ).then( function(data){
    console.log(data)
});