A python wrapper around clash of clans api
Project description
ClashOfClansAPI
Python Wrapper for SuperCells Clash Of Clans API
Get Token from https://developer.clashofclans.com/
Install
pip install cocapi
Features and usage examples
Initialize
Required to set up the class
from cocapi import CocApi token = 'YOUR_API_TOKEN' timeout=1 #requests timeout api=CocApi(token,timeout)
Clans
Information about a Clan
api.clan_tag(tag) #example tag "#9UOVJJ9J"
Click to view output
{ "warLeague": { "name": {}, "id": 0 }, "memberList": [ { "league": { "name": {}, "id": 0, "iconUrls": {} }, "tag": "string", "name": "string", "role": "string", "expLevel": 0, "clanRank": 0, "previousClanRank": 0, "donations": 0, "donationsReceived": 0, "trophies": 0, "versusTrophies": 0 } ], "isWarLogPublic": true, "tag": "string", "warFrequency": "string", "clanLevel": 0, "warWinStreak": 0, "warWins": 0, "warTies": 0, "warLosses": 0, "clanPoints": 0, "clanVersusPoints": 0, "requiredTrophies": 0, "name": "string", "location": { "localizedName": "string", "id": 0, "name": "string", "isCountry": true, "countryCode": "string" }, "type": "string", "members": 0, "labels": [ { "name": {}, "id": 0, "iconUrls": {} } ], "description": "string", "badgeUrls": {} }
Members Only
api.clan_members(tag)
returns membersList information from api.clan_tag(tag) under "items" in dict
War Log Information
api.clan_war_log(tag)
Click to view output
{items: [ { "clan": { "destructionPercentage": {}, "tag": "string", "name": "string", "badgeUrls": {}, "clanLevel": 0, "attacks": 0, "stars": 0, "expEarned": 0, "members": [ { "tag": "string", "name": "string", "mapPosition": 0, "townhallLevel": 0, "opponentAttacks": 0, "bestOpponentAttack": { "order": 0, "attackerTag": "string", "defenderTag": "string", "stars": 0, "destructionPercentage": 0 }, "attacks": [ { "order": 0, "attackerTag": "string", "defenderTag": "string", "stars": 0, "destructionPercentage": 0 } ] } ] }, "teamSize": 0, "opponent": { "destructionPercentage": {}, "tag": "string", "name": "string", "badgeUrls": {}, "clanLevel": 0, "attacks": 0, "stars": 0, "expEarned": 0, "members": [ { "tag": "string", "name": "string", "mapPosition": 0, "townhallLevel": 0, "opponentAttacks": 0, "bestOpponentAttack": { "order": 0, "attackerTag": "string", "defenderTag": "string", "stars": 0, "destructionPercentage": 0 }, "attacks": [ { "order": 0, "attackerTag": "string", "defenderTag": "string", "stars": 0, "destructionPercentage": 0 } ] } ] }, "endTime": "string", "result": "string" } ], "paging": {'cursors': {}} }
Current War Information
api.clan_current_war(tag)
Click to view output
{ "clan": { "destructionPercentage": {}, "tag": "string", "name": "string", "badgeUrls": {}, "clanLevel": 0, "attacks": 0, "stars": 0, "expEarned": 0, "members": [ { "tag": "string", "name": "string", "mapPosition": 0, "townhallLevel": 0, "opponentAttacks": 0, "bestOpponentAttack": { "order": 0, "attackerTag": "string", "defenderTag": "string", "stars": 0, "destructionPercentage": 0 }, "attacks": [ { "order": 0, "attackerTag": "string", "defenderTag": "string", "stars": 0, "destructionPercentage": 0 } ] } ] }, "teamSize": 0, "opponent": { "destructionPercentage": {}, "tag": "string", "name": "string", "badgeUrls": {}, "clanLevel": 0, "attacks": 0, "stars": 0, "expEarned": 0, "members": [ { "tag": "string", "name": "string", "mapPosition": 0, "townhallLevel": 0, "opponentAttacks": 0, "bestOpponentAttack": { "order": 0, "attackerTag": "string", "defenderTag": "string", "stars": 0, "destructionPercentage": 0 }, "attacks": [ { "order": 0, "attackerTag": "string", "defenderTag": "string", "stars": 0, "destructionPercentage": 0 } ] } ] }, "startTime": "string", "state": "string", "endTime": "string", "preparationStartTime": "string" }
Clan League Group Information
api.clan_leaguegroup(tag)
Click to view output
{ "tag": "string", "state": "string", "season": "string", "clans": [ { "tag": "string", "clanLevel": 0, "name": "string", "members": [ { "tag": "string", "townHallLevel": 0, "name": "string" } ], "badgeUrls": {} } ], "rounds": [ { "warTags": [ "string" ] } ] }
Warleague Information
api.clan_warleague(war_tag)
Click to view output
{ "tag": "string", "state": "string", "season": "string", "clans": [ { "tag": "string", "clanLevel": 0, "name": "string", "members": [ { "tag": "string", "townHallLevel": 0, "name": "string" } ], "badgeUrls": {} } ], "rounds": [ { "warTags": [ "string" ] } ] }
Player
Player information
api.players(player_tag) #for example "#900PUCPV"
Click to view output
{ "clan": { "tag": "string", "clanLevel": 0, "name": "string", "badgeUrls": {} }, "league": { "name": {}, "id": 0, "iconUrls": {} }, "townHallWeaponLevel": 0, "versusBattleWins": 0, "legendStatistics": { "previousSeason": { "trophies": 0, "id": "string", "rank": 0 }, "previousVersusSeason": { "trophies": 0, "id": "string", "rank": 0 }, "bestVersusSeason": { "trophies": 0, "id": "string", "rank": 0 }, "legendTrophies": 0, "currentSeason": { "trophies": 0, "id": "string", "rank": 0 }, "bestSeason": { "trophies": 0, "id": "string", "rank": 0 } }, "troops": [ { "level": 0, "name": {}, "maxLevel": 0, "village": "string" } ], "heroes": [ { "level": 0, "name": {}, "maxLevel": 0, "village": "string" } ], "spells": [ { "level": 0, "name": {}, "maxLevel": 0, "village": "string" } ], "role": "string", "attackWins": 0, "defenseWins": 0, "townHallLevel": 0, "labels": [ { "name": {}, "id": 0, "iconUrls": {} } ], "tag": "string", "name": "string", "expLevel": 0, "trophies": 0, "bestTrophies": 0, "donations": 0, "donationsReceived": 0, "builderHallLevel": 0, "versusTrophies": 0, "bestVersusTrophies": 0, "warStars": 0, "achievements": [ { "stars": 0, "value": 0, "name": {}, "target": 0, "info": {}, "completionInfo": {}, "village": "string" } ], "versusBattleWinCount": 0 }
Locations
All Locations Information
api.location()
Click to view output
{"items": [ { "localizedName": "string", "id": 0, "name": "string", "isCountry": true, "countryCode": "string" } ], "paging": {'cursors': {}} }
Information for a Single Location
api.location_id(location_tag) #for example "32000047"
returns the above information for a single location
Top Clans in a Location
api.location_id_clan_rank(location_tag)
Top 200 clans in a given location
Click to view output
{"items": [ { "clanLevel": 0, "clanPoints": 0, "location": { "localizedName": "string", "id": 0, "name": "string", "isCountry": true, "countryCode": "string" }, "members": 0, "tag": "string", "name": "string", "rank": 0, "previousRank": 0, "badgeUrls": {} } ], "paging": {'cursors': {}} }
Top Players in a Location
api.clan_leaguegroup(location_tag)
Top 200 players in a given location
Click to view output
{"items": [ { "clan": { "tag": "string", "name": "string", "badgeUrls": {} }, "league": { "name": {}, "id": 0, "iconUrls": {} }, "attackWins": 0, "defenseWins": 0, "tag": "string", "name": "string", "expLevel": 0, "rank": 0, "previousRank": 0, "trophies": 0 } ], "paging": {'cursors': {}} }
Top Versus Clans in a Location
api.location_clan_versus(location_tag)
Top 200 versus clans in a given location
Click to view output
{"items": [ { "clanPoints": 0, "clanVersusPoints": 0 } ], "paging": {'cursors': {}} }
Top Versus Players in a Location
api.location_player_versus(location_tag)
Top 200 versus players in a given location
Click to view output
{"items": [ { "clan": { "tag": "string", "name": "string", "badgeUrls": {} }, "versusBattleWins": 0, "tag": "string", "name": "string", "expLevel": 0, "rank": 0, "previousRank": 0, "versusTrophies": 0 } ], "paging": {'cursors': {}} }
Leagues
List leagues
api.league()
Click to view output
{"items": [ { "name": {}, "id": 0, "iconUrls": {} } ], "paging": {'cursors': {}} }
League Information
api.league_id(league_tag)
Click to view output
{ "name": {}, "id": 0, "iconUrls": {} }
List Season Leagues
api.league_season(league_tag)
Information is available only for Legend League
Click to view output
{"items": [ { "id": "string" } ], "paging": {'cursors': {}} }
League Season Ranking
api.league_season_id(league_tag, season_tag)
Information is available only for Legend League
Click to view output
{"items": [ { "clan": { "tag": "string", "name": "string", "badgeUrls": {} }, "league": { "name": {}, "id": 0, "iconUrls": {} }, "attackWins": 0, "defenseWins": 0, "tag": "string", "name": "string", "expLevel": 0, "rank": 0, "previousRank": 0, "trophies": 0 } ], "paging": {'cursors': {}} }
Labels
List Clan Labels
api.clan_leaguegroup(tag)
Click to view output
{"items": [ { "name": {}, "id": 0, "iconUrls": {} } ], "paging": {'cursors': {}} }
List Player Labels
api.labels_players()
Click to view output
{"items": [ { "name": {}, "id": 0, "iconUrls": {} } ], "paging": {'cursors': {}} }
Credits
Note versions below 2.0.0 are not supported anymore
*DISCLAIMER: cocapi is not affiliated with SuperCell©.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.