|
9 | 9 |  |
10 | 10 |  |
11 | 11 |
|
12 | | -### [Wiki](https://github.com/zero-sum-seattle/python-mlb-statsapi/wiki) | [Methods](docs/methods.md) | [Examples](docs/examples.md) | [Async](docs/async.md) | [Public API](docs/public-api.md) | [MLB Stats API](https://statsapi.mlb.com/) |
| 12 | +### [Wiki](https://github.com/zero-sum-seattle/python-mlb-statsapi/wiki) | [Methods](docs/methods.md) | [Examples](docs/examples.md) | [Stats](docs/stats.md) | [Async](docs/async.md) | [Public API](docs/public-api.md) | [MLB Stats API](https://statsapi.mlb.com/) |
13 | 13 |
|
14 | 14 | </div> |
15 | 15 |
|
@@ -143,7 +143,7 @@ See [Async usage](docs/async.md) for lifecycle, concurrency, custom HTTPX client |
143 | 143 |
|
144 | 144 | Where an async endpoint is supported, both clients return the same Pydantic models and follow the same public HTTP/error behavior. |
145 | 145 |
|
146 | | -The async surface is still smaller than the full synchronous API while 1.1 coverage is expanded. The [public API contract](docs/public-api.md#asyncmlb-public-client) is the authoritative list of supported async methods. |
| 146 | +The [public API contract](docs/public-api.md#asyncmlb-public-client) is the authoritative list of supported async methods. |
147 | 147 |
|
148 | 148 | ## Concurrent Async Requests |
149 | 149 |
|
@@ -190,16 +190,7 @@ team_ids = mlb.get_team_id("Seattle Mariners") |
190 | 190 |
|
191 | 191 | ### Stats |
192 | 192 |
|
193 | | -```python |
194 | | -stats = mlb.get_player_stats( |
195 | | - 664034, |
196 | | - stats=["season", "career"], |
197 | | - groups=["hitting"], |
198 | | - season=2022, |
199 | | -) |
200 | | -``` |
201 | | - |
202 | | -Higher-level stats helpers remain on the synchronous `Mlb` client in the current 1.1 async surface. |
| 193 | +The stats API has several entry points and returns a nested `stats[group][type]` structure. See the dedicated [Stats Guide](docs/stats.md) for `get_player_stats()`, `get_team_stats()`, `get_stats()`, and `get_players_stats_for_game()` examples using both `Mlb` and `AsyncMlb`. |
203 | 194 |
|
204 | 195 | ### Schedule |
205 | 196 |
|
@@ -258,6 +249,7 @@ print(player.model_dump_json(indent=2)) |
258 | 249 | | [Wiki](https://github.com/zero-sum-seattle/python-mlb-statsapi/wiki) | Endpoint reference, return objects, and model documentation | |
259 | 250 | | [Method reference](docs/methods.md) | Method signatures and short descriptions from the original README reference | |
260 | 251 | | [Usage examples](docs/examples.md) | Extended synchronous examples | |
| 252 | +| [Stats guide](docs/stats.md) | Player, team, general, and per-game stat queries with sync and async examples | |
261 | 253 | | [Async usage](docs/async.md) | Async installation, lifecycle, concurrency, and examples | |
262 | 254 | | [HTTP transport](docs/http-transport.md) | Timeouts, retries, strict HTTP, exceptions, and ownership | |
263 | 255 | | [Public API contract](docs/public-api.md) | Supported symbols, signatures, endpoint methods, and stability policy | |
|
0 commit comments