Brokeret LogoDocs
Getting Started/Quick Start

Quick Start

Get up and running with the Brokeret platform in under 10 minutes.

Prerequisites

Before you begin, make sure you have:

  • A Brokeret account (sign up at brokeret.com)
  • API credentials (available in your dashboard under Settings → API Keys)
  • A development environment with curl or an HTTP client library

Step 1: Get Your API Keys

Navigate to your Brokeret dashboard and create a new API key pair. You'll receive:

  • API Key — Your public identifier (safe to include in logs)
  • API Secret — Your private key (keep this secure, never commit to version control)
⚠️
WarningYour API Secret is shown only once during creation. Store it securely in your environment variables or a secrets manager.

Step 2: Make Your First Request

Test your credentials by fetching your account information:

curl -X GET https://api.brokeret.com/v1/account \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

You should receive a response like:

{
  "data": {
    "id": "acct_1234567890",
    "name": "My Brokerage",
    "status": "active",
    "created_at": "2026-01-15T10:30:00Z"
  }
}

Step 3: Create a Trading Account

Create a demo trading account to test with:

curl -X POST https://api.brokeret.com/v1/trading-accounts \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"Demo Account","group":"demo-standard","leverage":100,"currency":"USD","balance":10000}'

Step 4: Install an SDK

Choose your preferred language and install our official SDK:

# PHP
composer require brokeret/sdk

# Node.js
npm install @brokeret/sdk

# Python
pip install brokeret

PHP Example

<?php

use Brokeret\Client;

$client = new Client(
    apiKey: env('BROKERET_API_KEY'),
    apiSecret: env('BROKERET_API_SECRET'),
);

$accounts = $client->tradingAccounts()->list();

foreach ($accounts as $account) {
    echo "{$account->name}: {$account->balance} {$account->currency}\n";
}

Node.js Example

import { Brokeret } from '@brokeret/sdk';

const client = new Brokeret({
  apiKey: process.env.BROKERET_API_KEY,
  apiSecret: process.env.BROKERET_API_SECRET,
});

const accounts = await client.tradingAccounts.list();

accounts.forEach(account => {
  console.log(`${account.name}: ${account.balance} ${account.currency}`);
});

What's Next?