communitydragon/phizz

An auto-generated PHP library for Riot API

0.5.2 2026-03-25 21:29 UTC

Requires

• php: ^8.1
• ext-intl: *
• guzzlehttp/guzzle: ^7.0
• illuminate/contracts: ^10.0||^11.0||^12.0
• illuminate/support: ^10.0||^11.0||^12.0
• spatie/laravel-package-tools: ^1.0

Requires (Dev)

• cebe/php-openapi: ^1.8
• laravel/pint: ^1.0
• nette/php-generator: ^4.2
• nunomaduro/collision: ^6.4||^7.0||^8.0
• orchestra/testbench: ^8.0||^9.0||^10.0|^11.0
• pestphp/pest: ^1.23||^2.0||^3.0||^4.0
• phpstan/phpstan: ^2.1
• symfony/console: ^6.4||^7.0||^8.0
• symfony/filesystem: ^6.4||^7.0||^8.0
• symfony/finder: ^6.4||^7.0||^8.0
• symfony/yaml: ^6.4||^7.0||^8.0

MIT

• Sandi Karajic

• laravel
• communitydragon
• phizz

README

A type-safe, auto-generated Laravel client for the Riot Games API. Covers League of Legends, Teamfight Tactics, Legends of Runeterra, Valorant, and Riftbound — generated directly from official OpenAPI schemas with built-in caching, proactive rate limiting, and automatic regional routing.

Requirements

• PHP >= 8.1
• Laravel >= 10

Installation

composer require communitydragon/phizz

Publish the config file:

php artisan vendor:publish --tag="phizz-config"

Add your Riot API key to .env:

RIOT_API_KEY=your-api-key-here
RIOT_DEFAULT_PLATFORM=na1

Usage

Access APIs through the Phizz facade. Each game exposes its own client.

use Phizz\Facades\Phizz;
use Phizz\Enums\Platform;
use Phizz\Enums\Regional;

// League of Legends
$match    = Phizz::lol()->matchV5->getMatch('EUW1_1234567890');
$summoner = Phizz::lol()->summonerV4->getByPuuid($puuid);
$mastery  = Phizz::lol()->championMasteryV4->getAllChampionMasteriesByPuuid($puuid);

// Per-call platform override
$match = Phizz::lol(Platform::EUW)->matchV5->getMatch('EUW1_1234567890');

// Teamfight Tactics
$tftMatch    = Phizz::tft()->matchV1->getMatch('EUW1_1234567890');
$tftLeague   = Phizz::tft()->leagueV1->getChallengerLeague();
$tftSummoner = Phizz::tft()->summonerV1->getByPuuid($puuid);

// Valorant
$valMatch       = Phizz::val()->matchV1->getMatch($matchId);
$valLeaderboard = Phizz::val()->rankedV1->getLeaderboard('e7a1');

// Legends of Runeterra
$lorMatch       = Phizz::lor()->matchV1->getMatch($matchId);
$lorLeaderboard = Phizz::lor()->rankedV1->getLeaderboards();

// Account (cross-game)
$account = Phizz::riot()->accountV1->getByRiotId(gameName: 'IAmTheWhite', tagLine: 'EUW');

Bypassing the cache

Every API method accepts a force parameter. When true, the request always hits the network and the cache is skipped entirely — nothing is read from it and nothing is written to it.

// Always fetches fresh data, even when caching is enabled
$match = Phizz::lol()->matchV5->getMatch('EUW1_1234567890', force: true);

Caching

Caching is enabled by default and uses your application's default cache store. The TTL applied to each response is resolved in this order:

1. Per-method override in config/phizz.php under cache.method[]
2. Global default (cache.default, 60 seconds)

Per-method TTLs are configured using the TTL class, which provides a chained constant syntax:

use Phizz\TTL;

