Skip to content

schemas

schemas

Pydantic response models for the Clash of Clans API.

All fields are Optional with defaults to handle API variations gracefully. Models are based on real API responses captured February 2026.

Usage

from cocapi import CocApi, ApiConfig, Clan, Player

config = ApiConfig(use_pydantic_models=True) api = CocApi("token", config=config) clan = api.clan_tag("#2PP") # Returns Clan model print(clan.name, clan.clanLevel)

BadgeUrls

Bases: BaseModel

Clan badge image URLs in multiple sizes.

IconUrls

Bases: BaseModel

Icon image URLs for leagues, labels, and other entities.

Cursors

Bases: BaseModel

Pagination cursors for traversing list endpoints.

Paging

Bases: BaseModel

Paging metadata returned with paginated list responses.

PaginatedList

Bases: BaseModel, Generic[T]

Generic paginated response wrapper.

Location

Bases: BaseModel

A geographic location (country or region) used for rankings.

Label

Bases: BaseModel

A label that can be assigned to clans or players.

League

Bases: BaseModel

A player's trophy league (e.g. Legend League, Titan I).

LeagueTier

Bases: BaseModel

A tier within a league (sub-division).

CapitalLeague

Bases: BaseModel

Clan Capital league ranking.

BuilderBaseLeague

Bases: BaseModel

Builder Base league ranking.

WarLeague

Bases: BaseModel

Clan War League tier (e.g. Champion I, Master II).

LeagueSeason

Bases: BaseModel

A league season identifier (e.g. 2026-02).

ChatLanguage

Bases: BaseModel

A clan's configured chat language.

PlayerHouseElement

Bases: BaseModel

A single decorative element of a player's house.

PlayerHouse

Bases: BaseModel

Player house decoration data.

Troop

Bases: BaseModel

A troop in a player's army (home or builder village).

Hero

Bases: BaseModel

A hero unit (e.g. Barbarian King, Archer Queen).

HeroEquipment

Bases: BaseModel

Equipment item that can be assigned to a hero.

Spell

Bases: BaseModel

A spell in a player's spell factory.

Achievement

Bases: BaseModel

A player achievement with progress and star count.

PlayerClan

Bases: BaseModel

Compact clan info embedded in player responses.

LegendSeason

Bases: BaseModel

A single Legend League season result.

LegendStatistics

Bases: BaseModel

Legend League statistics including current, previous, and best seasons.

Player

Bases: BaseModel

Full player profile from the /players/{tag} endpoint.

VerifyTokenResponse

Bases: BaseModel

Response from the player token verification endpoint.

ClanMember

Bases: BaseModel

A member entry within a clan's member list.

ClanCapitalDistrict

Bases: BaseModel

A district within a clan's Clan Capital.

ClanCapital

Bases: BaseModel

Clan Capital data including hall level and districts.

Clan

Bases: BaseModel

Full clan profile from the /clans/{tag} endpoint.

ClanSearchEntry

Bases: BaseModel

Clan entry returned from the search endpoint (no memberList).

WarAttack

Bases: BaseModel

A single attack in a clan war.

WarMember

Bases: BaseModel

A clan member participating in a war.

WarClan

Bases: BaseModel

A clan's war data including members and attack summary.

ClanWar

Bases: BaseModel

Current or past clan war from the /clans/{tag}/currentwar endpoint.

ClanWarLogEntry

Bases: BaseModel

A single entry in a clan's war log.

ClanWarLeagueMember

Bases: BaseModel

A member in a Clan War League group.

ClanWarLeagueClan

Bases: BaseModel

A clan participating in a Clan War League group.

ClanWarLeagueRound

Bases: BaseModel

A round within a Clan War League season containing war tags.

ClanWarLeagueGroup

Bases: BaseModel

Full Clan War League group with clans and rounds.

ClanCapitalRaidSeasonMember

Bases: BaseModel

A member's participation in a Capital Raid season.

ClanCapitalRaidSeason

Bases: BaseModel

A Clan Capital raid season with attack/defense logs and rewards.

ClanRankingClan

Bases: BaseModel

Compact clan info in ranking entries.

ClanRankingEntry

Bases: BaseModel

A clan's entry in the trophy rankings leaderboard.

ClanBuilderBaseRankingEntry

Bases: BaseModel

A clan's entry in the Builder Base rankings leaderboard.

ClanCapitalRankingEntry

Bases: BaseModel

A clan's entry in the Clan Capital rankings leaderboard.

PlayerRankingEntry

Bases: BaseModel

A player's entry in the trophy rankings leaderboard.

PlayerBuilderBaseRankingEntry

Bases: BaseModel

A player's entry in the Builder Base rankings leaderboard.

GoldPassSeason

Bases: BaseModel

Current Gold Pass season start and end times.