fastballapi 0.1.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,6 @@
1
+ __pycache__/
2
+ *.egg-info/
3
+ .pytest_cache/
4
+ .venv/
5
+ dist/
6
+ build/
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 FastballAPI
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
@@ -0,0 +1,194 @@
1
+ Metadata-Version: 2.5
2
+ Name: fastballapi
3
+ Version: 0.1.0
4
+ Summary: Python client for the FastballAPI MLB data API. No dependencies.
5
+ Project-URL: Homepage, https://fastballapi.com
6
+ Project-URL: Documentation, https://fastballapi.com/docs
7
+ Project-URL: Repository, https://github.com/noahowsh/puckapi
8
+ Project-URL: Sign up, https://fastballapi.com/signup
9
+ Author-email: FastballAPI <support@fastballapi.com>
10
+ License-Expression: MIT
11
+ License-File: LICENSE
12
+ Keywords: api-client,betting,fastballapi,mlb,odds,player-props,sports-data
13
+ Classifier: Development Status :: 4 - Beta
14
+ Classifier: Intended Audience :: Developers
15
+ Classifier: Operating System :: OS Independent
16
+ Classifier: Programming Language :: Python :: 3
17
+ Classifier: Programming Language :: Python :: 3.9
18
+ Classifier: Programming Language :: Python :: 3.10
19
+ Classifier: Programming Language :: Python :: 3.11
20
+ Classifier: Programming Language :: Python :: 3.12
21
+ Classifier: Programming Language :: Python :: 3.13
22
+ Classifier: Topic :: Software Development :: Libraries :: Python Modules
23
+ Classifier: Typing :: Typed
24
+ Requires-Python: >=3.9
25
+ Provides-Extra: pandas
26
+ Requires-Dist: pandas>=1.5; extra == 'pandas'
27
+ Provides-Extra: test
28
+ Requires-Dist: pytest>=7; extra == 'test'
29
+ Description-Content-Type: text/markdown
30
+
31
+ # FastballAPI for Python
32
+
33
+ Python client for the [FastballAPI](https://fastballapi.com) MLB data API. It has no required dependencies (standard library only) and works on Python 3.9 and newer. Pandas is optional.
34
+
35
+ ## Install
36
+
37
+ ```bash
38
+ pip install fastballapi
39
+ pip install "fastballapi[pandas]" # only if you want DataFrames
40
+ ```
41
+
42
+ ## Set your key
43
+
44
+ Get a free key at https://fastballapi.com/signup. Free accounts get 500 credits a month.
45
+
46
+ ```bash
47
+ export FASTBALLAPI_API_KEY=your_key_here
48
+ ```
49
+
50
+ ```python
51
+ from fastballapi import Client
52
+
53
+ client = Client() # reads FASTBALLAPI_API_KEY
54
+ client = Client(api_key="your_key") # or pass it in
55
+ ```
56
+
57
+ ## Examples
58
+
59
+ ### 1. Player props for one game
60
+
61
+ `get_player_props` returns lines by sportsbook. Here are home run props for one game.
62
+
63
+ ```python
64
+ from fastballapi import Client, to_dataframe
65
+
66
+ client = Client()
67
+
68
+ props = client.get_player_props(
69
+ game_id="401815991",
70
+ market="batter_home_runs",
71
+ )
72
+ df = to_dataframe(props, key="props")
73
+ print(df[["player_name", "bookmaker", "line", "over_odds", "under_odds"]].head(10))
74
+ ```
75
+
76
+ ### 2. A pitcher's pitch mix
77
+
78
+ Find the player id with `search_players`, then ask for usage, velocity and whiff rate by pitch type.
79
+
80
+ ```python
81
+ from fastballapi import Client, to_dataframe
82
+
83
+ client = Client()
84
+
85
+ ohtani = client.search_players("Ohtani", limit=1)["players"][0]
86
+ mix = client.get_pitch_mix(ohtani["player_id"])
87
+ print(to_dataframe(mix, key="mix")[["name", "usage", "avg_velocity", "whiff_rate"]])
88
+ ```
89
+
90
+ ### 3. League leaders
91
+
92
+ `get_leaders` ranks qualified hitters or pitchers by a stat.
93
+
94
+ ```python
95
+ from fastballapi import Client
96
+
97
+ client = Client()
98
+
99
+ leaders = client.get_leaders("ops", limit=5)
100
+ for row in leaders["leaders"]:
101
+ print(row["name"], row["team"], row["ops"])
102
+ ```
103
+
104
+ ## Credits
105
+
106
+ Every method returns the `data` object from the response. After each call, `client.last_credits_used` and `client.last_credits_remaining` hold the counters from the `X-Credits-Used` and `X-Credits-Remaining` headers. Methods that take `estimate_only=True` return the price of a call without running or charging it.
107
+
108
+ ## Pandas
109
+
110
+ ```python
111
+ from fastballapi import to_dataframe
112
+
113
+ df = to_dataframe(data) # finds the main list in the response
114
+ df = to_dataframe(data, key="rows") # or name the list yourself
115
+ ```
116
+
117
+ Nested fields become dotted columns. Install pandas separately or with `pip install "fastballapi[pandas]"`.
118
+
119
+ ## Errors
120
+
121
+ Every error is an `APIError` subclass, with the server's message and the HTTP status.
122
+
123
+ | Exception | Status | Meaning |
124
+ | --- | --- | --- |
125
+ | `AuthError` | 401 | Missing, invalid or revoked key |
126
+ | `InsufficientCreditsError` | 402 | Not enough credits for the call |
127
+ | `NotFoundError` | 404 | The id or name does not exist |
128
+ | `RateLimitError` | 429 | Too many requests; has `.retry_after` when the server sends it |
129
+ | `APIError` | 400, 5xx | Bad arguments or a server problem |
130
+ | `APIConnectionError` | none | No response (network or timeout) |
131
+
132
+ ```python
133
+ from fastballapi import Client, APIError, InsufficientCreditsError, RateLimitError
134
+
135
+ client = Client()
136
+ try:
137
+ data = client.list_teams()
138
+ except InsufficientCreditsError:
139
+ print("Out of credits, top up at https://fastballapi.com")
140
+ except RateLimitError as exc:
141
+ print("Slow down, retry after", exc.retry_after)
142
+ except APIError as exc:
143
+ print(exc.status_code, exc.message)
144
+ ```
145
+
146
+ The client retries 429 and 5xx responses and connection failures up to 3 times with backoff, and honors `Retry-After`. Set `Client(max_retries=0)` to turn that off.
147
+
148
+ If you see `CERTIFICATE_VERIFY_FAILED` on a python.org install for macOS, run the "Install Certificates.command" script that came with Python, or `pip install certifi` (the client uses it when present).
149
+
150
+ ## Options
151
+
152
+ ```python
153
+ Client(
154
+ api_key=None, # defaults to $FASTBALLAPI_API_KEY
155
+ base_url="https://mcp.fastballapi.com", # point at another host
156
+ timeout=60.0, # seconds per request
157
+ max_retries=3,
158
+ )
159
+ ```
160
+
161
+ `client.call("tool_name", {"arg": "value"})` calls any tool by name, which helps when the API adds a tool before this package does.
162
+
163
+ ## Tools
164
+
165
+ Method names match the API tool names. Arguments are keyword arguments; required ones can also be passed positionally. Each method's docstring lists its arguments (`help(client.list_teams)`).
166
+
167
+ | Method | Credits | What it does |
168
+ | --- | --- | --- |
169
+ | `list_teams` | 1 | List teams |
170
+ | `get_games` | 2 | Games |
171
+ | `get_schedule` | 2 | Schedule |
172
+ | `get_game` | 5 | Game |
173
+ | `get_standings` | 2 | Standings |
174
+ | `get_injuries` | 2 | Injuries |
175
+ | `search_players` | 1 | Search players |
176
+ | `get_player` | 5 | Player |
177
+ | `get_player_games` | 5 | Player games |
178
+ | `get_leaders` | 5 | Leaders |
179
+ | `get_team_stats` | 5 | Team stats |
180
+ | `get_plate_appearances` | 10 | Plate appearances |
181
+ | `get_pitches` | 10 | Pitches |
182
+ | `get_pitch_mix` | 5 | Pitch mix |
183
+ | `get_spray_chart` | 10 | Spray chart |
184
+ | `get_odds` | 5 | Odds |
185
+ | `get_line_movement` | 10 | Line movement |
186
+ | `get_ratings` | 2 | Ratings |
187
+ | `get_player_props` | 10 | Player props |
188
+ | `get_prop_history` | 10 | Prop history |
189
+
190
+ Full API reference: https://fastballapi.com/docs
191
+
192
+ ## License
193
+
194
+ MIT
@@ -0,0 +1,164 @@
1
+ # FastballAPI for Python
2
+
3
+ Python client for the [FastballAPI](https://fastballapi.com) MLB data API. It has no required dependencies (standard library only) and works on Python 3.9 and newer. Pandas is optional.
4
+
5
+ ## Install
6
+
7
+ ```bash
8
+ pip install fastballapi
9
+ pip install "fastballapi[pandas]" # only if you want DataFrames
10
+ ```
11
+
12
+ ## Set your key
13
+
14
+ Get a free key at https://fastballapi.com/signup. Free accounts get 500 credits a month.
15
+
16
+ ```bash
17
+ export FASTBALLAPI_API_KEY=your_key_here
18
+ ```
19
+
20
+ ```python
21
+ from fastballapi import Client
22
+
23
+ client = Client() # reads FASTBALLAPI_API_KEY
24
+ client = Client(api_key="your_key") # or pass it in
25
+ ```
26
+
27
+ ## Examples
28
+
29
+ ### 1. Player props for one game
30
+
31
+ `get_player_props` returns lines by sportsbook. Here are home run props for one game.
32
+
33
+ ```python
34
+ from fastballapi import Client, to_dataframe
35
+
36
+ client = Client()
37
+
38
+ props = client.get_player_props(
39
+ game_id="401815991",
40
+ market="batter_home_runs",
41
+ )
42
+ df = to_dataframe(props, key="props")
43
+ print(df[["player_name", "bookmaker", "line", "over_odds", "under_odds"]].head(10))
44
+ ```
45
+
46
+ ### 2. A pitcher's pitch mix
47
+
48
+ Find the player id with `search_players`, then ask for usage, velocity and whiff rate by pitch type.
49
+
50
+ ```python
51
+ from fastballapi import Client, to_dataframe
52
+
53
+ client = Client()
54
+
55
+ ohtani = client.search_players("Ohtani", limit=1)["players"][0]
56
+ mix = client.get_pitch_mix(ohtani["player_id"])
57
+ print(to_dataframe(mix, key="mix")[["name", "usage", "avg_velocity", "whiff_rate"]])
58
+ ```
59
+
60
+ ### 3. League leaders
61
+
62
+ `get_leaders` ranks qualified hitters or pitchers by a stat.
63
+
64
+ ```python
65
+ from fastballapi import Client
66
+
67
+ client = Client()
68
+
69
+ leaders = client.get_leaders("ops", limit=5)
70
+ for row in leaders["leaders"]:
71
+ print(row["name"], row["team"], row["ops"])
72
+ ```
73
+
74
+ ## Credits
75
+
76
+ Every method returns the `data` object from the response. After each call, `client.last_credits_used` and `client.last_credits_remaining` hold the counters from the `X-Credits-Used` and `X-Credits-Remaining` headers. Methods that take `estimate_only=True` return the price of a call without running or charging it.
77
+
78
+ ## Pandas
79
+
80
+ ```python
81
+ from fastballapi import to_dataframe
82
+
83
+ df = to_dataframe(data) # finds the main list in the response
84
+ df = to_dataframe(data, key="rows") # or name the list yourself
85
+ ```
86
+
87
+ Nested fields become dotted columns. Install pandas separately or with `pip install "fastballapi[pandas]"`.
88
+
89
+ ## Errors
90
+
91
+ Every error is an `APIError` subclass, with the server's message and the HTTP status.
92
+
93
+ | Exception | Status | Meaning |
94
+ | --- | --- | --- |
95
+ | `AuthError` | 401 | Missing, invalid or revoked key |
96
+ | `InsufficientCreditsError` | 402 | Not enough credits for the call |
97
+ | `NotFoundError` | 404 | The id or name does not exist |
98
+ | `RateLimitError` | 429 | Too many requests; has `.retry_after` when the server sends it |
99
+ | `APIError` | 400, 5xx | Bad arguments or a server problem |
100
+ | `APIConnectionError` | none | No response (network or timeout) |
101
+
102
+ ```python
103
+ from fastballapi import Client, APIError, InsufficientCreditsError, RateLimitError
104
+
105
+ client = Client()
106
+ try:
107
+ data = client.list_teams()
108
+ except InsufficientCreditsError:
109
+ print("Out of credits, top up at https://fastballapi.com")
110
+ except RateLimitError as exc:
111
+ print("Slow down, retry after", exc.retry_after)
112
+ except APIError as exc:
113
+ print(exc.status_code, exc.message)
114
+ ```
115
+
116
+ The client retries 429 and 5xx responses and connection failures up to 3 times with backoff, and honors `Retry-After`. Set `Client(max_retries=0)` to turn that off.
117
+
118
+ If you see `CERTIFICATE_VERIFY_FAILED` on a python.org install for macOS, run the "Install Certificates.command" script that came with Python, or `pip install certifi` (the client uses it when present).
119
+
120
+ ## Options
121
+
122
+ ```python
123
+ Client(
124
+ api_key=None, # defaults to $FASTBALLAPI_API_KEY
125
+ base_url="https://mcp.fastballapi.com", # point at another host
126
+ timeout=60.0, # seconds per request
127
+ max_retries=3,
128
+ )
129
+ ```
130
+
131
+ `client.call("tool_name", {"arg": "value"})` calls any tool by name, which helps when the API adds a tool before this package does.
132
+
133
+ ## Tools
134
+
135
+ Method names match the API tool names. Arguments are keyword arguments; required ones can also be passed positionally. Each method's docstring lists its arguments (`help(client.list_teams)`).
136
+
137
+ | Method | Credits | What it does |
138
+ | --- | --- | --- |
139
+ | `list_teams` | 1 | List teams |
140
+ | `get_games` | 2 | Games |
141
+ | `get_schedule` | 2 | Schedule |
142
+ | `get_game` | 5 | Game |
143
+ | `get_standings` | 2 | Standings |
144
+ | `get_injuries` | 2 | Injuries |
145
+ | `search_players` | 1 | Search players |
146
+ | `get_player` | 5 | Player |
147
+ | `get_player_games` | 5 | Player games |
148
+ | `get_leaders` | 5 | Leaders |
149
+ | `get_team_stats` | 5 | Team stats |
150
+ | `get_plate_appearances` | 10 | Plate appearances |
151
+ | `get_pitches` | 10 | Pitches |
152
+ | `get_pitch_mix` | 5 | Pitch mix |
153
+ | `get_spray_chart` | 10 | Spray chart |
154
+ | `get_odds` | 5 | Odds |
155
+ | `get_line_movement` | 10 | Line movement |
156
+ | `get_ratings` | 2 | Ratings |
157
+ | `get_player_props` | 10 | Player props |
158
+ | `get_prop_history` | 10 | Prop history |
159
+
160
+ Full API reference: https://fastballapi.com/docs
161
+
162
+ ## License
163
+
164
+ MIT
@@ -0,0 +1,50 @@
1
+ [build-system]
2
+ requires = ["hatchling>=1.27"]
3
+ build-backend = "hatchling.build"
4
+
5
+ [project]
6
+ name = "fastballapi"
7
+ dynamic = ["version"]
8
+ description = "Python client for the FastballAPI MLB data API. No dependencies."
9
+ readme = "README.md"
10
+ requires-python = ">=3.9"
11
+ license = "MIT"
12
+ license-files = ["LICENSE"]
13
+ authors = [{ name = "FastballAPI", email = "support@fastballapi.com" }]
14
+ keywords = ["mlb", "sports-data", "api-client", "betting", "player-props", "odds", "fastballapi"]
15
+ classifiers = [
16
+ "Development Status :: 4 - Beta",
17
+ "Intended Audience :: Developers",
18
+ "Operating System :: OS Independent",
19
+ "Programming Language :: Python :: 3",
20
+ "Programming Language :: Python :: 3.9",
21
+ "Programming Language :: Python :: 3.10",
22
+ "Programming Language :: Python :: 3.11",
23
+ "Programming Language :: Python :: 3.12",
24
+ "Programming Language :: Python :: 3.13",
25
+ "Topic :: Software Development :: Libraries :: Python Modules",
26
+ "Typing :: Typed",
27
+ ]
28
+ dependencies = []
29
+
30
+ [project.optional-dependencies]
31
+ pandas = ["pandas>=1.5"]
32
+ test = ["pytest>=7"]
33
+
34
+ [project.urls]
35
+ Homepage = "https://fastballapi.com"
36
+ Documentation = "https://fastballapi.com/docs"
37
+ Repository = "https://github.com/noahowsh/puckapi"
38
+ "Sign up" = "https://fastballapi.com/signup"
39
+
40
+ [tool.hatch.version]
41
+ path = "src/fastballapi/_version.py"
42
+
43
+ [tool.hatch.build.targets.wheel]
44
+ packages = ["src/fastballapi"]
45
+
46
+ [tool.hatch.build.targets.sdist]
47
+ include = ["src", "tests", "README.md", "LICENSE", "pyproject.toml"]
48
+
49
+ [tool.pytest.ini_options]
50
+ testpaths = ["tests"]
@@ -0,0 +1,25 @@
1
+ """FastballAPI: Python client for the FastballAPI MLB data API."""
2
+ from ._core import (
3
+ APIConnectionError,
4
+ APIError,
5
+ AuthError,
6
+ InsufficientCreditsError,
7
+ NotFoundError,
8
+ RateLimitError,
9
+ to_dataframe,
10
+ )
11
+ from ._version import __version__
12
+ from .client import TOOLS, Client
13
+
14
+ __all__ = [
15
+ "APIConnectionError",
16
+ "APIError",
17
+ "AuthError",
18
+ "Client",
19
+ "InsufficientCreditsError",
20
+ "NotFoundError",
21
+ "RateLimitError",
22
+ "TOOLS",
23
+ "__version__",
24
+ "to_dataframe",
25
+ ]