Skip to main content
POST
Get an order quote

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

account_id
string
required

Body

application/json
instrument_id
string
required

ID of the instrument to quote.

side
enum<string>
required

The order side, buy or sell.

Available options:
buy,
sell
cash_amount

The cash amount for a buy order.

Example:

"1000.00"

limit_price

Optional limit price. When set, the quote is a deterministic bound: estimated_price echoes the limit, a cash buy returns affordable quantity and max_cost, a sell returns min_proceeds.

Example:

"25.7500"

quantity

The unit quantity for a sell order.

Example:

"12.5000"

return_only_fees
boolean
default:false

Whether to return only applicable fees.

Response

Successful Response

cash_amount
string
required

Cash the user chose to invest (before fees).

Example:

"10000.00"

created_at
string<date-time>
required

When the quote was issued.

currency
enum<string>
required

The currency every cash amount in this quote is given in.

Available options:
EUR,
USD,
GBP
estimate
EtfMarketCashEstimate · object
required

Estimated economics at the latest price.

expires_at
string<date-time>
required

When the quote expires.

id
string
required

Quote ID, redeemable via quote_id at order placement.

instrument
Bill · object
required

The full instrument being quoted.

is_binding
boolean
required

Whether the quoted price is binding at execution. Always false for security quotes; binding FX quotes are issued via /order-quotes/fx.

order_type
enum<string>
required

Market or limit.

Available options:
market,
limit
reservation
OrderQuoteReservation · object
required

What a placement referencing this quote would set aside.

side
enum<string>
required

Buy or sell.

Available options:
buy,
sell
quote_type
any
default:etf_market_cash

The kind of order quote returned, which determines the set of fields present in this response.