POST
/
api
/
v1
/
holdings
/
get
curl --request POST \
  --url https://integration-api.getfront.com/api/v1/holdings/get \
  --header 'Content-Type: application/json' \
  --header 'X-Client-Id: <api-key>' \
  --header 'X-Client-Secret: <api-key>' \
  --data '{
  "authToken": "<string>",
  "type": "robinhood",
  "includeMarketValue": true
}'
{
  "content": {
    "equityPositions": [
      {
        "symbol": "AAPL",
        "amount": 3,
        "costBasis": 109
      },
      {
        "symbol": "F",
        "amount": 27,
        "costBasis": 7.05791
      }
    ],
    "cryptocurrencyPositions": [
      {
        "marketValue": 75.15,
        "lastPrice": 0.05,
        "symbol": "DOGE",
        "amount": 1503,
        "costBasis": 0.033
      },
      {
        "symbol": "BTC",
        "amount": 3.0001672,
        "costBasis": 18000
      }
    ],
    "status": "succeeded",
    "notSupportedEquityPositions": [
      {
        "symbol": "CUSIP38259P508",
        "amount": 1
      }
    ],
    "notSupportedCryptocurrencyPositions": [],
    "nftPositions": [],
    "optionPositions": [],
    "type": "robinhood",
    "accountId": "5FUVPB0",
    "institutionName": "Robinhood",
    "accountName": "Margin account"
  },
  "status": "ok",
  "message": "",
  "errorType": ""
}

Authorizations

​
X-Client-Secret
string
header
required

Contact Front to get client Secret

​
X-Client-Id
string
header
required

Contact Front to get client Id

Body

application/json
Request containing authentication token
​
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 OpenSea Binance Gemini OkCoin KuCoin Etoro CexIo BinanceInternational Bitstamp GateIo Acorns Okx BitFlyer Coinlist Huobi Bitfinex KrakenDirect Vanguard BinanceInternationalDirect BitfinexDirect Bybit Paxos CoinbasePrime DeFiWallet

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
​
includeMarketValue
boolean

Response

200
application/json
Holdings obtained
​
status
enum<string>
Available options:
ok,
serverFailure,
permissionDenied,
badRequest,
notFound,
conflict,
tooManyRequest,
locked
​
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.

​
content
object
Get transfers initiated by MeshGet holdings values.