> ## Documentation Index
> Fetch the complete documentation index at: https://developers.soax.com/llms.txt
> Use this file to discover all available pages before exploring further.

# API overview

> Programmatic access to your SOAX account: packages, connection strings, locations, usage analytics, and API key management over a JSON REST API.

The SOAX API gives you programmatic access to everything you'd otherwise manage in the [dashboard](https://platform.soax.com): list and inspect your proxy packages, generate ready-to-use connection strings, browse available locations, pull usage analytics, and manage API keys — all without logging in.

<Note>
  The API manages your **account**. It is separate from the proxy gateway (`proxy.soax.com:1337`) that carries your actual proxy traffic. You authenticate to the API with an **API key** (`s_live_…`); you authenticate to the proxy gateway with a **package key** (a 10-character password, one per package). See [Authentication](/api/authentication) for the difference.
</Note>

## Base URL

All endpoints live under a single base URL and are versioned under `/v1`:

```
https://api.platform.soax.com/v1
```

Requests and responses are JSON over HTTPS. Use paths exactly as documented — the API keys collection paths end with a trailing slash (`/v1/api-keys/`), and calling them without it triggers a 307 redirect that not every HTTP client follows with the `Authorization` header intact.

## Authentication

Every request must carry an API key in the `Authorization` header:

```bash theme={null}
curl https://api.platform.soax.com/v1/api-keys/me \
  -H "Authorization: Bearer s_live_YOUR_API_KEY"
```

Keys are created in the dashboard under [**Settings → API keys**](https://platform.soax.com/settings/api-keys) and carry **scopes** that control which endpoints they can call. See [Authentication](/api/authentication) for the full scope reference.

## Endpoints at a glance

| Group                               | What it covers                                                                       |
| ----------------------------------- | ------------------------------------------------------------------------------------ |
| [API Keys](/api/keys/me)            | Inspect the current key, list, create, and revoke API keys                           |
| [Packages](/api/packages/list)      | List and inspect proxy packages, build connection strings, rotate package passwords  |
| [Locations](/api/locations/tiers)   | Tiers, countries, regions, cities, ISPs, ASNs, and ZIP codes available for targeting |
| [Account](/api/account/get)         | Account info, credit balances, subscription details                                  |
| [Analytics](/api/analytics/summary) | Usage summaries, traffic breakdowns, credits burned                                  |

## Pagination

`GET /v1/proxy/packages` uses cursor-based pagination. Each page returns `has_more` and `next_cursor`; pass `next_cursor` as the `cursor` query parameter to fetch the next page, and stop when `has_more` is `false`. Other list endpoints return complete lists without pagination.

## Rate limits

Each API key can make **5 requests per second**, and each client IP **500 requests per minute**. Exceeding either returns `429`. See [Rate limits](/api/rate-limits) for details and retry guidance.

## Errors

Errors use conventional HTTP status codes with a JSON body describing the problem. See [Error handling](/api/errors) for every status code, the response shapes, and how to handle each case.

## OpenAPI specification

The API is described by an OpenAPI 3.1 specification, useful for generating clients or importing into tools like Postman:

```
https://api.platform.soax.com/v1/openapi.json
```

## Next steps

<CardGroup cols={2}>
  <Card title="Quickstart" icon="rocket" href="/api/quickstart">
    Create an API key and make your first request in a few minutes.
  </Card>

  <Card title="Authentication" icon="key" href="/api/authentication">
    API keys, scopes, package restrictions, and key lifecycle.
  </Card>

  <Card title="Error handling" icon="triangle-exclamation" href="/api/errors">
    Status codes, error bodies, and how to handle each.
  </Card>

  <Card title="Rate limits" icon="gauge-high" href="/api/rate-limits">
    Limits, the 429 response, and how to check your remaining quota.
  </Card>
</CardGroup>