Sign in
Actions

Get user actions

Retrieve all actions performed by a user, with optional filtering by yield, status, category, etc. STALE actions that never reached the chain are excluded unless a status filter is provided. In the future, this may include personalized action recommendations.

get/v1/actions

Request

  • Base URL: https://api.yield.xyz
  • URL: https://api.yield.xyz/v1/actions
  • Auth: API key in header x-api-key

Query parameters

offsetnumber

Offset for pagination

limitnumber
Example:20

Maximum number of items to return

addressstring required
Example:0x742d35Cc6634C0532925a3b844Bc454e4438f44e

User wallet address to get actions for

status'CANCELED' | 'CREATED' | 'WAITING_FOR_NEXT' | 'PROCESSING' | 'FAILED' | 'SUCCESS' | 'STALE'

Filter actions by status. STALE actions that never reached the chain are excluded unless requested.

statusesstring[]

Filter actions by multiple statuses (supports CSV or repeated query params). STALE actions that never reached the chain are excluded unless requested.

intent'enter' | 'exit' | 'manage'

Filter actions by intent

type'STAKE' | 'UNSTAKE' | 'WITHDRAW_REQUEST' | 'INSTANT_WITHDRAW' | 'CLAIM_REWARDS' | 'AUTO_SWEEP_UNSTAKE_REWARDS' | 'AUTO_SWEEP_WITHDRAW_REWARDS' | 'RESTAKE_REWARDS' | 'WITHDRAW' | 'WITHDRAW_ALL' | 'RESTAKE' | 'CLAIM_UNSTAKED' | 'UNLOCK_LOCKED' | 'STAKE_LOCKED' | 'VOTE' | 'REVOKE' | 'VOTE_LOCKED' | 'REVOTE' | 'REBOND' | 'MIGRATE' | 'VERIFY_WITHDRAW_CREDENTIALS' | 'DELEGATE'

Filter by action type

yieldIdstring
Example:ethereum-eth-lido-staking

Filter actions by specific yield

yieldTypesstring[]

Filter actions by multiple yield types (supports CSV or repeated query params)

network'ethereum' | 'ethereum-goerli' | 'ethereum-holesky' | 'ethereum-sepolia' | 'ethereum-hoodi' | 'arbitrum' | 'base' | 'base-sepolia' | 'gnosis' | 'optimism' | 'polygon' | 'polygon-amoy' | 'starknet' | 'zksync' | 'linea' | 'unichain' | 'plume' | 'monad-testnet' | 'monad' | 'robinhood' | 'robinhood-testnet' | 'arc-testnet' | 'arc' | 'avalanche-c' | 'avalanche-c-atomic' | 'avalanche-p' | 'binance' | 'celo' | 'fantom' | 'harmony' | 'moonriver' | 'okc' | 'viction' | 'core' | 'sonic' | 'plasma' | 'katana' | 'hyperevm' | 'tempo' | 'pharos' | 'xlayer' | 'agoric' | 'akash' | 'axelar' | 'band-protocol' | 'bitsong' | 'canto' | 'chihuahua' | 'comdex' | 'coreum' | 'cosmos' | 'crescent' | 'cronos' | 'cudos' | 'desmos' | 'dydx' | 'evmos' | 'fetch-ai' | 'gravity-bridge' | 'injective' | 'irisnet' | 'juno' | 'kava' | 'ki-network' | 'mars-protocol' | 'nym' | 'okex-chain' | 'onomy' | 'osmosis' | 'persistence' | 'quicksilver' | 'regen' | 'secret' | 'sentinel' | 'sommelier' | 'stafi' | 'stargaze' | 'stride' | 'teritori' | 'tgrade' | 'umee' | 'sei' | 'mantra' | 'celestia' | 'saga' | 'zetachain' | 'dymension' | 'humansai' | 'neutron' | 'polkadot' | 'kusama' | 'westend' | 'bittensor' | 'aptos' | 'binancebeacon' | 'cardano' | 'near' | 'solana' | 'solana-devnet' | 'stellar' | 'stellar-testnet' | 'sui' | 'tezos' | 'tron' | 'ton' | 'ton-testnet' | 'hyperliquid'

Filter by network

Response

Returns a paginated list of user actions

totalnumber required

Total number of items available

offsetnumber required

Offset of the current page

limitnumber required

Limit of the current page

Example response

{
  "total": 100,
  "limit": 20,
  "items": [
    {
      "id": "action_123abc",
      "intent": "manage",
      "type": "CLAIM_REWARDS",
      "yieldId": "ethereum-eth-lido-staking",
      "address": "0x1234...",
      "amount": "1.0",
      "amountRaw": "1000000000000000000",
      "amountUsd": "1500.50",
      "transactions": [
        {
          "id": "tx_123abc",
          "title": "Approve USDC",
          "network": "ethereum",
          "status": "PENDING",
          "type": "STAKE",
          "hash": "0x1234567890abcdef...",
          "annotatedTransaction": {
            "method": "stake",
            "inputs": {
              "amount": "1000000000000000000"
            }
          },
          "description": "Approve USDC for staking",
          "gasEstimate": "21000",
          "explorerUrl": "https://etherscan.io/tx/0x1234..."
        }
      ],
      "events": [
        {
          "id": "event_123abc",
          "type": "REDEMPTION_SETTLED"
        }
      ],
      "executionPattern": "synchronous",
      "rawArguments": {
        "amount": "1.500000",
        "amountRaw": "1000000000000000000",
        "amounts": [
          "1.500000",
          "2.000000"
        ],
        "shareAmount": "1.500000",
        "shareAmountRaw": "1500000",
        "validatorAddress": "cosmosvaloper1...",
        "validatorAddresses": [
          "cosmosvaloper1...",
          "cosmosvaloper2..."
        ],
        "providerId": "kiln",
        "duration": 1209600,
        "inputToken": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48",
        "outputToken": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48",
        "subnetId": 1,
        "feeConfigurationId": "custom-fee-config-1",
        "cosmosPubKey": "cosmospub1...",
        "tezosPubKey": "edpk...",
        "cAddressBech": "0x123...",
        "pAddressBech": "P-avax1...",
        "executionMode": "individual",
        "ledgerWalletApiCompatible": true,
        "useMaxAmount": true,
        "useInstantExecution": true,
        "useAutoClaim": true,
        "useMaxAllowance": true,
        "feePayerAddress": "7Qo3awoTH4y5Vui1FQwsncq2arYDzUuivdeWhwgnAvVo",
        "rangeMin": "0.0",
        "rangeMax": "1.0",
        "percentage": 50,
        "tokenId": "12345"
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.