Get supported order features for institution
Get supported features for trading for a particular financial institution. Different institutions support different
features (e.g. different OrderType or different sets of TimeInForce values), so this endpoint is used to
describe such features for provided financial institution.
Authorizations
Contact Mesh to get client Secret
Contact Mesh to get client Id
Body
Auth token that allows connecting to the target institution
1Type of the institution to connect
Supported integrations:
Robinhood
ETrade
Alpaca
WeBull
Stash
InteractiveBrokers
Public
Coinbase
Kraken
CoinbasePro
CryptoCom
Binance
Gemini
OkCoin
KuCoin
Etoro
CexIo
BinanceInternational
Bitstamp
GateIo
Okx
BitFlyer
Coinlist
Huobi
Bitfinex
KrakenDirect
Vanguard
BinanceInternationalDirect
Bybit
CoinbasePrime
RobinhoodConnect
robinhood, eTrade, alpaca, tdAmeritrade, weBull, stash, interactiveBrokers, public, coinbase, kraken, coinbasePro, cryptoCom, openSea, binanceUs, gemini, cryptocurrencyAddress, cryptocurrencyWallet, okCoin, bittrex, kuCoin, etoro, cexIo, binanceInternational, bitstamp, gateIo, acorns, okx, bitFlyer, coinlist, huobi, bitfinex, deFiWallet, krakenDirect, vanguard, binanceInternationalDirect, bitfinexDirect, bybit, paxos, coinbasePrime, btcTurkDirect, kuCoinDirect, okxOAuth, paribuDirect, robinhoodConnect, blockchainCom, bitsoDirect, binanceConnect, binanceOAuth, revolutConnect, binancePay, bybitDirect Response
Account Id of the integration.
Type of the integration.
robinhood, eTrade, alpaca, tdAmeritrade, weBull, stash, interactiveBrokers, public, coinbase, kraken, coinbasePro, cryptoCom, openSea, binanceUs, gemini, cryptocurrencyAddress, cryptocurrencyWallet, okCoin, bittrex, kuCoin, etoro, cexIo, binanceInternational, bitstamp, gateIo, acorns, okx, bitFlyer, coinlist, huobi, bitfinex, deFiWallet, krakenDirect, vanguard, binanceInternationalDirect, bitfinexDirect, bybit, paxos, coinbasePrime, btcTurkDirect, kuCoinDirect, okxOAuth, paribuDirect, robinhoodConnect, blockchainCom, bitsoDirect, binanceConnect, binanceOAuth, revolutConnect, binancePay, bybitDirect Model, describing the asset pair trading ability
Specifies if this order type is supported for this integration.
The list of supported Time-in-force instructions for this order type.
immediateOrCancel, goodTillCanceled, goodTillDate, fillOrKill Specifies if this order type supports placing buy orders in base symbol amounts. For example, if payment/quote symbol is USD, base symbol is ETH, and this capability is supported, then the API can be instructed to buy 1 or other amount of ETH.
Specifies if this order type supports placing buy orders in quote symbol amounts. For example, if payment/quote symbol is USDC, and this capability is supported, then the API can be instructed to buy asset for 10 USDC or other amount.
Specifies if this order type supports placing sell orders in base symbol amounts. For example, if payment/quote symbol is USD, base symbol is ETH, and this capability is supported, then the API can be instructed to sell 1 or other amount of ETH.
Specifies if this order type supports placing sell orders in quote symbol amounts. For example, if payment/quote symbol is USDC, and this capability is supported, then the API can be instructed to sell asset for 10 USDC or other amount.
Specifies if this order type is supported for this integration.
The list of supported Time-in-force instructions for this order type.
immediateOrCancel, goodTillCanceled, goodTillDate, fillOrKill Specifies if this order type supports placing buy orders in base symbol amounts. For example, if payment/quote symbol is USD, base symbol is ETH, and this capability is supported, then the API can be instructed to buy 1 or other amount of ETH.
Specifies if this order type supports placing buy orders in quote symbol amounts. For example, if payment/quote symbol is USDC, and this capability is supported, then the API can be instructed to buy asset for 10 USDC or other amount.
Specifies if this order type supports placing sell orders in base symbol amounts. For example, if payment/quote symbol is USD, base symbol is ETH, and this capability is supported, then the API can be instructed to sell 1 or other amount of ETH.
Specifies if this order type supports placing sell orders in quote symbol amounts. For example, if payment/quote symbol is USDC, and this capability is supported, then the API can be instructed to sell asset for 10 USDC or other amount.
Model, describing the ability to place cryptocurrency orders.
Specifies if this order type is supported for this integration.
The list of supported Time-in-force instructions for this order type.
goodTillCanceled, immediateOrCancel, fillOrKill, goodForDay, postOnly, unknown Indicates if pre-market trading or after-hours trading is supported.
Specifies if this order type supports buying or selling in fractional amounts. If this value is false, then only whole shares can be traded.
Specifies if this order type supports placing buy orders in base symbol amounts. For example, if payment/quote symbol is USD, base symbol is AAPL, and this capability is supported, then the API can be instructed to buy 1 or other amount of AAPL.
Specifies if this order type supports placing buy orders in payment/quote symbol amounts. For example, if payment/quote symbol is USD, and this capability is supported, then the API can be instructed to buy asset for $10 or other dollar amount.
Specifies if this order type supports placing sell orders in base symbol amounts. For example, if payment/quote symbol is USD, base symbol is AAPL, and this capability is supported, then the API can be instructed to sell 1 or other amount of AAPL.
Specifies if this order type supports placing sell orders in payment/quote symbol amounts. For example, if payment/quote symbol is USD, and this capability is supported, then the API can be instructed to sell asset for $10 or other dollar amount.
Specifies if this order type is supported for this integration.
The list of supported Time-in-force instructions for this order type.
goodTillCanceled, immediateOrCancel, fillOrKill, goodForDay, postOnly, unknown Indicates if pre-market trading or after-hours trading is supported.
Specifies if this order type supports buying or selling in fractional amounts. If this value is false, then only whole shares can be traded.
Specifies if this order type supports placing buy orders in base symbol amounts. For example, if payment/quote symbol is USD, base symbol is AAPL, and this capability is supported, then the API can be instructed to buy 1 or other amount of AAPL.
Specifies if this order type supports placing buy orders in payment/quote symbol amounts. For example, if payment/quote symbol is USD, and this capability is supported, then the API can be instructed to buy asset for $10 or other dollar amount.
Specifies if this order type supports placing sell orders in base symbol amounts. For example, if payment/quote symbol is USD, base symbol is AAPL, and this capability is supported, then the API can be instructed to sell 1 or other amount of AAPL.
Specifies if this order type supports placing sell orders in payment/quote symbol amounts. For example, if payment/quote symbol is USD, and this capability is supported, then the API can be instructed to sell asset for $10 or other dollar amount.
Specifies if this order type is supported for this integration.
The list of supported Time-in-force instructions for this order type.
goodTillCanceled, immediateOrCancel, fillOrKill, goodForDay, postOnly, unknown Indicates if pre-market trading or after-hours trading is supported.
Specifies if this order type supports buying or selling in fractional amounts. If this value is false, then only whole shares can be traded.
Specifies if this order type supports placing buy orders in base symbol amounts. For example, if payment/quote symbol is USD, base symbol is AAPL, and this capability is supported, then the API can be instructed to buy 1 or other amount of AAPL.
Specifies if this order type supports placing buy orders in payment/quote symbol amounts. For example, if payment/quote symbol is USD, and this capability is supported, then the API can be instructed to buy asset for $10 or other dollar amount.
Specifies if this order type supports placing sell orders in base symbol amounts. For example, if payment/quote symbol is USD, base symbol is AAPL, and this capability is supported, then the API can be instructed to sell 1 or other amount of AAPL.
Specifies if this order type supports placing sell orders in payment/quote symbol amounts. For example, if payment/quote symbol is USD, and this capability is supported, then the API can be instructed to sell asset for $10 or other dollar amount.
List of fiat balances of the account.
Buying power indicating the maximum amount the user can spend to buy assets. E.g. available margin.
Withdrawable cash amount on the account.
Buying power available for placing cryptocurrency orders.
ISO 4217 currency code.
Limit for history records
Indicates if the integration is available.
Indicates if trading is generally supported at this time.
Status of the request.
succeeded, failed, notAuthorized Model, describing the ability to place equity orders.
Specifies if this order type is supported for this integration.
The list of supported Time-in-force instructions for this order type.
goodTillCanceled, immediateOrCancel, fillOrKill, goodForDay, postOnly, unknown Indicates if pre-market trading or after-hours trading is supported.
Specifies if this order type supports buying or selling in fractional amounts. If this value is false, then only whole shares can be traded.
Specifies if this order type supports placing buy orders in base symbol amounts. For example, if payment/quote symbol is USD, base symbol is AAPL, and this capability is supported, then the API can be instructed to buy 1 or other amount of AAPL.
Specifies if this order type supports placing buy orders in payment/quote symbol amounts. For example, if payment/quote symbol is USD, and this capability is supported, then the API can be instructed to buy asset for $10 or other dollar amount.
Specifies if this order type supports placing sell orders in base symbol amounts. For example, if payment/quote symbol is USD, base symbol is AAPL, and this capability is supported, then the API can be instructed to sell 1 or other amount of AAPL.
Specifies if this order type supports placing sell orders in payment/quote symbol amounts. For example, if payment/quote symbol is USD, and this capability is supported, then the API can be instructed to sell asset for $10 or other dollar amount.
Specifies if this order type is supported for this integration.
The list of supported Time-in-force instructions for this order type.
goodTillCanceled, immediateOrCancel, fillOrKill, goodForDay, postOnly, unknown Indicates if pre-market trading or after-hours trading is supported.
Specifies if this order type supports buying or selling in fractional amounts. If this value is false, then only whole shares can be traded.
Specifies if this order type supports placing buy orders in base symbol amounts. For example, if payment/quote symbol is USD, base symbol is AAPL, and this capability is supported, then the API can be instructed to buy 1 or other amount of AAPL.
Specifies if this order type supports placing buy orders in payment/quote symbol amounts. For example, if payment/quote symbol is USD, and this capability is supported, then the API can be instructed to buy asset for $10 or other dollar amount.
Specifies if this order type supports placing sell orders in base symbol amounts. For example, if payment/quote symbol is USD, base symbol is AAPL, and this capability is supported, then the API can be instructed to sell 1 or other amount of AAPL.
Specifies if this order type supports placing sell orders in payment/quote symbol amounts. For example, if payment/quote symbol is USD, and this capability is supported, then the API can be instructed to sell asset for $10 or other dollar amount.
Specifies if this order type is supported for this integration.
The list of supported Time-in-force instructions for this order type.
goodTillCanceled, immediateOrCancel, fillOrKill, goodForDay, postOnly, unknown Indicates if pre-market trading or after-hours trading is supported.
Specifies if this order type supports buying or selling in fractional amounts. If this value is false, then only whole shares can be traded.
Specifies if this order type supports placing buy orders in base symbol amounts. For example, if payment/quote symbol is USD, base symbol is AAPL, and this capability is supported, then the API can be instructed to buy 1 or other amount of AAPL.
Specifies if this order type supports placing buy orders in payment/quote symbol amounts. For example, if payment/quote symbol is USD, and this capability is supported, then the API can be instructed to buy asset for $10 or other dollar amount.
Specifies if this order type supports placing sell orders in base symbol amounts. For example, if payment/quote symbol is USD, base symbol is AAPL, and this capability is supported, then the API can be instructed to sell 1 or other amount of AAPL.
Specifies if this order type supports placing sell orders in payment/quote symbol amounts. For example, if payment/quote symbol is USD, and this capability is supported, then the API can be instructed to sell asset for $10 or other dollar amount.
Indicates if it is possible to cancel the placed order, while it's in the InProgress status.
Indicates if the preview of orders (preview order execution endpoint) is provided by the institution.
This allows to validate the order using the API of the institution. If the order preview is not supported,
Front API validates the order without calling the institution's API.
Supports getting price information directly from the institution.
Indicates whether the current exchange uses spreads as costs for trading
User-friendly display message that can be presented to the end user
Strictly-typed error type that is explaining the reason of an unsuccessful status of the operation. All possible error types are available in the documentation.
A message generated by the API
ok, serverFailure, permissionDenied, badRequest, notFound, conflict, tooManyRequest, locked, unavailableForLegalReasons