POST
/
api
/
v1
/
balance
/
get
curl --request POST \
  --url https://integration-api.meshconnect.com/api/v1/balance/get \
  --header 'Content-Type: application/json' \
  --header 'X-Client-Id: <api-key>' \
  --header 'X-Client-Secret: <api-key>' \
  --data '{
  "authToken": "Secret authentication token",
  "type": "binanceInternationalDirect"
}'
{
  "content": {
    "balances": [
      {
        "cash": 158.5,
        "buyingPower": 258.5,
        "currencyCode": "USD"
      },
      {
        "cash": 10,
        "buyingPower": 10,
        "currencyCode": "EUR"
      }
    ],
    "totalCashUsdValue": 10,
    "totalBuyingPowerUsdValue": 10
  },
  "status": "ok",
  "message": "",
  "errorType": ""
}

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
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 Alpaca Coinbase Kraken CryptoCom Binance Gemini OkCoin KuCoin CexIo BinanceInternational Bitstamp GateIo Okx BitFlyer Coinlist Huobi Bitfinex KrakenDirect BinanceInternationalDirect BitfinexDirect Bybit Paxos CoinbasePrime BtcTurkDirect KuCoinDirect OkxOAuth ParibuDirect RobinhoodConnect BlockchainCom BitsoDirect BybitDirect ParibuOAuth BinanceTrDirect

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,
paribuOAuth,
payPalConnect,
binanceTrDirect

Response

200
application/json
OK
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