fpl-api-node

fpl-api-node

A node wrapper for the Fantasy Premier League (fantasy.premierleague.com) restful web api. It's job is a simple one - to fetch and return data that maps to the available end-points.

Getting started

npm install fpl-api-node --save

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

or

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

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

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

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

Use cases

You can use the package in a number of ways. To leverage as a restful api on a web app using expressjs check out https://github.com/tgreyuk/fpl-angular-cli-express-seed.

A cache strategy is advisable on whatever platform the package is used with.

API

Functions

fetchBootstrapStatic

► fetchBootstrapStatic(): Promise<BootstrapStatic>

Defined in index.ts:60

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

Returns: Promise<BootstrapStatic>

---

fetchClassicLeagueStandings

► fetchClassicLeagueStandings(leagueId: number): Promise<League>

Defined in index.ts:120

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

Parameters:

Name	Type	Default	Description
leagueId	number	-	League id

Returns: Promise<League>

---

fetchElementTypes

► fetchElementTypes(): Promise<ElementType[]>

Defined in index.ts:89

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

Returns: Promise<ElementType[]>

---

fetchElements

► fetchElements(): Promise<Element[]>

Defined in index.ts:80

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

Returns: Promise<Element[]>

---

fetchEntry

► fetchEntry(entryId: number): Promise<Entry>

Defined in index.ts:26

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

Parameters:

Name	Type	Default	Description
entryId	number	-	Entry id

Returns: Promise<Entry>

---

fetchEntryEvent

► fetchEntryEvent(entryId: number, eventNumber: number): Promise<EntryEvent>

Defined in index.ts:39

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}

Parameters:

Name	Type	Default	Description
entryId	number	-	Entry id
eventNumber	number	-	The event / gameweek number

Returns: Promise<EntryEvent>

---

fetchEntryTransfers

► fetchEntryTransfers(entryId: number): Promise<EntryTransfers>

Defined in index.ts:50

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

Parameters:

Name	Type	Default	Description
entryId	number	-	Entry id

Returns: Promise<EntryTransfers>

---

fetchEvent

► fetchEvent(eventNumber: number): Promise<Event>

Defined in index.ts:109

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

Parameters:

Name	Type	Default	Description
eventNumber	number	-	-

Returns: Promise<Event>

---

fetchGameSettings

► fetchGameSettings(): Promise<GameSettings>

Defined in index.ts:99

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

Returns: Promise<GameSettings>

---

fetchTeams

► fetchTeams(): Promise<Team[]>

Defined in index.ts:70

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

Returns: Promise<Team[]>

---

↩  Back to top

---

Interface: BootstrapStatic

Properties

Name	Type
element_types	ElementType[]
elements	Element[]
events	GameEvent[]
game-settings	Game
phases	GamePhase[]
teams	Team[]
total-players	number

---

↩  Back to top

---

Interface: Element

Properties

Name	Type
assists	number
bonus	number
bps	number
chance_of_playing_next_round	undefined⎮number
chance_of_playing_this_round	undefined⎮number
clean_sheets	number
code	number
cost_change_event	number
cost_change_event_fall	number
cost_change_start	number
cost_change_start_fall	number
creativity	string
dreamteam_count	number
ea_index	number
element_type	number
ep_next	string
ep_this	string
event_points	number
first_name	string
form	string
goals_conceded	number
goals_scored	number
ict_index	string
id	number
in_dreamteam	boolean
influence	string
loaned_in	number
loaned_out	number
loans_in	number
loans_out	number
minutes	number
news	string
now_cost	number
own_goals	number
penalties_missed	number
penalties_saved	number
photo	string
points_per_game	string
red_cards	number
saves	number
second_name	string
selected_by_percent	string
special	boolean
squad_number	undefined⎮number
status	string
team	number
team_code	number
threat	string
total_points	number
transfers_in	number
transfers_in_event	number
transfers_out	number
transfers_out_event	number
value_form	string
value_season	string
web_name	string
yellow_cards	number

---

