https://github.com/xivapi/xivapi-py
An asynchronous Python client for XIVAPI
https://github.com/xivapi/xivapi-py
async ffxiv python xivapi
Last synced: 5 months ago
JSON representation
An asynchronous Python client for XIVAPI
- Host: GitHub
- URL: https://github.com/xivapi/xivapi-py
- Owner: xivapi
- License: mit
- Created: 2019-04-02T18:23:56.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2022-12-14T18:04:51.000Z (over 3 years ago)
- Last Synced: 2025-09-29T09:03:40.838Z (9 months ago)
- Topics: async, ffxiv, python, xivapi
- Language: Python
- Homepage: https://pypi.org/project/pyxivapi/
- Size: 84 KB
- Stars: 63
- Watchers: 4
- Forks: 16
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# pyxivapi
An asynchronous Python client for XIVAPI
[](https://www.codacy.com/manual/Yandawl/xivapi-py?utm_source=github.com&utm_medium=referral&utm_content=xivapi/xivapi-py&utm_campaign=Badge_Grade)
[](https://badge.fury.io/py/pyxivapi)
[](https://www.python.org/downloads/release/python-360/)
## Requirements
```python
python>=3.6.0
asyncio
aiohttp
```
## Installation
```python
pip install pyxivapi
```
## Supported API end points
* /character/search
* /character/id
* /freecompany/search
* /freecompany/id
* /linkshell/search
* /linkshell/id
* /pvpteam/search
* /pvpteam/id
* /index/search (e.g. recipe, item, action, pvpaction, mount, e.t.c.)
* /index/id
* /lore/search
* /lodestone/worldstatus
## Documentation
## Example
```python
import asyncio
import logging
import aiohttp
import pyxivapi
from pyxivapi.models import Filter, Sort
async def fetch_example_results():
client = pyxivapi.XIVAPIClient(api_key="your_key_here")
# Search Lodestone for a character
character = await client.character_search(
world="odin",
forename="lethys",
surname="lightpaw"
)
# Get a character by Lodestone ID with extended data & include their Free Company information, if it has been synced.
character = await client.character_by_id(
lodestone_id=8255311,
extended=True,
include_freecompany=True
)
# Search Lodestone for a free company
freecompany = await client.freecompany_search(
world="gilgamesh",
name="Elysium"
)
# Item search with paging
item = await client.index_search(
name="Eden",
indexes=["Item"],
columns=["ID", "Name"],
filters=[
Filter("LevelItem", "gt", 520)
],
sort=Sort("LevelItem", False),
page=0,
per_page=10
)
# Fuzzy search XIVAPI game data for a recipe by name. Results will be in English.
recipe = await client.index_search(
name="Crimson Cider",
indexes=["Recipe"],
columns=["ID", "Name", "Icon", "ItemResult.Description"]
)
# Fuzzy search XIVAPI game data for a recipe by name. Results will be in French.
recipe = await client.index_search(
name="Cidre carmin",
indexes=["Recipe"],
columns=["ID", "Name", "Icon", "ItemResult.Description"],
language="fr"
)
# Get an item by its ID (Omega Rod) and return the data in German
item = await client.index_by_id(
index="Item",
content_id=23575,
columns=["ID", "Name", "Icon", "ItemUICategory.Name"],
language="de"
)
filters = [
Filter("ClassJobLevel", "gte", 0)
]
# Get non-npc actions matching a given term (Defiance)
action = await client.index_search(
name="Defiance",
indexes=["Action", "PvPAction", "CraftAction"],
columns=["ID", "Name", "Icon", "Description", "ClassJobCategory.Name", "ClassJobLevel", "ActionCategory.Name"],
filters=filters,
string_algo="match"
)
# Search ingame data for matches against a given query. Includes item, minion, mount & achievement descriptions, quest dialog & more.
lore = await client.lore_search(
query="Shiva",
language="fr"
)
# Search for an item using specific filters
filters = [
Filter("LevelItem", "gte", 100)
]
sort = Sort("LevelItem", True)
item = await client.index_search(
name="Omega Rod",
indexes=["Item"],
columns=["ID", "Name", "Icon", "Description", "LevelItem"],
filters=filters,
sort=sort,
language="de"
)
await client.session.close()
if __name__ == '__main__':
logging.basicConfig(level=logging.INFO, format='%(message)s', datefmt='%H:%M')
loop = asyncio.get_event_loop()
loop.run_until_complete(fetch_example_results())
```