LedgerReadService
Get Portfolio Equity Snapshot
Retrieve current root portfolio equity grouped by logical account and asset.
Method
GET
Path
/v1/equity/portfolio/snapshot
Visibility
Authentication
Session token
MFA Requirement
Not required
GET
/v1/equity/portfolio/snapshot Request
Testnet
curl --request GET \ \ --url 'https://api.testnet.polyester.com/v1/equity/portfolio/snapshot' \ --header 'Accept: */*' \ --header 'X-API-KEY-ID: YOUR_API_KEY_ID' \ --header 'X-API-TIMESTAMP: YOUR_API_TIMESTAMP' \ --header 'X-API-SIGNATURE: YOUR_API_SIGNATURE'
Responses
{
"accounts": [
{
"accountId": "4Rh4iXdT",
"equity": "0.0001",
"topAssetIds": [
100
]
}
],
"assets": [
{
"asset": "USDT",
"balance": "0.0000001",
"equity": "0.0001"
}
],
"btcPrice": "0.005",
"quoteAsset": "USDT",
"totalEquity": "0.0001"
} 3 fields
accountId string
Public master-account or subaccount ID.
Example
4Rh4iXdT equity string
Current equity in USDT scaled by 1e4 (4 decimals).
Example
0.0001 topAssetIds integer[]
Up to three assets with the highest current equity value, ordered highest first. Assets without a current value are omitted.
Example
[100] 3 fields
asset string
Public unified asset ID.
Example
USDT balance string
Combined Funding and Trading balance in asset units scaled by 1e7 (7 decimals).
Example
0.0000001 equity string
Current equity in USDT scaled by 1e4 (4 decimals).
Example
0.0001 btcPrice string
Current BTC-USDT price scaled by 1e9. Zero when unavailable.
Example
0.005 quoteAsset string
Human-readable quote asset symbol (always "USDT").
Example
USDT totalEquity string
Current equity across the master account and all owned subaccounts in USDT, scaled by 1e4 (4 decimals).
Example
0.0001| Key | Status | Error | When |
|---|---|---|---|
| unauthenticated | 401 | Unauthenticated | Authentication required. |
| permission-denied | 403 | Permission Denied | Permission denied. |
| invalid-argument | 400 | Invalid Argument | Invalid argument. |
| not-found | 404 | Not Found | Not found. |
| unavailable | 503 | Unavailable | Service unavailable. |