↩  Back to top

---

Interface: ElementType

Properties

Name	Type
id	number
plural_name	string
plural_name_short	string
singular_name	string
singular_name_short	string

---

↩  Back to top

---

Interface: Entry

Properties

Name	Type
chips	EntryChip[]
entry	EntryDetails
history	EntryHistory[]
leagues	EntryLeagues
season	EntrySeason[]

---

↩  Back to top

---

Interface: EntryAutomaticSub

Properties

Name	Type
element_in	number
element_out	number
entry	number
event	number
id	number

---

↩  Back to top

---

Interface: EntryChip

Properties

Name	Type
chip	number
entry	number
event	number
name	string
played_time_formatted	string
status	string
time	Date

---

↩  Back to top

---

Interface: EntryDetails

Properties

Name	Type
bank	number
current_event	number
deleted	boolean
email	boolean
event_transfers	number
event_transfers_cost	number
extra_free_transfers	number
favourite_team	any
id	number
joined_seconds	number
joined_time	Date
kit	string
name	string
player	number
player_first_name	string
player_last_name	string
player_region_id	number
player_region_name	string
player_region_short_iso	string
started_event	number
strategy	any
summary_event_points	number
summary_event_rank	any
summary_overall_points	number
summary_overall_rank	number
total_loans	number
total_loans_active	number
total_transfers	number
transfers_or_loans	string
value	number

---

↩  Back to top

---

Interface: EntryEvent

Properties

Name	Type
active_chip	string
automatic_subs	EntryAutomaticSub[]
can_change_captain	boolean
ce	number
entry	EntryDetails
entry_history	EntryHistory
fixtures	Fixture[]
leagues	EntryLeagues
manager_subs	any[]
own_entry	boolean
picks	EntryPick[]
points	number
state	EntryState

---

↩  Back to top

---

Interface: EntryHistory

Properties

Name	Type
bank	number
entry	number
event	number
event_transfers	number
event_transfers_cost	number
id	number
movement	string
overall_rank	number
points	number
points_on_bench	number
rank	undefined⎮number
rank_sort	undefined⎮number
targets	any
total_points	number
value	number

---

↩  Back to top

---

Interface: EntryLeague

Properties

Name	Type
_scoring	string
admin_entry	undefined⎮number
closed	boolean
created	Date
entry_can_admin	boolean
entry_can_forum	boolean
entry_can_invite	boolean
entry_can_leave	boolean
entry_change	any
entry_code	string
entry_last_rank	number
entry_movement	string
entry_rank	number
forum_disabled	boolean
id	number
league_type	string
make_code_public	boolean
name	string
rank	any
reprocess_standings	boolean
short_name	string
size	any
start_event	number

---

↩  Back to top

---

Interface: EntryLeagues

Properties

Name	Type
classic	EntryLeague[]
cup	EntryLeague[]
h2h	EntryLeague[]

---

↩  Back to top

---

Interface: EntryPick

Properties

Name	Type
can_captain	any
can_sub	any
element	number
element_type	number
explain	any[][]
has_played	boolean
is_captain	boolean
is_sub	boolean
is_vice_captain	boolean
multiplier	number
points	number
position	number
stats	Stats

---

↩  Back to top

---

Interface: EntrySeason

Properties

Name	Type
id	number
player	number
rank	number
season	number
season_name	string
total_points	number

---

↩  Back to top

---

Interface: EntryState

Properties

Name	Type
deadline_time	Date
deadline_time_formatted	string
event	number
event_day	number
sub_state	string

---

↩  Back to top

---

Interface: EntryTransferHistory

Properties

Name	Type
element_in	number
element_in_cost	number
element_out	number
element_out_cost	number
entry	number
event	number
id	number
time	Date
time_formatted	string

---

↩  Back to top

---

Interface: EntryTransfers

Properties

Name	Type
entry	Entry
history	EntryTransferHistory[]
leagues	EntryLeagues
wildcards	EntryWildcard[]

---

↩  Back to top

---

