puckapi-com Model projections API

openapi: 3.2.0
info:
  title: PuckAPI Model projections API
  version: 1.0.0
  description: PuckAPI hockey data. Every tool is a POST to /v1/{tool} with a JSON body of its arguments and costs the credits in x-credits. The same tools are an MCP server at https://mcp.puckapi.com/mcp and free accounts get credits every month at https://puckapi.com/signup
  termsOfService: https://puckapi.com/terms
  contact:
    name: PuckAPI support
    email: support@puckapi.com
    url: https://puckapi.com/docs
servers:
- url: https://mcp.puckapi.com
security:
- apiKey: []
- bearer: []
tags:
- name: Model projections
paths:
  /v1/get_prop_projections:
    post:
      operationId: get_prop_projections
      summary: Prop projections
      description: 'Paid plans only (not available on the free plan). Use for the model''s projected stat lines for tonight''s NHL players: for each game, each skater''s projected goals, assists, points and shots with a low-to-high range, and each goalie''s projected saves. Skaters also carry over probabilities at the usual half-point lines (goals 0.5 and 1.5, assists 0.5 and 1.5, points 0.5 to 2.5, shots 1.5 to 5.5): goals use the model''s own goal distribution, the others are Poisson on the projected rate. Optional team (either side of the game) and player (name fragment) filters. Tonight''s slate only; no date argument. Numbers only: no odds, prices or injury notes. An empty slate costs nothing; so does a failed call. Costs 25 credits.'
      tags:
      - Model projections
      x-credits: 25
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                team:
                  description: Team abbreviation, e.g. COL. Keeps the games that team plays in, home or away.
                  type: string
                  pattern: ^[A-Za-z]{2,4}$
                player:
                  description: Part of a player's name, e.g. makar. Accents are ignored. Keeps only matching players.
                  type: string
                  minLength: 2
                  maxLength: 64
              additionalProperties: false
      responses:
        '200':
          description: The result, wrapped in data.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      generatedAt:
                        type: string
                      method:
                        type: string
                      games:
                        type: array
                        items:
                          type: object
                          properties:
                            gameId:
                              type: string
                            gameDate:
                              type: string
                            startTimeUtc:
                              type: string
                            homeTeam:
                              type: string
                            awayTeam:
                              type: string
                            skaters:
                              type: array
                              items:
                                type: object
                                properties:
                                  playerId:
                                    type: number
                                  name:
                                    type: string
                                  team:
                                    type: string
                                  position:
                                    type: string
                                  goals:
                                    anyOf:
                                    - type: object
                                      properties:
                                        projected:
                                          type: number
                                        low:
                                          type: number
                                        high:
                                          type: number
                                        overProbs:
                                          type: array
                                          items:
                                            type: object
                                            properties:
                                              line:
                                                type: number
                                              overProb:
                                                type: number
                                            required:
                                            - line
                                            - overProb
                                            additionalProperties: false
                                      required:
                                      - projected
                                      - low
                                      - high
                                      - overProbs
                                      additionalProperties: false
                                    - type: 'null'
                                  assists:
                                    anyOf:
                                    - type: object
                                      properties:
                                        projected:
                                          type: number
                                        low:
                                          type: number
                                        high:
                                          type: number
                                        overProbs:
                                          type: array
                                          items:
                                            type: object
                                            properties:
                                              line:
                                                type: number
                                              overProb:
                                                type: number
                                            required:
                                            - line
                                            - overProb
                                            additionalProperties: false
                                      required:
                                      - projected
                                      - low
                                      - high
                                      - overProbs
                                      additionalProperties: false
                                    - type: 'null'
                                  points:
                                    anyOf:
                                    - type: object
                                      properties:
                                        projected:
                                          type: number
                                        low:
                                          type: number
                                        high:
                                          type: number
                                        overProbs:
                                          type: array
                                          items:
                                            type: object
                                            properties:
                                              line:
                                                type: number
                                              overProb:
                                                type: number
                                            required:
                                            - line
                                            - overProb
                                            additionalProperties: false
                                      required:
                                      - projected
                                      - low
                                      - high
                                      - overProbs
                                      additionalProperties: false
                                    - type: 'null'
                                  shots:
                                    anyOf:
                                    - type: object
                                      properties:
                                        projected:
                                          type: number
                                        low:
                                          type: number
                                        high:
                                          type: number
                                        overProbs:
                                          type: array
                                          items:
                                            type: object
                                            properties:
                                              line:
                                                type: number
                                              overProb:
                                                type: number
                                            required:
                                            - line
                                            - overProb
                                            additionalProperties: false
                                      required:
                                      - projected
                                      - low
                                      - high
                                      - overProbs
                                      additionalProperties: false
                                    - type: 'null'
                                required:
                                - playerId
                                - name
                                - team
                                - position
                                - goals
                                - assists
                                - points
                                - shots
                                additionalProperties: false
                            goalies:
                              type: array
                              items:
                                type: object
                                properties:
                                  playerId:
                                    type: number
                                  name:
                                    type: string
                                  team:
                                    type: string
                                  saves:
                                    anyOf:
                                    - type: object
                                      properties:
                                        projected:
                                          type: number
                                        low:
                                          type: number
                                        high:
                                          type: number
                                      required:
                                      - projected
                                      - low
                                      - high
                                      additionalProperties: false
                                    - type: 'null'
                                required:
                                - playerId
                                - name
                                - team
                                - saves
                                additionalProperties: false
                          required:
                          - gameId
                          - gameDate
                          - startTimeUtc
                          - homeTeam
                          - awayTeam
                          - skaters
                          - goalies
                          additionalProperties: false
                      count:
                        type: number
                    required:
                    - generatedAt
                    - method
                    - games
                    - count
                    additionalProperties: false
                required:
                - data
        '400':
          description: Invalid arguments.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                - error
        '401':
          description: Missing or invalid API key.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                - error
        '402':
          description: Not enough credits.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                - error
        '429':
          description: Rate limited.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                - error
components:
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: x-api-key
    bearer:
      type: http
      scheme: bearer
      description: The same API key as a bearer token.
externalDocs:
  description: Documentation
  url: https://puckapi.com/docs