{"id":15018369,"url":"https://github.com/kelmatou/leagueapi","last_synced_at":"2026-02-23T00:40:12.751Z","repository":{"id":33084159,"uuid":"142478095","full_name":"Kelmatou/LeagueAPI","owner":"Kelmatou","description":"League of Legends API \u0026 Data Framework in Swift","archived":false,"fork":false,"pushed_at":"2022-02-09T11:31:17.000Z","size":39755,"stargazers_count":57,"open_issues_count":1,"forks_count":13,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-01-30T20:29:12.672Z","etag":null,"topics":["clash","framework","ios","league","league-api","league-of-legends","leagueapi","leagueoflegends","riot-api","riot-games","riot-games-api","riotgames","runnetera","swift5","teamfight-tactics"],"latest_commit_sha":null,"homepage":"","language":"Swift","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Kelmatou.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-07-26T18:19:05.000Z","updated_at":"2025-01-13T00:33:30.000Z","dependencies_parsed_at":"2022-08-03T07:01:37.289Z","dependency_job_id":null,"html_url":"https://github.com/Kelmatou/LeagueAPI","commit_stats":null,"previous_names":[],"tags_count":22,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Kelmatou%2FLeagueAPI","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Kelmatou%2FLeagueAPI/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Kelmatou%2FLeagueAPI/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Kelmatou%2FLeagueAPI/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Kelmatou","download_url":"https://codeload.github.com/Kelmatou/LeagueAPI/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":237869238,"owners_count":19379288,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["clash","framework","ios","league","league-api","league-of-legends","leagueapi","leagueoflegends","riot-api","riot-games","riot-games-api","riotgames","runnetera","swift5","teamfight-tactics"],"created_at":"2024-09-24T19:51:53.342Z","updated_at":"2026-02-23T00:40:12.654Z","avatar_url":"https://github.com/Kelmatou.png","language":"Swift","readme":"# LeagueAPI - Documentation\n\n[![Build Status](https://travis-ci.com/Kelmatou/LeagueAPI.svg?branch=master)](https://travis-ci.org/Kelmatou/LeagueAPI)\n[![CocoaPods Compatible](https://img.shields.io/cocoapods/v/LeagueAPI.svg)](https://img.shields.io/cocoapods/v/LeagueAPI.svg)\n[![Carthage Compatible](https://img.shields.io/badge/Carthage-compatible-4BC51D.svg?style=flat)](https://github.com/Carthage/Carthage)\n[![Platform](https://img.shields.io/cocoapods/p/LeagueAPI.svg?style=flat)](https://github.com/Kelmatou/LeagueAPI)\n[![MIT Licensed](https://img.shields.io/badge/license-MIT-green.svg)](https://github.com/Kelmatou/LeagueAPI/blob/master/LICENSE)\n\n\u003cp align=\"center\"\u003e\n \u003cimg width=\"200\" src=\"https://github.com/Kelmatou/LeagueAPI/blob/master/screenshots/devices.png\"\u003e\n\u003c/p\u003e\nLeague API is a League of Legends Framework in Swift. It provides an easy way to get League's data into your iOS, WatchOS, TvOS and MacOS \u0026 Linux application.  \n\nIt is designed to be easy to use, taking advantage of Swift enums. It also comes with some internal mechanisms, to handle any API key rate limit. \n\n**Support League of Legends, Clash, Teamfight Tactics and League of Runnetera APIs**\n\n\u003cimg width=\"200\" src=\"https://github.com/Kelmatou/LeagueAPI/blob/master/screenshots/homepage.png\"\u003e \u003cimg width=\"200\" src=\"https://github.com/Kelmatou/LeagueAPI/blob/master/screenshots/live_game.gif\"\u003e \u003cimg width=\"200\" src=\"https://github.com/Kelmatou/LeagueAPI/blob/master/screenshots/history.gif\"\u003e \u003cimg width=\"200\" src=\"https://github.com/Kelmatou/LeagueAPI/blob/master/screenshots/champion_info.png\"\u003e\n\n## 🚧 Installation 🚧\n\n### CocoaPods\n\n* Go in your project, in the folder where is located *YourProject.xcodeproj*.\n* Run `pod init`.\n* Open Podfile for editing (do not use Textedit as it will insert invalid characters).\n* Right under \"use_frameworks!\", write `pod 'LeagueAPI'`.\n* Run `pod install`.\n* A *YourProject.xcworkspace* was created. From now, you should open this file instead of *YourProject.xcodeproj*.\n* If you can write `import LeagueAPI` in your project without compiler error, you're done. Great job! If it is not the case, you can open an issue so that I can look at your problem.\n\n### Carthage\n\n* Go in your project, in the folder where is located *YourProject.xcodeproj*.\n* Create a file named *Cartfile* and write `github \"Kelmatou/LeagueAPI\"` in it.\n* Run `carthage bootstrap --platform iOS --use-xcframeworks` in Terminal (for Xcode \u003c 12, you don't necessarily need to add --use-xcframeworks).\n* Open *YourProject.xcodeproj* and go to target General settings.\n* Add LeagueAPI.framework in Embedded Binaries (located at Carthage/Build/LeagueAPI.xcframework).\n* If you can write `import LeagueAPI` in your project without compiler error, you're done. Great job! If it is not the case, read the troubleshooting section below.\n\n### Manual\n* Download a Release version [here](https://github.com/Kelmatou/LeagueAPI/releases) (or Github content but you may get a version with experimental changes).\n* Open *LeagueAPI/LeagueAPI.xcodeproj*.\n* Select LeagueAPI-Release scheme and build it (play button or cmd+b) for your desired platform (Simulator or iOS Generic Device).\n* In the Project Navigator, you'll find a folder Products with *LeagueAPI.framework*. Drag and drop it in your project general settings -\u003e Embedded Binaries.\n* If you can write `import LeagueAPI` in your project without compiler error, you're done. Great job! If you encounter a problem on this step, check if you selected the same platform as LeagueAPI.framework in you project's destination target (Simulator or iOS device). If it does not solve your problem, read the troubleshooting section below.\n\n### Troubleshooting\n\nThis section lists the main solutions to be able to `import LeagueAPI` in your project.\n\n* Go back to your project, target settings -\u003e Build Settings -\u003e Framework Search Paths, then add the path to LeagueAPI.framework.\n\nIf none of these helped you, open an issue describing your problem and I'll try to check it out as soon as possible.\n\n\n## 📋 Requirements 📋\n\n### 📦 Minimum versions 📦\n\n📱 iOS 9.0  \n⌚ WatchOS 2.0  \n📺 TvOS 9.0  \n💻 MacOS 10.9 (Mavericks)  \n\n### 🔑 Riot API Key 🔑\n\nTo use LeagueAPI, you'll require a Riot API Key.\nYou'll get one by visiting https://developer.riotgames.com. Create an account and on you dashboard, you'll be able to generate your key.\nBy default, Riot will generate a 'Development Key', which expires in 24h. When your application is ready to be deployed and respects Riot API usage conditions, you can apply for a 'Production Key'.\nPlease note that you should agree with [Riot API usage policy](https://developer.riotgames.com/policies.html)\n\n## 😈 First Blood 😈\n\nStarting using this framework requires you to create an instance of LeagueAPI by writing:\n\n`let league = LeagueAPI(APIToken: \"*INSERT YOUR KEY HERE*\")`\n\nNow use this instance everywhere, you shouldn't recreate the LeagueAPI variable.\n\n## 🧐 And then? 🧐\n\nLeagueAPI is divided in 4 different APIs:\n* Riot API\n* League of Legends API\n* Team Fight Tactics API\n* Legends of Runnetera API\n\n### Riot API\n\nRiot API returns information about Riot Games accounts for each player.  \nIt is accessible from `league.riotAPI`. From there you'll access the methods for:\n\n* [Riot Accounts](https://github.com/Kelmatou/LeagueAPI/wiki/Riot-Accounts)\n\n### League of Legends API\n\nLeague of Legends API contains methods related to League of Legends game.  \nIt is accessible through `league.lolAPI`. From there you'll get information about:\n\n**League of Legends**\n* [Summoners](https://github.com/Kelmatou/LeagueAPI/wiki/Summoners)\n* [Spectator/Live Game](https://github.com/Kelmatou/LeagueAPI/wiki/Spectator---Live-Game)\n* [Ranked/Leagues](https://github.com/Kelmatou/LeagueAPI/wiki/Ranked---Leagues)\n* [Ranked/Leagues EXP](https://github.com/Kelmatou/LeagueAPI/wiki/Ranked-Leagues---EXP)\n* [Match History](https://github.com/Kelmatou/LeagueAPI/wiki/Match-History)\n* [Champion Mastery](https://github.com/Kelmatou/LeagueAPI/wiki/Champion-Mastery)\n* [Champions](https://github.com/Kelmatou/LeagueAPI/wiki/Champions)\n* [Server Status](https://github.com/Kelmatou/LeagueAPI/wiki/Status)\n* [Verification Code](https://github.com/Kelmatou/LeagueAPI/wiki/Verification-Code)\n* [Tournament Stub](https://github.com/Kelmatou/LeagueAPI/wiki/Tournament-Stub)\n* [Tournaments](https://github.com/Kelmatou/LeagueAPI/wiki/Tournaments)\n* [Patch](https://github.com/Kelmatou/LeagueAPI/wiki/Patch)\n* [Profile Icons](https://github.com/Kelmatou/LeagueAPI/wiki/Profile-Icons)\n* [Items](https://github.com/Kelmatou/LeagueAPI/wiki/Items)\n* [Summoner Spells](https://github.com/Kelmatou/LeagueAPI/wiki/Summoner-Spells)\n* [Runes](https://github.com/Kelmatou/LeagueAPI/wiki/Runes)\n* [Ranked Tier](https://github.com/Kelmatou/LeagueAPI/wiki/Ranked-Tiers)\n* [Champions Detailed](https://github.com/Kelmatou/LeagueAPI/wiki/Champions-(Detailed)) **- deprecated from 3.0.0**\n\n**Clash**\n* [Clash](https://github.com/Kelmatou/LeagueAPI/wiki/Clash)\n\n### Teamfight Tactics\n\nTeamfight Tactics API contains methods related to Teamfight Tactics game.  \nIt is accessible through `league.tftAPI`. From there you'll find information for:\n\n* [Summoners](https://github.com/Kelmatou/LeagueAPI/wiki/TFT-Summoners)\n* [Ranked](https://github.com/Kelmatou/LeagueAPI/wiki/TFT-Ranked-Leagues)\n* [Match History](https://github.com/Kelmatou/LeagueAPI/wiki/TFT-Match-History)\n* [Items](https://github.com/Kelmatou/LeagueAPI/wiki/TFT-Items)\n* [Champions](https://github.com/Kelmatou/LeagueAPI/wiki/TFT-Champions)\n* [Traits](https://github.com/Kelmatou/LeagueAPI/wiki/TFT-Traits)\n\n### Legends of Runnetera\n\nLegends of Runnetera API contains methods related to Leagueof Runnetera game.  \nIt is accessible through `league.lorAPI`. From there you'll get information about:\n\n* [Ranked](https://github.com/Kelmatou/LeagueAPI/wiki/Runnetera-Ranked)\n\nFull documentation is available [here](https://github.com/Kelmatou/LeagueAPI/wiki).  \nNote that only the last release will appear in the documentation. See previous revisions for older LeagueAPI versions.\n\n## Make LeagueAPI Grow Up!\n\nIf anything you wanted was missing, do not hesitate to open an issue or create a pull request. It could help future developers.\nIf you found LeagueAPI helpful or cool to use don't hesitate to promote it by adding a ⭐️ 😉\n\n## Contributors\n\nAntoine Clop ([Kelmatou](https://github.com/Kelmatou))  \nRonan Cendrier ([Hanoki](https://github.com/Hanoki))  \nAmmon Parry ([AmmonP](https://github.com/AmmonP))  \nSandi Karajic ([SKarajic](https://github.com/SKarajic))\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkelmatou%2Fleagueapi","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkelmatou%2Fleagueapi","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkelmatou%2Fleagueapi/lists"}