Skip to main content

Typed pypercache-based wrapper for the public Valorant API.

Project description

Valorant Assets API

A typed Python wrapper for the public Valorant API, built on pypercache.

Features

  • Typed @apimodel schema resources for the main /v1 endpoints
  • Built-in response caching via pypercache
  • UUID lookups and collection methods
  • Convenience helpers for playable agents, name-based lookup, active events, current season, and flattened contract rewards
  • Convenience helpers for downloading assets and finding their path on disk
  • Optional request logging

Install

pip install valorant-assets-api

For local development:

pip install -e .[test]

Usage

from valorant_assets_api import ValorantAPI

api = ValorantAPI()

for agent in api.list_agents(playable_only=True):
    print(agent.display_name, "-", agent.role.display_name if agent.role else "No role")

current_season = api.get_current_season()
version = api.get_version()

Documentation & Tutorial

Read the docs online, or start at docs/index.md for the Markdown version.

For a step-by-step walkthrough covering setup, localization, UUID lookups, convenience helpers, and cache configuration, see the tutorial notebook.

Endpoint Coverage

list_* and get_* methods map directly to public /v1 endpoints. Helper methods compose those calls into higher-level lookups.

Endpoint Collection Detail Helpers
/agents list_agents() get_agent() find_agent()
/buddies list_buddies() get_buddy() -
/bundles list_bundles() get_bundle() -
/ceremonies list_ceremonies() get_ceremony() -
/competitivetiers list_competitive_tiers() get_competitive_tier_set() -
/contenttiers list_content_tiers() get_content_tier() -
/contracts list_contracts() get_contract() list_contract_rewards()
/currencies list_currencies() get_currency() -
/events list_events() get_event() get_active_events()
/gamemodes list_gamemodes() get_gamemode() -
/gear list_gear() get_gear() -
/levelborders list_level_borders() get_level_border() -
/maps list_maps() get_map() find_map()
/missions list_missions() get_mission() -
/objectives list_objectives() get_objective() -
/playercards list_player_cards() get_player_card() -
/playertitles list_player_titles() get_player_title() -
/seasons list_seasons() get_season() get_current_season()
/sprays list_sprays() get_spray() -
/themes list_themes() get_theme() -
/weapons list_weapons() get_weapon() find_weapon()
/version - get_version() -

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_assets_api-0.1.2.tar.gz (24.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

valorant_assets_api-0.1.2-py3-none-any.whl (19.0 kB view details)

Uploaded Python 3

File details

Details for the file valorant_assets_api-0.1.2.tar.gz.

File metadata

  • Download URL: valorant_assets_api-0.1.2.tar.gz
  • Upload date:
  • Size: 24.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.13

File hashes

Hashes for valorant_assets_api-0.1.2.tar.gz
Algorithm Hash digest
SHA256 16c0abc3d5841b184bb5d515f71efb766ec1a44f54230d0118e4e4bb2e72d495
MD5 62aa03dfd529faac1eb14a4731e8a77e
BLAKE2b-256 20349d08dd46ccca80d72363e290169764ea16cff547ce5ec41fbd00e28d1ad4

See more details on using hashes here.

File details

Details for the file valorant_assets_api-0.1.2-py3-none-any.whl.

File metadata

File hashes

Hashes for valorant_assets_api-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 f3bd74b9b9fc2bbe2151e3274dcec900c2181d162995865d9b5d26836fdf2251
MD5 6516d0625676e472c4a5c15123347e03
BLAKE2b-256 df5ea3e9baf9a6512f0d2ab8c415521809bc7e27d3d64f60578361fb4129e16f

See more details on using hashes here.

Supported by

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