Metadata-Version: 2.5
Name: birdieapi
Version: 0.1.0
Summary: Python client for the BirdieAPI golf data API. No dependencies.
Project-URL: Homepage, https://birdieapi.com
Project-URL: Documentation, https://birdieapi.com/docs
Project-URL: Repository, https://github.com/noahowsh/puckapi
Project-URL: Sign up, https://birdieapi.com/signup
Author-email: BirdieAPI <support@birdieapi.com>
License-Expression: MIT
License-File: LICENSE
Keywords: api-client,betting,birdieapi,golf,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

# BirdieAPI for Python

Python client for the [BirdieAPI](https://birdieapi.com) golf 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 birdieapi
pip install "birdieapi[pandas]"   # only if you want DataFrames
```

## Set your key

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

```bash
export BIRDIEAPI_API_KEY=your_key_here
```

```python
from birdieapi import Client

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

## Examples

### 1. Recent tournaments

`list_tournaments` filters by season and status.

```python
from birdieapi import Client

client = Client()

events = client.list_tournaments(status="final", limit=3)["tournaments"]
for e in events:
    print(e["tournament_id"], e["name"], e["winner_name"], e["winning_to_par"])
```

### 2. A leaderboard

Pass a tournament id from `list_tournaments`.

```python
from birdieapi import Client, to_dataframe

client = Client()

board = client.get_leaderboard("401850916", limit=10)
print(to_dataframe(board).head(10))
```

### 3. A player's results

Find the player id with `search_players`, then pull his results for a season.

```python
from birdieapi import Client

client = Client()

scheffler = client.search_players("Scheffler", limit=1)["players"][0]
results = client.get_player_results(scheffler["player_id"], season=2026, limit=5)
print(scheffler["name"], results)
```

## 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 birdieapi 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 "birdieapi[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 birdieapi import Client, APIError, InsufficientCreditsError, RateLimitError

client = Client()
try:
    data = client.list_tournaments()
except InsufficientCreditsError:
    print("Out of credits, top up at https://birdieapi.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 $BIRDIEAPI_API_KEY
    base_url="https://mcp.birdieapi.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_tournaments)`).

| Method | Credits | What it does |
| --- | --- | --- |
| `list_tournaments` | 1 | List tournaments |
| `get_schedule` | 1 | Schedule |
| `get_leaderboard` | 2 | Leaderboard |
| `get_course` | 2 | Course |
| `search_players` | 1 | Search players |
| `get_player` | 5 | Player |
| `get_player_results` | 5 | Player results |
| `get_player_stats` | 5 | Player stats |
| `get_scorecard` | 2 | Scorecard |
| `get_course_history` | 5 | Course history |
| `get_head_to_head` | 5 | Head to head |
| `get_ratings` | 2 | Ratings |
| `get_leaders` | 5 | Leaders |
| `get_winner_odds` | 5 | Winner odds |

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

## License

MIT
