> ## Documentation Index
> Fetch the complete documentation index at: https://docs.x.com/llms.txt
> Use this file to discover all available pages before exploring further.

# paginator

> Reference for the paginator Python package in the X API SDK, grouping the client and Pydantic models for the paginator endpoints of the X API v2.

Cursor-based pagination utilities for the X API SDK.

This module provides a Cursor class for elegant pagination support across
all API clients. The Cursor enables easy iteration over paginated results
using both .pages() and .items() methods with proper type safety.

### `class xdk.paginator.Cursor`

\[`ResponseType`]

#### Parámetros

<ParamField path="path.method" type="PaginatableMethod" />

### `__init__`

Inicializa el cursor.

#### Parámetros

<ParamField path="path.method" type="PaginatableMethod">
  El método de la API a llamar por cada página (debe admitir paginación)
</ParamField>

### `items`

Itera sobre elementos individuales de respuestas paginadas.

#### Parámetros

<ParamField path="path.limit" type="int or None" default="None">
  Número máximo de elementos a devolver (None para ilimitado)
</ParamField>

#### Devuelve

`IteratorAny`

### `pages`

Itera sobre páginas de respuestas.

#### Parámetros

<ParamField path="path.limit" type="int or None" default="None">
  Número máximo de páginas a devolver (None para ilimitado)
</ParamField>

#### Devuelve

`IteratorResponseType`

### `class xdk.paginator.PaginatableMethod`

\[`ResponseType`]

### `__init__`

### `xdk.paginator.cursor`

Crea un cursor con inferencia y validación de tipos adecuadas.
Esta función factory ayuda con la inferencia de tipos para que obtengas
sugerencias de tipo adecuadas para el tipo de respuesta, y valida que el método
admita paginación tanto en análisis estático como en tiempo de ejecución.

#### Parámetros

<ParamField path="path.method" type="PaginatableMethod">
  El método de la API a envolver (debe admitir paginación)
</ParamField>