Get Holders Snapshot Of Certain Creator Coin
In this tutorial, you will learn how to get all the holders snapshot of a certain Creator Coin by calling the Moxie Protocol Subgraph API.
Pre-requisites
Install dependenciesgraphql
and graphql-request
to your project :- npm
- yarn
- pnpm
- bun
npm install graphql graphql-request
yarn add graphql graphql-request
pnpm add graphql graphql-request
bun install graphql graphql graphql-request
Step 1: Add The API Query To Your Code
To get all the holders snapshot of a certain Creator Coin, you can use the following query:
- Query
- Variable
- Response
query MyQuery($symbol: String, $blockNumber: Int) {
subjectTokens(where: {symbol: $symbol}, block: {number: $blockNumber}) {
portfolio(where: {balance_gt: 0}) {
balance
user {
id
}
}
}
}
{
/**
* There are 3 types of Creator Coins, here's how the symbol is formatted:
* - USER -> fid:<fid>
* - CHANNEL -> cid:<channel-id>
* - NETWORK (Only for Farcaster) -> id:farcaster
*/
"symbol": "id:farcaster",
"blockNumber": 17895057
}
{
"data": {
"subjectTokens": [
{
"portfolio": [
{
"balance": "11616135683624072140",
"user": {
"id": "0x011c08baf3908843c30391767890d7e9a94116fe"
}
}
]
}
]
}
}
graphql-request
library:- TypeScript
- JavaScript
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($symbol: String, $blockNumber: Int) {
subjectTokens(where: {symbol: $symbol}, block: {number: $blockNumber}) {
portfolio(where: {balance_gt: 0}) {
balance
user {
id
}
}
}
}
`;
const variable = {
/**
* There are 3 types of Creator Coins, here's how the symbol is formatted:
* - USER -> fid:<fid>
* - CHANNEL -> cid:<channel-id>
* - NETWORK (Only for Farcaster) -> id:farcaster
*/
"symbol": "id:farcaster",
"blockNumber": 17895057
}
try {
const data = await graphQLClient.request(query, variable);
console.log(data);
} catch (e) {
throw new Error(e);
}
index.js
const { gql, GraphQLClient } = require("graphql-request");
const graphQLClient = new GraphQLClient(
"https://api.studio.thegraph.com/query/23537/moxie_protocol_stats_mainnet/version/latest"
);
const query = gql`
query MyQuery($symbol: String, $blockNumber: Int) {
subjectTokens(where: {symbol: $symbol}, block: {number: $blockNumber}) {
portfolio(where: {balance_gt: 0}) {
balance
user {
id
}
}
}
}
`;
const variable = {
/**
* There are 3 types of Creator Coins, here's how the symbol is formatted:
* - USER -> fid:<fid>
* - CHANNEL -> cid:<channel-id>
* - NETWORK (Only for Farcaster) -> id:farcaster
*/
"symbol": "id:farcaster",
"blockNumber": 17895057
}
try {
const data = await graphQLClient.request(query, variable);
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:
- TypeScript
- JavaScript
ts-node index.ts
node index.js
If it runs successfully, you should see the data returned in the terminal:
{
"data": {
"subjectTokens": [
{
"portfolio": [
{
"balance": "11616135683624072140",
"user": {
"id": "0x011c08baf3908843c30391767890d7e9a94116fe"
}
}
]
}
]
}
}
Congrats! 🥳🎉 You've just fetched all the holders snapshot of a certain Creator Coin!
Developer Support
If you have any questions or need help with other use cases, feel free to join the Moxie Official Warpcast channel and ask your questions there.
Our team is always ready to help you with any questions you may have.