Queries

The subgraph can be queried to retrieve important information about PYESwap, pairs, tokens, transactions, users, and more. This page will provide examples for common queries.

To try these queries and run your own visit the subgraph sandbox.

Global Data

To query global data you can pass in the PYESwap Factory address and select from available fields.

Global Stats

All time volume in USD, total liquidity in USD, all time transaction count.

{
  pyeFactories(first: 5) {
    id
    totalPairs
    totalTransactions
    totalVolumeUSD
  }
  bundles(first: 5) {
    id
    bnbPrice
  }
}

Global Historical lookup

To get a snapshot of past state, use The Graph's block query feature and query at a previous block. See this post to get more information about fetching block numbers from timestamps. This can be used to calculate things like 24hr volume.

{
 pyeFactory(id: "0xb664BDCe35b5EE182e8832d4F3b615232e98a51E", block: {number: 15860506}){
   totalVolumeUSD
   totalLiquidityUSD
   totalTransactions
 }
}

Pair Data

Pair Overview

Fetch a snapshot of the current state of the pair with common values. This example fetches the PYE/WBNB pair.

{
 pair(id: "0x08386c3e469420Ed44522C3AF38fC91713D2Cbbf"){
     token0 {
       id
       symbol
       name
       derivedBNB
     }
     token1 {
       id
       symbol
       name
       derivedBNB
     }
     reserve0
     reserve1
     reserveUSD
     trackedReserveBNB
     token0Price
     token1Price
     volumeUSD
     totalTransactions
 }
}

All pairs in PYESwap

The Graph limits entity return amounts to 1000 per query as of now. To get all pairs on PYESwap use a loop and graph skip query to fetch multiple chunks of 1000 pairs. The query would look like this (where skip is some incrementing variable passed into your query).

{
 query pairs($skip: Int!) {
   pairs(first: 1000, skip: $skip) {
     id
   }
 }
}

Most liquid pairs

Order by liquidity to get the most liquid pairs in PYESwap.

{
 pairs(first: 1000, orderBy: reserveUSD, orderDirection: desc) {
   id
 }
}

Recent Swaps within a Pair

Get the last 100 swaps on a pair by fetching Swap events and passing in the pair address. You'll often want token information as well.

{
swaps(orderBy: timestamp, orderDirection: desc, where:
 { pair: "0x08386c3e469420Ed44522C3AF38fC91713D2Cbbf" }
) {
     pair {
       token0 {
         symbol
       }
       token1 {
         symbol
       }
     }
     amount0In
     amount0Out
     amount1In
     amount1Out
     amountUSD
     to
 }
}

Pair Daily Aggregated

Day data is useful for building charts and historical views around entities. To get stats about a pair in daily buckets query for day entities bounded by timestamps. This query gets the first 100 days after the given unix timestamp on the PYE/WBNB pair.

{
 pairDayDatas(first: 100, orderBy: date, orderDirection: asc,
   where: {
     pairAddress: "0x08386c3e469420Ed44522C3AF38fC91713D2Cbbf",
     date_gt: 1592505859
   }
 ) {
     date
     dailyVolumeToken0
     dailyVolumeToken1
     dailyVolumeUSD
     reserveUSD
 }
}

Token Data

Token data can be fetched using the token contract address as an ID. Token data is aggregated across all pairs the token is included in. Any token that is included in some pair in PYESwap can be queried.

Token Overview

Get a snapshot of the current stats on a token in PYESwap. This query fetches current stats on PYE. The allPairs field gets the first 200 pairs PYE is included in sorted by liquidity in derived USD.

{
 token(id: "0xb4B486496469B3269c8907543706C377daAA4dD9"){
   name
   symbol
   decimals
   derivedBNB
   derivedUSD
   tradeVolumeUSD
   totalLiquidity
 }
}

All Tokens in PYESwap

Similar to fetching all pairs (see above), you can query all tokens in PYESwap. Because The Graph service limits return size to 1000 entities use graphql skip query. (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
     name
     symbol
   }
 }
}

Token Transactions

To get transactions that include a token you'll need to first fetch an array of pairs that the token is included in (this can be done with the allPairs field on the Token entity.) Once you have an array of pairs the token is included in, filter on that in the transaction lookup.

This query fetches the latest 30 mints, swaps, and burns involving PYE. The allPairs array could look something like this where we include the PYE/WBNB pair address and the PYE/BUSD pair address.

allPairs = [
 "0x08386c3e469420Ed44522C3AF38fC91713D2Cbbf",
 "0x6EFf6062c365F5328E17B28b614E5bd122a31383"
]

query($allPairs: [String!]) {
 mints(first: 30, where: { pair_in: $allPairs }, orderBy: timestamp, orderDirection: desc) {
   transaction {
     id
     timestamp
   }
   to
   liquidity
   amount0
   amount1
   amountUSD
 }
 burns(first: 30, where: { pair_in: $allPairs }, orderBy: timestamp, orderDirection: desc) {
   transaction {
     id
     timestamp
   }
   to
   liquidity
   amount0
   amount1
   amountUSD
 }
 swaps(first: 30, where: { pair_in: $allPairs }, orderBy: timestamp, orderDirection: desc) {
   transaction {
     id
     timestamp
   }
   amount0In
   amount0Out
   amount1In
   amount1Out
   amountUSD
   to
 }
}

Token Daily Aggregated

Like pair and global daily lookups, tokens have daily entities that can be queries as well. This query gets daily information for PYE. Note that you may want to sort in ascending order to receive your days from oldest to most recent in the return array.

{
 tokenDayDatas(orderBy: date, orderDirection: asc,
  where: {
    token: "0xb4B486496469B3269c8907543706C377daAA4dD9"
  }
 ) {
    id
    date
    priceUSD
    totalLiquidityToken
    totalLiquidityUSD
    totalLiquidityBNB
    dailyVolumeBNB
    dailyVolumeToken
    dailyVolumeUSD
 }
}

BNB Price

You can use the Bundle entity to query current USD price of BNB in PYESwap based on a weighted average of stablecoins.

{
 bundle(id: "1" ) {
   bnbPrice
 }
}