Litport documentation
Use Litport as a proxy provider or retrieve the public free-proxy list. These pages describe the deployed behavior, including exact credentials, limits, errors, and response shapes.
Choose an integration#
| Goal | Start here | Authentication |
|---|---|---|
| Retrieve public free proxies | Free proxy API | None |
| Connect through a purchased proxy | Tokens, proxy products, and hubs | Proxy token username and password |
| Encrypt the connection to the proxy itself | HTTPS proxy endpoint | Proxy token username and password over TLS |
| Select PPG geography or a sticky session | Pay-per-GB proxy parameters | Parameters in the proxy username |
| Get a new IP for a proxy now | Change IP | Dashboard sign-in, the proxy's change-IP link, or an API key |
| Inventory existing tokens, read usage, or change a movable token's location, rotation, or IP | Litport API | API key in a Bearer header |
| Read a package's state, or manage its allowed IPs | Packages API | API key in a Bearer header |
| Serve repeat static HTTPS responses for free | Static response cache | Proxy token username and password with a cache suffix |
| Let an AI assistant use the Litport API | MCP server for AI assistants | API key in a Bearer header |
The API's writes are token location, rotation, and new IP, and a package's allowed IPs; every write needs a Bearer API key. Tokens themselves can't be created or deleted through the API.
Free API quickstart#
curl --get 'https://litport.net/api/free-proxy' \
--data-urlencode 'country=us' \
--data-urlencode 'protocol=https' \
--data-urlencode 'limit=25'
The response is a bare JSON array. This endpoint is public and does not use an API key.
API quickstart#
Create your API key on Settings, place it in an environment variable, then list existing tokens:
export LITPORT_API_KEY='lit_replace_with_your_key'
curl --fail-with-body 'https://litport.net/api/v1/tokens?limit=20' \
-H "Authorization: Bearer $LITPORT_API_KEY"
Never put the key in a URL, proxy username, client-side application, log, or support message.
Credentials and identifiers#
| Term | Meaning |
|---|---|
| Proxy token username |
Data-plane credentials sent to an HTTP or SOCKS5 proxy endpoint. |
| Proxy token ID | Stable non-secret identifier used by authenticated API routes. |
User API key (lit_…) |
Account control-plane credential sent only as Authorization: Bearer …. |
An API key is not a proxy password and cannot open a proxied connection. A proxy token ID is not a secret.
Machine-readable resources#
- OpenAPI 3.1 contract
- Documentation index for coding agents
- Combined Markdown documentation
- Every page is available as Markdown through its Markdown link.
The semantic HTML pages are canonical. The HTML, Markdown, navigation, and agent resources are generated from the same source files to reduce contract drift.
Operational basics#
- Use UTC ISO-8601 timestamps, for example
2026-08-25T12:00:00Z. - Treat byte counters as decimal strings; JavaScript clients should not coerce large values to
Number. - Read proxy errors for data-plane failures and API errors for REST failures. They are different error systems.
- Use the
X-Request-IDresponse header when reporting an API failure.