{"openapi":"3.1.0","info":{"title":"BrawlToolsAPI","description":"\n### BrawlTools API\n- No Auth Required, Free to Use\n- Please credit if using these stats in your project\n- Free plan is rate-limited. Token plans may have higher limits depending on plan/scope.\n- Largely 120 seconds cache\n- Not perfect, stats are collected by polling the Official API\n- [BrawlTools Discord](https://discord.gg/eXxMdPtzSX)\n\nThis content is not affiliated with, endorsed, sponsored, or specifically approved by Supercell and Supercell is not responsible for it.\nFor more information see [Supercell’s Fan Content Policy](https://supercell.com/fan-content-policy)\n","version":"1.2.0"},"paths":{"/generate-api-keys":{"post":{"tags":["Utility"],"summary":"Generate Api-Keys (Official Api)","operationId":"Generate_API_Keys__Official_API__generate_api_keys_post","parameters":[{"name":"ip","in":"query","required":true,"schema":{"type":"string","title":"Ip"}},{"name":"email","in":"query","required":true,"schema":{"type":"string","title":"Email"}},{"name":"password","in":"query","required":true,"schema":{"type":"string","title":"Password"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/brawlers":{"get":{"tags":["Brawlers"],"summary":"Get List Of Available Brawlers","operationId":"Get_list_of_available_brawlers_brawlers_get","parameters":[{"name":"api_key","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Api Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/brawlers/{brawlerId}":{"get":{"tags":["Brawlers"],"summary":"Get Information About A Brawler","operationId":"Get_information_about_a_brawler_brawlers__brawlerId__get","parameters":[{"name":"brawlerId","in":"path","required":true,"schema":{"type":"integer","title":"Brawlerid"}},{"name":"api_key","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Api Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/brawlers/{brawlerId}/bestbuild":{"get":{"tags":["Brawlers"],"summary":"💎 Get Best Build Information About A Brawler","operationId":"__Get_Best_build_information_about_a_brawler_brawlers__brawlerId__bestbuild_get","parameters":[{"name":"brawlerId","in":"path","required":true,"schema":{"type":"integer","title":"Brawlerid"}},{"name":"api_key","in":"query","required":true,"schema":{"type":"string","title":"Api Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/players/search":{"get":{"tags":["Players"],"summary":"Search Players By Name Or Tag","operationId":"Search_players_by_name_or_tag_players_search_get","parameters":[{"name":"name","in":"query","required":true,"schema":{"type":"string","minLength":2,"title":"Name"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":250,"minimum":1,"default":50,"title":"Limit"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":0,"default":0,"title":"Offset"}},{"name":"api_key","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Api Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/players/{tag}":{"get":{"tags":["Players"],"summary":"Get Player Information","operationId":"Get_player_information_players__tag__get","parameters":[{"name":"tag","in":"path","required":true,"schema":{"type":"string","title":"Tag"}},{"name":"api_key","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Api Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/players/{tag}/battlelog":{"get":{"tags":["Players"],"summary":"Get Log Of Recent Battle For A Player.","operationId":"Get_log_of_recent_battle_for_a_player__players__tag__battlelog_get","parameters":[{"name":"tag","in":"path","required":true,"schema":{"type":"string","title":"Tag"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","default":25,"title":"Limit"}},{"name":"api_key","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Api Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/players/{tag}/log":{"get":{"tags":["Players"],"summary":"💎 Get Player Log Information","operationId":"__Get_player_log_information_players__tag__log_get","parameters":[{"name":"tag","in":"path","required":true,"schema":{"type":"string","title":"Tag"}},{"name":"api_key","in":"query","required":true,"schema":{"type":"string","title":"Api Key"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","default":25,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/players/{tag}/history":{"get":{"tags":["Players"],"summary":"💎 Get Player History Information","operationId":"__Get_player_history_information_players__tag__history_get","parameters":[{"name":"tag","in":"path","required":true,"schema":{"type":"string","title":"Tag"}},{"name":"api_key","in":"query","required":true,"schema":{"type":"string","title":"Api Key"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","default":25,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/players/{tag}/push":{"get":{"tags":["Players"],"summary":"💎 Get Player Push Information","operationId":"__Get_player_push_information_players__tag__push_get","parameters":[{"name":"tag","in":"path","required":true,"schema":{"type":"string","title":"Tag"}},{"name":"api_key","in":"query","required":true,"schema":{"type":"string","title":"Api Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/players/{tag}/image":{"get":{"tags":["Players"],"summary":"Get Player Images","description":"Options:\r\n\n1: Classic Player Image\r\n\n3: Detailed Brawler Image\r\n\n4: Brawler Ranks Image\r\n\n41: Brawler old Ranks Image\r\n\n6: Brawler Mastery (Historic) Image\r\n\n8: Brawler Trophy Image\r\n\n9: Brawler highest Trophy Image\r\n\n10: Player Season Progress Image\n13: Brawler highest Win Rate Image\r\n\n14: Brawler current Win Rate Image","operationId":"Get_player_images_players__tag__image_get","parameters":[{"name":"tag","in":"path","required":true,"schema":{"type":"string","title":"Tag"}},{"name":"option","in":"query","required":false,"schema":{"type":"integer","default":1,"title":"Option"}},{"name":"quality","in":"query","required":false,"schema":{"type":"string","default":"high","title":"Quality"}},{"name":"api_key","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Api Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/players/{tag}/chart":{"get":{"tags":["Players"],"summary":"Get Player Charts","description":"Options:\r\n\n1: Trophy Chart\r\n\n2: Activity Chart\r\n\n3: Monthly Activity Chart\r\n\n4: 3vs3 Wins Chart\r\n\n5: Solo Wins Chart\r\n\n6: Duo Wins Chart\r\n\n7: Mastery (Historic) Chart\r\n\n8: Fame Chart\r\n\n9: Records Chart","operationId":"Get_player_charts_players__tag__chart_get","parameters":[{"name":"tag","in":"path","required":true,"schema":{"type":"string","title":"Tag"}},{"name":"option","in":"query","required":false,"schema":{"type":"integer","default":1,"title":"Option"}},{"name":"api_key","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Api Key"}},{"name":"from","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"DD.MM.YY or DD.MM.YYYY","title":"From"},"description":"DD.MM.YY or DD.MM.YYYY"},{"name":"to","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"DD.MM.YY or DD.MM.YYYY","title":"To"},"description":"DD.MM.YY or DD.MM.YYYY"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/rankings/{countryCode}/clubs":{"get":{"tags":["Rankings"],"summary":"Get Club Rankings For A Country Or Global Rankings.","description":"Two letter country code, or 'global' for global rankings.","operationId":"Get_club_rankings_for_a_country_or_global_rankings__rankings__countryCode__clubs_get","parameters":[{"name":"countryCode","in":"path","required":true,"schema":{"type":"string","title":"Countrycode"}},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Limit"}},{"name":"api_key","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Api Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/rankings/{countryCode}/players":{"get":{"tags":["Rankings"],"summary":"Get Player Rankings For A Country Or Global Rankings.","description":"Two letter country code, or 'global' for global rankings.","operationId":"Get_player_rankings_for_a_country_or_global_rankings__rankings__countryCode__players_get","parameters":[{"name":"countryCode","in":"path","required":true,"schema":{"type":"string","title":"Countrycode"}},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Limit"}},{"name":"api_key","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Api Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/rankings/{countryCode}/brawlers/{brawlerId}":{"get":{"tags":["Rankings"],"summary":"Get Brawler Rankings For A Country Or Global Rankings.","description":"Two letter country code, or 'global' for global rankings.","operationId":"Get_brawler_rankings_for_a_country_or_global_rankings__rankings__countryCode__brawlers__brawlerId__get","parameters":[{"name":"countryCode","in":"path","required":true,"schema":{"type":"string","title":"Countrycode"}},{"name":"brawlerId","in":"path","required":true,"schema":{"type":"integer","title":"Brawlerid"}},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Limit"}},{"name":"api_key","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Api Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/game":{"get":{"tags":["Game Data"],"summary":"List Csv Files","operationId":"List_CSV_Files_game_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}},"/events":{"get":{"tags":["Events"],"summary":"Get List Of Active And Upcoming Events","operationId":"Get_list_of_active_and_upcoming_events_events_get","parameters":[{"name":"api_key","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Api Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/maps":{"get":{"tags":["Events"],"summary":"Get List Of All Maps.","operationId":"Get_list_of_all_Maps__maps_get","parameters":[{"name":"api_key","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Api Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/maps/{mapId}":{"get":{"tags":["Events"],"summary":"Get Information About A Map","operationId":"Get_information_about_a_Map_maps__mapId__get","parameters":[{"name":"mapId","in":"path","required":true,"schema":{"type":"integer","title":"Mapid"}},{"name":"api_key","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Api Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/clubs/search":{"get":{"tags":["Clubs"],"summary":"Search Clubs By Name Or Tag","operationId":"Search_clubs_by_name_or_tag_clubs_search_get","parameters":[{"name":"name","in":"query","required":true,"schema":{"type":"string","minLength":2,"title":"Name"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":250,"minimum":1,"default":50,"title":"Limit"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":0,"default":0,"title":"Offset"}},{"name":"api_key","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Api Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/clubs/{tag}":{"get":{"tags":["Clubs"],"summary":"Get Club Information","operationId":"Get_club_information_clubs__tag__get","parameters":[{"name":"tag","in":"path","required":true,"schema":{"type":"string","title":"Tag"}},{"name":"api_key","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Api Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/clubs/{tag}/log":{"get":{"tags":["Clubs"],"summary":"💎 Get Club Log Information","operationId":"__Get_club_log_information_clubs__tag__log_get","parameters":[{"name":"tag","in":"path","required":true,"schema":{"type":"string","title":"Tag"}},{"name":"api_key","in":"query","required":true,"schema":{"type":"string","title":"Api Key"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","default":25,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/clubs/{tag}/history":{"get":{"tags":["Clubs"],"summary":"💎 Get Club History Information","operationId":"__Get_club_history_information_clubs__tag__history_get","parameters":[{"name":"tag","in":"path","required":true,"schema":{"type":"string","title":"Tag"}},{"name":"api_key","in":"query","required":true,"schema":{"type":"string","title":"Api Key"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","default":25,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/clubs/{tag}/image":{"get":{"tags":["Clubs"],"summary":"Get Club Images","description":"Options:\r\n\n2: Classic Club Image\r\n\n200: Classic Club Image (Portrait Format)","operationId":"Get_Club_images_clubs__tag__image_get","parameters":[{"name":"tag","in":"path","required":true,"schema":{"type":"string","title":"Tag"}},{"name":"option","in":"query","required":false,"schema":{"type":"integer","default":2,"title":"Option"}},{"name":"quality","in":"query","required":false,"schema":{"type":"string","default":"high","title":"Quality"}},{"name":"api_key","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Api Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/clubs/{tag}/chart":{"get":{"tags":["Clubs"],"summary":"Get Club Charts","description":"Options:\r\n\n1: Trophy Chart\r\n\n2: Member Chart\r\n\n3: Member Wins Chart","operationId":"Get_Club_charts_clubs__tag__chart_get","parameters":[{"name":"tag","in":"path","required":true,"schema":{"type":"string","title":"Tag"}},{"name":"option","in":"query","required":false,"schema":{"type":"integer","default":1,"title":"Option"}},{"name":"api_key","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Api Key"}},{"name":"from","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"DD.MM.YY or DD.MM.YYYY","title":"From"},"description":"DD.MM.YY or DD.MM.YYYY"},{"name":"to","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"DD.MM.YY or DD.MM.YYYY","title":"To"},"description":"DD.MM.YY or DD.MM.YYYY"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}