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

# FighterAPI for Python

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

## Set your key

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

```bash
export FIGHTERAPI_API_KEY=your_key_here
```

```python
from fighterapi import Client

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

## Examples

### 1. Recent events

`list_events` filters by season and status. Pass `league="pfl"` or `"bellator"` for other promotions.

```python
from fighterapi import Client

client = Client()

events = client.list_events(status="final", limit=3)["events"]
for e in events:
    print(e["event_id"], e["event_date"], e["name"])
```

### 2. A fight card

`get_event` returns the bouts on one event.

```python
from fighterapi import Client

client = Client()

card = client.get_event("600061541")
print(card)
```

### 3. A fighter's record

Find the id with `search_fighters`, then pull his fight history.

```python
from fighterapi import Client

client = Client()

fighter = client.search_fighters("Makhachev", limit=1)["fighters"][0]
fights = client.get_fighter_fights(fighter["fighter_id"], limit=5)
print(fighter["name"], fights)
```

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

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

| Method | Credits | What it does |
| --- | --- | --- |
| `list_events` | 1 | List events |
| `get_event` | 2 | Event |
| `get_schedule` | 2 | Schedule |
| `get_fight` | 5 | Fight |
| `search_fighters` | 1 | Search fighters |
| `get_fighter` | 5 | Fighter |
| `get_fighter_fights` | 5 | Fighter fights |
| `get_leaders` | 5 | Leaders |
| `get_ratings` | 2 | Ratings |
| `get_odds` | 5 | Odds |
| `get_line_movement` | 10 | Line movement |

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

## License

MIT
