Skip to content
Longport Whale
Overview

Broker API

Institution-grade API for Broker integrations and self-built administration systems

Broker API is an institution-grade API for Brokers. It supports Server-to-Server integrations and can also power a Broker’s self-built administration system. Authorization is scoped to the Broker, so one credential covers the approved institutional data and SaaS back-office capabilities.

In both scenarios, API requests must originate from a Broker-controlled server. Institution credentials such as Access Keys must never be stored in browser code or Broker App. A self-built administration UI calls Broker API through Broker Server.

At a glance

Caller Broker Server or the server behind a self-built Broker administration UI
Authorization subject Broker (Broker-scoped Authorization)
Private data scope Approved broker-wide scope
Form HTTPS API for Server-to-Server integration and self-built administration systems

Not for

Environments

Environment Base URL
Test https://b-api.longbridge.xyz
Production https://b-api.lbkrs.com

Get started

  1. Quickstart — make your first request
  2. Authentication — required headers and credentials
  3. Passthrough Headers — locale and platform headers
  4. Browse the API Reference groups in the sidebar, organized by business domain
Whale Docs