Documentation

Documentation

Comprehensive guides and API reference for developers

Quick Start

# Install the BullishAI SDK
npm install @bullishai/sdk

# Initialize the client
import { BullishAI } from '@bullishai/sdk';

const client = new BullishAI({
  apiKey: 'your-api-key'
});

# Fetch portfolio data
const portfolio = await client.portfolio.get();
console.log(portfolio.totals.tpv);

Documentation Sections

🔐

Authentication

Learn how to authenticate API requests and manage API keys securely.

📊

Portfolio Endpoints

Access portfolio data, holdings, and performance metrics programmatically.

📈

Quote & Market Data

Retrieve real-time and historical stock quotes, prices, and market information.

🔔

Alerts API

Create, manage, and monitor price alerts and notifications via API.

🔗

Webhooks

Set up webhooks to receive real-time notifications for portfolio events.

⚡

Rate Limits

Understand API rate limits, throttling, and best practices for optimal performance.

Usage Examples

Get Portfolio Holdings

const holdings = await client.portfolio.holdings();
holdings.items.forEach(holding => {
  console.log(`${holding.symbol}: ${holding.totalShares} shares`);
});

Create Price Alert

const alert = await client.alerts.create({
  symbol: 'AAPL',
  type: 'price_above',
  value: 200
});

console.log(`Alert created: ${alert.id}`);

Need Help?

Can't find what you're looking for? Our support team is here to help.

Contact Support