FPL Cat

Use this when the user wants their Fantasy Premier League team rated or reviewed, or asks what to change: 'rate my team', 'how good is my team?', 'who should I transfer out?', 'who should I bring in?', 'what's wrong with my team?'. Scores the squad 0-100 against the best squad the same money buys, by our model's predicted points over the next 6 gameweeks, and gives the 3 changes worth the most points, with 3 replacements each. Needs the team ID or all 15 player names.

{
  "type": "object",
  "properties": {
    "team": {
      "description": "The user's FPL team ID: the number after /entry/ in the address of their FPL Points page (fantasy.premierleague.com/entry/1234567/event/6). The whole link works too. Once the user has given it, reuse it for every later question in this conversation; don't ask again.",
      "type": [
        "string",
        "number"
      ]
    },
    "players": {
      "description": "Without a team ID: all 15 player names from the user's squad, e.g. read from a screenshot of their Pick Team or Points page, bench included. All 15 are needed: if the screenshot is cropped, ask the user for the rest before calling.",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "captain": {
      "description": "With players only: the user's captain, one of the 15.",
      "type": "string"
    },
    "bank": {
      "description": "With players only: money in the bank, £m. Default 0.",
      "type": "number"
    }
  },
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Use this when the user asks who to start, who to bench or who to captain in their own Fantasy Premier League team this gameweek: 'who should I start?', 'pick my team for GW7', 'should I bench Gordon?', 'is my lineup right?'. Gives our model's best XI, bench order, captain and vice-captain from their 15 for the next gameweek, and what changes from the lineup they have now. Needs the team ID (reuse it if the user gave it earlier in this conversation) or all 15 player names. Doesn't suggest transfers (use rate_team) or plan later gameweeks.

{
  "type": "object",
  "properties": {
    "team": {
      "description": "The user's FPL team ID: the number after /entry/ in the address of their FPL Points page (fantasy.premierleague.com/entry/1234567/event/6). The whole link works too. Once the user has given it, reuse it for every later question in this conversation; don't ask again.",
      "type": [
        "string",
        "number"
      ]
    },
    "players": {
      "description": "Without a team ID: all 15 player names from the user's squad, e.g. read from a screenshot of their Pick Team or Points page, bench included. All 15 are needed: if the screenshot is cropped, ask the user for the rest before calling.",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "captain": {
      "description": "With players only: the user's captain, one of the 15.",
      "type": "string"
    },
    "bank": {
      "description": "With players only: money in the bank, £m. Default 0.",
      "type": "number"
    }
  },
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Use this when the user asks who to captain in Fantasy Premier League: 'who should I captain?', 'best captain for GW7?', 'Haaland or Saka for captain?', 'differential captain?'. No team ID needed: without one it gives the best captains in the whole game by our model's predicted points next gameweek, so call it straight away rather than asking. If the user has given their team ID earlier in this conversation, pass it as team to get the best captains from their own squad.

{
  "type": "object",
  "properties": {
    "team": {
      "description": "The user's FPL team ID: the number after /entry/ in the address of their FPL Points page (fantasy.premierleague.com/entry/1234567/event/6). The whole link works too. Once the user has given it, reuse it for every later question in this conversation; don't ask again.",
      "type": [
        "string",
        "number"
      ]
    },
    "players": {
      "description": "Without a team ID: all 15 player names from the user's squad, e.g. read from a screenshot of their Pick Team or Points page, bench included. All 15 are needed: if the screenshot is cropped, ask the user for the rest before calling.",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "captain": {
      "description": "With players only: the user's captain, one of the 15.",
      "type": "string"
    },
    "bank": {
      "description": "With players only: money in the bank, £m. Default 0.",
      "type": "number"
    },
    "limit": {
      "description": "How many picks, default 5.",
      "type": "integer",
      "minimum": 1,
      "maximum": 10
    },
    "maxOwnership": {
      "description": "Only players owned by at most this % of managers (differentials).",
      "type": "number",
      "minimum": 0,
      "maximum": 100
    }
  },
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Use this when the user asks about their Fantasy Premier League chips: 'should I bench boost this week?', 'when should I triple captain?', 'which chips do I have left?', 'should I wildcard?'. Says which chips they have left in this window (GW1-19 or GW20-38), whether to play one this gameweek, and the best one coming up, by our model. Needs the team ID (for the chips already played; reuse it if the user gave it earlier in this conversation) or all 15 names.

{
  "type": "object",
  "properties": {
    "team": {
      "description": "The user's FPL team ID: the number after /entry/ in the address of their FPL Points page (fantasy.premierleague.com/entry/1234567/event/6). The whole link works too. Once the user has given it, reuse it for every later question in this conversation; don't ask again.",
      "type": [
        "string",
        "number"
      ]
    },
    "players": {
      "description": "Without a team ID: all 15 player names from the user's squad, e.g. read from a screenshot of their Pick Team or Points page, bench included. All 15 are needed: if the screenshot is cropped, ask the user for the rest before calling.",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "captain": {
      "description": "With players only: the user's captain, one of the 15.",
      "type": "string"
    },
    "bank": {
      "description": "With players only: money in the bank, £m. Default 0.",
      "type": "number"
    }
  },
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Use this when the user wants FPL Cat to remember their Fantasy Premier League team, change the saved one or forget it: 'remember my team 123456', 'my team ID is 123456', 'change my saved team', 'forget my team'. Saves the team ID to their FPL Cat account (the client asks them to sign in first), so team tools work without it later. The first team ID a signed-in user gives any team tool is saved automatically; use this to change or forget it.

{
  "type": "object",
  "properties": {
    "team": {
      "description": "The user's FPL team ID: the number after /entry/ in the address of their FPL Points page (fantasy.premierleague.com/entry/1234567/event/6). The whole link works too. Once the user has given it, reuse it for every later question in this conversation; don't ask again.",
      "type": [
        "string",
        "number"
      ]
    },
    "forget": {
      "description": "true: remove the saved team.",
      "type": "boolean"
    }
  },
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Use this when the user asks about one to three Fantasy Premier League players: 'how many points will Saka get?', 'is Palmer worth buying?', 'Saka or Palmer?', 'is Isak fit?'. Gives our model's predicted points for the next gameweek with where they come from (minutes, goals, assists, clean sheet, bonus, defensive contributions), his chance of playing, news, fixtures, price and ownership. With 2-3 names, compares them on next gameweek. Pass all the names in one call.

{
  "type": "object",
  "properties": {
    "players": {
      "minItems": 1,
      "maxItems": 3,
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "1-3 player names (e.g. 'Saka', 'Gabriel ARS') or FPL player ids, all in this one call: for 'Saka or Palmer?' pass ['Saka', 'Palmer']."
    }
  },
  "required": [
    "players"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Use this when the user wants Fantasy Premier League players that fit a brief: 'best midfielders under £7m', 'cheap defenders for the next 3 gameweeks', 'differential forwards under 10% owned', 'best Arsenal players', 'replacement for Isak under £8m'. Ranks by our model's predicted points for next gameweek, or by price, form or ownership; horizon adds each player's fixtures for up to 6 gameweeks. Also finds a player by name. Ranking over several gameweeks is in FPL Cat Pro.

{
  "type": "object",
  "properties": {
    "position": {
      "type": "string",
      "enum": [
        "GK",
        "DEF",
        "MID",
        "FWD"
      ]
    },
    "minPrice": {
      "description": "£m",
      "type": "number"
    },
    "maxPrice": {
      "description": "£m",
      "type": "number"
    },
    "club": {
      "description": "Club name or short name, e.g. 'Arsenal' or 'ARS'.",
      "type": "string"
    },
    "maxOwnership": {
      "description": "Only players owned by at most this % of managers.",
      "type": "number",
      "minimum": 0,
      "maximum": 100
    },
    "horizon": {
      "description": "Gameweeks of fixtures to show, 1-6. Default 1. The ranking is always next gameweek's.",
      "type": "integer",
      "minimum": 1,
      "maximum": 6
    },
    "sort": {
      "description": "Default points (our model's).",
      "type": "string",
      "enum": [
        "points",
        "price",
        "form",
        "ownership"
      ]
    },
    "includeDoubtful": {
      "description": "Include players under 50% to play. Default false.",
      "type": "boolean"
    },
    "limit": {
      "description": "Default 10.",
      "type": "integer",
      "minimum": 1,
      "maximum": 25
    },
    "name": {
      "description": "Look a player up by name instead (the other filters are ignored).",
      "type": "string"
    }
  },
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Use this when the user wants the best Fantasy Premier League squad from scratch: 'best team for £100m', 'wildcard team', 'free hit team for GW7', 'best team for £102.5m'. Gives our model's best 15-man squad with the XI, bench and captain for next gameweek. Default: the £100.0m Wildcard squad (next 6 gameweeks), free. mode 'freehit' (best for next gameweek only) and any other budget are FPL Cat Pro: they need the user to sign in to FPL Cat (the client will ask), and a signed-in user without Pro gets the £100m Wildcard squad instead. Not a squad built from the user's own team.

{
  "type": "object",
  "properties": {
    "mode": {
      "description": "wildcard (default): best over the next 6 gameweeks. freehit: best for next gameweek only (Pro, needs sign-in).",
      "type": "string",
      "enum": [
        "wildcard",
        "freehit"
      ]
    },
    "budget": {
      "description": "£m, default 100. Another budget is Pro (needs sign-in). Free Hit: the user's team value plus bank.",
      "type": "number",
      "minimum": 80,
      "maximum": 120
    }
  },
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Use this when the user asks who is injured, doubtful or suspended in Fantasy Premier League, for one club or all: 'Arsenal injuries', 'is Saka injured?', 'who's out this week?', 'any injury news?'. FPL's own flags with their news and chance of playing, plus unconfirmed injury reports for players FPL still lists as fit (say these are reported, not confirmed by FPL). For one player's full picture, player_projection is better.

{
  "type": "object",
  "properties": {
    "club": {
      "description": "Club name or short name; default all clubs.",
      "type": "string"
    },
    "kind": {
      "description": "Default all.",
      "type": "string",
      "enum": [
        "all",
        "injured",
        "doubtful",
        "suspended",
        "unconfirmed"
      ]
    },
    "limit": {
      "description": "Default 25, most-owned first.",
      "type": "integer",
      "minimum": 1,
      "maximum": 60
    }
  },
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Use this when the user asks about Fantasy Premier League fixtures: 'which teams have the easiest fixtures?', 'Arsenal's next 5 fixtures', 'best fixture run for defenders', 'who to target for GW7-10?'. Our difficulty rating (1 easiest to 5 hardest) for every club's next 1-6 gameweeks, with blanks and doubles.

{
  "type": "object",
  "properties": {
    "club": {
      "description": "One club; default all 20.",
      "type": "string"
    },
    "gameweeks": {
      "description": "How many gameweeks ahead, default 6.",
      "type": "integer",
      "minimum": 1,
      "maximum": 6
    },
    "sort": {
      "description": "Default easiest.",
      "type": "string",
      "enum": [
        "easiest",
        "hardest"
      ]
    }
  },
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Use this when the user asks about Fantasy Premier League price rises and falls: 'who's rising tonight?', 'will Saka drop in price?', 'price changes today', 'who went up this week?'. likely: players closest to a rise or fall by FPL's own progress figure, with net transfers this gameweek. changed: rises and falls already made this gameweek.

{
  "type": "object",
  "properties": {
    "mode": {
      "description": "Default likely.",
      "type": "string",
      "enum": [
        "likely",
        "changed"
      ]
    },
    "players": {
      "description": "Only these players.",
      "maxItems": 10,
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "position": {
      "type": "string",
      "enum": [
        "GK",
        "DEF",
        "MID",
        "FWD"
      ]
    },
    "club": {
      "type": "string"
    },
    "limit": {
      "description": "Per direction, default 10.",
      "type": "integer",
      "minimum": 1,
      "maximum": 25
    }
  },
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Use this when the user asks who takes penalties, corners or free kicks for a Premier League club: 'who's on pens for Chelsea?', 'Arsenal set-piece takers', 'which defenders take corners?'. FPL's own order for penalties, corners and indirect free kicks, and direct free kicks.

{
  "type": "object",
  "properties": {
    "clubs": {
      "description": "Club names; default all 20.",
      "maxItems": 20,
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  },
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Use this when the user asks when the Fantasy Premier League deadline is: 'when's the deadline?', 'how long until GW7?', 'what gameweek is it?'.

{
  "type": "object",
  "properties": {},
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Use this when the user asks about Fantasy Premier League bonus points or BPS during or after Premier League matches: 'provisional bonus in Man Utd v Spurs', 'who's getting bonus?', 'is Saka on bonus?', 'live BPS'. Provisional bonus (3-2-1) from the live Bonus Points System for matches in play or finished this gameweek, and the BPS gap to the next bonus. Only useful on match days.

{
  "type": "object",
  "properties": {
    "match": {
      "description": "A club in the match, e.g. 'Man Utd' or 'Man Utd v Spurs'. Default: every match that has started.",
      "type": "string"
    },
    "player": {
      "description": "A player's name: his BPS, rank in the match and gap to more bonus.",
      "type": "string"
    }
  },
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Use this when the user asks how their Fantasy Premier League gameweek went: 'how did my team do?', 'review my gameweek', 'was my captain right?', 'did my transfers work?', 'how many points did my bench score?'. Their points vs the average, gameweek and overall rank, captain vs the best captain they had, bench points, auto-subs, and each transfer's points in vs out. Live during a gameweek. Needs the team ID: if the user gives a number with 'my team', that's it; reuse it if they gave it earlier in this conversation.

{
  "type": "object",
  "properties": {
    "team": {
      "description": "The user's FPL team ID: the number after /entry/ in the address of their FPL Points page (fantasy.premierleague.com/entry/1234567/event/6). The whole link works too. Once the user has given it, reuse it for every later question in this conversation; don't ask again.",
      "type": [
        "string",
        "number"
      ]
    },
    "gameweek": {
      "description": "Default: the current gameweek (the last one if it hasn't started).",
      "type": "integer",
      "minimum": 1,
      "maximum": 38
    }
  },
  "$schema": "http://json-schema.org/draft-07/schema#"
}