royaleapi / cr-api-docs Goto Github PK

• RoyaleAPI/cr-api#237
• RoyaleAPI/cr-api#240

This is the current documentation for ratelimits.

• Royale War Stats
• https://royalewarstats.com
• Munsterlander
• <munsterlander#4174>
• Access quick visualizations of your clan and member activity regarding the clan war as well as other battles played. Quickly identify who contributes and who should be kicked.

The 429 (too many requests) is not listed.

From @henrywkk on August 10, 2018 8:27

Issue Report:

Under the doc for clan war (https://docs.royaleapi.com/#/endpoints/clan_war), the state in Matchmaking sample should be "matchmaking" instead of "collectionDay" (https://docs.royaleapi.com/json/clan_war_80LCC09P.json)

Copied from original issue: RoyaleAPI/cr-api#418

• Link: https://github.com/Blind-Striker/clash-royale-client-dotnet
• Author: Deniz İrgin
• https://github.com/Blind-Striker
• https://twitter.com/denizirgin
• Discord username of author: Blind-Striker#9013
• Description:

P.E.K.K.A is a client library targeting .NET Standard 2.0 and .NET 4.6.1 that provides an easy way to interact with both official Clash Royale API and unofficial public API Royale API

From @Alpha185 on July 4, 2018 23:16

Show every clan member in the war list, even who never participated:

Who never participated in a clan war is not showing up at the list, I propose that if a player is part of the clan and doesn't participate at a war then you mark a dash "-" at the space provided for the medal icon.
This way I know who's being inactive
If the player was not at the clan then you leave it blank

https://royaleapi.com/clan/UR9290J/war/analytics

Copied from original issue: RoyaleAPI/cr-api#402

https://docs.royaleapi.com/#/endpoints/player_battles
Description says "This endpoint return battles played by one or more player profiles."

https://docs.royaleapi.com/#/endpoints/player_chests
Description also says "This endpoint return battles played by one or more player profiles."

It's 100% the same as /top/clans in terms of how to use it.
So a simple copy-pasta. :)

RoyaleAPI/cr-api#313 (comment)

From @fourjr on February 13, 2018 8:43

If you try and load up a /popular/players or /clan/search endpoint, the time it takes for the API response is quite long.

With the maxResults parameter, one could specify that they would only want the first result. This would not only save API resources but optimise our programs.

Copied from original issue: RoyaleAPI/cr-api#237

From @Tithanium on June 18, 2018 16:31

Usually, the query with enpoints
https://api.royaleapi.com/tournaments/open?prep=1
returns 100 open tournements...

but it would be great to have an enpoint such as :
https://api.royaleapi.com/tournaments/open?notfull=1
to get tournaments tag that are not full from the API data.
or
https://api.royaleapi.com/tournaments/open?emptyslots=10
to get tournaments tag that have at least 10 empty slots ?

Would it be possible ?
Thanks again for all this work.

Copied from original issue: RoyaleAPI/cr-api#369

From @mwolverine63 on March 20, 2018 3:58

In the documentation, it states that you can list multiple player tags in one request.

However, it does not make it clear that this is treated as multiple requests at once -- I made the mistake of listing the top 200 player tags in this 'one' request, without realizing I was overloading the server.

Copied from original issue: RoyaleAPI/cr-api#285

• Name of app: Royale Verify
• Link to Name of app: https://discordapp.com/oauth2/authorize?client_id=475712000635305994&permissions=268627008&scope=bot
• Author(s) of app: nikoskon
• Link(s) to author(s) of app: https://twitter.com/nikoskon03
• Discord username(s) of author(s): nikoskon#6100
• Description: A bot that verifies users based on their Clash Royale account

