ProxyWhirl DocsDocumentation
Canonical ProxyWhirl documentation for Python, REST, CLI, MCP, strategies, and operations.
ProxyWhirl is a drop-in Python proxy rotator: create a rotator, make requests, and let it hydrate an empty pool from every enabled built-in public source on first use. It also includes sync and async clients, validation, circuit breakers, retry policies, caching, a REST API, a CLI, and an MCP server.
This Fumadocs site is the canonical documentation path at /docs/. Generated reference pages stay source-grounded through pnpm --dir web run docs:generate.
Start Here
| Surface | Use It For |
|---|---|
| Quickstart | Install ProxyWhirl and send the first rotated request. |
| Guides | Client setup, configuration, retries, deployment, troubleshooting. |
| Concepts | Proxy lifecycle, strategies, resilience, and security. |
| Interfaces | MCP server and REST API deployment. |
| Reference | Generated Python, REST, CLI, sources, and strategies. |
Documentation Pipeline
pnpm --dir web run docs:generatepnpm --dir web run lintpnpm --dir web run test:runpnpm --dir web run build
Production Assurance
Use Operations for contributor gates and Operations Playbook for runtime validation. Proxy lists publish under /proxy-lists/.