# 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](/docs/free-proxy-api) | None |
| Connect through a purchased proxy | [Tokens, proxy products, and hubs](/docs/proxy-concepts) | Proxy token username and password |
| Select PPG geography or a sticky session | [Pay-per-GB proxy parameters](/docs/ppg-proxies) | Parameters in the proxy username |
| Inventory existing tokens or read usage | [Account API](/docs/api) | Account API key in a Bearer header |

There is no account API endpoint to create, edit, disable, rotate, or delete proxy tokens.

## Free API quickstart

```bash
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 account API key.

## Account API quickstart

Create your account API key on [Settings](/users/settings), place it in an environment variable, then list existing tokens:

```bash
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"
```

The account API is read-only. Never put the key in a URL, proxy username, client-side application, log, or support message.

## Credentials and identifiers

| Term | Meaning |
| --- | --- |
| Proxy token username/password | Data-plane credentials sent to an HTTP or SOCKS5 proxy endpoint. |
| Proxy token ID | Stable non-secret identifier used by authenticated account API routes. |
| User API key (`lit_…`) | Account control-plane credential sent only as `Authorization: Bearer …`. |

An account 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](/docs/openapi.json)
- [Documentation index for coding agents](/llms.txt)
- [Combined Markdown documentation](/llms-full.txt)
- 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](/docs/proxy-errors) for data-plane failures and [account API errors](/docs/api/errors) for REST failures. They are different error systems.
- Use the `X-Request-ID` response header when reporting an account API failure.