https://github.com/reuhreuh/valorant-api-client
Simple Java Valorant client based on official Riot API
https://github.com/reuhreuh/valorant-api-client
java maven riot-games riot-games-api valorant valorant-api
Last synced: 20 days ago
JSON representation
Simple Java Valorant client based on official Riot API
- Host: GitHub
- URL: https://github.com/reuhreuh/valorant-api-client
- Owner: reuhreuh
- License: mit
- Created: 2022-04-09T14:53:35.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2025-03-05T08:52:45.000Z (about 2 months ago)
- Last Synced: 2025-03-05T09:36:13.098Z (about 2 months ago)
- Topics: java, maven, riot-games, riot-games-api, valorant, valorant-api
- Language: Java
- Homepage:
- Size: 195 KB
- Stars: 5
- Watchers: 2
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# valorant-api-client
Simple Java Valorant client consuming official [Riot API](https://developer.riotgames.com/apis).
## Status
| Type | Status |
| ---- | ------ |
| Build | [](https://github.com/reuhreuh/valorant-api-client/actions/workflows/maven-master.yml)|
| Quality | [](https://github.com/reuhreuh/valorant-api-client/actions/workflows/codeql.yml)|
| Javadoc | [](https://javadoc.io/doc/net.rr-world/valorant-api-client)|
| Tests | |
|Licence | [](https://github.com/reuhreuh/valorant-api-client/blob/master/LICENSE)|
## Features
`valorant-api-client` provides 1 to 1 SDK to read official Valorant Riot API. There is no data transformation, no statistics calculation at least for now...;)
So far following end-points are implemented:
`VAL-MATCH-V1`
- /val/match/v1/matches/{matchId}
- /val/match/v1/matchlists/by-puuid/{puuid}
The SDK also provides a set of Java Enums for Valorant model (with UUIDs used in API) for :
- Acts
- Agents
- Maps
- Regions
- Weapons
## Getting started
### Prerequisites
What you need is :
- A Valorant Riot API key
- Java 11 & Maven
### Installation
Import dependency in your `pom.xml` :
```xml
...
1.0.18
...
...
net.rr-world
valorant-api-client
${valorant.client.version}
...
```
### Usage
Just instanciate the client with API key and Region :
```java
ValorantClient client = new ValorantClient("RGAPI-XXX", Region.EU);
Match m = client.getMatch("de3dc2b3-7db8-4b96-8a8a-17e5cee8e634");
```
If you are in a Spring context, you may wish to initialize a bean using your `RestTemplate` instance :
```java
@Bean
public ValorantClient getClient(@Autowired RestTemplate restClient, @Value("${riot.api.key}") String apiKey) {
return new ValorantClient(apiKey, Region.EU, restClient);
}
```
## Documentation
Javadoc is available [here](https://javadoc.io/doc/net.rr-world/valorant-api-client/latest/index.html)
## Changelog
### v1.0.19 (TBD)
- ...
### v1.0.18 (2025-03-05)
- Add new agent `Waylay`
### v1.0.17 (2025-01-29)
- Add new Episode 10
- Add new agent `Tejo`
- Update `Pearl` coordinates
### v1.0.16 (2024-08-29)
- Add new agent `Vyse`
### v1.0.15 (2024-06-12)
- Add new Episode 9
- Add new map `Abyss`
### v1.0.14 (2024-03-27)
- Add new Agent `Clove`
### v1.0.13 (2024-01-10)
- Fix `Outlaw` identifier
### v1.0.12 (2024-01-10)
- Add new Episode 8
- Add new weapon `Outlaw`
- Add `PremierMatchInfo` attribute on `Match`
### v1.0.11 (2023-10-31)
- Add new Agent `Iso`
### v1.0.10 (2023-09-07)
- Add new Map `Sunset`
- Add `accountLevel` and `isObserver` mapping on `Player`
### v1.0.9 (2023-07-01)
- Add new Episode 7
- Add new Agent `Deadlock`
### v1.0.8 (2023-03-08)
- Add new Agent `Gekko`
### v1.0.7 (2023-02-19)
- Upgrade Spring version
- Use concrete classes for `RoundResult` few attributes (`bombDefuser`, `defusePlayerLocations`)
- Use one single object `Location`
### v1.0.6 (2023-01-11)
- Add Episode 6, with 3 new Acts
- Add new Map `Lotus`
### v1.0.5 (2022-11-07)
- Fix Harbor identifier
- Upgrade spring starter version
### v1.0.4 (2022-10-17)
- Add new Agent `Harbor`
### v1.0.3 (2022-06-22)
- Add new Episode 5
- Add new map `Pearl`
### v1.0.2 (2022-05-07)
- Add Agents role
- Add Chamber & Neon abilities/Ultimate as Weapon (as seen by Riot API)
### v1.0.1 (2022-04-27)
- Package refactoring
- Add new Enum value for `Fade` Agent
### v1.0.0 (2022-04-20)
- Init