{"id":15141507,"url":"https://github.com/natoune/royale-api","last_synced_at":"2026-01-20T14:33:25.228Z","repository":{"id":221537935,"uuid":"754670900","full_name":"Natoune/royale-api","owner":"Natoune","description":"A wrapper for the Clash Royale API.","archived":false,"fork":false,"pushed_at":"2024-02-08T15:26:23.000Z","size":8,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-07-02T09:10:51.482Z","etag":null,"topics":["clash","clash-royale","clash-royale-api","clashroyale","supercell"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","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/Natoune.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2024-02-08T14:45:54.000Z","updated_at":"2024-02-08T14:54:15.000Z","dependencies_parsed_at":"2024-02-08T15:59:22.250Z","dependency_job_id":"0ef01c31-1616-461e-b2b2-c9be14ffdbcf","html_url":"https://github.com/Natoune/royale-api","commit_stats":null,"previous_names":["natoune/royale-api"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/Natoune/royale-api","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Natoune%2Froyale-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Natoune%2Froyale-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Natoune%2Froyale-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Natoune%2Froyale-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Natoune","download_url":"https://codeload.github.com/Natoune/royale-api/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Natoune%2Froyale-api/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28604924,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-20T12:01:53.233Z","status":"ssl_error","status_checked_at":"2026-01-20T12:01:46.545Z","response_time":117,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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","clash-royale","clash-royale-api","clashroyale","supercell"],"created_at":"2024-09-26T09:01:06.739Z","updated_at":"2026-01-20T14:33:25.212Z","avatar_url":"https://github.com/Natoune.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Clash Royale API for NPM\n\n![NPM Downloads](https://img.shields.io/npm/dm/royale-api)\n![NPM License](https://img.shields.io/npm/l/royale-api)\n\nA wrapper for the [Clash Royale API](https://developer.clashroyale.com).  \nThis package is not affiliated with [Supercell](https://supercell.com/) or [RoyaleAPI](https://royaleapi.com/).\n\n## Getting a token\n\nTo use Clash Royale API for NPM, you need to get an API token from the [Clash Royale Developer Portal](https://developer.clashroyale.com).  \nYou can also use another API provider like [RoyaleAPI](https://docs.royaleapi.com/).\n\n## Usage\n\nFirst, install the package using NPM or your favorite package manager:\n\n```bash\nnpm install royale-api\n```\n\nUsage example:\n\n```javascript\nconst RoyaleAPI = require(\"royale-api\");\n\nconst cr = new RoyaleAPI(\"token\");\n\ncr.getPlayer(\"#AAAAAAAA\").then((player) =\u003e {\n\tconsole.log(player);\n});\n```\n\n## Methods\n\nThere is one method for each endpoint of the Clash Royale API (see [documentation](https://developer.clashroyale.com/#/documentation)):\n\n### Clans\n\n-   `getClanWarLog(clanTag: string, options?: object): Promise\u003cobject\u003e`\n-   `getClans(options?: object): Promise\u003cobject\u003e`\n-   `getClanRiverRaceLog(clanTag: string, options?: object): Promise\u003cobject\u003e`\n-   `getClanCurrentWar(clanTag: string): Promise\u003cobject\u003e`\n-   `getClan(clanTag: string): Promise\u003cobject\u003e`\n-   `getClanMembers(clanTag: string, options?: object): Promise\u003cobject\u003e`\n-   `getClanCurrentRiverRace(clanTag: string): Promise\u003cobject\u003e`\n\n### Players\n\n-   `getPlayer(playerTag: string): Promise\u003cobject\u003e`\n-   `getPlayerUpcomingChests(playerTag: string): Promise\u003cobject\u003e`\n-   `getPlayerBattleLog(playerTag: string): Promise\u003cobject\u003e`\n\n### Cards\n\n-   `getCards(options?: object): Promise\u003cobject\u003e`\n\n### Tournaments\n\n-   `getTournaments(options?: object): Promise\u003cobject\u003e`\n-   `getTournament(tournamentTag: string): Promise\u003cobject\u003e`\n\n### Locations\n\n-   `getLocationClanRankings(locationId: number, options?: object): Promise\u003cobject\u003e`\n-   `getLocationPlayerRankings(locationId: number, options?: object): Promise\u003cobject\u003e`\n-   `getLocationClanWarRankings(locationId: number, options?: object): Promise\u003cobject\u003e`\n-   `getSeasonPathOfLegends(seasonId: string, options?: object): Promise\u003cobject\u003e`\n-   `getSeason(seasonId: string): Promise\u003cobject\u003e`\n-   `getSeasonPlayerRankings(seasonId: string, options?: object): Promise\u003cobject\u003e`\n-   `getSeasons(): Promise\u003cobject\u003e`\n-   `getLocations(options?: object): Promise\u003cobject\u003e`\n-   `getSeasonsV2(): Promise\u003cobject\u003e`\n-   `getLocation(locationId: number): Promise\u003cobject\u003e`\n-   `getGlobalTournamentRankings(tournamentTag: string, options?: object): Promise\u003cobject\u003e`\n-   `getLocationPathOfLegends(locationId: number, options?: object): Promise\u003cobject\u003e`\n\n### Challenges\n\n-   `getChallenges(): Promise\u003cobject\u003e`\n\n### Global Tournaments\n\n-   `getGlobalTournaments(): Promise\u003cobject\u003e`\n\n## Contributing\n\nContributions to the \"royale-api\" project are welcome. To contribute, follow these steps:\n\n1. Fork the repository\n2. Create a new branch: `git checkout -b feature/my-feature`\n3. Make your changes and commit them: `git commit -m \"Add my feature\"`\n4. Push your changes to the branch: `git push origin feature/my-feature`\n5. Open a pull request\n\n## License\n\nThis project is licensed under the [MIT License](LICENSE.md).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnatoune%2Froyale-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnatoune%2Froyale-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnatoune%2Froyale-api/lists"}