Initialization

Learn how to initialize the DotPassportClient.

Basic Initialization

import { DotPassportClient } from '@dotpassport/sdk';

const client = new DotPassportClient({
  apiKey: 'live_your_api_key_here'
});

Configuration Options

interface DotPassportConfig {
  apiKey: string;      // Required: Your API key
  baseUrl?: string;    // Optional: API base URL
}

API Key

Your authentication key. Get it from the developer dashboard.

const client = new DotPassportClient({
  apiKey: process.env.DOTPASSPORT_API_KEY!
});

Base URL

Override the default API URL (useful for testing):

const client = new DotPassportClient({
  apiKey: 'test_key',
  baseUrl: 'https://api-staging.dotpassport.com'
});

Environment-Specific Setup

Development

const client = new DotPassportClient({
  apiKey: process.env.DOTPASSPORT_TEST_KEY!,
  baseUrl: 'https://api-staging.dotpassport.com'
});

Production

const client = new DotPassportClient({
  apiKey: process.env.DOTPASSPORT_LIVE_KEY!
});

Singleton Pattern

Create a single instance for your entire application:

// lib/dotpassport.ts
import { DotPassportClient } from '@dotpassport/sdk';

export const dotpassport = new DotPassportClient({
  apiKey: process.env.DOTPASSPORT_API_KEY!
});

// Usage in other files
import { dotpassport } from './lib/dotpassport';

const scores = await dotpassport.getScores(address);

Next Steps

• Profile Methods

• Scores Methods

• Error Handling