Sign in
Actions

Simulate entering a yield

Simulates an enter action without creating or persisting an action or transactions. The response is sectioned so it can grow additively: v1 returns gas (and entryReserveEstimate for Solana enters); fee and execution-outcome sections will be added as further optional keys. A 200 does not guarantee the action would succeed on-chain — construction-level prechecks may be skipped during simulation.

post/v1/actions/enter/simulate

Request

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

Request body

yieldIdstring required

Yield ID to perform the action on

addressstring required

User wallet address

Example request

{
  "yieldId": "ethereum-eth-lido-staking",
  "address": "0x1234...",
  "arguments": {
    "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"
  }
}

Response

Simulation result for the enter action

entryReserveEstimatestring

Total SOL side-reserve required for enter validation: account rent plus ~0.005 SOL priority-fee buffer. For max native-SOL deposit use balance minus this value; do not also subtract the gas amount. Only returned on enter simulations; omitted for exits and when unavailable.

Example response

{
  "gas": {
    "token": {
      "symbol": "ETH",
      "name": "Ethereum",
      "decimals": 18,
      "network": "Ethereum",
      "address": "0x...",
      "logoURI": "https://...",
      "isPoints": true,
      "coinGeckoId": "ethereum"
    },
    "transactions": [
      {
        "token": {
          "symbol": "ETH",
          "name": "Ethereum",
          "decimals": 18,
          "network": "Ethereum",
          "address": "0x...",
          "logoURI": "https://...",
          "isPoints": true,
          "coinGeckoId": "ethereum"
        }
      }
    ]
  }
}

Changes

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