Docs/Getting Started/Introduction

Introduction

Alphagent provides a powerful, modern API for building financial applications. Our infrastructure handles the complexity of banking, card issuance, and payments, allowing you to focus on your product.

Real-time Data

Stream market data and transaction events via WebSockets with sub-millisecond latency.

Bank-grade Security

Fully compliant with SOC2 Type II, PCI DSS, and ISO 27001 standards.

#Installation

Install the Alphagent Node.js SDK using your preferred package manager.

bash

$ npm install @alphagent/sdk

#Configuration

Initialize the client with your private API key. You can find your keys in the Developer Dashboard.

index.js

import { AlphagentClient } from '@alphagent/sdk';

// Initialize the client
const client = new AlphagentClient({
  apiKey: 'sk_live_51Mz...',
  version: '2024-03-01'
});

const account = await client.accounts.retrieve('acct_123');

Production Keys

Never commit your production API keys to version control. Use environment variables (e.g. ALPHAGENT_SECRET_KEY) to store secrets securely.

Available Scopes

Scope	Description	Access Level
read_only	View data only, no mutations allowed.	Public
write_transactions	Create and modify transactions.	Restricted
admin_full	Full access to all resources.	Secret Key Only

Authentication