Get balances
curl --request GET \
--url https://api.portalhq.io/api/v3/clients/me/integrations/agg/balances \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.portalhq.io/api/v3/clients/me/integrations/agg/balances"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.portalhq.io/api/v3/clients/me/integrations/agg/balances', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.portalhq.io/api/v3/clients/me/integrations/agg/balances",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.portalhq.io/api/v3/clients/me/integrations/agg/balances"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.portalhq.io/api/v3/clients/me/integrations/agg/balances")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.portalhq.io/api/v3/clients/me/integrations/agg/balances")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": {
"cash": [
{
"tokenSymbol": "<string>",
"totalRaw": "<string>",
"decimals": 123,
"chains": [
{
"chainId": "<string>",
"tokenAddress": "<string>",
"balanceRaw": "<string>",
"decimals": 123,
"lastSyncedAt": "<string>",
"heldRaw": "<string>",
"availableRaw": "<string>",
"tokenSymbol": "<string>",
"address": "<string>",
"custodyKind": "<string>",
"venue": "<string>",
"venueAccountId": "<string>",
"externalAccountId": "<string>",
"isFresh": true,
"registeredByAgg": true,
"legacyKind": "<string>"
}
],
"availableRaw": "<string>",
"reservedRaw": "<string>"
}
],
"positions": [
{
"venue": "<string>",
"balance": 123,
"costBasis": 123,
"unrealizedPnl": 123,
"realizedPnl": 123,
"priceSource": "<string>",
"bookQuality": "<string>",
"migrationPending": true,
"costBasisUnknown": true,
"realizedPnlIncomplete": true
}
],
"venueCash": [
{
"venue": "<string>",
"balanceCents": 123,
"updatedAt": "<string>",
"transferable": true,
"executionBackend": "<string>",
"accountModel": "<string>",
"asset": "<string>",
"decimals": 123,
"balanceRaw": "<string>",
"availableRaw": "<string>",
"unmatchedExposureRaw": "<string>",
"portfolioValueCents": 123
}
],
"paper": {
"startingBalance": 123,
"cashBalance": 123,
"positionsValue": 123,
"realizedPnl": 123,
"unrealizedPnl": 123,
"earnings": 123
}
}
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "yield-xyz-borrow returned a response for GET /v1/positions that does not match the expected schema",
"id": "INTEGRATION_RESPONSE_SCHEMA_DRIFT",
"details": {
"integration": "yield-xyz-borrow",
"endpoint": "GET /v1/positions",
"issues": [
{
"path": "supplyBalances.0.balanceUsd",
"message": "Expected string, received number",
"code": "invalid_type"
}
]
}
}{
"error": "<string>"
}Agg
Get balances
Cash by token with a per-chain breakdown, and the value of open positions by venue.
Needs a linked Agg session (POST /link). Not available to account-abstracted clients.
GET
/
clients
/
me
/
integrations
/
agg
/
balances
Get balances
curl --request GET \
--url https://api.portalhq.io/api/v3/clients/me/integrations/agg/balances \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.portalhq.io/api/v3/clients/me/integrations/agg/balances"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.portalhq.io/api/v3/clients/me/integrations/agg/balances', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.portalhq.io/api/v3/clients/me/integrations/agg/balances",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.portalhq.io/api/v3/clients/me/integrations/agg/balances"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.portalhq.io/api/v3/clients/me/integrations/agg/balances")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.portalhq.io/api/v3/clients/me/integrations/agg/balances")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": {
"cash": [
{
"tokenSymbol": "<string>",
"totalRaw": "<string>",
"decimals": 123,
"chains": [
{
"chainId": "<string>",
"tokenAddress": "<string>",
"balanceRaw": "<string>",
"decimals": 123,
"lastSyncedAt": "<string>",
"heldRaw": "<string>",
"availableRaw": "<string>",
"tokenSymbol": "<string>",
"address": "<string>",
"custodyKind": "<string>",
"venue": "<string>",
"venueAccountId": "<string>",
"externalAccountId": "<string>",
"isFresh": true,
"registeredByAgg": true,
"legacyKind": "<string>"
}
],
"availableRaw": "<string>",
"reservedRaw": "<string>"
}
],
"positions": [
{
"venue": "<string>",
"balance": 123,
"costBasis": 123,
"unrealizedPnl": 123,
"realizedPnl": 123,
"priceSource": "<string>",
"bookQuality": "<string>",
"migrationPending": true,
"costBasisUnknown": true,
"realizedPnlIncomplete": true
}
],
"venueCash": [
{
"venue": "<string>",
"balanceCents": 123,
"updatedAt": "<string>",
"transferable": true,
"executionBackend": "<string>",
"accountModel": "<string>",
"asset": "<string>",
"decimals": 123,
"balanceRaw": "<string>",
"availableRaw": "<string>",
"unmatchedExposureRaw": "<string>",
"portfolioValueCents": 123
}
],
"paper": {
"startingBalance": 123,
"cashBalance": 123,
"positionsValue": 123,
"realizedPnl": 123,
"unrealizedPnl": 123,
"earnings": 123
}
}
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "yield-xyz-borrow returned a response for GET /v1/positions that does not match the expected schema",
"id": "INTEGRATION_RESPONSE_SCHEMA_DRIFT",
"details": {
"integration": "yield-xyz-borrow",
"endpoint": "GET /v1/positions",
"issues": [
{
"path": "supplyBalances.0.balanceUsd",
"message": "Expected string, received number",
"code": "invalid_type"
}
]
}
}{
"error": "<string>"
}Authorizations
Client API Key or Client Session Token (CST). Pass as a Bearer token in the Authorization header.
Query Parameters
true re-reads the chains first, e.g. right after a deposit. Live mode only.
live (default) or paper. Paper rows only appear on reads that pass the same mode.
Available options:
live, paper Response
Success
Show child attributes
Show child attributes
Was this page helpful?