The Graph exposes a GraphQL endpoint to query the events and entities within the Synthetix system.
Synthetix has four bundled subgraps, all generated from this one repository:
- Synthetix: issuing (aka minting) sUSD, burning sUSD and transferring SNX & Synths: https://thegraph.com/explorer/subgraph/synthetixio-team/synthetix
- Exchanges: synth Exchange Volume and fees generated: https://thegraph.com/explorer/subgraph/synthetixio-team/synthetix-exchanges
- Rates: historical rates on-chain for the various synths to USD: https://thegraph.com/explorer/subgraph/synthetixio-team/synthetix-rates
- Depot: deposits, withdrawls and successful exchanges in the Depot: https://thegraph.com/explorer/subgraph/synthetixio-team/synthetix-depot
- Loans: loans created and closed using EtherCollateral: https://thegraph.com/explorer/subgraph/synthetixio-team/synthetix-loans
- Binary Options: Binary options data: https://thegraph.com/explorer/subgraph/synthetixio-team/synthetix-binary-options
For any of the four subgraphs: snx
, exchanges
, rates
, depot
, loans
and binary-options
as [subgraph]
- Run the
npm run codegen:[subgraph]
task to prepare the TypeScript sources for the GraphQL (generated/schema) and the ABIs (generated/[ABI]/*) - [Optional] run the
npm run build:[subgraph]
task for the subgraph - Deploy via
npm run deploy:[subgraph]
. Note: requires env variable of$THEGRAPH_SNX_ACCESS_TOKEN
set in bash to work.
Please use our node & browser utility: synthetix-data.
In it's simplest version (on a modern browser assuming async await
support and fetch
):
// Fetch all Exchanges in the last 24hrs s
(async () => {
const ts = Math.floor(Date.now() / 1e3);
const oneDayAgo = ts - 3600 * 24;
const body = JSON.stringify({
query: `{
synthExchanges(
orderBy:timestamp,
orderDirection:desc,
where:{timestamp_gt: ${oneDayAgo}}
)
{
fromAmount
fromAmountInUSD
fromCurrencyKey
toCurrencyKey
block
timestamp
toAddress
toAmount
toAmountInUSD
feesInUSD
}
}`,
variables: null,
});
const response = await fetch('https://api.thegraph.com/subgraphs/name/synthetixio-team/synthetix-exchanges', {
method: 'POST',
body,
});
const json = await response.json();
const { synthExchanges } = json.data;
// ...
console.log(synthExchanges);
})();
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 synthetix-data for an example.