Portal Android SDK/io.portalhq.android.api/YieldXyzApi

YieldXyzApi

class YieldXyzApi(host: String, apiKey: String, requests: PortalRequests)

API class specifically for Yield.xyz integration functionality.

This class handles all yield-related API calls including discovering yields, entering/exiting yield opportunities, managing yields, and tracking transactions.

Parameters

host

The base URL of the API server.

apiKey

The API key used for authentication.

requests

An instance of PortalRequests to handle HTTP requests.

Constructors

YieldXyzApi

constructor(host: String, apiKey: String, requests: PortalRequests)

Functions

enterYield

suspend fun enterYield(request: YieldXyzEnterRequest): Result<YieldXyzEnterYieldResponse>

Enters a yield opportunity through the Yield.xyz integration.

exitYield

suspend fun exitYield(request: YieldXyzExitRequest): Result<YieldXyzExitResponse>

Exits a yield opportunity through the Yield.xyz integration.

getHistoricalYieldActions

suspend fun getHistoricalYieldActions(request: YieldXyzGetHistoricalActionsRequest): Result<YieldXyzGetHistoricalActionsResponse>

Retrieves historical yield actions with optional filtering.

getYieldBalances

suspend fun getYieldBalances(request: YieldXyzGetBalancesRequest): Result<YieldXyzGetBalancesResponse>

Retrieves yield balances for specified addresses and networks.

getYields

suspend fun getYields(request: YieldXyzGetYieldsRequest): Result<YieldXyzGetYieldsResponse>

Retrieves yield opportunities from the Yield.xyz integration.

getYieldTransaction

suspend fun getYieldTransaction(transactionId: String): Result<YieldXyzGetTransactionResponse>

Retrieves a single yield action transaction by its ID.

manageYield

suspend fun manageYield(request: YieldXyzManageYieldRequest): Result<YieldXyzManageYieldResponse>

Manages a yield opportunity through the Yield.xyz integration.

submitTransactionHash

suspend fun submitTransactionHash(request: YieldXyzTrackTransactionRequest): Result<Boolean>

Submits a transaction hash for tracking in the Yield.xyz integration.