SDK

High-level SDK for integrating Limitry usage tracking.

Limitry SDK

High-level SDK for integrating Limitry usage tracking and rate limiting.

class limitry.sdk.Client

Bases: object

Main client for interacting with the Limitry API

__init__(api_key, base_url=None, timeout=None, headers=None)

Initialize the Limitry client.

Parameters:

• api_key (str) – Your Limitry API key

• base_url (Optional[str]) – Base URL for the API (defaults to https://api.limitry.com/v1)

• timeout (Optional[int]) – Request timeout in seconds (defaults to 30)

• headers (Optional[Dict[str, str]]) – Additional headers to include in requests

Example:

client = Client(api_key="your-api-key")

async __aenter__()

Async context manager entry

async __aexit__(exc_type, exc_val, exc_tb)

Async context manager exit

async close()

Close the HTTP client

async request(method, path, params=None, json=None, headers=None)

Make an HTTP request to the API.

Parameters:

• method (str) – HTTP method (GET, POST, PUT, DELETE, etc.)

• path (str) – API endpoint path

• params (Optional[Dict[str, Any]]) – Query parameters

• json (Optional[Dict[str, Any]]) – JSON body for request

• headers (Optional[Dict[str, str]]) – Additional headers for this request

Return type:

Any

Returns:

Response data (parsed JSON)

Raises:

• AuthenticationError – When authentication fails (401/403)

• APIError – When API request fails

• NetworkError – When network error occurs

class limitry.sdk.ClientConfig

Bases: object

Configuration for the Limitry SDK client

__init__(api_key, base_url=None, timeout=None, headers=None)

Initialize client configuration.

Parameters:

• api_key (str) – Your Limitry API key

• base_url (Optional[str]) – Base URL for the API (defaults to https://api.limitry.com/v1)

• timeout (Optional[int]) – Request timeout in seconds (defaults to 30)

• headers (Optional[Dict[str, str]]) – Additional headers to include in requests

exception limitry.sdk.LimitryError

Bases: Exception

Base exception for all Limitry SDK errors

__init__(message, cause=None)

Parameters:

• message (str)

• cause (Exception | None)

exception limitry.sdk.APIError

Bases: LimitryError

Exception raised when an API request fails

__init__(message, status, status_text, response=None)

Parameters:

• message (str)

• status (int)

• status_text (str)

• response (Dict[str, Any] | None)

exception limitry.sdk.AuthenticationError

Bases: APIError

Exception raised when authentication fails (401/403)

__init__(message='Authentication failed. Please check your API key.', status=401, response=None)

Parameters:

• message (str)

• status (int)

• response (Dict[str, Any] | None)

exception limitry.sdk.NetworkError

Bases: LimitryError

Exception raised when a network error occurs

__init__(message, cause=None)

Parameters:

• message (str)

• cause (Exception | None)

class limitry.sdk.PaginatedResponse

Bases: Generic[T]

Response from a paginated API endpoint

__init__(data, next_cursor=None, has_more=False)

Initialize a paginated response.

Parameters:

• data (list[TypeVar(T)]) – List of items in this page

• next_cursor (Optional[str]) – Cursor for the next page (if available)

• has_more (bool) – Whether there are more pages available

async limitry.sdk.paginate_all(fetch_page, initial_cursor=None)

Iterator helper for auto-pagination.

Automatically fetches all pages using cursor-based pagination.

Parameters:

• fetch_page (Callable[[Optional[str]], Awaitable[PaginatedResponse[TypeVar(T)]]]) – Async function that fetches a page given an optional cursor

• initial_cursor (Optional[str]) – Optional initial cursor to start from

Yields:

Individual items from all pages

Return type:

AsyncGenerator[TypeVar(T), None]

Example:

async def fetch_events(cursor: Optional[str] = None):
    response = await client.request("GET", "/events", params={"cursor": cursor})
    return PaginatedResponse(
        data=response["data"],
        next_cursor=response.get("nextCursor"),
        has_more=response.get("hasMore", False),
    )

async for event in paginate_all(fetch_events):
    print(event.id)

async limitry.sdk.collect_all(fetch_page, initial_cursor=None)

Collect all items from paginated endpoint into a list.

Parameters:

• fetch_page (Callable[[Optional[str]], Awaitable[PaginatedResponse[TypeVar(T)]]]) – Async function that fetches a page given an optional cursor

• initial_cursor (Optional[str]) – Optional initial cursor to start from

Return type:

list[TypeVar(T)]

Returns:

List of all items from all pages

Example:

async def fetch_events(cursor: Optional[str] = None):
    response = await client.request("GET", "/events", params={"cursor": cursor})
    return PaginatedResponse(
        data=response["data"],
        next_cursor=response.get("nextCursor"),
        has_more=response.get("hasMore", False),
    )

all_events = await collect_all(fetch_events)