🚀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.

As of 3 October, 2024, FarScores do not factor in follows from users who have not been active on Farcaster in the previous 60 days, on a rolling basis.

Every 1 point on FarBoosts is earned by contributing 100,000 Moxie into your total locked value (TVL) into the Moxie protocol or providing 100,000 Moxie into the Liquidity Pool (Uniswap v2 & Aerodrome).

Additionally, you can also earn 1.2 point on FarBoosts by for every 100,000 Moxie worth of Fan Token is locked into the Moxie Staking contract for at least 3 months.

To learn more about FarScores & FarBoosts, click here.

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:

React

npm install @airstack/airstack-react

Node

npm install @airstack/node

React

yarn add @airstack/airstack-react

Node

yarn add @airstack/node

React

pnpm install @airstack/airstack-react

Node

pnpm install @airstack/node

pip install airstack

Then, add the following snippets to your code:

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>;
  }
};

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);

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

Code

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

{
  "data": {
    "Socials": {
      "Social": [
        {
          "realTimeFarScore": {
            "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 organicFarScore field:

Try Demo

Code

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

{
  "data": {
    "Socials": {
      "Social": [
        {
          "realTimeFarScore": {
            "organicScore": 146.90271263184002
          }
        }
      ]
    }
  }
}

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 organicScore field:

Try Demo

Code

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

{
  "data": {
    "Socials": {
      "Social": [
        {
          "farcasterScore": {
            "farScore": 844.5147695782599.
            "organicScore": 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

Code

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

{
  "data": {
    "Socials": {
      "Social": [
        {
          "realTimeFarScore": {
            "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 to get all the boost variables:

Try Demo

Code

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

{
  "data": {
    "Socials": {
      "Social": [
        {
          "realTimeFarScore": {
            "lpBoost": 0,
            "tvlBoost": 7.687219015,
            "powerBoost": 0
          }
        }
      ]
    }
  }
}

By adding up the LP boost, TVL boost, and power boost, you'll get the total Farboost of a user.

Get The FarBoost Of A User Gained From Providing Liquidity to DEXs (Also referred to as LP Boost)

You can get the Liquidity Boost, that is the FarBoost of a user gained from providing liquidity to DEXs, by using the Socials API and inputting the user's FID in userId input:

Try Demo

Code

query MyQuery {
  Socials(
    input: {
      filter: {
        dappName: {_eq: farcaster},
        userId: {_eq: "6500"}
      },
      blockchain: ethereum
    }
  ) {
    Social {
      realTimeFarScore {
        lpBoost
      }
    }
  }
}

{
  "data": {
    "Socials": {
      "Social": [
        {
          "realTimeFarScore": {
            "lpBoost": 83.5087240215
          }
        }
      ]
    }
  }
}

Get The FarBoost Of A User Gained Only From TVL

You can get the TVL Boost, that is 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

Code

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

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

Get The FarBoost Of A User Gained From Locking Fan Tokens (Moxie Power Boost)

You can get the Moxie Power Boost by using the Socials API and inputting the user's FID in userId input:

Try Demo

Code

query MyQuery {
  Socials(
    input: {
      filter: {
        dappName: {_eq: farcaster},
        userId: {_eq: "602"}
      },
      blockchain: ethereum
    }
  ) {
    Social {
      realTimeFarScore {
        powerBoost
      }
    }
  }
}

{
  "data": {
    "Socials": {
      "Social": [
        {
          "realTimeFarScore": {
            "powerBoost": 9.738300070127268
          }
        }
      ]
    }
  }
}

Get The Moxie Hero Multiplier Of A User

You can get the Moxie Hero Multiplier by using the Socials API and inputting the user's FID in userId input and first getting the Moxie Hero Boost:

Try Demo

Code

query MyQuery {
  Socials(
    input: {
      filter: {
        dappName: {_eq: farcaster},
        userId: {_eq: "488178"}
      },
      blockchain: ethereum
    }
  ) {
    Social {
      userId
      profileName
      farcasterScore {
        farBoost
        farRank
        farScore
        farScoreRaw
        heroBoost
        liquidityBoost
        powerBoost
        tvl
        tvlBoost
      }
    }
  }
}

{
  "data": {
    "Socials": {
      "Social": [
        {
          "userId": "488178",
          "profileName": "nikomfer.eth",
          "farcasterScore": {
            "farBoost": 290.87599810419005,
            "farRank": 3,
            "farScore": 582.6746181312901,
            "farScoreRaw": "58267461813129.003488414568103642",
            // This is the Moxie Hero Boost of the user
            "heroBoost": 291.337309065645,
            "liquidityBoost": 0,
            "powerBoost": 288.56944329691504,
            "tvl": "828868042240291844385275",
            "tvlBoost": 2.306554807275
          }
        },
        // Other Farcaster users
      ]
    }
  }
}

Once you get the Moxie Hero boost of the user, you can use the formula here to get the multiplier.

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

Code

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

{
  "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.

Get Top Farcaster Users Sorted By Their Total FarScores

You can get the top Farcaster users sorted by their total Farscores by using the FarScores API and configure the API to sort by farScore in descending order:

Try Demo

Code

query MyQuery {
  FarScores(
    input: {
      filter: {},
      limit: 200,
      order: {farScore: DESC}
    }
  ) {
    FarScore {
      farScore
      social {
        profileName
        fid: userId
      }
    }
  }
}

{
  "data": {
    "FarScores": {
      "FarScore": [
        {
          "farScore": 849.6258547342253,
          "social": {
            "profileName": "bigdegenenergy.eth",
            "fid": "317777"
          }
        },
        // Other Farcaster users
      ]
    }
  }
}

Get Top Farcaster Users Sorted By Their Organic FarScores

You can get the top Farcaster users sorted by their organic Farscores by using the FarScores API and configure the API to sort by organicScore in descending order:

Try Demo

Code

query MyQuery {
  FarScores(
    input: {
      filter: {},
      limit: 200,
      order: {organicScore: DESC}
    }
  ) {
    FarScore {
      organicScore
      social {
        profileName
        fid: userId
      }
    }
  }
}

{
  "data": {
    "FarScores": {
      "FarScore": [
        {
          "organicScore": 146.90271263184002,
          "social": {
            "profileName": "dwr.eth",
            "fid": "3"
          }
        },
        // Other Farcaster users
      ]
    }
  }
}

Get Top Farcaster Users Sorted By Their TVL Boost

You can get the top Farcaster users sorted by their TVL boost by using the FarScores API and configure the API to sort by tvlBoost in descending order:

Try Demo

Code

query MyQuery {
  FarScores(
    input: {
      filter: {},
      limit: 200,
      order: {tvlBoost: DESC}
    }
  ) {
    FarScore {
      tvlBoost
      social {
        profileName
        fid: userId
      }
    }
  }
}

{
  "data": {
    "FarScores": {
      "FarScore": [
        {
          "tvlBoost": 61.1144161984,
          "social": {
            "profileName": "betashop.eth",
            "fid": "602"
          }
        },
        // Other Farcaster users
      ]
    }
  }
}

Get Top Farcaster Users Sorted By Their Liquidity Boost

You can get the top Farcaster users sorted by their Liquidity Boost by using the FarScores API and configure the API to sort by lpBoost in descending order:

Try Demo

Code

query MyQuery {
  FarScores(
    input: {
      filter: {},
      limit: 200,
      order: {lpBoost: DESC}
    }
  ) {
    FarScore {
      lpBoost
      social {
        profileName
        fid: userId
      }
    }
  }
}

{
  "data": {
    "FarScores": {
      "FarScore": [
        {
          "lpBoost": 848.5269513826,
          "social": {
            "profileName": "bigdegenenergy.eth",
            "fid": "317777"
          }
        },
        // Other Farcaster users
      ]
    }
  }
}

Get Top Farcaster Users Sorted By Their Power Boost

You can get the top Farcaster users sorted by their Power Boost by using the FarScores API and configure the API to sort by powerBoost in descending order:

Try Demo

Code

query MyQuery {
  FarScores(
    input: {
      filter: {},
      limit: 200,
      order: {powerBoost: DESC}
    }
  ) {
    FarScore {
      powerBoost
      social {
        profileName
        fid: userId
      }
    }
  }
}

{
  "data": {
    "FarScores": {
      "FarScore": [
        {
          "powerBoost": 61.1144161984,
          "social": {
            "profileName": "farcastor.eth",
            "fid": "308322"
          }
        },
        // Other Farcaster users
      ]
    }
  }
}

Get All The Current Moxie Heroes

You can get the Farcaster users that are currently Moxie Heroes by using the FarScores API and configure the API by setting the heroBoost filter to greater than 0 to only fetch those with Hero boost:

Try Demo

Code

query MyQuery {
  FarScores(
    input: {
      filter: {
        # Only get user that have hero boost
        heroBoost: {_gt: 0}
      },
      limit: 200
    }
  ) {
    FarScore {
      farScore
      heroBoost
      social {
        profileName
        fid: userId
      }
    }
  }
}

{
  "data": {
    "FarScores": {
      "FarScore": [
        {
          "farScore": 87.00799974768002,
          "heroBoost": 86.888154018,
          "social": {
            "profileName": "banthafodderdan",
            "fid": "379581"
          }
        },
        {
          "farScore": 94.05552537371149,
          "heroBoost": 70.5416440302836,
          "social": {
            "profileName": "aaronv.eth",
            "fid": "354795"
          }
        },
        // Other Moxie Heroes
      ]
    }
  }
}

Developer Support

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

More Resources

PreviousFarScores, FarBoost, and Cast Scores NextMoxie Heroes

Last updated 1 month ago

Was this helpful?

Table Of Contents

Pre-requisites

Get Started

Get The FarScores Of A User

Try Demo

Code

Get The FarScores Of A User Without Any FarBoosts

Try Demo

Code

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

Try Demo

Code

Get The FarRank Of A User

Try Demo

Code

Get The FarBoost Of A User

Try Demo

Code

Get The FarBoost Of A User Gained From Providing Liquidity to DEXs (Also referred to as LP Boost)

Try Demo

Code

Get The FarBoost Of A User Gained Only From TVL

Try Demo

Code

Get The FarBoost Of A User Gained From Locking Fan Tokens (Moxie Power Boost)

Try Demo

Code

Get The Moxie Hero Multiplier Of A User

Try Demo

Code

Get The TVL Of A User

Try Demo

Code

Get Top Farcaster Users Sorted By Their Total FarScores

Try Demo

Code

Get Top Farcaster Users Sorted By Their Organic FarScores

Try Demo

Code

Get Top Farcaster Users Sorted By Their TVL Boost

Try Demo

Code

Get Top Farcaster Users Sorted By Their Liquidity Boost

Try Demo

Code

Get Top Farcaster Users Sorted By Their Power Boost

Try Demo

Code

Get All The Current Moxie Heroes

Try Demo

Code

Developer Support

More Resources