Get symbol information

Authorizations

X-Client-Secret

string

header

required

Contact Mesh to get client Secret

X-Client-Id

string

header

required

Contact Mesh to get client Id

Body

application/json

amount

number

required

Amount of purchase.

amountIsInPaymentSymbol

boolean

required

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.

authToken

string

required

Auth token that allows connecting to the target institution

Minimum length: 1

isCryptocurrency

boolean

required

Some Stock and Crypto symbols can intersect, so the type of the asset needs to be specified explicitly.

orderType

enum<string>

required

Available options:

market,

limit,

stopLoss

paymentIsCryptocurrency

boolean

required

Indicates whether the PaymentSymbol is fiat or cryptocurrency

paymentSymbol

string

required

Symbol to use for payment, defaults to USD.

Minimum length: 1

symbol

string

required

Symbol to trade. For example, AAPL or ETH

Minimum length: 1

timeInForce

enum<string>

required

Available options:

goodTillCanceled,

immediateOrCancel,

fillOrKill,

goodForDay,

postOnly,

unknown

type

enum<string>

required

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

Available options:

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

amountInFiat

number | null

deprecated

amountInPaymentSymbol

number | null

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.

amountIsFiat

boolean | null

deprecated

extendedHours

boolean

Specifies if the extended trading hours should be used.

mfaCode

string | null

MFA Code to create an order (requested by Kraken if MFA is enabled in user settings)

price

number

Price of the unit, used for Limit and StopLoss orders.

side

enum<string>

Available options:

unknown,

buy,

sell

Response

200 - application/json

content

object

displayMessage

string | null

User-friendly display message that can be presented to the end user

errorData

any | null

errorType

string | null

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.

message

string | null

A message generated by the API

status

enum<string>

Available options:

ok,

serverFailure,

permissionDenied,

badRequest,

notFound,

conflict,

tooManyRequest,

locked,

unavailableForLegalReasons