Skip to main content

Get Protocol Summary

In this tutorial, you will learn how to get the Moxie protocol summary data, which includes:

  • active protocol beneficiary
  • protocol buy & sell percentage fee
  • fan tokens buy & sell percentage fee
  • etc.

by calling the Moxie Protocol Subgraph API.

Pre-requisites

Install dependencies graphql and graphql-request to your project :
npm install graphql graphql-request 

Step 1: Add The API Query To Your Code

To get Moxie protocol summary, you can use the following query:

query MyQuery {
summaries {
activeProtocolFeeBeneficiary {
beneficiary
totalFees
}
protocolBuyFeePct
protocolSellFeePct
subjectBuyFeePct
subjectSellFeePct
totalReserve
totalBuyVolume
totalSellVolume
totalProtocolFee
}
}
With this GraphQL query, you can add it to your source code and call the API with the graphql-request library:
index.ts
import { gql, GraphQLClient } from "graphql-request";


const graphQLClient = new GraphQLClient(
"https://api.studio.thegraph.com/query/23537/moxie_protocol_stats_mainnet/version/latest"
);

const query = gql`
query MyQuery {
summaries {
activeProtocolFeeBeneficiary {
beneficiary
totalFees
}
protocolBuyFeePct
protocolSellFeePct
subjectBuyFeePct
subjectSellFeePct
totalReserve
totalBuyVolume
totalSellVolume
totalProtocolFee
}
}
`;



try {
const data = await graphQLClient.request(query);
console.log(data);
} catch (e) {
throw new Error(e);
}

Step 2: Execute Your Code

Once you have your code ready, you can execute it by running the following command:

ts-node index.ts

If it runs successfully, you should see the data returned in the terminal:

{
"data": {
"summaries": [
{
"activeProtocolFeeBeneficiary": {
"beneficiary": "0x648e7e89a70ef654b5754e9eb91bf931a477e3cd",
"totalFees": "263686938800000000000000"
},
"protocolBuyFeePct": "10000000000000000",
"protocolSellFeePct": "20000000000000000",
"subjectBuyFeePct": "30000000000000000",
"subjectSellFeePct": "40000000000000000",
"totalReserve": "26696218719309458229047159",
"totalBuyVolume": "248812605935485122316883",
"totalSellVolume": "0",
"totalProtocolFee": "0"
}
]
}
}

Congrats! 🥳🎉 You've just fetched Moxie protocol summary!

Developer Support

If you have any questions or need help with other use cases, feel free to join the /airstack Warpcast channel and ask your questions there.

Our team is always ready to help you with any questions you may have.