@profilex/sdk

TypeScript SDK for ProfileX API - Generate banners, badges, analytics, and more.

Installation

npm install @profilex/sdk

Usage

import { ProfileXClient } from '@profilex/sdk';

const client = new ProfileXClient({
  token: 'your-profilex-token',
  baseURL: 'https://api.profilex.com'
});

// Get a profile banner
const bannerUrl = await client.getBanner('johndoe', {
  theme: 'dark',
  size: 'large'
});

// Get analytics data
const analytics = await client.getAnalytics('johndoe', {
  period: '30d'
});

// Record events
await client.recordEvent({
  type: 'banner.render',
  profileId: 'johndoe',
  metadata: { format: 'svg' }
});

API Methods

• getBanner() - Generate profile banners
• getCommitGraph() - Get commit graph SVGs
• getBadge() - Generate Shields-like badges
• getEmbed() - Get embed codes
• getAnalytics() - Fetch analytics data
• getAnalyticsSummary() - Get analytics summary
• recordEvent() - Record telemetry events
• getProfile() - Get profile data
• updateProfile() - Update profile data

Authentication

Use ProfileX-Token v2 for authentication:

const client = new ProfileXClient({
  token: 'PXTK_...'
});

License

MIT