Skip to content

Guide

Everything you need to build with PokeLance, from your first request to caching the entire gamut of PokéAPI resources on disk.

  • Installation

    Install PokeLance with uv or pip with support for both asynchronous and synchronous execution.

    Installation

  • Quickstart

    Create a client, ping the API, and fetch your first resources in a few lines of code.

    Quickstart

  • Configuration

    Tune cache sizes, bring your own niquests sessions, configure logging, and control endpoint pre-loading.

    Configuration

  • Fetching Data

    Understand the get_* / fetch_* pattern, getch_data, and constructing requests straight from_url.

    Fetching Data

  • Extensions Reference

    A complete map of all 11 extensions and every category/endpoint they expose.

    Extensions Reference

  • Caching In Depth

    LRU in-memory caches, endpoint auto-completion, and persisting entire resource sets to disk as JSON.

    Caching In Depth

  • Error Handling

    The exception hierarchy, HTTP status mapping, and "did you mean...?" suggestions for typoed resources.

    Error Handling

  • Media: Sprites & Cries

    Download sprites and cries with a built-in LRU cache (get_image, get_audio).

    Media

Recipes

Full, runnable integrations built on top of the client.

  • Discord Bot

    Share a PokeLanceAsyncClient across your whole bot's lifetime.

    Discord Bot

  • FastAPI Service

    Expose PokeLance's cache-then-fetch pattern as a read-through REST API.

    FastAPI Service

  • Notebook Playground

    An interactive Jupyter notebook for exploring the client cell-by-cell.

    Notebook Playground

Reading alongside the API Reference

Every page here links out to the relevant API Reference section.

Comments