POST
/
api
/
v1
/
balance
/
get

Authorizations

​
X-Client-Secret
string
headerrequired

Contact Mesh to get client Secret

​
X-Client-Id
string
headerrequired

Contact Mesh to get client Id

Body

application/json
​
authToken
string
required

Auth token that allows connecting to the target institution

Minimum length: 1
​
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 Acorns Okx BitFlyer Coinlist Huobi Bitfinex KrakenDirect Vanguard BinanceInternationalDirect BitfinexDirect Bybit Paxos CoinbasePrime BtcTurkDirect KuCoinDirect OkxOAuth ParibuDirect RobinhoodConnect BlockchainCom BitsoDirect

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

Response

200 - application/json
​
status
enum<string>
Available options:
ok,
serverFailure,
permissionDenied,
badRequest,
notFound,
conflict,
tooManyRequest,
locked,
unavailableForLegalReasons
​
message
string | null

A message generated by the API

​
displayMessage
string | null

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

​
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.

​
errorData
any | null
​
content
object
Get aggregated portfolioGet aggregated portfolio fiat balances