Method Signature
agent.getPortfolio(params: GetPortfolioParams): Promise<AgentInfo>
Description
Retrieves comprehensive information about an agent including current status, deposits, withdrawals, and protocol configuration.
Parameters
Smart account wallet address.
Set to true if the wallet parameter is an origin wallet address instead of a smart account address.
Return Value
Smart account wallet address.
Current agent status. One of:
active - Agent is actively optimizingdeactivated - Agent has been stoppeddeactivating - Agent is in the process of deactivatingactivating - Agent is in the process of activatingactivation_failed - Agent failed to activatedeactivated_fee_not_paid - Agent deactivated due to unpaid fees
List of deposits made to the agent.
List of withdrawals (optional).
When the agent was activated.
Protocols the agent is configured to use.
Protocols currently being used (optional).
Token currently being managed (optional).
Origin wallet address (optional).
Example
import { GizaAgent, Chain } from '@giza/agent-sdk';
const giza = new GizaAgent({ chainId: Chain.BASE });
// Get portfolio by smart account address
const portfolio = await giza.agent.getPortfolio({
wallet: smartAccountAddress,
});
console.log('Status:', portfolio.status);
console.log('Activation Date:', portfolio.activation_date);
console.log('Selected Protocols:', portfolio.selected_protocols);
// Calculate total deposits
const totalDeposits = portfolio.deposits.reduce(
(sum, deposit) => sum + deposit.amount,
0
);
console.log('Total Deposits:', totalDeposits);
// Get portfolio by origin wallet
const portfolioByOrigin = await giza.agent.getPortfolio({
wallet: userWallet,
is_origin_wallet: true,
});
Output
{
wallet: '0xabc123...',
status: 'active',
deposits: [
{
amount: 1000000000, // 1000 USDC
token_type: '0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913',
date: '2024-01-15T12:00:00Z',
tx_hash: '0x...'
}
],
withdraws: [],
activation_date: '2024-01-15T12:00:00Z',
selected_protocols: ['aave', 'compound', 'moonwell'],
current_protocols: ['aave'],
current_token: 'USDC',
eoa: '0x742d35Cc6634C0532925a3b844Bc454e4438f44e'
}
Error Handling
import { ValidationError, GizaAPIError } from '@giza/agent-sdk';
try {
const portfolio = await giza.agent.getPortfolio({
wallet: smartAccountAddress,
});
} catch (error) {
if (error instanceof ValidationError) {
console.error('Invalid parameters:', error.message);
} else if (error instanceof GizaAPIError) {
console.error('Failed to get portfolio:', error.message);
}
}
Next Steps
