ClaimRewards

post

Claims rewards for the specified assets and rewards

Authorizations

BearerAuthApiKeyAuth

Path parameters

addressstringRequired

• Address claiming the rewards

Header parameters

AuthorizationstringRequired

• Authorization token from the request header

Body

• Input parameters for claiming rewards

tostringOptional

The recipient address.

datastringOptional

The data to be sent with the transaction.

valuestringOptional

The value of the transaction.

gasLimitstringOptional

The gas limit for the transaction.

noncestringOptional

The transaction nonce.

simulatebooleanOptional

Whether to simulate the transaction.

gasstringOptional

The gas limit for the transaction.

gasPricestringOptional

The gas price for the transaction.

maxFeePerGasstringOptional

The maximum fee per gas.

maxPriorityFeePerGasstringOptional

The maximum priority fee per gas.

chain_idstringOptional

The chain ID.

encodingstringOptional

The encoding type.

typenumber · doubleOptional

The type of transaction.

blobGasstringOptional

The gas for blob transactions.

blobGasFeeCapstringOptional

The gas fee cap for blob transactions.

blobHashesstring[]Optional

The hashes for blob transactions.

dryrunbooleanOptional

Flag to indicate if the transaction is a dry run.

inputstringOptional

The input data.

EOAbooleanOptional

Flag to indicate if the transaction is from an externally owned account.

contract_addressstringOptional

The address of the contract.

token_idstringOptional

The token ID.

token_idsstringOptional

The token IDs.

approvedbooleanOptional

Whether the transaction is approved.

broadcastbooleanOptional

Flag to indicate if the transaction should be broadcasted.

alwaysIncrementNoncebooleanOptional

Flag to indicate if the nonce should always be incremented.

assetstringOptional

The asset involved in the transaction.

amountstringOptional

The amount of tokens.

interestRateModenumber · doubleOptional

The interest rate mode.

referralCodenumber · doubleOptional

The referral code.

onBehalfOfstringOptional

The address on behalf of which the transaction is made.

receiverAddressstringOptional

The receiver address.

assetsstring[]Optional

The list of asset addresses.

amountsstring[]Optional

The amounts involved in the transaction.

modesnumber · double[]Optional

The modes of the transaction.

paramsstringOptional

Additional parameters.

rateModenumber · doubleOptional

The rate mode.

useAsCollateralbooleanOptional

Whether to use as collateral.

collateralAssetstringOptional

The collateral asset.

debtAssetstringOptional

The debt asset.

userstringOptional

The user address.

debtToCoverstringOptional

The debt to cover.

receiveATokenbooleanOptional

Whether to receive a token.

slippageLimitPercentnumber · doubleOptional

The slippage limit percentage.

minHealthFactorany ofOptional

The minimum health factor.

stringOptional

or

number · doubleOptional

premiumsany ofOptional

The premiums.

string[]Optional

or

number · double[]Optional

initiatorstringOptional

The initiator of the transaction.

rolestringOptional

The role of the user.

accountstringOptional

The account involved in the transaction.

initialDepositany ofOptional

The initial deposit.

stringOptional

or

number · doubleOptional

borrowAmountany ofOptional

The borrow amount.

stringOptional

or

number · doubleOptional

rewardstringOptional

The reward address.

Responses

200

Transaction result of the claim operation

application/json

post

HTTPcURLJavaScriptPython

