Types

Parameter types used for API requests.

class clash_royale.types.PaginationParams[source]

Common pagination parameters for API requests.

Parameters:

  • limit – Maximum total number of items to fetch (default: unlimited). Controls how many results you get in total. Example: limit=50 will fetch at most 50 items across all pages.

  • page_size – Number of items per API request. This is sent as “limit” to the API. Only change if you need to optimize request sizes or work around API constraints.

  • after – Cursor for pagination (automatically managed by PaginatedList).

  • before – Cursor for backward pagination (automatically managed by PaginatedList).

limit: int
page_size: int
after: str
before: str
class clash_royale.types.ClanSearchParams[source]

Parameters for clan search endpoint.

Parameters:

  • limit – Maximum total number of items to fetch (default: unlimited). Controls how many results you get in total. Example: limit=50 will fetch at most 50 items across all pages.

  • page_size – Number of items per API request. This is sent as “limit” to the API. Only change if you need to optimize request sizes or work around API constraints.

  • after – Cursor for pagination (automatically managed by PaginatedList).

  • before – Cursor for backward pagination (automatically managed by PaginatedList).

  • location_id – Filter by clan location identifier (e.g. 57000094).

  • min_members – Filter by minimum number of clan members.

  • max_members – Filter by maximum number of clan members.

  • min_score – Filter by minimum amount of clan score.

location_id: int
min_members: int
max_members: int
min_score: int
limit: int
page_size: int
after: str
before: str