Skip to main content
GET
/
v2
/
transactions
/
rewards
/
claim
/
{userAddress}
Claim rewards
curl --request GET \
  --url https://api.vaults.fyi/v2/transactions/rewards/claim/{userAddress} \
  --header 'x-api-key: <api-key>'
{
  "mainnet": {
    "currentActionIndex": 123,
    "actions": [
      {
        "name": "<string>",
        "tx": {
          "to": "<string>",
          "chainId": 1,
          "data": "<string>",
          "value": "<string>"
        },
        "simulation": {
          "url": "<string>",
          "status": "success",
          "tokensReceived": {},
          "tokensSpent": {}
        }
      }
    ]
  },
  "optimism": {
    "currentActionIndex": 123,
    "actions": [
      {
        "name": "<string>",
        "tx": {
          "to": "<string>",
          "chainId": 1,
          "data": "<string>",
          "value": "<string>"
        },
        "simulation": {
          "url": "<string>",
          "status": "success",
          "tokensReceived": {},
          "tokensSpent": {}
        }
      }
    ]
  },
  "arbitrum": {
    "currentActionIndex": 123,
    "actions": [
      {
        "name": "<string>",
        "tx": {
          "to": "<string>",
          "chainId": 1,
          "data": "<string>",
          "value": "<string>"
        },
        "simulation": {
          "url": "<string>",
          "status": "success",
          "tokensReceived": {},
          "tokensSpent": {}
        }
      }
    ]
  },
  "polygon": {
    "currentActionIndex": 123,
    "actions": [
      {
        "name": "<string>",
        "tx": {
          "to": "<string>",
          "chainId": 1,
          "data": "<string>",
          "value": "<string>"
        },
        "simulation": {
          "url": "<string>",
          "status": "success",
          "tokensReceived": {},
          "tokensSpent": {}
        }
      }
    ]
  },
  "gnosis": {
    "currentActionIndex": 123,
    "actions": [
      {
        "name": "<string>",
        "tx": {
          "to": "<string>",
          "chainId": 1,
          "data": "<string>",
          "value": "<string>"
        },
        "simulation": {
          "url": "<string>",
          "status": "success",
          "tokensReceived": {},
          "tokensSpent": {}
        }
      }
    ]
  },
  "base": {
    "currentActionIndex": 123,
    "actions": [
      {
        "name": "<string>",
        "tx": {
          "to": "<string>",
          "chainId": 1,
          "data": "<string>",
          "value": "<string>"
        },
        "simulation": {
          "url": "<string>",
          "status": "success",
          "tokensReceived": {},
          "tokensSpent": {}
        }
      }
    ]
  },
  "unichain": {
    "currentActionIndex": 123,
    "actions": [
      {
        "name": "<string>",
        "tx": {
          "to": "<string>",
          "chainId": 1,
          "data": "<string>",
          "value": "<string>"
        },
        "simulation": {
          "url": "<string>",
          "status": "success",
          "tokensReceived": {},
          "tokensSpent": {}
        }
      }
    ]
  },
  "swellchain": {
    "currentActionIndex": 123,
    "actions": [
      {
        "name": "<string>",
        "tx": {
          "to": "<string>",
          "chainId": 1,
          "data": "<string>",
          "value": "<string>"
        },
        "simulation": {
          "url": "<string>",
          "status": "success",
          "tokensReceived": {},
          "tokensSpent": {}
        }
      }
    ]
  },
  "celo": {
    "currentActionIndex": 123,
    "actions": [
      {
        "name": "<string>",
        "tx": {
          "to": "<string>",
          "chainId": 1,
          "data": "<string>",
          "value": "<string>"
        },
        "simulation": {
          "url": "<string>",
          "status": "success",
          "tokensReceived": {},
          "tokensSpent": {}
        }
      }
    ]
  },
  "worldchain": {
    "currentActionIndex": 123,
    "actions": [
      {
        "name": "<string>",
        "tx": {
          "to": "<string>",
          "chainId": 1,
          "data": "<string>",
          "value": "<string>"
        },
        "simulation": {
          "url": "<string>",
          "status": "success",
          "tokensReceived": {},
          "tokensSpent": {}
        }
      }
    ]
  },
  "berachain": {
    "currentActionIndex": 123,
    "actions": [
      {
        "name": "<string>",
        "tx": {
          "to": "<string>",
          "chainId": 1,
          "data": "<string>",
          "value": "<string>"
        },
        "simulation": {
          "url": "<string>",
          "status": "success",
          "tokensReceived": {},
          "tokensSpent": {}
        }
      }
    ]
  },
  "ink": {
    "currentActionIndex": 123,
    "actions": [
      {
        "name": "<string>",
        "tx": {
          "to": "<string>",
          "chainId": 1,
          "data": "<string>",
          "value": "<string>"
        },
        "simulation": {
          "url": "<string>",
          "status": "success",
          "tokensReceived": {},
          "tokensSpent": {}
        }
      }
    ]
  },
  "bsc": {
    "currentActionIndex": 123,
    "actions": [
      {
        "name": "<string>",
        "tx": {
          "to": "<string>",
          "chainId": 1,
          "data": "<string>",
          "value": "<string>"
        },
        "simulation": {
          "url": "<string>",
          "status": "success",
          "tokensReceived": {},
          "tokensSpent": {}
        }
      }
    ]
  },
  "hyperliquid": {
    "currentActionIndex": 123,
    "actions": [
      {
        "name": "<string>",
        "tx": {
          "to": "<string>",
          "chainId": 1,
          "data": "<string>",
          "value": "<string>"
        },
        "simulation": {
          "url": "<string>",
          "status": "success",
          "tokensReceived": {},
          "tokensSpent": {}
        }
      }
    ]
  },
  "plasma": {
    "currentActionIndex": 123,
    "actions": [
      {
        "name": "<string>",
        "tx": {
          "to": "<string>",
          "chainId": 1,
          "data": "<string>",
          "value": "<string>"
        },
        "simulation": {
          "url": "<string>",
          "status": "success",
          "tokensReceived": {},
          "tokensSpent": {}
        }
      }
    ]
  },
  "avalanche": {
    "currentActionIndex": 123,
    "actions": [
      {
        "name": "<string>",
        "tx": {
          "to": "<string>",
          "chainId": 1,
          "data": "<string>",
          "value": "<string>"
        },
        "simulation": {
          "url": "<string>",
          "status": "success",
          "tokensReceived": {},
          "tokensSpent": {}
        }
      }
    ]
  },
  "katana": {
    "currentActionIndex": 123,
    "actions": [
      {
        "name": "<string>",
        "tx": {
          "to": "<string>",
          "chainId": 1,
          "data": "<string>",
          "value": "<string>"
        },
        "simulation": {
          "url": "<string>",
          "status": "success",
          "tokensReceived": {},
          "tokensSpent": {}
        }
      }
    ]
  },
  "linea": {
    "currentActionIndex": 123,
    "actions": [
      {
        "name": "<string>",
        "tx": {
          "to": "<string>",
          "chainId": 1,
          "data": "<string>",
          "value": "<string>"
        },
        "simulation": {
          "url": "<string>",
          "status": "success",
          "tokensReceived": {},
          "tokensSpent": {}
        }
      }
    ]
  },
  "mega-eth": {
    "currentActionIndex": 123,
    "actions": [
      {
        "name": "<string>",
        "tx": {
          "to": "<string>",
          "chainId": 1,
          "data": "<string>",
          "value": "<string>"
        },
        "simulation": {
          "url": "<string>",
          "status": "success",
          "tokensReceived": {},
          "tokensSpent": {}
        }
      }
    ]
  },
  "monad": {
    "currentActionIndex": 123,
    "actions": [
      {
        "name": "<string>",
        "tx": {
          "to": "<string>",
          "chainId": 1,
          "data": "<string>",
          "value": "<string>"
        },
        "simulation": {
          "url": "<string>",
          "status": "success",
          "tokensReceived": {},
          "tokensSpent": {}
        }
      }
    ]
  },
  "etherlink": {
    "currentActionIndex": 123,
    "actions": [
      {
        "name": "<string>",
        "tx": {
          "to": "<string>",
          "chainId": 1,
          "data": "<string>",
          "value": "<string>"
        },
        "simulation": {
          "url": "<string>",
          "status": "success",
          "tokensReceived": {},
          "tokensSpent": {}
        }
      }
    ]
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.vaults.fyi/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
userAddress
string
required

User address to claim rewards for

Pattern: ^0x[a-fA-F0-9]{40}$

Query Parameters

​
simulate
boolean
default:false

DEPRECATED: This parameter is deprecated and no longer functional

​
claimIds
string[]
required

Array of claim IDs to be claimed

Minimum string length: 1

Response

Default Response

​
mainnet
object
required
​
optimism
object
required
​
arbitrum
object
required
​
polygon
object
required
​
gnosis
object
required
​
base
object
required
​
unichain
object
required
​
swellchain
object
required
​
celo
object
required
​
worldchain
object
required
​
berachain
object
required
​
ink
object
required
​
bsc
object
required
​
hyperliquid
object
required
​
plasma
object
required
​
avalanche
object
required
​
katana
object
required
​
linea
object
required
​
mega-eth
object
required
​
monad
object
required
​
etherlink
object
required