Metadata-Version: 2.5
Name: fastballapi
Version: 0.1.0
Summary: Python client for the FastballAPI MLB data API. No dependencies.
Project-URL: Homepage, https://fastballapi.com
Project-URL: Documentation, https://fastballapi.com/docs
Project-URL: Repository, https://github.com/noahowsh/puckapi
Project-URL: Sign up, https://fastballapi.com/signup
Author-email: FastballAPI <support@fastballapi.com>
License-Expression: MIT
License-File: LICENSE
Keywords: api-client,betting,fastballapi,mlb,odds,player-props,sports-data
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Typing :: Typed
Requires-Python: >=3.9
Provides-Extra: pandas
Requires-Dist: pandas>=1.5; extra == 'pandas'
Provides-Extra: test
Requires-Dist: pytest>=7; extra == 'test'
Description-Content-Type: text/markdown

# FastballAPI for Python

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.

## Install

```bash
pip install fastballapi
pip install "fastballapi[pandas]"   # only if you want DataFrames
```

## Set your key

Get a free key at https://fastballapi.com/signup. Free accounts get 500 credits a month.

```bash
export FASTBALLAPI_API_KEY=your_key_here
```

```python
from fastballapi import Client

client = Client()                      # reads FASTBALLAPI_API_KEY
client = Client(api_key="your_key")    # or pass it in
```

## Examples

### 1. Player props for one game

`get_player_props` returns lines by sportsbook. Here are home run props for one game.

```python
from fastballapi import Client, to_dataframe

client = Client()

props = client.get_player_props(
    game_id="401815991",
    market="batter_home_runs",
)
df = to_dataframe(props, key="props")
print(df[["player_name", "bookmaker", "line", "over_odds", "under_odds"]].head(10))
```

### 2. A pitcher's pitch mix

Find the player id with `search_players`, then ask for usage, velocity and whiff rate by pitch type.

```python
from fastballapi import Client, to_dataframe

client = Client()

ohtani = client.search_players("Ohtani", limit=1)["players"][0]
mix = client.get_pitch_mix(ohtani["player_id"])
print(to_dataframe(mix, key="mix")[["name", "usage", "avg_velocity", "whiff_rate"]])
```

### 3. League leaders

`get_leaders` ranks qualified hitters or pitchers by a stat.

```python
from fastballapi import Client

client = Client()

leaders = client.get_leaders("ops", limit=5)
for row in leaders["leaders"]:
    print(row["name"], row["team"], row["ops"])
```

## Credits

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.

## Pandas

```python
from fastballapi import to_dataframe

df = to_dataframe(data)                # finds the main list in the response
df = to_dataframe(data, key="rows")    # or name the list yourself
```

Nested fields become dotted columns. Install pandas separately or with `pip install "fastballapi[pandas]"`.

## Errors

Every error is an `APIError` subclass, with the server's message and the HTTP status.

| Exception | Status | Meaning |
| --- | --- | --- |
| `AuthError` | 401 | Missing, invalid or revoked key |
| `InsufficientCreditsError` | 402 | Not enough credits for the call |
| `NotFoundError` | 404 | The id or name does not exist |
| `RateLimitError` | 429 | Too many requests; has `.retry_after` when the server sends it |
| `APIError` | 400, 5xx | Bad arguments or a server problem |
| `APIConnectionError` | none | No response (network or timeout) |

```python
from fastballapi import Client, APIError, InsufficientCreditsError, RateLimitError

client = Client()
try:
    data = client.list_teams()
except InsufficientCreditsError:
    print("Out of credits, top up at https://fastballapi.com")
except RateLimitError as exc:
    print("Slow down, retry after", exc.retry_after)
except APIError as exc:
    print(exc.status_code, exc.message)
```

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.

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).

## Options

```python
Client(
    api_key=None,                          # defaults to $FASTBALLAPI_API_KEY
    base_url="https://mcp.fastballapi.com",           # point at another host
    timeout=60.0,                          # seconds per request
    max_retries=3,
)
```

`client.call("tool_name", {"arg": "value"})` calls any tool by name, which helps when the API adds a tool before this package does.

## Tools

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)`).

| Method | Credits | What it does |
| --- | --- | --- |
| `list_teams` | 1 | List teams |
| `get_games` | 2 | Games |
| `get_schedule` | 2 | Schedule |
| `get_game` | 5 | Game |
| `get_standings` | 2 | Standings |
| `get_injuries` | 2 | Injuries |
| `search_players` | 1 | Search players |
| `get_player` | 5 | Player |
| `get_player_games` | 5 | Player games |
| `get_leaders` | 5 | Leaders |
| `get_team_stats` | 5 | Team stats |
| `get_plate_appearances` | 10 | Plate appearances |
| `get_pitches` | 10 | Pitches |
| `get_pitch_mix` | 5 | Pitch mix |
| `get_spray_chart` | 10 | Spray chart |
| `get_odds` | 5 | Odds |
| `get_line_movement` | 10 | Line movement |
| `get_ratings` | 2 | Ratings |
| `get_player_props` | 10 | Player props |
| `get_prop_history` | 10 | Prop history |

Full API reference: https://fastballapi.com/docs

## License

MIT
