Synthetix Subgraph
The Graph exposes a GraphQL endpoint to query the events and entities within the Synthetix system.
Synthetix has three bundled subgraps, all generated from this one repository:
- Minting, Burning and Transferring SNX & Synths: https://thegraph.com/explorer/subgraph/synthetixio-team/synthetix
- Synth Exchange Volume and fees generated: https://thegraph.com/explorer/subgraph/synthetixio-team/synthetix-exchanges
- Historical rates on-chain for the various synths to USD: https://thegraph.com/explorer/subgraph/synthetixio-team/synthetix-rates
Using this as a JS module
Supported queries
exchanges.since({ timestampInSecs = 1 day ago })
Get the lastN
exchanges since the given timestampInSecs (in seconds, so one hour ago is3600
). These are ordered in reverse chronological order.exchanges.total()
Get the total exchange volume, total fees and total number of unique exchange addresses.depot.userActions({ user })
Get all depot deposit (sUSD
) actions for the given user -deposit
,withdrawl
,unaccepted
,removed
.depot.clearedDeposits({ fromAddress, toAddress })
Get all cleared synth deposits (payments ofETH
forsUSD
) either from a givenfromAddress
or (and as well as) to a giventoAddress
How to query via the npm library (CLE)
# get last 24 hours of exchange activity, ordered from latest to earliest npx synthetix-subgraph exchanges.since
Use as a node or webpack dependency
const snxData = ; snxDataexchanges;
Use in a browser
Or query the subgraphs without any JS library
In it's simplest version (on a modern browser assuming async await
support and fetch
):
// Fetch all Exchanges in the last 24hrs sasync { const ts = Math; const oneDayAgo = ts - 3600 * 24; const body = JSON; const response = await ; const json = await response; const synthExchanges = jsondata; // ... console;};
Note: due to The Graph limitation, only
100
results will be returned (the maximum allowedfirst
amount). The way around this is to use paging (using theskip
operator in GraphQL). See the functionpageResults
in index.js for an example.