v1

latestOpenAPI 3.0.22026-07-24113565544.0 KB

Exchanges

Create Instrument Exchange

Creates an Instrument Exchange. The ability to sale of a held instrument and purchase of another.

post/exchanges

Request body

accountNostring required

The user's unique account number, that is human readable.

sellSymbolstring required

This will be the ticker of the mutual fund you will be liquidating.

buySymbolstring required

This will be the ticker of the mutual fund you will be purchasing with the proceeds of the liquidation.

amountCashnumber required

This is the total notional amount you exchange from the sellSymbol to the buySymbol. This field is populated if quantity is null

quantitynumber required

This is the total quantity being sold of the sellSymbol. The proceeds, less any fees, will be used to purchase the buySymbol. This field is only required if amountCash is null.

Example request

{
  "accountNo": "DWBG000052",
  "sellSymbol": "VTSMX",
  "buySymbol": "VTSAX",
  "quantity": 100.503
}

Response

Creating an Exchange was Successful.

idstring required

The specific id of the exchange.

exchangeNostring required

The specific exchange number