Interface: EntryWildcard

Properties

Name	Type
chip	number
entry	number
event	number
name	string
played_time_formatted	string
status	string
time	Date

---

↩  Back to top

---

Interface: Event

Properties

Name	Type
elements	EventElements
fixtures	Fixture[]

---

↩  Back to top

---

Interface: EventElements

Indexable

[key: number]: object

explain: EventElementsExplain[]

stats: Stats

---

↩  Back to top

---

Interface: EventElementsExplain

Indexable

[key: string]: object

name: string

points: number

value: number

---

↩  Back to top

---

Interface: Fixture

Properties

Name	Type
code	number
deadline_time	Date
deadline_time_formatted	string
event	number
event_day	number
finished	boolean
finished_provisional	boolean
id	number
kickoff_time	Date
kickoff_time_formatted	string
minutes	number
provisional_start_time	boolean
started	boolean
stats	FixtureStats
team_a	number
team_a_score	number
team_h	number
team_h_score	number

---

↩  Back to top

---

Interface: FixtureStatHomeAndAway

Properties

Name	Type
a	FixtureStatValue[]
h	FixtureStatValue[]

---

↩  Back to top

---

Interface: FixtureStatValue

Properties

Name	Type
element	number
value	number

---

↩  Back to top

---

Interface: FixtureStats

Properties

Name	Type
assists	FixtureStatHomeAndAway
bonus	FixtureStatHomeAndAway
bps	FixtureStatHomeAndAway
goals_scored	FixtureStatHomeAndAway
own_goals	FixtureStatHomeAndAway
penalties_missed	FixtureStatHomeAndAway
penalties_saved	FixtureStatHomeAndAway
red_cards	FixtureStatHomeAndAway
saves	FixtureStatHomeAndAway
yellow_cards	FixtureStatHomeAndAway

---

↩  Back to top

---

Interface: Game

Properties

Name	Type
bps_assists	number
bps_attempted_passes_limit	number
bps_big_chances_created	number
bps_big_chances_missed	number
bps_cbi_limit	number
bps_clearances_blocks_interceptions	number
bps_dribbles	number
bps_errors_leading_to_goal	number
bps_errors_leading_to_goal_attempt	number
bps_fouls	number
bps_key_passes	number
bps_long_play	number
bps_long_play_limit	number
bps_offside	number
bps_open_play_crosses	number
bps_own_goals	number
bps_pass_percentage_70	number
bps_pass_percentage_80	number
bps_pass_percentage_90	number
bps_penalties_conceded	number
bps_penalties_missed	number
bps_penalties_saved	number
bps_recoveries	number
bps_recoveries_limit	number
bps_red_cards	number
bps_saves	number
bps_short_play	number
bps_tackled	number
bps_tackles	number
bps_target_missed	number
bps_winning_goals	number
bps_yellow_cards	number
cup_start_event_id	number
currency_decimal_places	number
currency_multiplier	number
currency_symbol	string
default_formation	number[][]
facebook_app_id	string
fifa_league_id	number
formations	GameFormations
game_timezone	string
league_h2h_tiebreak	string
league_join_private_max	number
league_join_public_max	number
league_max_ko_rounds_h2h	number
league_points_h2h_draw	number
league_points_h2h_lose	number
league_points_h2h_win	number
league_prefix_public	string
league_size_classic_max	number
league_size_h2h_max	number
perform_league_id	number
photo_base_url	string
scoring_assists	number
scoring_bonus	number
scoring_bps	number
scoring_concede_limit	number
scoring_creativity	number
scoring_ea_index	number
scoring_ict_index	number
scoring_influence	number
scoring_long_play	number
scoring_long_play_limit	number
scoring_own_goals	number
scoring_penalties_missed	number
scoring_penalties_saved	number
scoring_red_cards	number
scoring_saves	number
scoring_saves_limit	number
scoring_short_play	number
scoring_threat	number
scoring_yellow_cards	number
squad_squadplay	number
squad_squadsize	number
squad_team_limit	number
squad_total_spend	number
static_game_url	string
support_email_address	string
sys_cdn_cache_enabled	boolean
sys_use_event_live_api	boolean
sys_vice_captain_enabled	boolean
transfers_cost	number
transfers_limit	number
transfers_sell_on_fee	number
transfers_type	string
ui_el_hide_currency_qi	boolean
ui_el_hide_currency_sy	boolean
ui_element_wrap	number
ui_selection_player_limit	number
ui_selection_price_gap	number
ui_selection_short_team_names	boolean
ui_show_home_away	boolean

