> ## Documentation Index
> Fetch the complete documentation index at: https://proclubs-sdk.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Clubs

> Search for clubs and retrieve club information and aggregate statistics.

## `clubs.search`

Find clubs by name.

```ts theme={null}
const clubs = await proclubs.clubs.search({
  name: 'HEMLE FC',
  platform: 'common-gen5',
})
```

<ParamField path="name" type="string" required>
  Club name, trimmed by the SDK. Must contain from 1 through 32 characters.
</ParamField>

<ParamField path="platform" type="Platform">
  Optional per-request platform override.
</ParamField>

<ResponseField name="result" type="Promise<ClubSummary[]>">
  Matching clubs. Known fields include `clubId`, `clubName`, `platform`, `wins`,
  `losses`, `ties`, `gamesPlayed`, `gamesPlayedPlayoff`, `goals`, `goalsAgainst`,
  `cleanSheets`, `points`, `reputationtier`, `promotions`, `relegations`,
  `bestDivision`, `currentDivision`, and `clubInfo` (with `customKit`). When
  nested `clubInfo` includes a `regionId`, the SDK also adds `regionLabel` for
  known regions. See [Regions](/docs/reference/regions).
</ResponseField>

## `clubs.playoffAchievements`

Get a club's playoff performance history.

```ts theme={null}
const achievements = await proclubs.clubs.playoffAchievements({
  clubId: '12345',
})
```

<ParamField path="clubId" type="string | number" required>
  Non-empty club identifier.
</ParamField>

<ParamField path="platform" type="Platform">
  Optional per-request platform override.
</ParamField>

<ResponseField name="result" type="Promise<PlayoffAchievement[]>">
  One entry per season, in EA response order. The raw `seasonId`,
  `seasonName`, `bestDivision`, and `bestFinishGroup` values are preserved.
  The SDK also adds `seasonLabel`, `divisionLabel`, and `finishLabel` when it
  can resolve them. Nested `clubInfo` uses the same fields and region-label
  enrichment as the other club responses. If EA supplies a field with the same
  name as a derived label, the raw field is preserved and the resolved value is
  available under `derivedLabels`. For a raw `clubInfo.regionLabel`, the
  calculated region label is available under `clubInfo.derivedLabels.regionLabel`.
</ResponseField>

<Note>
  A club without playoff history returns `[]`, not an error. Unknown season,
  division, and result IDs remain available in the raw fields. Season labels
  fall back to `Season {seasonId}` when EA introduces a new internal season key
  and `seasonId` is a finite number or digits-only string. Otherwise, the SDK
  returns the normalized `seasonName` when available, or `undefined`.
</Note>

## `clubs.get`

Get information for one club.

```ts theme={null}
const club = await proclubs.clubs.get({ clubId: '12345' })
```

<ParamField path="clubId" type="string | integer" required>
  Non-empty club identifier.
</ParamField>

<ParamField path="platform" type="Platform">
  Optional per-request platform override.
</ParamField>

<ResponseField name="result" type="Promise<ClubInfo | null>">
  The selected club or `null`. The SDK unwraps the upstream index map (`{ [clubId]: ClubInfo }`)
  to return the `ClubInfo` resource directly. Known fields include `clubId`, `name`, `regionId`,
  `regionLabel`, `teamId`, and `customKit` (with stadium name, kit IDs, kit colors, crest asset ID).
  `regionId` is the raw EA value. `regionLabel` is derived by the SDK when the ID is known.
  See [Regions](/docs/reference/regions).
</ResponseField>

## `clubs.overallStats`

Get the aggregate record for one club.

```ts theme={null}
const stats = await proclubs.clubs.overallStats({ clubId: 12345 })
```

<ParamField path="clubId" type="string | integer" required>
  Non-empty club identifier.
</ParamField>

<ParamField path="platform" type="Platform">
  Optional per-request platform override.
</ParamField>

<ResponseField name="result" type="Promise<ClubOverallStats | null>">
  The selected aggregate record or `null`. The SDK finds the matching record by club ID.
  Known fields include `clubId`, `wins`, `losses`, `ties`, `gamesPlayed`,
  `gamesPlayedPlayoff`, `goals`, `goalsAgainst`, `promotions`, `relegations`,
  `bestDivision`, `bestFinishGroup`, `skillRating`, `reputationtier`,
  `leagueAppearances`, streak stats (`wstreak`, `unbeatenstreak`), and recent match history (`lastMatch0..9`, `lastOpponent0..9`).
</ResponseField>

<Note>
  Numeric statistics can arrive from EA as a string, number, or `null`. The SDK
  preserves that upstream representation.
</Note>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.