fpl-api-node

fpl-api-node

A simple node wrapper for the Fantasy Premier League (fantasy.premierleague.com) restful web api.

Installation

npm install fpl-api-node --save

Usage

The package is written in typescript and can be consumed either strongly-typed or in plain Javascript.

Typescript:

import * as fplapi from 'fpl-api-node';

Javascript:

const fplapi = require('fpl-api-node');

Example

fplapi.getEntry(123456).then((data) => {

    // do something with our data
    console.log(data);

}).catch((err) => {
    // something went wrong
});

Documentation

Typescript

Typescript docs can be found at https://tgreyuk.github.io/fpl-api-node

API

• fplApiNode
  • ~getEntry(entryId) ⇒ Promise
  • ~getEntryEvent(entryId, eventNumber) ⇒ Promise
  • ~getEntryTransfers(entryId) ⇒ Promise
  • ~getAllStaticData() ⇒ Promise
  • ~getTeams() ⇒ Promise
  • ~getElements() ⇒ Promise
  • ~getElementTypes() ⇒ Promise
  • ~getGameSettings() ⇒ Promise
  • ~getEvent() ⇒ Promise
  • ~getClassicLeagueStandings(leagueId) ⇒ Promise

fplApiNode~getEntry(entryId) ⇒ Promise

Entry (Fpl manager team): A promise that if fulfilled returns an object mapped to https://fantasy.premierleague.com/drf/entry/${id}/history

Kind: inner method of fplApiNode

Param	Description
entryId	Entry id

fplApiNode~getEntryEvent(entryId, eventNumber) ⇒ Promise

Entry event. Details of a particular event (or gameweek): A promise that if fulfilled returns an object mapped to https://fantasy.premierleague.com/drf/entry/${id}/event/${eventNumber}

Kind: inner method of fplApiNode

Param	Description
entryId	Entry id
eventNumber	The event / gameweek number

fplApiNode~getEntryTransfers(entryId) ⇒ Promise

Entry transfers: A promise that if fulfilled returns an object mapped to https://fantasy.premierleague.com/drf/entry/${id}/transfers

Kind: inner method of fplApiNode

Param	Description
entryId	Entry id

fplApiNode~getAllStaticData() ⇒ Promise

All static game data: A promise that if fulfilled returns an object mapped to https://fantasy.premierleague.com/drf/bootstrap-static

Kind: inner method of fplApiNode

fplApiNode~getTeams() ⇒ Promise

Teams (Premier Leaugue clubs): A promise that if fulfilled returns an object mapped to https://fantasy.premierleague.com/drf/teams

Kind: inner method of fplApiNode

fplApiNode~getElements() ⇒ Promise

Elements (players): A promise that if fulfilled returns an object mapped to https://fantasy.premierleague.com/drf/elements

Kind: inner method of fplApiNode

fplApiNode~getElementTypes() ⇒ Promise

Element types: A promise that if fulfilled returns an object mapped to https://fantasy.premierleague.com/drf/elements-types

Kind: inner method of fplApiNode

fplApiNode~getGameSettings() ⇒ Promise

Game settings: A promise that if fulfilled returns an object mapped to https://fantasy.premierleague.com/drf/game-settings

Kind: inner method of fplApiNode

fplApiNode~getEvent() ⇒ Promise

Event /gameweek details: A promise that if fulfilled returns an object mapped to https://fantasy.premierleague.com/drf/event/${eventNumber}/live

Kind: inner method of fplApiNode

fplApiNode~getClassicLeagueStandings(leagueId) ⇒ Promise

Classic league standings: A promise that if fulfilled returns an object mapped to https://fantasy.premierleague.com/drf/leagues-classic-standings/${id}

Kind: inner method of fplApiNode

Param	Description
leagueId	League id