---

↩  Back to top

---

Interface: GameElement

Properties

Name	Type
bps_clean_sheets	number
bps_goals_scored	number
scoring_clean_sheets	number
scoring_goals_conceded	number
scoring_goals_scored	number
squad_max_play	number
squad_min_play	number
squad_select	number

---

↩  Back to top

---

Interface: GameEvent

Properties

Name	Type
average_entry_score	number
data_checked	boolean
deadline_time	Date
deadline_time_epoch	number
deadline_time_formatted	string
deadline_time_game_offset	number
finished	boolean
highest_score	undefined⎮number
highest_scoring_entry	undefined⎮number
id	number
is_current	boolean
is_next	boolean
is_previous	boolean
name	string

---

↩  Back to top

---

Interface: GameFormations

Properties

Name	Type
1-2-5-3	number[][]
1-3-4-3	number[][]
1-3-5-2	number[][]
1-4-3-3	number[][]
1-4-4-2	number[][]
1-4-5-1	number[][]
1-5-2-3	number[][]
1-5-3-2	number[][]
1-5-4-1	number[][]

---

↩  Back to top

---

Interface: GamePhase

Properties

Name	Type
id	number
name	string
start_event	number
stop_event	number

---

↩  Back to top

---

Interface: GameSettings

Properties

Name	Type
element_type	GameElement
game	Game

---

↩  Back to top

---

Interface: IApiLeaguePositions

Properties

Name	Type
entry	number
entry_name	string
event_total	number
id	number
last_rank	number
league	number
movement	string
own_entry	boolean
player_name	string
rank	number
rank_sort	number
start_event	number
stop_event	number
total	number

---

↩  Back to top

---

Interface: League

Properties

Name	Type
league	LeagueDetails
new_entries	LeagueStandings
standings	LeagueStandings
update_status	number

---

↩  Back to top

---

Interface: LeagueDetails

Properties

Name	Type
_scoring	string
admin_entry	any
closed	boolean
created	Date
forum_disabled	boolean
id	number
league_type	string
leagueban_set	any[]
make_code_public	boolean
name	string
rank	any
reprocess_standings	boolean
short_name	string
size	any
start_event	number

---

↩  Back to top

---

Interface: LeagueStandings

Properties

Name	Type
has_next	boolean
number	number
results	IApiLeaguePositions[]

---

↩  Back to top

---

Interface: Stats

Properties

Name	Type
assists	number
bonus	number
bps	number
clean_sheets	number
creativity	number
goals_conceded	number
goals_scored	number
ict_index	number
in_dreamteam	boolean
influence	number
minutes	number
own_goals	number
penalties_missed	number
penalties_saved	number
red_cards	number
saves	number
threat	number
total_points	number
yellow_cards	number

---

↩  Back to top

---

Interface: Team

Properties

Name	Type
code	number
current_event_fixture	TeamFixture[]
draw	number
form	any
id	number
link_url	string
loss	number
name	string
next_event_fixture	TeamFixture[]
played	number
points	number
position	number
short_name	string
strength	number
strength_attack_away	number
strength_attack_home	number
strength_defence_away	number
strength_defence_home	number
strength_overall_away	number
strength_overall_home	number
team_division	number
unavailable	boolean
win	number

---

↩  Back to top

---

Interface: TeamFixture

Properties

Name	Type
day	number
event_day	number
id	number
is_home	boolean
month	number
opponent	number

---

↩  Back to top

---