Skip to main content
1
Install the SDK
2
Requires Node.js 18 or later.
3
npm install @paxos/sdk
4
Set Up Credentials
5
Create API credentials in the Paxos Dashboard and export them as environment variables.
6
export PAXOS_CLIENT_ID="your_client_id"
export PAXOS_CLIENT_SECRET="your_client_secret"
7
If you don’t have a Sandbox account, sign up here.
8
Make Your First API Call
9
Create a file called index.ts with the following code. This example creates a client, lists your profiles, and prints the result.
10
import { PaxosClient } from "@paxos/sdk";

const client = new PaxosClient({
  clientId: process.env.PAXOS_CLIENT_ID!,
  clientSecret: process.env.PAXOS_CLIENT_SECRET!,
  sandbox: true,
});

async function main() {
  // List profiles
  for await (const profile of client.profiles.listProfiles({ limit: 10 })) {
    console.log(`Profile: ${profile.id} (${profile.nickname})`);
  }
}

main().catch(console.error);
11
Run the program:
12
npx tsx index.ts

​
Next Steps