Skip to main content

An unofficial synchronous client package for interacting with Riot Games' Valorant API endpoints.

Project description

valorant.py

GitHub Actions valorant on PyPI Downloads License Code style: black Contribute

valorant.py is an unofficial API wrapper for Riot Games' Valorant API endpoints. It's modern, easy to use, feature-rich, and intuitive! Implemented with object oriented designs and explicit reloads to prevent 429s, valorant.py is the best Valorant API wrapper out there!

Bulletin Board

Most recent version: 0.5.0 (🎉)

Changes:

  • Internal redesign of HTTP requests
  • Updates to error handling for Client and AsyncClient
  • A few bug fixes (👍)
  • References: #24, #20, #23

Coming Soon: Endpoint coverage for matches!

Installation

Manager Command
PIP pip install valorant
Poetry python -m poetry add valorant
Easy Install easy_install valorant

Usage

Quickstart:

import valorant

KEY = "RGAPI-Key-Here"
client = valorant.Client(KEY)

agents = client.get_characters()

for agent in agents:
    print(agent.name)

Asynchronous Client:

import valorant

KEY = "RGAPI-Key-Here"
client = valorant.AsyncClient(KEY)

async def _main():
    agents = await client.get_characters()

    for agent in agents:
        print(agent.name)

valorant.run(_main())

Local Client:

This is intended for use with the game locally. Eases the use of doing things like getting live match data, chat sessions, friend requests, etc. Doesn't need an access key. The current Local Client is a work-in-progress and is unstable.

import valorant

client = valorant.LocalClient()

print(client.get_session())

Documentation

The public API documentation for valorant.py is hosted here.

If you're making edits to the documentation, you can generate the HTML and start a local server by running bash bin/docs.sh in the repository directory. This requires Ruby 2.5 or higher (Sorry if you have to install Ruby just to edit the docs =P).

Contributing

  1. Fork the repository: Fork
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -a -m 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request! 🎉

You can also re-create these steps with GitHub Desktop, Visual Studio Code, or whatever git version control UI you prefer. You don't have to, but I use prefixes for all my commits (i.e ✨: add asyncio run to package namespace). I have a personal style guide that I use, which you can find here.

Final Note

Thanks for taking the time to check out valorant.py! 🎉

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

valorant-0.5.1.tar.gz (9.5 kB view details)

Uploaded Source

Built Distribution

valorant-0.5.1-py3-none-any.whl (9.7 kB view details)

Uploaded Python 3

File details

Details for the file valorant-0.5.1.tar.gz.

File metadata

  • Download URL: valorant-0.5.1.tar.gz
  • Upload date:
  • Size: 9.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/3.10.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.2 CPython/3.8.12

File hashes

Hashes for valorant-0.5.1.tar.gz
Algorithm Hash digest
SHA256 2a4124c173968d863fca90bb4695524524e7c277cf1ce5f2b29c558799ba0801
MD5 991929baf0c81c76e05924ec29074ebb
BLAKE2b-256 0fd9d5f7ef67e0cb5876262d8cb74d31e2d9afe2f6e1be6ed0663edcee5e6099

See more details on using hashes here.

File details

Details for the file valorant-0.5.1-py3-none-any.whl.

File metadata

  • Download URL: valorant-0.5.1-py3-none-any.whl
  • Upload date:
  • Size: 9.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/3.10.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.2 CPython/3.8.12

File hashes

Hashes for valorant-0.5.1-py3-none-any.whl
Algorithm Hash digest
SHA256 71ca14ffc14d8f5bf5be8116d74bf1c373cbe5844cb99384f6715fcd576a0d1e
MD5 8e290d65d9807dc92f3de907cd2cb1be
BLAKE2b-256 7844c33202aa9c2dd2cf5f65484b6bb69a4e4bfdf7885ed3877372c440e12f85

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page