JavaScript SDK Quick Start

Get started with the Aries JavaScript/Node.js SDK in minutes

Prerequisites

• Node.js 14 or higher
• npm or yarn package manager
• Aries API credentials (client ID and client secret)

Installation

Install the Aries JavaScript SDK using npm or yarn:

npm install @aries-exchange/sdk
# or
yarn add @aries-exchange/sdk

Initialize the Client

import { AriesClient } from '@aries-exchange/sdk';

// Initialize the client with your credentials
const client = new AriesClient({
  clientId: 'your_client_id',
  clientSecret: 'your_client_secret'
});

Basic Operations

Get Account Information

// Retrieve user account details
const accounts = await client.accounts.getUserAccounts();
console.log(accounts);

Place a Market Order

// Place a simple market order
const order = await client.orders.placeOrder({
  symbol: 'AAPL',
  quantity: 10,
  side: 'buy',
  orderType: 'market'
});
console.log(`Order placed:`, order);

Search for Securities

// Search for a security
const results = await client.marketData.search('AAPL');
console.log(results);

TypeScript Support

The SDK includes full TypeScript definitions:

import { AriesClient, Order } from '@aries-exchange/sdk';

const client = new AriesClient({
  clientId: 'your_client_id',
  clientSecret: 'your_client_secret'
});

const order: Order = await client.orders.placeOrder({
  symbol: 'AAPL',
  quantity: 10,
  side: 'buy',
  orderType: 'market'
});

Next Steps

Now that you have the basics working, explore the SDK’s capabilities:

• Portfolio - Manage portfolios and holdings
• Markets - Access market data and quotes
• Orders - Advanced order management
• Account Management - Detailed account operations

Additional Resources

• Full JavaScript SDK Documentation
• API Reference
• GitHub Repository