Savings
Get savings summary
Returns balances for all savings accounts associated with the authenticated wallet.
Each balance entry includes the savings account ID, currency, total capital contributed, claimed interest, and unclaimed interest.
Requires the savings permission on the API key.
get/savings/summary
Request
- Base URLhttps://api.altcointrader.co.za
- AuthAPI key in header X-API-KEY and API key in header X-TIMESTAMP and API key in header X-SIGNATURE
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Response
Savings summary returned successfully.
Example response
{
"wallet_id": "wallet-001",
"balances": [
{
"savings_account_id": "sav-001",
"currency": "USDT",
"capital_contributions": "1000.00000000",
"claimed_interest": "12.50000000",
"unclaimed_interest": "3.20000000",
"calculated_at": 1712000000
}
],
"calculated_at": 1712000000
}Changes
No recorded changes to this operation across all 3 revisions of this API.