Get symbol information
Returns information on trading allowance for a provided symbol. For example - some institutions allow fractional trading for some symbols, but do not allow it for others. So before placing an order the API client can check if the required symbol can be traded fractionally with the provided institution.
Authorizations
Contact Mesh to get client Secret
Contact Mesh to get client Id
Body
Auth token that allows connecting to the target institution
Type 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 Symbol to trade. For example, AAPL or ETH
Symbol to use for payment, defaults to USD.
Amount of purchase.
Price of the unit, used for Limit and StopLoss orders.
Some Stock and Crypto symbols can intersect, so the type of the asset needs to be specified explicitly.
Indicates whether the PaymentSymbol is fiat or cryptocurrency
This value indicates if the order should be executed in payment/quote currency amount (e.g. purchase ETH for $10). This can be
performed only if the current institution supports such orders (SupportsPlacingSellOrdersInPaymentSymbolAmount and
SupportsPlacingBuyOrdersInPaymentSymbolAmount fields in get supported order features for institution) and AmountInPaymentSymbol
value is passed.
Specifies the target amount in the payment/quote currency. For example, setting this to 10 when the AmountInPaymentSymbol = true
and PaymentSymbol = USD will instruct the API to place an order to buy/sell the asset worth $10.
Specifies if the extended trading hours should be used.
market, limit, stopLoss goodTillCanceled, immediateOrCancel, fillOrKill, goodForDay, postOnly, unknown MFA Code to create an order (requested by Kraken if MFA is enabled in user settings)
unknown, buy, sell Response
ok, serverFailure, permissionDenied, badRequest, notFound, conflict, tooManyRequest, locked, unavailableForLegalReasons A message generated by the API
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.