Skip to main content

Interface: ClanSearchOptions

Clan search options for a request.

If name is used as part of search query, it needs to be at least three characters long. Name search parameter is interpreted as wild card search, so it may appear anywhere in the clan name.

Properties​

name​

• Optional name: string

Search clans by name.

Defined in​

types/lib.ts:147


minMembers​

• Optional minMembers: number

Filter by minimum number of clan members.

Defined in​

types/lib.ts:150


maxMembers​

• Optional maxMembers: number

Filter by maximum number of clan members.

Defined in​

types/lib.ts:153


minClanPoints​

• Optional minClanPoints: number

Filter by minimum amount of clan points.

Defined in​

types/lib.ts:156


minClanLevel​

• Optional minClanLevel: number

Filter by minimum clan level.

Defined in​

types/lib.ts:159


warFrequency​

• Optional warFrequency: string

Filter by clan war frequency.

Defined in​

types/lib.ts:162


locationId​

• Optional locationId: string

Filter by clan location identifier. For list of available locations, refer to getLocations operation.

Defined in​

types/lib.ts:165


labelIds​

• Optional labelIds: string

Comma separated list of label IDs to use for filtering results.

Defined in​

types/lib.ts:168


limit​

• Optional limit: number

Limit the number of items returned in the response.

Defined in​

types/lib.ts:171


after​

• Optional after: string

Return only items that occur after this marker. Before marker can be found from the response, inside the 'paging' property. Note that only after or before can be specified for a request, not both.

Defined in​

types/lib.ts:178


before​

• Optional before: string

Return only items that occur before this marker. Before marker can be found from the response, inside the 'paging' property. Note that only after or before can be specified for a request, not both.

Defined in​

types/lib.ts:185