Skip to main content
POST
/
clients
/
me
/
integrations
/
yield-xyz
/
actions
/
exit
Exit a yield position
curl --request POST \
  --url https://api.portalhq.io/api/v3/clients/me/integrations/yield-xyz/actions/exit \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "yieldId": "<string>",
  "address": "<string>",
  "arguments": {
    "amount": "<string>",
    "validatorAddress": "<string>",
    "validatorAddresses": [
      "<string>"
    ],
    "providerId": "<string>",
    "duration": 123,
    "inputToken": "<string>",
    "subnetId": 123,
    "tronResource": "BANDWIDTH",
    "feeConfigurationId": "<string>",
    "cosmosPubKey": "<string>",
    "tezosPubKey": "<string>",
    "cAddressBech": "<string>",
    "pAddressBech": "<string>",
    "executionMode": "individual",
    "ledgerWalletApiCompatible": true,
    "skipPrechecks": true,
    "feePayerAddress": "<string>"
  }
}
'
{
  "data": {
    "rawResponse": {
      "transactions": [
        {}
      ],
      "yieldId": "<string>"
    }
  }
}

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.

Authorizations

​
Authorization
string
header
required

Client API Key or Client Session Token (CST). Pass as a Bearer token in the Authorization header.

Body

application/json
​
yieldId
string
required

The yield opportunity ID to exit.

​
address
string
required

Wallet address exiting the yield position.

​
arguments
object

Optional yield-specific arguments. Which fields are supported depends on the yield opportunity's mechanics.

Response

Exit transactions built successfully

​
data
object