Skip to main content
This is one of two ways to integrate the Investments API. If you do not hold your own regulatory permissions, use the Managed model instead.

Who this is for

You are a regulated entity — a broker, an asset manager, a licensed fintech — and you already hold the permissions to hold client assets and maintain a ledger of your end users. In the Direct model you are GetEquity’s counterparty. Your organisation has a single account and a single wallet, and every order is placed as your organisation. GetEquity does not provision accounts for your end users and does not hold a per-user balance for them.

How your end users are represented

Each trade carries a customer object naming the end user the activity belongs to:
POST api/token/{id}/buy
GetEquity stores this attribution against the order and the resulting transaction. The email address is the identity key: reuse the same address across trades and they accumulate against one customer record. Those records are what the Customers endpoints return. A customer appears there once they have traded — there is no separate call to create one.
A customer is an attribution record, not an account. It has no credentials, no wallet and no balance of its own. Holding the position for each end user, and reconciling it against your organisation’s aggregate position on GetEquity, is your responsibility as the regulated party.

The flow

1

Fund your organisation wallet

Call Fund Wallet to get a virtual account or payment link. All trades settle against this single wallet.
2

Find something to trade

Use Get All Tokens, Get Raising Tokens or Search Token to locate the asset.
3

Place the order

Call Buy Token or Sell Token with the customer object attached. For a raise rather than a secondary trade, use Fund Buy.
4

Track it

Orders return immediately as pending. Watch the order.created and transaction.created webhook events, or poll Get Order.
5

Reconcile

Use Get Customer Transactions to pull activity for one end user by email, and Get Wallet Balance for your organisation’s position.

Endpoints in this model

Trade

Buy, sell and fund-buy tokens, plus token discovery and market data.

Customers

List and search the end users you have traded on behalf of.

Orders

Retrieve and cancel orders your organisation has placed.

Transactions

Per-customer transaction history and total volume.

Wallet

Fund, withdraw from and check the balance of your organisation wallet.

Webhooks

Order, transaction and wallet events for your organisation.

Authentication

Every request uses your organisation’s secret key. There are no per-user tokens in this model.