// config/phizz.php
'cache' => [
    'enabled' => env('RIOT_CACHE_ENABLED', true),
    'store'   => env('RIOT_CACHE_STORE', null),
    'default' => env('RIOT_CACHE_TTL', 60),
    'method'  => [
        TTL::lol::matchV5::getMatch           => 86400, // matches — cache for 24 h
        TTL::lol::matchV5::getTimeline        => 86400,
        TTL::lol::summonerV4::getByPuuid      => 3600,  // slow-changing — 1 h
        TTL::lol::leagueV4::getChallengerLeague => 300, // rankings — 5 min
        TTL::lol::spectatorV5::getCurrentGameInfoByPuuid => 30, // live game — 30 s
    ],
],

Sane defaults for all endpoints across every game are shipped in the published config.

Retry strategy

Phizz automatically retries on 429 responses. Two built-in strategies are available:

use Phizz\Retry;

// Exponential backoff: 1 s, 2 s, 4 s, 8 s, ...  (default)
'retry' => ['strategy' => Retry::exponential()],

// Fixed delay between every attempt
'retry' => ['strategy' => Retry::fixed(seconds: 2)],

When a Retry-After header is present in the 429 response, Phizz always respects it over the configured strategy.

Rate limiting

Phizz tracks Riot's X-App-Rate-Limit and X-Method-Rate-Limit response headers and sleeps proactively before sending requests that would otherwise trigger a 429. Rate limit state is stored in the configured cache store and scoped per platform and endpoint.

Platforms & regions

use Phizz\Enums\Platform;    // na1, euw1, kr, br1, jp1, ...
use Phizz\Enums\Regional;    // Americas, Europe, Asia, SEA
use Phizz\Enums\ValPlatform; // NA, EU, AP, KR, BR, LatAm, Esports

Endpoints that require a regional host (e.g. match history) automatically convert a Platform to the correct Regional value — Platform::EUW becomes Regional::Europe transparently.

Supported APIs

Cross-game (riot)

API	Version
Account	V1

League of Legends (lol)

API	Version
Challenges	V1
Champion Mastery	V4
Champion	V3
Clash	V1
League EXP	V4
League	V4
Match	V5
RSO Match	V1
Spectator	V5
Status	V4
Summoner	V4
Tournament Stub	V5
Tournament	V5

Teamfight Tactics (tft)

API	Version
League	V1
Match	V1
Spectator	V5
Status	V1
Summoner	V1

Valorant (val)

API	Version
Console Match	V1
Console Ranked	V1
Content	V1
Match	V1
Ranked	V1
Status	V1

Legends of Runeterra (lor)

API	Version
Deck	V1
Inventory	V1
Match	V1
Ranked	V1
Status	V1

Riftbound (riftbound)

API	Version
Content	V1

Configuration reference

// config/phizz.php
return [
    // Your Riot Games API key
    'api_key' => env('RIOT_API_KEY', ''),

    // Default platform used when none is specified per-call
    'default_platform' => env('RIOT_DEFAULT_PLATFORM', Platform::NA),

    // Maximum seconds to wait for a response before timing out
    'timeout' => env('RIOT_TIMEOUT', 60),

    // Retry strategy on 429 responses
    'retry' => [
        'strategy' => Retry::exponential(),
    ],

    // Response caching
    'cache' => [
        'enabled' => env('RIOT_CACHE_ENABLED', true),
        'store'   => env('RIOT_CACHE_STORE', null),   // null = app default
        'default' => env('RIOT_CACHE_TTL', 60),       // fallback TTL in seconds
        'method'  => [
            // Per-endpoint TTL overrides using TTL constants
            TTL::lol::matchV5::getMatch => 86400,
            // ...
        ],
    ],

    // Log all requests and responses (useful for debugging)
    'logging' => [
        'enabled' => env('RIOT_LOGGING_ENABLED', false),
    ],
];

Testing

composer test           # run the full test suite
composer test-coverage  # run tests with coverage report
composer analyse        # run PHPStan static analysis
composer format         # run Laravel Pint code formatter

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

• Sandi Karajic
• All Contributors

License

The MIT License (MIT). Please see License File for more information.