Skip to main content

​
Overview

Get up and running with the Bluum Finance API in under 10 minutes. This guide walks you through creating an account, obtaining your API credentials, and making your first API call.
What you’ll need: A web browser and a terminal or API client (curl, Postman, or similar). No prior setup required.

​
Step-by-step setup

1

Create an account

Sign up for a Bluum Finance account to access the API.
  1. Visit the Bluum Finance dashboard
  2. Click Sign up or Create account
  3. Complete the registration form with your email and company information
  4. Verify your email address when prompted
Bluum Finance dashboard login page showing sign up option

The Bluum Finance dashboard login page where you can create a new account

You should receive a confirmation email. Click the verification link to activate your account.
2

Get API credentials

Access your API credentials from the dashboard after logging in.
  1. Log in to the Bluum Finance dashboard
  2. Navigate to Settings or API Keys in the dashboard menu
  3. Click Create API Key or Generate Credentials
  4. Copy your API Key and API Secret immediately—the secret is only shown once
Dashboard API credentials page showing API key and secret fields

The API credentials section in the dashboard showing where to find your API key and secret

Store your API secret securely. If you lose it, you’ll need to generate a new API key pair. Never commit credentials to version control.
You should have both an API Key (starts with letters/numbers) and an API Secret (longer string). Keep these ready for the next step.
3

Make your first API call

Test your credentials by retrieving a list of tradable assets. This endpoint doesn’t require an account to be created first.
cURL
curl -X GET 'https://sandbox.api.bluum.finance/v1/assets?asset_class=us_equity&tradable=true' \
  -H 'Authorization: Basic '$(echo -n 'YOUR_API_KEY:YOUR_API_SECRET' | base64)
Node.js
const apiKey = 'YOUR_API_KEY';
const apiSecret = 'YOUR_API_SECRET';
const credentials = Buffer.from(`${apiKey}:${apiSecret}`).toString('base64');

const response = await fetch(
  'https://sandbox.api.bluum.finance/v1/assets?asset_class=us_equity&tradable=true',
  {
    method: 'GET',
    headers: {
      'Authorization': `Basic ${credentials}`
    }
  }
);

const assets = await response.json();
console.log(assets);
Python
import requests
import base64

api_key = 'YOUR_API_KEY'
api_secret = 'YOUR_API_SECRET'
credentials = base64.b64encode(f'{api_key}:{api_secret}'.encode()).decode()

response = requests.get(
  'https://sandbox.api.bluum.finance/v1/assets',
  params={'asset_class': 'us_equity', 'tradable': True},
  headers={'Authorization': f'Basic {credentials}'}
)

assets = response.json()
print(assets)
Replace YOUR_API_KEY and YOUR_API_SECRET with the credentials you obtained in the previous step.
[
  {
    "id": "6c5b2403-24a9-4b55-a3dd-5cb1e4b50da6",
    "symbol": "AAPL",
    "name": "Apple Inc.",
    "class": "us_equity",
    "exchange": "NASDAQ",
    "status": "active",
    "tradable": true,
    "fractionable": true
  },
  {
    "id": "7d6c3514-35ba-5c66-b4ee-6dc2f5c61eb7",
    "symbol": "MSFT",
    "name": "Microsoft Corporation",
    "class": "us_equity",
    "exchange": "NASDAQ",
    "status": "active",
    "tradable": true,
    "fractionable": true
  }
]
If you receive a JSON array of assets, your credentials are working correctly. You’re ready to explore the API further.

​
Troubleshooting

Verify that your API key and secret are correct and properly Base64 encoded. The format should be Basic <base64_encoded_credentials> where credentials are API_KEY:API_SECRET.
Ensure you’ve verified your email address. Check your spam folder if you didn’t receive the verification email. Contact [email protected] if you continue to have issues.
Some accounts may require approval before API access is enabled. Contact [email protected] to request API access activation.

​
Next steps

Now that you’ve made your first API call, explore what else you can build: