> ## 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.

# TypeScript Quickstart

> Install the Paxos TypeScript 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 TypeScript SDK and lists the profiles on your Sandbox account. It takes about five minutes.

## ➊ Prerequisites

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

## ➋ Install

```shell theme={"theme":{"light":"github-light","dark":"github-dark"}}
npm install @paxosglobal/sdk
```

## ➌ 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.ts`:

```typescript theme={"theme":{"light":"github-light","dark":"github-dark"}}
import { PaxosClient, Scope, isApiError } from "@paxosglobal/sdk";

async function main() {
  const { PAXOS_CLIENT_ID, PAXOS_CLIENT_SECRET } = process.env;
  if (!PAXOS_CLIENT_ID || !PAXOS_CLIENT_SECRET) {
    throw new Error("Set PAXOS_CLIENT_ID and PAXOS_CLIENT_SECRET");
  }

  const client = new PaxosClient({
    clientId: PAXOS_CLIENT_ID,
    clientSecret: PAXOS_CLIENT_SECRET,
    scopes: [Scope.FUNDING_READ_PROFILE],
    sandbox: true,
  });

  try {
    for await (const profile of client.profiles.listProfiles()) {
      console.log(`Profile: ${profile.id} (${profile.nickname})`);
    }
  } catch (err) {
    if (isApiError(err)) {
      console.error(`API error ${err.status}: ${err.title} (request_id: ${err.requestId})`);
      process.exitCode = 1;
    } else {
      throw err;
    }
  }
}

void main();
```

Run it:

```shell theme={"theme":{"light":"github-light","dark":"github-dark"}}
npx tsx quickstart.ts
```

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

If a call fails, include the `requestId` 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).