• Name of app (e.g. MyAwesomeBot): Clash Royale Clan War Tracker
• Link to Name of app (e.g. http://github.com/bot/MyAwesomeBot): royalewartracker.com
• Author(s) of app (e.g. SomeAuthor): Brian Kates
• Link(s) to author(s) of app (e.g. http://github.com/SomeAuthor): https://www.linkedin.com/in/briankates/
• Discord username(s) of author(s) <SomeAuthor#1234>bek816#6393
• Description (e.g. My awesome Discord bot using cr-api): Track and analyze all of your clan wars! Identify your clan MVPs!

In the Discord server, Selfish announced that the /auth/stats is now active again. The docs currently say differently

From @Samisage on March 6, 2018 15:54

Name of App: Clanstats (NOTE: Currently designed for the clan "Chapsters" but these are early stages.)
Link: http://samisage.com/app/clanstats/
Authors: Samisage, bobbob (aka. Ujimaflip), ma
Link to Author: http://samisage.com
Discord Usernames: Samisage#7684 , ujimaflip#9369 , ma#7333

Description:

Features of this website for the clan "Chapsters", Includes:

Graphs of users combined stats,
Clickable user names to see stats of specific user,
Utilities for members of the clan,
Leader board on the front page.

[All Stats are updated every 5 minutes and are stored in a database so if the API isn't working the latest data will be shown.]

Graphs example:
http://samisage.com/u/15.50.20-06.03.18.leader
http://samisage.com/u/15.50.34-06.03.18.timeline

If you're not in the Chapsters clan, consider checking it out or check back in a while to see if we've changed the way the website works.

Copied from original issue: RoyaleAPI/cr-api#273

• Name of app (statistics clans)
• Link to Name of app (http://andrestapia.000webhostapp.com/clash.php?tag_clan=90purqrq)
• Author(s) of app (andres tapia)
• Link(s) to author(s) of app (http://andrestapia.000webhostapp.com)
• Discord username(s) of author(s)
• Description (to get clan statistics)

From @fourjr on February 13, 2018 10:13

/auth/stats is now only returning the lastRequest which is basically the current time, and thus making this endpoint useless

{
  "id": "180314310298304512",
  "lastRequest": 1514173190,
  "requestCount": {
    "2017-12-25": 2,
    "2017-12-27": 6,
    "2017-12-29": 5,
    "2017-12-30": 16,
    "2018-01-02": 60,
    "2018-01-03": 198,
    "2018-01-04": 291,
    "2018-01-05": 1,
    "2018-01-06": 8,
    "2018-01-07": 44,
    "2018-01-08": 23,
    "2018-01-09": 247,
    "2018-01-10": 232,
    "2018-01-11": 288,
    "2018-01-12": 207,
    "2018-01-13": 297,
    "2018-01-14": 306,
    "2018-01-15": 321,
    "2018-01-16": 295,
    "2018-01-17": 344,
    "2018-01-18": 319,
    "2018-01-19": 265,
    "2018-01-20": 306,
    "2018-01-21": 289,
    "2018-01-22": 431,
    "2018-01-23": 353,
    "2018-01-24": 269,
    "2018-01-25": 283
  }
}

This was an example of what data it used to give

Copied from original issue: RoyaleAPI/cr-api#240

From @paoloalby on February 28, 2018 8:9

Issue Report:

1. I noticed that the json from clan/xxxxx/history now gives only the last 7 days and no more.
2. Expected behaviour: since yesterday, I can track donation, trophies, etc of my clanmate for last months, and not only last week

You changed it, and from now, it will be in this way, or it's a temporary bug ?

Copied from original issue: RoyaleAPI/cr-api#262

From @ZeNeLLiE on July 26, 2018 2:19

https://api.royaleapi.com/tournaments/search?name=b

type is not returned. ("open", "passwordProtected")

Expected:

[
{
"tag": "20CVYRV8",
"type": "open",
"status": "inPreparation",
"creatorTag": "#99Y90URP8",
"name": "Andrei Geanta",
"maxCapacity": 50,
"preparationDuration": 7200,
"duration": 3600,
"createTime": 1520249970,
"startTime": null,
"endTime": null,
"playerCount": 50,
"members": []
},
{
"tag": "C9LRLP0",
"type": "passwordProtected",
"status": "inProgress",
"creatorTag": "#989G8QLCG",
"name": "ali",
"description": "vous pouvez pas rejoindre",
"maxCapacity": 100,
"preparationDuration": 7200,
"duration": 3600,
"createTime": 1520251673,
"startTime": null,
"endTime": null,
"playerCount": 29,
"members": []
},
]

Actual:

{
"tag": "29CV0PQG",
"name": "bora jogar",
"open": true,
"maxPlayers": 50,
"currentPlayers": 50,
"status": "inProgress",
"createTime": 1532564781,
"prepTime": 7200,
"startTime": null,
"endTime": null,
"duration": 3600,
"description": "entra quem quiser",
"updatedAt": 1532571124,
"members": []
},

Copied from original issue: RoyaleAPI/cr-api#413

• Link: https://github.com/Altarrel/goroyale
• Author: Altarrel
• Link to author: https://github.com/Altarrel
• Discord username of author: Altarrel#1083
• Description: A wrapper for RoyaleAPI written in Go (Golang).
  • Easy access to endpoints through methods in goroyale.Client
  • Simple ratelimit handling where a special error is returned (RatelimitError) with an attribute RetryAfter representing how long to wait before running another request.
  • Field Filter and other query parameters through a url.Values or map[string][]string object passed to endpoint methods.

Responses needs updating.

use /player/:tag/battles and .../chests

From @BlackHoleFox on April 7, 2018 19:53

Url: https://docs.royaleapi.com/#/endpoints/player_chests

The link that 404's is the "You can see an implementation of this at https://royaleapi.com/player/L88P2282/chests" part, clicking the referenced link leads to a 404 page. Probably not the best thing to be in docs.

Copied from original issue: RoyaleAPI/cr-api-ux#56

Name of app: Royale Verify
Link to Name of app: https://github.com/nikoskon2003/royale-verify
Author(s) of app: nikoskon
links(s) to author(s) of app: https://twitter.com/nikoskon03 , https://github.com/nikoskon2003
Discord username(s) of author(s): nikoskon#6100
Description: A bot that verifies users based on their Clash Royale account

• Name of app: Clash Royale Helper
• Play Store: https://play.google.com/store/apps/details?id=clashroyalehelper.joaopinho.com.clashroyalehelper
• Author of app: João Pinho
• Link to author of app: https://play.google.com/store/apps/developer?id=Jo%C3%A3o+Pinho
• Email contact: [email protected]
• Facebook Page: https://www.facebook.com/ClashRoyaleHelperApp
• Discord username of author: Pincha#4048
• Description: Clash Royale Helper is an application with the purpose to help users of Clash Royale management their accounts.
  With Clash Royale Helper, you can:
  -> Create decks as many as you want.
  -> See your deck list when you want.
  -> Export your decks whenever you want to the game Clash Royale. So the slot decks in game will never be an problem now. You can save decks for all events and game plays that you want and export them when necessary.
  -> Import decks from Clash Royale game to the Clash Royale App.
  -> You can copy one deck from the "Deck List" to "Deck Builder" in order to create a similar deck fastest and very simpler.
  -> Delete decks.

Feel free to customize more than one deck for each special event too.

If i have to provide more information feel free to sent me an email ;)

Thank you for your awesome api

Website : http://howsmyclan.com/
Author: Sagi Yehuday.
Discord User Name: Yael
Description :
Find out who the most valuable members of your clan are using simple indicators.
Find open joinable Tournaments using cr-api real-time data.

Clan search API is wrongly given instead of tournament search API.

Can this kindly be changed to
https://api.royaleapi.com/tournament/search?name=

From @xlucasfelix on February 26, 2018 11:49

• Clash Royale Dicas Stats
• https://www.clashroyaledicas.com/stats/
• play.google.com/store/apps/details?id=com.clashdicas.clashroyaledicas (will be added to the app soon)
• Lucas Felix (developed by Reginaldo P.)
• https://twitter.com/ClashDicas
• ClashDicas - ClashDicas - Lucas Felix#1019
• Profile statistics tool for the Brazilian Clash Royale community

Copied from original issue: RoyaleAPI/cr-api#258

• Name of app: Sakura Stats
• Link to app: https://goo.gl/Ssuymh
• Author: DeadlyAlive
• Discord username: <DeadlyAlive#7229 >
• Description:
  Clan war data collection and war forecast!
  Post any ideas or feedback: https://goo.gl/P7fvJn

On this page:

https://docs.royaleapi.com/#/endpoints/clan_war

The collection day and war day full JSON responses are backwards.

On this page:

https://docs.royaleapi.com/#/endpoints/clan_warlog

The full JSON response is the same as the one for the previous page. https://docs.royaleapi.com/json/clan_war_9LPVG9UC.json and as such, doesn't have all the data.

- Name of app - Clash Royale War Assistat
- Link to Name of app - https://play.google.com/store/apps/details?id=com.abhiinteractive.clashroyalewarassistant
- Author(s) of app - Abhijeet
- Discord username(s) of author(s) - Abhi#3574
- Description - Check yours and other competitor war clan details, performance of your clan in last 10 wars(total counts for no of wins, cards, etc. for each member helping you decide whom to promote or kick if you're a leader), war battles of your clan(copy a winners deck for yourself), get notified to attack, and lot lot more!

After testing my error handling, I noticed that x-ratelimit-retry-after is in what looks like microseconds.
The docs says seconds (https://docs.royaleapi.com/#/faq).

Testing in Postman I get:

x-ratelimit-limit →5
x-ratelimit-remaining →0
x-ratelimit-retry-after →129

Right after, I request again and I get:

x-ratelimit-limit →5
x-ratelimit-remaining →4

also include note thta history isnt tracked until requested

Name: Clan Activity Statistics

Link: https://jsfiddle.net/wbcf8jz3/17/

Description: A tiny fiddle that shows 10 best & worst members of a clan based on war wins & war participation in the last 10 wars, and donations in the last 2 weeks. You can use it for suggestions on who to promote or demote. Feedback welcome.

Author: haulin#1030

Many JSON response examples from the documentation are outdated or missing information. I'd like to see updated especially the player and clan JSON responses.

In this table in the Player Verification endpoint the parameter is listed as PLAYER_API_TOKEN when the parameter's name is actually just token.

From @mlieshoff on May 12, 2018 10:46

Could you please provide a documentation of all current response headers, because it's getting more and more confusing to get track them via the discord chat.

Copied from original issue: RoyaleAPI/cr-api#316

Clicking "Full JSON response" on https://docs.royaleapi.com/#/endpoints/popular_decks will lead to a 404.

From @nelsonalmendra on February 26, 2018 12:51

• Name of app: Clash Royale Chest Tracker
• Link to Name of app: https://play.google.com/store/apps/details?id=com.nelsonalmendra.clashroyalechesttracker
• Author(s) of app: Nelson Almendra
• Link(s) to author(s) of app: https://twitter.com/NelsonAlmendra
• Discord username(s) of author(s): Illusionpt
• Description: Simple way to keep tracking of the next chests.

Copied from original issue: RoyaleAPI/cr-api#259

• Name of app: chest tracker
• Link to Name of app: after publish app to store, we will send link for you.
• Author(s) of app: AnhNT, LongLD
• Link(s) to author(s) of app: https://github.com/ssPerman01
• Discord username(s) of author(s)
• Description: We want build app android (maybe both IOS):

• check chest for user
• open tourament
• clan statistics

• Name of app : Chest Cycle Tracker

• Link to Name of app : https://play.google.com/store/apps/details?id=in.sidheart.clashroyalechestcycle

• Author(s) of app : Sid-Heart

• Link(s) to author(s) of app : https://github.com/sid-heart

• Discord username(s) of author(s) : Mystic#0137

• Description : See your Clash Royale stats, next chest, war details and much more!

• Name of app : Spell Comparator Clash Royale
• Link to Name of app :
  • iOS : https://itunes.apple.com/us/app/spell-comparator-clash-royale/id1424483560
  • Android : https://play.google.com/store/apps/details?id=com.clashroyalespells
• Author(s) of app :
  • Jordan Montel
  • Romain Capelli
• Link(s) to author(s) of app : https://www.facebook.com/SpellComparator/
• Discord username(s) of author(s) :
  • T0yBoy#7309
  • illou#5455
• Description :
  • Spell Comparator for Clash Royale is the ideal application to know the combination of the damage that your spells can do according to the level of your cards on the other units!

Name of app - CR Tracker for Chests
Link to Name of app - https://play.google.com/store/apps/details?id=com.abhiinteractive.crtrackerforchests
Author of app - Abhi Interactive
Link to author of app - https://github.com/Abhijeet589
Discord username of author - Abhi#3574
Description - A simple app to help you know about your upcoming and special chests

Not sure when this was changed but none of the side bar items link anywhere anymore:

https://docs.royaleapi.com/#/authentication