POST //aave/v3/rewards/{address}/claimRewards HTTP/1.1
Host: beta.usemoon.ai
Authorization: text
Content-Type: application/json
Accept: */*
Content-Length: 1111

{
  "to": "text",
  "data": "text",
  "value": "text",
  "gasLimit": "text",
  "nonce": "text",
  "simulate": true,
  "gas": "text",
  "gasPrice": "text",
  "maxFeePerGas": "text",
  "maxPriorityFeePerGas": "text",
  "chain_id": "text",
  "encoding": "text",
  "type": 1,
  "accessList": [
    {
      "address": "text",
      "storageKeys": [
        "text"
      ]
    }
  ],
  "blobGas": "text",
  "blobGasFeeCap": "text",
  "blobHashes": [
    "text"
  ],
  "dryrun": true,
  "input": "text",
  "EOA": true,
  "contract_address": "text",
  "token_id": "text",
  "token_ids": "text",
  "approved": true,
  "broadcast": true,
  "alwaysIncrementNonce": true,
  "asset": "text",
  "amount": "text",
  "interestRateMode": 1,
  "referralCode": 1,
  "onBehalfOf": "text",
  "receiverAddress": "text",
  "assets": [
    "text"
  ],
  "amounts": [
    "text"
  ],
  "modes": [
    1
  ],
  "params": "text",
  "rateMode": 1,
  "useAsCollateral": true,
  "collateralAsset": "text",
  "debtAsset": "text",
  "user": "text",
  "debtToCover": "text",
  "receiveAToken": true,
  "inputTokens": [
    {
      "tokenAddress": "text",
      "amount": "text"
    }
  ],
  "outputTokens": [
    {
      "tokenAddress": "text",
      "proportion": 1
    }
  ],
  "slippageLimitPercent": 1,
  "minHealthFactor": "text",
  "premiums": [
    "text"
  ],
  "initiator": "text",
  "role": "text",
  "account": "text",
  "initialDeposit": "text",
  "borrowAmount": "text",
  "reward": "text"
}

200

Transaction result of the claim operation

{
  "success": true,
  "message": "text",
  "data": {
    "simulation": {
      "changes": [
        {
          "assetType": "NATIVE",
          "changeType": "APPROVE",
          "from": "text",
          "to": "text",
          "rawAmount": "text",
          "amount": "text",
          "name": "text",
          "symbol": "text",
          "decimals": 1,
          "contractAddress": "text",
          "logo": "text",
          "tokenId": "text"
        }
      ],
      "gasUsed": "text",
      "error": {
        "message": "text"
      }
    },
    "broadcasted": {
      "success": true,
      "message": "text",
      "data": "text"
    },
    "message": "text",
    "success": true,
    "user_op": "text",
    "data": {
      "simulation": {
        "changes": [
          {
            "assetType": "NATIVE",
            "changeType": "APPROVE",
            "from": "text",
            "to": "text",
            "rawAmount": "text",
            "amount": "text",
            "name": "text",
            "symbol": "text",
            "decimals": 1,
            "contractAddress": "text",
            "logo": "text",
            "tokenId": "text"
          }
        ],
        "gasUsed": "text",
        "error": {
          "message": "text"
        }
      },
      "transaction_hash": "text",
      "signed_transaction": "text",
      "raw_transaction": "text",
      "data": "text",
      "transactions": [
        {
          "moon_scan_url": "text",
          "transaction_hash": "text",
          "signed_transaction": "text",
          "signed_message": "text",
          "raw_transaction": "text",
          "signature": "text",
          "transaction": {
            "type": 1,
            "chain_id": 1,
            "data": "text",
            "gas": "text",
            "gas_price": "text",
            "gas_tip_cap": "text",
            "gas_fee_cap": "text",
            "value": "text",
            "nonce": 1,
            "from": "text",
            "to": "text",
            "blob_gas": "text",
            "blob_gas_fee_cap": "text",
            "blob_hashes": [
              "text"
            ],
            "v": "text",
            "r": "text",
            "s": "text"
          },
          "userOps": [
            {
              "nonce": "text",
              "data": "text",
              "value": "text",
              "to": "text",
              "from": "text",
              "maxFeePerGas": "text",
              "maxPriorityFeePerGas": "text"
            }
          ],
          "userop_transaction": "text"
        }
      ],
      "moon_scan_url": "text",
      "signature": "text",
      "transaction": {
        "type": 1,
        "chain_id": 1,
        "data": "text",
        "gas": "text",
        "gas_price": "text",
        "gas_tip_cap": "text",
        "gas_fee_cap": "text",
        "value": "text",
        "nonce": 1,
        "from": "text",
        "to": "text",
        "blob_gas": "text",
        "blob_gas_fee_cap": "text",
        "blob_hashes": [
          "text"
        ],
        "v": "text",
        "r": "text",
        "s": "text"
      },
      "userOps": [
        {
          "nonce": "text",
          "data": "text",
          "value": "text",
          "to": "text",
          "from": "text",
          "maxFeePerGas": "text",
          "maxPriorityFeePerGas": "text"
        }
      ],
      "userop_transaction": "text",
      "user_op": "text",
      "success": true,
      "message": "text",
      "broadcasted": {
        "success": true,
        "message": "text",
        "data": "text"
      }
    },
    "params": [],
    "function": "text",
    "transaction": {
      "data": "text",
      "value": "text",
      "to": "text",
      "from": "text",
      "gasPrice": "text",
      "gasLimit": "text",
      "maxPriorityFeePerGas": "text",
      "maxFeePerGas": "text",
      "nonce": 1,
      "type": 1,
      "chainId": "text"
    }
  }
}