ExClash is an Elixir library for working with Supercell's Clash of Clans API.

Docs

This material is unofficial and is not endorsed by Supercell. For more information see Supercell's Fan Content Policy.

The package can be installed by adding ex_clash to your list of dependencies in mix.exs:

def deps do
  [
    {:ex_clash, "~> 1.0"}
  ]
end

• HTTP requests are made using Req.
• Due to the aforementioned dependency, this library requires the use of at least Elixir v1.12 or newer. At time of building, Elixir v1.16 was used.
• A developer account at https://developer.clashofclans.com/ is required so you can acquire An API Token for authorized use of Supercell's API.

• Add your token to any [ENV].secret.exs and start using this library.

  config :ex_clash, token: "YOUR SUPER SECRET TOKEN"

• Get well-defined structs back from responses instead of parsing maps with string keys.
• HTTP functions are available to make your own API requests. Just use ExClash.HTTP.get/2 which will handle auth, the url, and query params for you.
• Not sure if feature; this library is not going to tell you if you got a parameter wrong in your Keyword list. It'll just forward it along to Req to consume, who will just attach it as a query param and Supercell's API will ignore it. 🤷

TODO: Provide copious examples of usage of this library.

Endpoints with ✅ have been implemented. All requests are GET requests except for the one that is labelled "POST."

• ✅ /clans
• ✅ /clans/{clanTag}
• /clans/{clanTag}/capitalraidseasons
• /clans/{clanTag}/members
• /clans/{clanTag}/warlog
• /clans/{clanTag}/currentwar
• /clans/{clanTag}/currentwar/leaguegroup
• /clanwarleagues/wars/{warTag}

• /players/{playerTag}
• /players/{playerTag}/verifytoken (POST)

• /capitalleagues
• /capitalleagues/{leagueId}
• /leagues
• /leagues/{leagueId}
• /leagues/{leagueId}/seasons
• /leagues/{leagueId}/seasons/{seasonId}
• /builderbaseleagues
• /builderbaseleagues/{leagueId}
• /warleagues
• /warleagues/{leagueId}

• /locations
• /locations/{locationId}
• /locations/{locationId}/rankings/clans
• /locations/{locationId}/rankings/players
• /locations/{locationId}/rankings/players-builder-base
• /locations/{locationId}/rankings/clans-builder-base
• /locations/{locationId}/rankings/capitals

• /goldpass/seasons/current

Currently, Supercell does not have any Esports related API endpoints. I'm including this category here because they have the category in their developer portal.

• /labels/players
• /labels/clans