Aave Protocol Subgraphs
The Aave Protocol subgraphs index data from the protocol smart contracts, and expose a GraphQL endpoint hosted by The Graph.
Active deployments
Protocol Subgraphs
Production networks
Test networks
Governance Subgraphs
Usage
Subgraphs can be queried directly from the graph explorer, or from another application. The following section gives common queries for Aave protocol data.
Helpful Queries
See TheGraph API docs for a complete guide on querying capabilities.
User Transaction History
V2
```
{
userTransactions(
where: { user: "insert_lowercase_address_here" }
orderBy: timestamp
orderDirection: desc
) {
id
timestamp
txHash
action
... on Deposit {
amount
reserve {
symbol
decimals
}
assetPriceUSD
}
... on RedeemUnderlying {
amount
reserve {
symbol
decimals
}
assetPriceUSD
}
... on Borrow {
amount
borrowRateMode
borrowRate
stableTokenDebt
variableTokenDebt
reserve {
symbol
decimals
}
assetPriceUSD
}
... on UsageAsCollateral {
fromState
toState
reserve {
symbol
}
}
... on Repay {
amount
reserve {
symbol
decimals
}
assetPriceUSD
}
... on Swap {
borrowRateModeFrom
borrowRateModeTo
variableBorrowRate
stableBorrowRate
reserve {
symbol
decimals
}
}
... on LiquidationCall {
collateralAmount
collateralReserve {
symbol
decimals
}
principalAmount
principalReserve {
symbol
decimals
}
collateralAssetPriceUSD
borrowAssetPriceUSD
}
}
}
```
V3
```
{
userTransactions(
where: { user: "insert_lowercase_address_here" }
orderBy: timestamp
orderDirection: desc
) {
id
timestamp
txHash
action
... on Supply {
amount
reserve {
symbol
decimals
}
assetPriceUSD
}
... on RedeemUnderlying {
amount
reserve {
symbol
decimals
}
assetPriceUSD
}
... on Borrow {
amount
borrowRateMode
borrowRate
stableTokenDebt
variableTokenDebt
reserve {
symbol
decimals
}
assetPriceUSD
}
... on UsageAsCollateral {
fromState
toState
reserve {
symbol
}
}
... on Repay {
amount
reserve {
symbol
decimals
}
assetPriceUSD
}
... on SwapBorrowRate {
borrowRateModeFrom
borrowRateModeTo
variableBorrowRate
stableBorrowRate
reserve {
symbol
decimals
}
}
... on LiquidationCall {
collateralAmount
collateralReserve {
symbol
decimals
}
principalAmount
principalReserve {
symbol
decimals
}
collateralAssetPriceUSD
borrowAssetPriceUSD
}
}
}
```
Reserve Data
#### Reserve Summary
The `reserve` entity gives data on the assets of the protocol including rates, configuration, and total supply/borrow amounts.
The aave-utilities library includes a [`formatReserves`](https://github.com/aave/aave-utilities/#formatReserves) function which can be used to format all data into a human readable format. The queries to fetch data for passing into this function can be found [here](https://github.com/aave/aave-utilities#subgraph).
Why does the raw subgraph data not match app.aave.com?
- aToken and debtToken balances are continuously increasing. The subgraph provides a snapshot of the balance at the time of indexing (not querying), which means fields affected by interest such as `totalLiquidity`, `availableLiquidity`, and `totalCurrentVariableDebt` will need to be formatted to get real-time values
- All rates (liquidityRate, variableBorrowRate, stableBorrowRate) are expressed as _APR_ with RAY units (10**27). To convert to the APY percentage as shown on the Aave frontend: `supplyAPY = (((1 + ((liquidityRate / 10**27) / 31536000)) ^ 31536000) - 1) \* 100`. [`formatReserves`](https://github.com/aave/aave-utilities/#formatReserves) will perform this calculation for you.
User Data
#### User Summary
The `userReserve` entity gives the supply and borrow balances for a particular user along with the underlying reserve data.
The aave-utilities library includes a [`formatUserSummary`](https://github.com/aave/aave-utilities#formatUserSummary) function which can be used to format all data into a human readable format. The queries to fetch data for passing into this function can be found [here](https://github.com/aave/aave-utilities#subgraph).
Why does the raw subgraph data not match my account balances on app.aave.com?
- aToken and debtToken balances are continuously increasing. The subgraph provides a snapshot of the balance at the time of indexing (not querying), which means fields affected by interest such as `currentATokenBalance`, `currentVariableDebt`, and `currentStableDebt` will need to be formatted to get the real-time values
Querying Tips
### Historical Queries
You can query for historical data by specifying a block number:
```
{
reserves(block: {number: 14568297}){
symbol
liquidityRate
}
}
```
To query based on a historical timestamp, you will need to convert the timstamp to the most recent block number, you will need to use an external tool such as [this](https://www.npmjs.com/package/ethereum-block-by-date).
### Pagination
The Graph places a limit on the number of items which can returned by a single query (currently 100). To fetch a larger number of items, the `first` and `skip` parameters can be used to create paginated queries.
For example, if you wanted to fetch the first 200 transactions for an Aave market, you can't query 200 items at once, but you can achieve the same thing by concatenating the output of these queries:
```
{
userTransactions(orderBy: timestamp, orderDirection: asc, first: 100, skip: 0){
timestamp
}
}
```
```
{
userTransactions(orderBy: timestamp, orderDirection: asc, first: 100, skip: 100){
timestamp
}
}
```
Development
# copy env and adjust its content with your personal access token and subgraph name
# you can get an access token from https://thegraph.com/explorer/dashboard
cp .env.test .env
# install project dependencies
npm i
# to regenrate types if schema.graphql has changed
npm run subgraph:codegen
# to run a test build of your subgraph
npm run subgraph:build
# now you're able to deploy to thegraph hosted service with one of the deploy commands:
npm run deploy:hosted:mainnet
Troubleshooting
If a subgraph encounters an error while indexing, the logs on the explorer may not display the error. You can check for errors on a pending or synced subgraph with the following commands, replacing aave/protocol-v2 with your subgraph name:
Pending:
curl --location --request POST 'https://api.thegraph.com/index-node/graphql' --data-raw '{"query":"{ indexingStatusForPendingVersion(subgraphName: \"aave/protocol-v2\") { subgraph fatalError { message } nonFatalErrors {message } } }"}'
Synced:
curl --location --request POST 'https://api.thegraph.com/index-node/graphql' --data-raw '{"query":"{ indexingStatusForCurrentVersion(subgraphName: \"aave/protocol-v2\") { subgraph fatalError { message } nonFatalErrors {message } } }"}'