Skip to main content
POST
Record a trade

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

accountId
integer
required

The financial account ID

Body

application/json
side
enum<string>
required

BUY or SELL.

Available options:
BUY,
SELL
quantity
number
required
Required range: x <= 999999999999
price
number
required

Price per unit in the account currency.

Required range: 0 <= x <= 999999999999
date
string<date-time>
required

The trade date. Not in the future, not before the position was opened.

security_id
integer | null

The security traded, by catalogue id (from the positions list or the securities search). A buy of a security the account does not hold yet opens the position. Either this or provider_symbol.

provider_symbol
string | null

Alternatively the provider symbol of a search result not in the catalogue yet: verified and created before the trade is posted (422 with reason when it cannot be priced).

Maximum string length: 32
fees
number | null

Commission and other costs, in the account currency. Defaults to 0.

Required range: 0 <= x <= 999999999999
description
string | null

Shown as the row's description; defaults to "Bought 10 AAPL at 150".

Maximum string length: 500

Response

message
string
required
Allowed value: "Trade recorded."
data
TransactionResource · object
required