🚀FarScores & FarBoosts

Learn how to fetch the FarScores, FarBoosts, FarRank of a Farcaster member. In addition, you can also fetch a user's TVL and how much it impacts a member's FarBoosts.

Every Farcaster Member earns a FarScore based on their relative influence in the Farcaster network and each FarScore user can be increased by earning FarBoosts, which consequently can also increase a Farcaster Member's FarRank.

Every 1 point on FarBoosts is earned by contributing 100,000 Moxie into your total locked value (TVL) to the Moxie protocol.

To learn more about FarScores & FarBoosts, click here.

Table Of Contents

• Get The FarScores Of A User

• Get The FarScores Of A User Without Any FarBoosts

• Get The Percentage Of Increase Of User's FarScore From FarBoosts

• Get The FarRank Of A User

• Get The FarBoost Of A User

• Get The FarBoost Of A User Gained Only From TVL

• Get The TVL Of A User

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 The FarScores Of A User

You can get the FarScores of a user by using the Socials API and inputting the user's FID in userId input:

Try Demo

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

Show me the FarScore of FID 3

Code

Query

query MyQuery{
  Socials(
    input: {
      filter: {
        dappName: {_eq: farcaster},
        userId: {_eq: "3"}
      },
      blockchain: ethereum
    }
  ) {
    Social {
      farcasterScore {
        farScore # Get the FarScore here
      }
    }
  }
}

Response

{
  "data": {
    "Socials": {
      "Social": [
        {
          "farcasterScore": {
            "farScore": 844.5147695782599
          }
        }
      ]
    }
  }
}

Get The FarScores Of A User Without Any FarBoosts

You can get the original FarScores of a user without any FarBoosts by using the Socials API and inputting the user's FID in userId input to fetch the farScore and farBoost field:

Try Demo

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

Show me the FarScore & Farboosts of FID 3

Code

Query

query MyQuery{
  Socials(
    input: {
      filter: {
        dappName: {_eq: farcaster},
        userId: {_eq: "3"}
      },
      blockchain: ethereum
    }
  ) {
    Social {
      farcasterScore {
        farScore
        farBoost
      }
    }
  }
}

Response

{
  "data": {
    "Socials": {
      "Social": [
        {
          "farcasterScore": {
            "farScore": 844.5147695782599.
            "farBoost": 7.051118295399999
          }
        }
      ]
    }
  }
}

To get the original FarScore without any FarBoosts, simply substract farScore to farBoost.

Get The Percentage Of Increase Of User's FarScore From FarBoosts

You can get the percentage of increase from FarBoosts by using the Socials API and inputting the user's FID in userId input to fetch the farScore and farBoost field:

Try Demo

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

Show me the FarScore & Farboosts of FID 3

Code

Query

query MyQuery{
  Socials(
    input: {
      filter: {
        dappName: {_eq: farcaster},
        userId: {_eq: "3"}
      },
      blockchain: ethereum
    }
  ) {
    Social {
      farcasterScore {
        farScore
        farBoost
      }
    }
  }
}

Response

{
  "data": {
    "Socials": {
      "Social": [
        {
          "farcasterScore": {
            "farScore": 844.5147695782599.
            "farBoost": 7.051118295399999
          }
        }
      ]
    }
  }
}

To get the percentage of increase, simply divide farBoost by farScore and multiply it by 100%.

Get The FarRank Of A User

You can get the FarRank of a user by using the Socials API and inputting the user's FID in userId input:

Try Demo

https://app.airstack.xyz/query/21EkpJ8N4P

Show me the FarRank of FID 3

Code

Query

query MyQuery{
  Socials(
    input: {
      filter: {
        dappName: {_eq: farcaster},
        userId: {_eq: "3"}
      },
      blockchain: ethereum
    }
  ) {
    Social {
      farcasterScore {
        farRank
      }
    }
  }
}

Response

{
  "data": {
    "Socials": {
      "Social": [
        {
          "farcasterScore": {
            "farRank": 1
          }
        }
      ]
    }
  }
}

Get The FarBoost Of A User

You can get the FarBoost of a user by using the Socials API and inputting the user's FID in userId input:

Try Demo

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

Show me the Farboost of FID 3

Code

Query

query MyQuery{
  Socials(
    input: {
      filter: {
        dappName: {_eq: farcaster},
        userId: {_eq: "3"}
      },
      blockchain: ethereum
    }
  ) {
    Social {
      farcasterScore {
        farBoost
      }
    }
  }
}

Response

{
  "data": {
    "Socials": {
      "Social": [
        {
          "farcasterScore": {
            "farBoost": 7.051118295399999
          }
        }
      ]
    }
  }
}

Get The FarBoost Of A User Gained Only From TVL

You can get the FarBoost of a user gained only from TVL by using the Socials API and inputting the user's FID in userId input:

Try Demo

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

Show me the TVL Boosts of FID 3

Code

Query

query MyQuery{
  Socials(
    input: {
      filter: {
        dappName: {_eq: farcaster},
        userId: {_eq: "3"}
      },
      blockchain: ethereum
    }
  ) {
    Social {
      farcasterScore {
        tvlBoost
      }
    }
  }
}

Response

{
  "data": {
    "Socials": {
      "Social": [
        {
          "farcasterScore": {
            // This value is 10^(-23) to the user's TVL
            "tvlBoost": 7.051118295399999
          }
        }
      ]
    }
  }
}

Get The TVL Of A User

You can get the TVL of a user in the Moxie protocol by using the Socials API and inputting the user's FID in userId input:

Try Demo

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

Show me the TVL of FID 3

Code

Query

query MyQuery{
  Socials(
    input: {
      filter: {
        dappName: {_eq: farcaster},
        userId: {_eq: "3"}
      },
      blockchain: ethereum
    }
  ) {
    Social {
      farcasterScore {
        tvl
      }
    }
  }
}

Response

{
  "data": {
    "Socials": {
      "Social": [
        {
          "farcasterScore": {
            "tvl": "705111829539999900000000"
          }
        }
      ]
    }
  }
}

The value returned in tvl will be in wei. Therefore, you should divide the number by 10^18 to get the real value.

Developer Support

If you have any questions or need help regarding fetching Moxie earnings data, please join our Airstack's Telegram group.

More Resources

• FarScores, FarBoost, and Cast Scores

• Socials API References