Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Invisi/python-gw2

Open more actions menu

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

61 Commits
61 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

python-gw2

A Python wrapper for easy and typed access of Guild Wars 2's API.

Installation

Requirements

  • Python >= 3.11
  • httpx
  • pydantic

Since this project is currently not released on PyPi, the easiest way of installing it is as follows:

# With poetry
$ poetry add git+https://github.com/Invisi/python-gw2.git
# With pip
$ pip install git+https://github.com/Invisi/python-gw2.git#egg=gw2

Basic usage

from gw2.api import Account, Character, Recipes

async with Account() as client:
    # Authenticates *this instance* for this endpoint
    client.auth("ABCDE-...")
    data = await client.get()

    print(data.commander)  # True
    print(data.last_modified)  # a datetime instance

async with Account() as client:
    # Authenticate for this instance and all following instances
    client.global_auth("ABCDE-...")
    data = await client.get()

    print(data.last_modified)  # still a datetime instance

async with Character("Some Character") as client:
    # Retrieve data with previously set API key
    data = await client.get()

    print(data.profession)  # "Elementalist"
async for recipe in Recipes().many(ids=[1,2,3,4]):
    # Retrieve recipes as async iterator
    print(recipe)

# ...

Supported endpoints

  • (The asset CDN for the build id in case the API is down)
Big list of endpoints
  • /v2.json
  • /v2/account/*
  • /v2/achievements
  • /v2/achievements/categories
  • /v2/achievements/groups
  • /v2/backstory/*
  • /v2/build
  • /v2/characters/* (with some exceptions)
  • /v2/colors
  • /v2/continents/*
  • /v2/currencies
  • /v2/dailycrafting
  • /v2/dungeons
  • /v2/emblem/(backgrounds, foregrounds)
  • /v2/emotes
  • /v2/files
  • /v2/finishers
  • /v2/gliders
  • /v2/guild/:id/*
  • /v2/guild/(permissions, search, upgrades)
  • /v2/home/(cats, nodes)
  • /v2/items
  • /v2/itemstats
  • /v2/legendaryarmory
  • /v2/legends
  • /v2/mailcarriers
  • /v2/mapchests
  • /v2/maps
  • /v2/masteries
  • /v2/materials
  • /v2/minis
  • /v2/mounts/(skins, types)
  • /v2/novelties
  • /v2/outfits
  • /v2/pets
  • /v2/professions
  • /v2/pvp/*
  • /v2/quaggans
  • /v2/quests
  • /v2/races
  • /v2/raids
  • /v2/recipes
  • /v2/recipes/search
  • /v2/skills
  • /v2/skins
  • /v2/specializations
  • /v2/stories
  • /v2/stories/seasons
  • /v2/titles
  • /v2/tokeninfo
  • /v2/worldbosses
  • /v2/worlds
  • /v2/wvw/*

Planned features

  • ID-based caching
  • Rate limiting with burst and automatic handling for 429
  • The other endpoints I potentially forgot about
Another big list of endpoints
  • /v2/achievements/(daily, tomorrow)
  • /v2/createsubtoken
  • /v2/commerce/*

Missing features/endpoints

  • /v2/characters/:id/(heropoints, training)
    • Returns nonsense or simply nothing
  • /v2/characters/:id/(skills, specializations)
    • Deprecated, use buildtabs instead
  • /v2/matches/stats/:id/teams
    • Dead on arrival, never seen actual data here

License

MIT

About

An async Python wrapper for the GW2 API

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

Morty Proxy This is a proxified and sanitized view of the page, visit original site.