Subgraph Query Examples
This doc will teach you how to query Pegasys V3 analytics by writing GraphQL queries on the subgraph. You can fetch data points like :
and much more. Below are some example queries. To run a query copy and paste it into the v3 explorer to get fresh data.
Global Data
Global data refers to data points about the Pegasys v3 protocol as a whole. Some examples of global data points are total value locked in the protocol, total pools deployed, or total transaction counts. Thus, to query global data you must pass in the Pegasys V3 Factory address 0xeAa20BEA58979386A7d37BAeb4C1522892c74640 and select the desired fields. Reference the full factory schema to see all possible fields.
Current Global Data
An example querying total pool count, transaction count, and total volume in USD and ETH:
{
factory(id: "0xeAa20BEA58979386A7d37BAeb4C1522892c74640" ) {
poolCount
txCount
totalVolumeUSD
totalVolumeETH
}
}
Historical Global Data
You can also query historical data by specifying a block number.
{
factory(id: "0xeAa20BEA58979386A7d37BAeb4C1522892c74640", block: {number: 13380584}){
poolCount
txCount
totalVolumeUSD
totalVolumeETH
}
}
Pool Data
To get data about a certain pool, pass in the pool address. Reference the full pool schema and adjust the query fields to retrieve the data points you want.
General Pool Query
The query below returns the feeTier, spot price, and liquidity for the ETH-USDT pool.
{
pool(id: "0xd3ef8d514deb494c252fd9735134807b3a4527b6") {
tick
token0 {
symbol
id
decimals
}
token1 {
symbol
id
decimals
}
feeTier
sqrtPrice
liquidity
}
}
All Possible Pools
The maxiumum items you can query at once is 1000. Thus to get all possible pools, you can interate using the skip variable. To get pools beyond the first 1000 you can also set the skip as shown below.
Skipping First 1000 Pools
This query sets the skip value and returns the first 10 responses after the first 1000.
{
pools(first:10, skip:1000){
id
token0 {
id
symbol
}
token1 {
id
symbol
}
}
}
Creating a Skip Variable
This next query sets a skip variable. In your language and environment of choice you can then iterate through a loop, query to get 1000 pools each time, and continually adjust skip by 1000 until all pool responses are returned.
Check out this example from our interface for poolDayData that does something similar.
Note: This query will not work in the graph explorer and more resembles the structure of a query you'd pass to some graphql middleware like Apollo.
query pools( $skip: Int!) {
pools(
first: 1000
skip: $skip
orderDirection: asc
) {
id
sqrtPrice
token0 {
id
}
token1 {
id
}
}
}
Most Liquid Pools
Retrieve the top 1000 most liquid pools. You can use this similar set up to orderBy other variables like number of swaps or volume.
{
pools(first: 1000, orderBy: liquidity, orderDirection: desc) {
id
}
}
Pool Daily Aggregated
This query returns daily aggregated data for the first 10 days since the given timestamp for the SYS-ETH pool.
{
poolDayDatas(first: 10, orderBy: date, where: {
pool: "0xb0631942b2d862ccf9c4b753c1ef068e6bec1cfb",
date_gt: 1633642435
} ) {
date
liquidity
sqrtPrice
token0Price
token1Price
volumeToken0
volumeToken1
}
}
Swap Data
General Swap Data
To query data about a particular swap, input the transaction hash + "#" + the index in the swaps the transaction array.R This is the reference for the full swap schema.
Recent Swaps Within a Pool
You can set the where field to filter swap data by pool address. This example fetches data about multiple swaps for the USDC-USDT pool, ordered by timestamp.
{
swaps(orderBy: timestamp, orderDirection: desc, where:
{ pool: "0x197e0865e759235699a758c5428944964627cde1" }
) {
pool {
token0 {
id
symbol
}
token1 {
id
symbol
}
}
sender
recipient
amount0
amount1
}
}
Token Data
Input the the token contract address to fetch token data. Any token that exists in at least one Pegasys V3 pool can be queried. The output will aggregate data across all v3 pools that include the token.
General Token Data
This queries the decimals, symbol, name, pool count, and volume in USD for the SYS token. Reference the full token schema for all possible fields you can query.
{
token(id:"0x368433CaC2A0B8D76E64681a9835502a1f2A8A30") {
symbol
name
decimals
volumeUSD
poolCount
}
}
Token Daily Aggregated
You can fetch aggregate data about a specific token over a 24-hour period. This query gets 10-days of the 24-hour volume data for the PSYS token ordered from oldest to newest.
{
tokenDayDatas(first: 10, where: {token: "0x48023b16c3e81AA7F6eFFbdEB35Bb83f4f31a8fd"}, orderBy: date, orderDirection: asc) {
date
token {
id
symbol
}
volumeUSD
}
}
All Tokens
Similar to retrieving all pools, you can fetch all tokens by using skip. Note: This query will not work in the graph sandbox and more resembles the structure of a query you'd pass to some graphql middleware like Apollo.
query tokens($skip: Int!) {
tokens(first: 1000, skip: $skip) {
id
symbol
name
}
}
Position Data
General Position Data
To get data about a specific position, input the NFT tokenId. This queries the collected fees for token0 and token1 and current liquidity for the position with tokedId 3. Reference the full position schema to see all fields.
{
position(id:3) {
id
collectedFeesToken0
collectedFeesToken1
liquidity
token0 {
id
symbol
}
token1
{
id
symbol
}
}
}
Contribute
There are many more queries you can do with the Pegasys v3 subgraph including data related to ticks, mints, positions, and burns. Once again you can reference the full schema here. If you'd like to suggest more example queries to showcase, feel free to drop some suggestions in discord under #dev-chat or contribute your own queries by submitting a pull request to the docs repo.