🧩Moxie Fan Token Balances

Learn how to fetch user's Fan Token portfolio balances across all their wallets and vesting contracts. In addition, you will also learn how you can setup Fan Token gating for your project/application.

Table Of Contents

• Get User's Fan Token Balances By Wallet Address

• Get User's Fan Token Balances By FID

• Check If Certain User Hold Certain Fan Token (Fan Token Gating)

Pre-requisites

• An Airstack API key. To access this, you'll need to hold at least 1 /airstack Channel Fan Token.

• Basic knowledge of GraphQL

Get Started

JavaScript/TypeScript/Python

If you are using JavaScript/TypeScript or Python, Install the Airstack SDK:

npm

React

npm install @airstack/airstack-react

Node

npm install @airstack/node

yarn

React

yarn add @airstack/airstack-react

Node

yarn add @airstack/node

pnpm

React

pnpm install @airstack/airstack-react

Node

pnpm install @airstack/node

pip

pip install airstack

Then, add the following snippets to your code:

React

import { init, useQuery } from "@airstack/airstack-react";

init("YOUR_AIRSTACK_API_KEY");

const query = `YOUR_QUERY`; // Replace with GraphQL Query

const Component = () => {
  const { data, loading, error } = useQuery(query);

  if (data) {
    return <p>Data: {JSON.stringify(data)}</p>;
  }

  if (loading) {
    return <p>Loading...</p>;
  }

  if (error) {
    return <p>Error: {error.message}</p>;
  }
};

Node

import { init, fetchQuery } from "@airstack/node";

init("YOUR_AIRSTACK_API_KEY");

const query = `YOUR_QUERY`; // Replace with GraphQL Query

const { data, error } = await fetchQuery(query);

console.log("data:", data);
console.log("error:", error);

Python

import asyncio
from airstack.execute_query import AirstackClient

api_client = AirstackClient(api_key="YOUR_AIRSTACK_API_KEY")

query = """YOUR_QUERY""" # Replace with GraphQL Query

async def main():
    execute_query_client = api_client.create_execute_query_object(
        query=query)

    query_response = await execute_query_client.execute_query()
    print(query_response.data)

asyncio.run(main())

Other Programming Languages

To access the Airstack APIs in other languages, you can use https://api.airstack.xyz/gql as your GraphQL endpoint.

Get User's Fan Token Balances By Wallet Address

You can get a user's Fan Token portfolio balances by using the MoxieUserPortfolio API and inputting the user's wallet address in walletAddress input:

Try Demo

https://app.airstack.xyz/query/LSFYWtiYxc

Show me the Moxie Fan token portfolio balances of 0xd7029bdea1c17493893aafe29aad69ef892b8ff2

Code

Query

query MyQuery {
  MoxieUserPortfolios(
    input: {
      filter: {
        walletAddress: {
          _eq: "0xd7029bdea1c17493893aafe29aad69ef892b8ff2"
        }
      }
    }
  ) {
    MoxieUserPortfolio {
      fanTokenSymbol
      fanTokenAddress
      fanTokenName
      amount: totalUnlockedAmount
    }
  }
}

Response

{
  "data": {
    "MoxieUserPortfolios": {
      "MoxieUserPortfolio": [
        {
          "fanTokenSymbol": "fid:3",
          "fanTokenAddress": "0xd83b15a9c8dc73f1a5ba279ea7815abf97a91fff",
          "fanTokenName": "dwr.eth",
          "amount": 13020342330530892
        },
        // Other Fan Tokens in portfolio by 0xd7029bdea1c17493893aafe29aad69ef892b8ff2
      ]
    }
  }
}

Get User's Fan Token Balances By FID

You can get a user's Fan Token portfolio balances by using the MoxieUserPortfolio API and inputting the user's FID in fid input:

Try Demo

https://app.airstack.xyz/query/ZdLg1vJBVV

Show me the Moxie Fan token portfolio balances of FID 3

Code

Query

query MyQuery {
  MoxieUserPortfolios(
    input: {
      filter: {
        fid: {_eq: "3"}
      }
    }
  ) {
    MoxieUserPortfolio {
      fanTokenAddress
      fanTokenName
      fanTokenSymbol
      amount: totalUnlockedAmount
    }
  }
}

Response

{
  "data": {
    "MoxieUserPortfolios": {
      "MoxieUserPortfolio": [
        {
          "fanTokenAddress": "0xbe2f22ae9f1bff46a9d814395cf70bfae8ed3a86",
          "fanTokenName": "betashop.eth",
          "fanTokenSymbol": "fid:602",
          "amount": 10000000000000000000
        },
        // Other Fan Tokens owned by FID 3
      ]
    }
  }
}

Check If Certain User Hold Certain Fan Token

You can check if a certain user hold a certain Fan Token in their portfolio balance by using the MoxieUserPortfolio API and inputting the user's wallet to the walletAddress input and the Fan Token symbol to the fanTokenSymbol input:

Alternatively, you can also use fid and fanTokenAddress to specify the user and Fan Token input, respectively.

Try Demo

https://app.airstack.xyz/query/odTEChTFUe

Check If 0xd7029bdea1c17493893aafe29aad69ef892b8ff2 hold Fan Token FID 3

Code

Query

query GetPortfolioInfo {
  MoxieUserPortfolios(
    input: {
      filter: {
        walletAddress: {
          # user's wallet address
          _eq: "0xd7029bdea1c17493893aafe29aad69ef892b8ff2"
        },
        fanTokenSymbol: {
          # Fan Token to check, symbol will be based on types:
          # - User: fid:<FID>
          # - Channel: cid:<CHANNEL-ID>
          # - Network: id:farcaster
          _eq: "fid:3"
        }
      }
    }
  ) {
    MoxieUserPortfolio {
      amount: totalUnlockedAmount
    }
  }
}

Response

{
  "data": {
    "MoxieUserPortfolios": {
      "MoxieUserPortfolio": [
        // If not `null`, then it indicates that the user hold the FT
        {
          "amount": 13020342330530892
        }
      ]
    }
  }
}

Developer Support

If you have any questions or need help regarding fetching Farcaster user's Moxie Fan Token portfolio data, please join our Airstack's Telegram group.

More Resources

• MoxieUserPortfolio API References