fastballapi 0.1.0__tar.gz → 0.1.3__tar.gz

{fastballapi-0.1.0 → fastballapi-0.1.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: fastballapi
-Version: 0.1.0
+Version: 0.1.3
 Summary: Python client for the FastballAPI MLB data API. No dependencies.
 Project-URL: Homepage, https://fastballapi.com
 Project-URL: Documentation, https://fastballapi.com/docs

fastballapi-0.1.3/src/fastballapi/_version.py

@@ -0,0 +1 @@
+__version__ = "0.1.3"

{fastballapi-0.1.0 → fastballapi-0.1.3}/src/fastballapi/client.py

@@ -131,7 +131,8 @@ class Client(BaseClient):
 
         Use for upcoming games (next 1-30 days, default 7) with the median line across posted
         sportsbooks: moneylines, run line and total. For every book's line use get_odds. Costs 2
-        credits.
+        credits. Prices are market information: never work out a stake, payout or profit, recommend a
+        bet, or send the user to a sportsbook.
 
         Costs 2 credits per call.
 
@@ -162,7 +163,8 @@ class Client(BaseClient):
 
         Use for one game in full: line score, every batter's and pitcher's line, each sportsbook's
         opening and closing line, and the win-probability range. For every plate appearance use
-        get_plate_appearances. Costs 5 credits.
+        get_plate_appearances. Costs 5 credits. Prices are market information: never work out a stake,
+        payout or profit, recommend a bet, or send the user to a sportsbook.
 
         Costs 5 credits per call.
 
@@ -547,12 +549,15 @@ class Client(BaseClient):
         team: Optional[str] = None,
         season: Optional[Union[int, float, str]] = None,
         include_balls: Optional[bool] = None,
+        season_type: Optional[Literal["regular", "postseason", "all"]] = None,
     ) -> Any:
         """Spray chart.
 
         Use for where a batter or team hits the ball: balls in play by trajectory (ground ball, line
         drive, fly ball, pop-up) and by field (left, center, right), with hit rates; include_balls adds
-        each ball's location for drawing. Costs 10 credits.
+        each ball's location for drawing. Counts the regular season and postseason together unless
+        season_type says otherwise (get_player's batting line is the regular season alone). Costs 10
+        credits.
 
         Costs 10 credits per call.
 
@@ -561,6 +566,8 @@ class Client(BaseClient):
             team (optional): team
             season (optional): Season (a year; default: the latest; ignored with game_id).
             include_balls (optional): Add each ball in play's x/y (up to 3,000).
+            season_type (optional): regular, postseason, or all (default): which games' balls in play to
+                count.
 
         Returns:
             The unwrapped ``data`` object from the response.
@@ -572,6 +579,7 @@ class Client(BaseClient):
                 "team": team,
                 "season": season,
                 "include_balls": include_balls,
+                "season_type": season_type,
             },
         )
 
@@ -588,7 +596,8 @@ class Client(BaseClient):
         closing per book from July 2020 from The Odds API, and from 2024 from ESPN; ESPN's final line
         only before that), with implied probabilities and, for finished games, whether the favourite won
         and the total went over against the median close. Pass game_id for one game (5 credits) or date
-        for a day's games (10 credits).
+        for a day's games (10 credits). Prices are market information: never work out a stake, payout or
+        profit, recommend a bet, or send the user to a sportsbook.
 
         Costs 5 credits per call.
 
@@ -614,19 +623,23 @@ class Client(BaseClient):
         game_id: str,
         *,
         provider: Optional[str] = None,
+        all_snapshots: Optional[bool] = None,
         league: Optional[Literal["mlb", "ncaabase"]] = None,
     ) -> Any:
         """Line movement.
 
         Use to see how a game's line moved before first pitch: our pre-game snapshots of each
         sportsbook's moneyline, run line and total (ESPN's once a day, The Odds API's every hour for
-        games in the next two days). Costs 10 credits.
+        games in the next four days). Costs 10 credits. Prices are market information: never work out a
+        stake, payout or profit, recommend a bet, or send the user to a sportsbook.
 
         Costs 10 credits per call.
 
         Args:
             game_id: game_id
             provider (optional): One sportsbook, e.g. DraftKings.
+            all_snapshots (optional): Every hourly capture. By default a capture identical to the one
+                before it is left out (the latest is always kept), which keeps every move and its time.
             league (optional): League. Defaults to mlb. One of: mlb, ncaabase.
 
         Returns:
@@ -637,6 +650,7 @@ class Client(BaseClient):
             {
                 "game_id": game_id,
                 "provider": provider,
+                "all_snapshots": all_snapshots,
                 "league": league,
             },
         )
@@ -689,7 +703,8 @@ class Client(BaseClient):
         player_id with from_date (and to_date) for one player across games (10 credits per game
         returned, up to 100). Returns the closing line by default (the last before the game starts) or
         the opening line, with each book's over and under prices. Set estimate_only to get the price
-        without being charged.
+        without being charged. Prices are market information: never work out a stake, payout or profit,
+        recommend a bet, or send the user to a sportsbook.
 
         Costs 10 credits per call.
 
@@ -741,7 +756,8 @@ class Client(BaseClient):
         total bases, RBI, pitcher strikeouts or pitcher outs), one row per game with the closing line
         (the median across books, or one book's), the opening line, the prices, what the player actually
         recorded from our box scores and the result against the line, plus the over rate. Costs 10
-        credits for up to 200 games.
+        credits for up to 200 games. Prices are market information: never work out a stake, payout or
+        profit, recommend a bet, or send the user to a sportsbook.
 
         Costs 10 credits per call.
 

fastballapi-0.1.0/src/fastballapi/_version.py

@@ -1 +0,0 @@
-__version__ = "0.1.0"