đ Resolve Farcaster UsersLearn how to resolve Farcaster(s) fname/username/FID to 0x address, ENS, Lens, and XMTP and Reverse Resolution.
Airstack provides easy-to-use APIs for enriching Farcaster applications and for integrating onchain and offchain data with Farcaster.
Table Of Contents
In this guide you will learn how to use Airstack to:
Pre-requisites
Basic knowledge of GraphQL
Get Started
JavaScript/TypeScript/Python
If you are using JavaScript/TypeScript or Python, Install the Airstack SDK:
npm yarn pnpm pip
React
Copy npm install @airstack/airstack-react
Node
Copy npm install @airstack/node
React
Copy yarn add @airstack/airstack-react
Node
Copy yarn add @airstack/node
React
Copy pnpm install @airstack/airstack-react
Node
Copy pnpm install @airstack/node
Then, add the following snippets to your code:
React Node Python
Copy 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 >;
}
};
Copy import { init , fetchQuery } from "@airstack/node" ;
init ( "YOUR_AIRSTACK_API_KEY" );
const query = `YOUR_QUERY` ; // Replace with GraphQL Query
const { data , error } = fetchQuery (query);
console .log ( "data:" , data);
console .log ( "error:" , error);
Copy 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.
đ¤ AI Natural Language â Airstack provides an AI solution for you to build GraphQL queries to fulfill your use case easily. You can find the AI prompt of each query in the demo's caption or title for yourself to try.
Get All 0x addresses of Farcaster user(s)
You can resolve an array of Farcaster user(s) to their 0x addresses:
Try Demo
Show 0x addresses of Farcaster user name dwr.eth and user ID 1 Code
Query Response
Copy query GetAddressesOfFarcasters {
Socials(
input: {
filter : { identity : { _in : [ "fc_fname:dwr.eth" , "fc_fid:1" ] } }
blockchain : ethereum
}
) {
Social {
userAssociatedAddresses
}
}
}
Copy {
"data" : {
"Socials" : {
"Social" : [
{
"userAssociatedAddresses" : [
"0x8773442740c17c9d0f0b87022c722f9a136206ed" ,
"0x86924c37a93734e8611eb081238928a9d18a63c0"
]
} ,
{
"userAssociatedAddresses" : [
"0xd7029bdea1c17493893aafe29aad69ef892b8ff2"
]
} ,
{
"userAssociatedAddresses" : [
"0xb877f7bb52d28f06e60f557c00a56225124b357f" ,
"0xa14b4c95b5247199d74c5578531b4887ca5e4909" ,
"0xd7029bdea1c17493893aafe29aad69ef892b8ff2" ,
"0x74232bf61e994655592747e20bdf6fa9b9476f79"
]
}
]
}
}
}
Get All Solana addresses of Farcaster user
You can resolve a Farcaster user to their Solana addresses by using Socials
API:
Try Demo
Show me the Solana connected address of Farcaster user v Code
Query Response
Copy query MyQuery {
Socials(
input: {
filter : { dappName : { _eq : farcaster }, profileName : { _eq : "v" } }
blockchain : ethereum
}
) {
Social {
connectedAddresses {
address
blockchain
chainId
timestamp
}
}
}
}
Copy {
"data" : {
"Socials" : {
"Social" : [
{
"connectedAddresses" : [
{
"address" : "9t92xZy9q5SyfKBH4rZwEDFXjaZKgzj5PgviPhKtBjyy" ,
"blockchain" : "solana" ,
"chainId" : "900" ,
"timestamp" : "2024-02-16T22:13:14Z"
} ,
{
"address" : "0x91031dcfdea024b4d51e775486111d2b2a715871" ,
"blockchain" : "ethereum" ,
"chainId" : "1" ,
"timestamp" : "2023-04-28T17:42:20Z"
} ,
{
"address" : "0x182327170fc284caaa5b1bc3e3878233f529d741" ,
"blockchain" : "ethereum" ,
"chainId" : "1" ,
"timestamp" : "2023-07-26T20:46:33Z"
}
]
}
]
}
}
}
Get Farcaster profiles of a given Solana address
You can resolve Solana address to get all the Farcaster profiles owned by the given Solana address by using the Socials
API:
Try Demo
Show me the Farcaster profile of solana address 9t92xZy9q5SyfKBH4rZwEDFXjaZKgzj5PgviPhKtBjyy Code
Query Response
Copy query MyQuery {
Socials(
input: {
filter : {
identity : { _eq : "9t92xZy9q5SyfKBH4rZwEDFXjaZKgzj5PgviPhKtBjyy" }
dappName : { _eq : farcaster }
}
blockchain : ethereum
}
) {
Social {
profileName
fid : userId
userAssociatedAddresses
}
}
}
Copy {
"data" : {
"Socials" : {
"Social" : [
{
"profileName" : "v" ,
"fid" : "2" ,
"userAssociatedAddresses" : [
"0x4114e33eb831858649ea3702e1c9a2db3f626446" ,
"0x91031dcfdea024b4d51e775486111d2b2a715871" ,
"0x182327170fc284caaa5b1bc3e3878233f529d741" ,
"0xf86a7a5b7c703b1fd8d93c500ac4cc75b67477f0" ,
"9t92xZy9q5SyfKBH4rZwEDFXjaZKgzj5PgviPhKtBjyy"
]
}
]
}
}
}
Get all ENS domains owned by Farcaster user(s)
You can resolve an array of Farcaster user(s) to their ENS domains:
Try Demo
Show all ENS domains owned by Farcaster user name dwr.eth and user id 1 Code
Query Response
Copy query GetENSOfFarcasters {
Domains(
input: {
filter : { owner : { _in : [ "fc_fname:dwr.eth" , "fc_fid:1" ] } }
blockchain : ethereum
}
) {
Domain {
name
}
}
}
Copy {
"data" : {
"Domains" : {
"Domain" : [
{
"name" : "noun124.eth"
} ,
{
"name" : "dwr.mirror.xyz"
} ,
{
"name" : "warpcast.eth"
} ,
{
"name" : "danromero.eth"
}
]
}
}
}
Get All Web3 Social Accounts (Farcaster, Lens) owned by 0x address or ENS
You can resolve any 0x address or ENS to their web3 socials, which comprise of Farcaster and Lens:
Try Demo
Show web3 social accounts (Farcaster, Lens) owned by dwr.eth and 0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045 Code
Query Response
Copy query GetWeb3SocialsOfFarcasters {
Socials(
input: {
filter : {
identity : {
_in : [ "dwr.eth" , "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045" ]
}
}
blockchain : ethereum
}
) {
Social {
dappName
profileName
}
}
}
Copy {
"data" : {
"Socials" : {
"Social" : [
{
"dappName" : "farcaster" ,
"profileName" : "vbuterin"
} ,
{
"dappName" : "lens" ,
"profileName" : "lens/@vitalik"
} ,
{
"dappName" : "lens" ,
"profileName" : "lens/@danromero"
} ,
{
"dappName" : "farcaster" ,
"profileName" : "dwr.eth"
}
]
}
}
}
Get Lens Profile of Farcaster user(s)
You can resolve an array of Farcaster user(s) to their Lens profile, if any:
Try Demo
Show Lens profiles owned by Farcaster user name dwr.eth and user id 5650 Code
Query Response
Copy query GetLensOfFarcasters {
Socials(
input: {
filter : {
identity : { _in : [ "fc_fname:dwr.eth" , "fc_fid:5650" ] }
dappName : { _eq : lens }
}
blockchain : ethereum
}
) {
Social {
dappName
profileName
}
}
}
Copy {
"data" : {
"Socials" : {
"Social" : [
{
"dappName" : "lens" ,
"profileName" : "lens/@vitalik"
} ,
{
"dappName" : "lens" ,
"profileName" : "lens/@danromero"
}
]
}
}
}
Check If XMTP is Enabled for Farcaster user(s)
You can check if an array of Farcaster user(s) have their XMTP enabled or not:
Try Demo
Code
Query Response
Copy query GetXMTPOfFarcasters {
XMTPs(
input: {
blockchain : ALL
filter : { owner : { _in : [ "fc_fname:varunsrin.eth" , "fc_fid:5650" ] } }
}
) {
XMTP {
isXMTPEnabled
owner {
socials(input: { filter : { dappName : { _eq : farcaster } } }) {
profileName
}
}
}
}
}
Copy {
"data" : {
"XMTPs" : {
"XMTP" : [
{
"isXMTPEnabled" : true ,
"owner" : {
"socials" : [
{
"profileName" : "vbuterin"
}
]
}
} ,
{
"isXMTPEnabled" : true ,
"owner" : {
"socials" : [
{
"profileName" : "varunsrin.eth"
}
]
}
}
]
}
}
}
Developer Support
If you have any questions or need help regarding resolving identities for Farcaster user(s), please join our Airstack's Telegram group.
More Resources