Skip to main content
POST

Authorizations

Authorization
string
header
required

Auth0-issued access token that includes the scopes listed for the endpoint.

Headers

x-user-id
string
required

User identifier for the M2M client to specify which user's data to access.

Pattern: ^[a-f0-9]{24}$

Body

application/json

Asset preview request. orderType defaults to Market when omitted. Limit orders are always express (no smart/aggregate leg).

  • Market buyside: buy, amount required; orderType omitted or Market; limitPrice and timeInForce are not allowed.
  • Market sellside: sell, quantity required; same market rules as buy.
  • Limit buyside: buy, orderType: Limit, amount, limitPrice, and timeInForce required.
  • Limit sellside: sell, orderType: Limit, quantity, limitPrice, and timeInForce required.
side
enum<string>
required
Available options:
buy
isin
string
required

ISIN of the asset to trade

Pattern: ^[A-Z]{2}[A-Z0-9]{9}[0-9]$
amount
number<double>
required

Required when side is buy. Whole-currency amount to invest.

Required range: x >= 0.01
orderType
enum<string>
default:Market

Order type. Omit to default to market.

Available options:
Market
quantity
number<double>

Optional. Ignored for buy orders; included for backward compatibility.

Required range: x >= 0.0001

Response

Asset transaction preview retrieved successfully

Preview of a transaction showing execution options, fees, and estimated orders

executionWindow
object

Execution window for both express and smart execution scenarios

fees
object

Wealthyhood fee breakdown for express vs smart execution (commission and FX only on preview)

partnerFees
object

Partner (ETE/NBG) countervalue fees per execution mode; omitted for retail Wealthyhood users.

orders
object

Orders preview for both express and smart execution scenarios

foreignCurrencyRates
object

Foreign currency exchange rates keyed by ISIN

willSkipOrders
boolean

Whether orders will be skipped due to low amounts

willResultInLowQuantityHolding
boolean

Whether the transaction will result in a low quantity holding

hasETFOrders
boolean

Whether the transaction includes ETF orders