Documentation Index
Fetch the complete documentation index at: https://docs.portalhq.io/llms.txt
Use this file to discover all available pages before exploring further.
Function Signature
Future<YieldXyzGetHistoricalActionsResponse> getHistoricalActions({
int? offset,
int? limit,
String? address,
YieldXyzActionStatus? status,
YieldXyzActionIntent? intent,
String? type,
String? yieldId,
})
Description
Retrieve past yield actions including entries, exits, and management operations.
Parameters
| Parameter | Type | Required | Description |
|---|
offset | int? | No | Pagination offset |
limit | int? | No | Maximum number of results |
address | String? | No | Filter by wallet address |
status | YieldXyzActionStatus? | No | Filter by action status |
intent | YieldXyzActionIntent? | No | Filter by action intent (enter, exit, manage) |
type | String? | No | Filter by action type |
yieldId | String? | No | Filter by yield opportunity ID |
Returns
YieldXyzGetHistoricalActionsResponse - An object containing:
| Property | Type | Description |
|---|
items | List<YieldXyzHistoricalActionItem?> | List of historical actions |
total | int | Total number of actions |
offset | int | Current pagination offset |
limit | int | Current page size |
metadata | YieldXyzGetBalancesMetadata? | Response metadata |
error | String? | Error message, if any |
Example
import 'package:portal_flutter/portal_flutter.dart';
final portal = Portal();
final response = await portal.yieldIntegrations.yieldxyz.getHistoricalActions(
address: '0x1234...',
intent: YieldXyzActionIntent.enter,
limit: 20,
);
for (final action in response.items) {
if (action != null) {
print('Action: ${action.id} - ${action.status}');
}
}
Errors
| Code | Description |
|---|
NOT_INITIALIZED | Portal was not initialized |
YIELD_FAILED | Failed to get historical yield actions |
