Metadata-Version: 2.5
Name: jx3api
Version: 2026.11.15
Summary: The Python SDK to the JX3API
License: MIT License
Requires-Python: >=3
Requires-Dist: httpx
Description-Content-Type: text/markdown

# jx3api-py
The Python SDK to the [JX3API](https://www.jx3api.com).

Version: `2026.11.15`.

## Installation

### From pypi
```bash
pip install --no-cache -U jx3api
```

### From github
```bash
pip install --no-cache -U git+https://github.com/JX3API/jx3api-py.git
```

## Quick Start

### Sync
```python
from jx3api import JX3API

api = JX3API(token=..., ticket=...)

api.active_calendar()
api.role_detail(server="梦江南", name="角色名")
```

### Async
```python
from jx3api import AsyncJX3API

async_api = AsyncJX3API(token=..., ticket=...)

await async_api.active_calendar()
await async_api.role_detail(server="梦江南", name="角色名")
```

## API

Endpoints follow the [current OpenAPI specification](https://www.jx3api.com/openapi).
The SDK returns the response's `detail` field and raises `APIError` when `status` is not 200.

- `school_matrix`, `school_skills`, `school_talent`, and `rank_trials` accept `kungfu`. The three school methods require only `token`.
- `role_achievement(server=..., name=..., class_=1, subclass=None)` queries achievement distribution. `tuilan_achievement` remains an alias.
- `calcd_attribute`, `calcd_detail`, and `calcd_records` query recorded equipment through the same API host.
- Renamed methods retain aliases: `duowan_statistics`, `rank_statistics`, `card_preset`, `rank_arena`, `rank_championship`, `rank_constable`, and `rank_outlaw`.
- Removed endpoints: `home_furniture`, `home_travel`, `event_missing`, `raid_records`, `castle_status`, and `fenxian_records`.
