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

# Python Quickstart

> Install the Paxos Python SDK and list profiles in the Sandbox.

> [!NOTE]
>
> Beta: we aim to avoid breaking changes, but they may occur before 1.0.

This quickstart installs the Paxos Python SDK and lists the profiles on your Sandbox account. It takes about five minutes.

## ➊ Prerequisites

* Python 3.11 or later.
* A Paxos [Sandbox account](https://docs.paxos.com/guides/developer/account.md).

## ➋ Install

```shell theme={"theme":{"light":"github-light","dark":"github-dark"}}
pip install paxos-sdk
```

To use request signing, install the optional extra instead: `pip install "paxos-sdk[signing]"`.

## ➌ Set up credentials

Create Sandbox API credentials with the `funding:read_profile` scope. See [Configure API Credentials](https://docs.paxos.com/guides/developer/credentials.md).

```shell theme={"theme":{"light":"github-light","dark":"github-dark"}}
export PAXOS_CLIENT_ID="your_client_id"
export PAXOS_CLIENT_SECRET="your_client_secret"
```

Scopes are required when you construct a client. This quickstart requests `funding:read_profile`, which lets the client list profiles.

## ➍ List your profiles

Save the following as `quickstart.py`:

```python theme={"theme":{"light":"github-light","dark":"github-dark"}}
import os

import paxos
from paxos.enums import Scope


def main():
    with paxos.Client(
        client_id=os.environ["PAXOS_CLIENT_ID"],
        client_secret=os.environ["PAXOS_CLIENT_SECRET"],
        sandbox=True,
        scopes=[Scope.FUNDING_READ_PROFILE],
    ) as client:
        try:
            for profile in client.profiles.list_profiles():
                print(f"Profile: {profile.id} ({profile.nickname})")
        except paxos.PaxosError as err:
            print(f"Request failed: {err}")
            raise SystemExit(1)


if __name__ == "__main__":
    main()
```

Run it:

```shell theme={"theme":{"light":"github-light","dark":"github-dark"}}
python quickstart.py
```

The output lists each profile's ID and nickname. `list_profiles` returns an iterator that fetches additional pages automatically.

For async applications, use `paxos.AsyncClient` with `async with`, `await` single-resource methods, and use `async for` over list methods.

If a call fails, include the `request_id` when you contact Support.

## Next steps

* Read [Authentication](https://docs.paxos.com/sdks/authentication.md) to learn how credentials and scopes work.
* Explore the [Sandbox](https://docs.paxos.com/guides/developer/sandbox.md) to fund test profiles and simulate flows.
* Browse the [API Reference](https://docs.paxos.com/api-reference) for the endpoints available on each service.

> Questions? Contact [Support](https://support.paxos.com).
