Fantasy Pundit Status API

openapi: 3.2.0
info:
  title: Fantasy Pundit Public Status API
  version: 0.9.0
  description: Retrieve, reserve, or request one canonical written commentary for the current available Fantasy Premier League mini-league Gameweek. No Fantasy Pundit account or OAuth is required.
servers:
- url: https://api.fantasypundit.lol
tags:
- name: Status
  description: Service and FPL availability.
paths:
  /health:
    get:
      operationId: getHealth
      summary: Check API availability
      tags:
      - Status
      responses:
        '200':
          description: The API is available.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Health'
  /api/capabilities:
    get:
      operationId: getProductCapabilities
      summary: Read current product availability
      description: Returns stable, public availability states for commentary and on-demand audio. A paused capability is an expected product state, not an outage.
      tags:
      - Status
      responses:
        '200':
          description: Current product capabilities.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProductCapabilities'
  /api/fpl/status:
    get:
      operationId: getFplStatus
      summary: Read official FPL Gameweek status
      description: Returns official FPL timing context. Do not use lastCompletedGameweek as the sole generation gate; the commentary request resolves league-specific readiness after full-time.
      tags:
      - Status
      responses:
        '200':
          description: Current public FPL timing state.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FplStatus'
        '502':
          $ref: '#/components/responses/Error'
components:
  schemas:
    Health:
      type: object
      required:
      - ok
      - service
      - time
      - capabilities
      properties:
        ok:
          type: boolean
          const: true
        service:
          type: string
        time:
          type: string
          format: date-time
        capabilities:
          $ref: '#/components/schemas/ProductCapabilities'
    ProductCapabilities:
      type: object
      required:
      - schemaVersion
      - commentary
      - audio
      properties:
        schemaVersion:
          type: string
          const: fantasy-pundit.capabilities.v1
        commentary:
          type: object
          required:
          - availability
          properties:
            availability:
              type: string
              enum:
              - available
              - paused
          additionalProperties: false
        audio:
          type: object
          required:
          - availability
          - mode
          properties:
            availability:
              type: string
              enum:
              - available
              - paused
            mode:
              type: string
              const: on_demand
          additionalProperties: false
      additionalProperties: false
    Error:
      type: object
      required:
      - error
      properties:
        code:
          type: string
        error:
          type: string
        retryAfterSeconds:
          type: integer
          minimum: 1
          description: Minimum whole seconds to wait before retrying the same write request.
        resetAt:
          type: string
          format: date-time
          description: The earliest advertised time to retry the same write request.
      additionalProperties: false
    FplStatus:
      type: object
      required:
      - phase
      - lastCompletedGameweek
      properties:
        phase:
          type: string
          enum:
          - preseason
          - live
          - completed
        lastCompletedGameweek:
          type:
          - integer
          - 'null'
          minimum: 1
          maximum: 38
        currentGameweek:
          type:
          - integer
          - 'null'
          minimum: 1
          maximum: 38
        nextGameweek:
          type:
          - integer
          - 'null'
          minimum: 1
          maximum: 38
        expectedReadyAt:
          type:
          - string
          - 'null'
          format: date-time
          description: 'While the current Gameweek is live or settling, when its roast usually lands: the first 10:00 UK time at least ten hours after the final kick-off. An estimate, not a guarantee.'
      additionalProperties: true
  responses:
    Error:
      description: The request could not be completed.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
externalDocs:
  description: Fantasy Pundit integration guide
  url: https://fantasypundit.lol/docs/
x-fantasy-pundit-mcp:
  url: https://api.fantasypundit.lol/mcp
  version: 0.9.0
  protocolVersions:
  - '2026-07-28'
  - '2025-11-25'
  - '2025-06-18'
  - '2025-03-26'
  discoveryMethod: server/discover
  authentication: none
  documentationResources:
  - fantasy-pundit://guide/weekly-commentary
  - fantasy-pundit://guide/capabilities
  optionalExperiences:
  - league_selection_form
  - embedded_edition_card
  toolSchemas: Read tools/list for the live input and output schemas, nextStep values and polling guidance.
  canonicalTools:
  - name: get_league_commentary
    purpose: Read an existing canonical weekly commentary and league roast without starting generation.
    annotations:
      readOnlyHint: true
      destructiveHint: false
      idempotentHint: true
      openWorldHint: true
  - name: generate_weekly_commentary
    purpose: Create or reuse the canonical weekly commentary and league roast after an explicit user request. Optional gameweek guards the expected current week and refuses a stale request.
    annotations:
      readOnlyHint: false
      destructiveHint: false
      idempotentHint: true
      openWorldHint: true
  - name: get_commentary_result
    purpose: Check a queued league-roast job and return its exact commentary and links.
    annotations:
      readOnlyHint: true
      destructiveHint: false
      idempotentHint: true
      openWorldHint: true