Skip to main content
GET
/
v1
/
actions
/
{actionId}
Get action details
curl --request GET \
  --url https://api.yield.xyz/v1/actions/{actionId} \
  --header 'x-api-key: <api-key>'
{
  "id": "action_123abc",
  "intent": "manage",
  "type": "CLAIM_REWARDS",
  "yieldId": "ethereum-eth-lido-staking",
  "address": "0x1234...",
  "amount": "1000000000000000000",
  "amountRaw": "1000000000000000000",
  "amountUsd": "1500.50",
  "transactions": [
    {
      "id": "tx_123abc",
      "title": "Approve USDC",
      "network": "ethereum",
      "status": "PENDING",
      "type": "STAKE",
      "hash": "0x1234567890abcdef...",
      "createdAt": "2023-11-07T05:31:56Z",
      "broadcastedAt": "2023-11-07T05:31:56Z",
      "signedTransaction": "<string>",
      "unsignedTransaction": "0x02f87082012a022f2f83018000947a250d5630b4cf539739df2c5dacb4c659f2488d880de0b6b3a764000080c080a0ef0de6c7b46fc75dd6cb86dccc3cfd731c2bdf6f3d736557240c3646c6fe01a6a07cd60b58dfe01847249dfdd7950ba0d045dded5bbe410b07a015a0ed34e5e00d",
      "annotatedTransaction": {
        "method": "stake",
        "inputs": {
          "amount": "1000000000000000000"
        }
      },
      "structuredTransaction": {},
      "stepIndex": 0,
      "description": "Approve USDC for staking",
      "error": "<string>",
      "gasEstimate": "21000",
      "explorerUrl": "https://etherscan.io/tx/0x1234...",
      "isMessage": false
    }
  ],
  "executionPattern": "synchronous",
  "rawArguments": {
    "amount": "1000000000000000000",
    "validatorAddress": "cosmosvaloper1...",
    "validatorAddresses": [
      "cosmosvaloper1...",
      "cosmosvaloper2..."
    ],
    "providerId": "kiln",
    "duration": 1209600,
    "inputToken": "0xA0b86a33E6776C8DB91C5C7AcE16ccE5C5eE0d7E",
    "subnetId": 1,
    "feeConfigurationId": "custom-fee-config-1",
    "cosmosPubKey": "cosmospub1...",
    "tezosPubKey": "edpk...",
    "cAddressBech": "0x123...",
    "pAddressBech": "P-avax1...",
    "executionMode": "individual",
    "ledgerWalletApiCompatible": true
  },
  "createdAt": "2023-11-07T05:31:56Z",
  "completedAt": "2023-11-07T05:31:56Z"
}

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
actionId
string
required

The unique identifier of the action

Response

Action details retrieved successfully

​
id
string
required

Unique action identifier

Example:

"action_123abc"

​
intent
enum<string>
required

High-level action intent

Available options:
enter,
manage,
exit
Example:

"manage"

​
type
enum<string>
required

Specific action type

Available options:
STAKE,
UNSTAKE,
CLAIM_REWARDS,
RESTAKE_REWARDS,
WITHDRAW,
WITHDRAW_ALL,
RESTAKE,
CLAIM_UNSTAKED,
UNLOCK_LOCKED,
STAKE_LOCKED,
VOTE,
REVOKE,
VOTE_LOCKED,
REVOTE,
REBOND,
MIGRATE,
VERIFY_WITHDRAW_CREDENTIALS,
DELEGATE
Example:

"CLAIM_REWARDS"

​
yieldId
string
required

Yield ID this action belongs to

Example:

"ethereum-eth-lido-staking"

​
address
string
required

User wallet address

Example:

"0x1234..."

​
amount
string | null
required

Amount involved in the action

Example:

"1000000000000000000"

​
amountRaw
string | null
required

Raw wei amount (full precision)

Example:

"1000000000000000000"

​
amountUsd
string | null
required

USD value of the amount

Example:

"1500.50"

​
transactions
object[]
required

Array of transactions for this action

​
executionPattern
enum<string>
required

Transaction execution pattern - synchronous (submit one by one, wait for each), asynchronous (submit all at once), or batch (single transaction with multiple operations)

Available options:
synchronous,
asynchronous,
batch
Example:

"synchronous"

​
rawArguments
object
required

Raw arguments exactly as submitted by the user for this action

​
createdAt
string<date-time>
required

When the action was created

​
completedAt
string<date-time> | null
required

When the action was completed

​
status
enum<string>
required

Current status of the action

Available options:
CANCELED,
CREATED,
WAITING_FOR_NEXT,
PROCESSING,
FAILED,
SUCCESS,
STALE