GET
/
api
/
v1
/
balance
/
portfolio
curl --request GET \
  --url https://integration-api.getfront.com/api/v1/balance/portfolio \
  --header 'X-Client-Id: <api-key>' \
  --header 'X-Client-Secret: <api-key>'
{
  "content": {
    "fiatBalances": [
      {
        "symbol": "USD",
        "cash": 3.099,
        "buyingPower": 3.099
      },
      {
        "symbol": "EUR",
        "cash": -102.88,
        "buyingPower": 1293.596
      }
    ]
  },
  "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

Query Parameters

UserId
string

End user ID to get the aggregated portfolio for.

Response

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