description

layout

Learn how to use Airstack to search for social profiles across Lens and Farcaster that fulfills the given regex patterns, filters or sort variables the API offered.

title

description

tableOfContents

outline

pagination

visible
true

visible
true

visible
true

visible

visible
true

🔍 Search Social Profiles

Airstack provides easy-to-use Socials API for searching social profiles across Lens and Farcaster easily by using RegEx patterns.

With this, you can build your very own social profile search engine easily and plug it into your application.

For demo on social profile search engine, check out Airstack Explorer here.

Airstack Explorer Social Profile Search Engine

Get All Social Profiles Starting With Given Words
Get All Social Profiles Containing Given Words
Get All Social Profiles That Has Certain Number of Letters
Get All Lens Profiles Starting With Given Words
Get All Lens Profiles Containing Given Words
Get All Lens Profiles That Has Certain Number of Letters
Get All Farcaster Users Starting With Given Words
Get All Farcaster Users Containing Given Words
Get All Farcaster Users That Has Certain Number of Letters

Pre-requisites

An Airstack account
Basic knowledge of GraphQL

Get Started

JavaScript/TypeScript/Python

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

{% tabs %} {% tab title="npm" %} React

npm install @airstack/airstack-react

Node

npm install @airstack/node

{% endtab %}

{% tab title="yarn" %} React

yarn add @airstack/airstack-react

Node

yarn add @airstack/node

{% endtab %}

{% tab title="pnpm" %} React

pnpm install @airstack/airstack-react

Node

pnpm install @airstack/node

{% endtab %}

{% tab title="pip" %}

pip install airstack

{% endtab %} {% endtabs %}

Then, add the following snippets to your code:

{% tabs %} {% tab title="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>;
  }
};

{% endtab %}

{% tab title="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);

{% endtab %}

{% tab title="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())

{% endtab %} {% endtabs %}

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.

Airstack AI (Demo)

Get All Social Profiles Starting With Given Words

You can fetch all Lens and Farcaster users that starts with given words by providing an array of regex patterns containing:

"^<given-words>" for Farcaster search
"^lens/@<given-words>" for Lens search

to the _regex_in operator in Socials API:

Try Demo

{% embed url="https://app.airstack.xyz/query/z7uWnFzcXD" %} show me all Lens and Farcaster profiles starting with "a" {% endembed %}

Code

{% tabs %} {% tab title="Query" %}

query MyQuery {
  Socials(
    input: {
      filter: {
        # This regex pattern will search Lens & Farcaster profiles
        # starting with "a"
        profileName: {_regex_in: ["^a", "^lens/@a"]},
      },
      blockchain: ethereum
    }
  ) {
    Social {
      dappName
      profileName
    }
  }
}

{% endtab %}

{% tab title="Response" %}

{
  "data": {
    "Socials": {
      "Social": [
        {
          "dappName": "farcaster",
          "profileName": "atty"
        },
        {
          "dappName": "lens",
          "profileName": "lens/@anastasia1337"
        },
        {
          "dappName": "farcaster",
          "profileName": "anita-mpf"
        }
        // Other Lens & Farcaster profiles starting with "a"
      ]
    }
  }
}

{% endtab %} {% endtabs %}

Get All Social Profiles Containing Given Words

You can fetch all Lens and Farcaster users that contains given words by providing "<given-words>" directly to the _regex operator in Socials API:

Try Demo

{% embed url="https://app.airstack.xyz/query/IBrXUm2Rm1" %} show me all Lens and Farcaster profiles containing with "abc" {% endembed %}

Code

{% tabs %} {% tab title="Query" %}

query MyQuery {
  Socials(
    input: {
      filter: {
        # This regex pattern will search Lens & Farcaster profiles
        # containing "abc"
        profileName: {_regex: "abc"}
      },
      blockchain: ethereum
    }
  ) {
    Social {
      dappName
      profileName
    }
  }
}

{% endtab %}

{% tab title="Response" %}

{
  "data": {
    "Socials": {
      "Social": [
        {
          "dappName": "lens",
          "profileName": "lens/@abcoathup"
        },
        {
          "dappName": "lens",
          "profileName": "lens/@phabc"
        },
        {
          "dappName": "farcaster",
          "profileName": "abcabc"
        }
        // Other Lens and Farcaster profiles containing "abc"
      ]
    }
  }
}

{% endtab %} {% endtabs %}

Get All Social Profiles That Has Certain Number of Letters

You can fetch all Lens and Farcaster users that starts with given words by providing an array of regex patterns containing:

"^.{min_number_of_letters, max_number_of_letters}$" for Farcaster search
"^lens/@.{min_number_of_letters, max_number_of_letters}$" for Lens search

to the _regex_in operator in Socials API, where the minimum should always be less than or equal to the maximum:

Try Demo

{% embed url="https://app.airstack.xyz/query/szgoFIqPfe" %} Show me all Lens and Farcaster profiles that has 3 letters or less {% endembed %}

Code

{% tabs %} {% tab title="Query" %}

query MyQuery {
  Socials(
    input: {
      filter: {
        # This regex pattern search Lens & Farcaster profiles
        # that have 1-3 letters in its profile name
        profileName: {_regex_in: ["^.{1,3}$", "^lens/@.{1,3}$"]}
        dappName: {_eq: farcaster}
      },
      blockchain: ethereum
    }
  ) {
    Social {
      dappName
      profileName
    }
  }
}

{% endtab %}

{% tab title="Response" %}

{
  "data": {
    "Socials": {
      "Social": [
        {
          "dappName": "farcaster",
          "profileName": "977"
        },
        {
          "dappName": "farcaster",
          "profileName": "nem"
        },
        {
          "dappName": "farcaster",
          "profileName": "vw"
        }
        // Other Lens & Farcaster profiles that has 3 letters or less
      ]
    }
  }
}

{% endtab %} {% endtabs %}

Get All Lens Profiles Starting With Given Words

You can fetch all Lens profiles that starts with given words by providing the regex pattern "^lens/@<given-words>" to the _regex operator in Socials API:

Try Demo

{% embed url="https://app.airstack.xyz/query/uzlh7IZa4c" %} show me all Lens profiles starting with "a" {% endembed %}

Code

{% tabs %} {% tab title="Query" %}

query MyQuery {
  Socials(
    input: {
      filter: {
        # This regex pattern will search all Lens profile
        # starting with "a"
        profileName: {_regex: "^lens/@a"},
        dappName: {_eq: lens}
      },
      blockchain: ethereum
    }
  ) {
    Social {
      dappName
      profileName
    }
  }
}

{% endtab %}

{% tab title="Response" %}

{
  "data": {
    "Socials": {
      "Social": [
        {
          "dappName": "lens",
          "profileName": "lens/@anastasia1337"
        },
        {
          "dappName": "lens",
          "profileName": "lens/@amg888"
        },
        {
          "dappName": "lens",
          "profileName": "lens/@alexdark"
        }
        // Other Lens profiles starting with "a"
      ]
    }
  }
}

{% endtab %} {% endtabs %}

Get All Lens Profiles Containing Given Words

You can fetch all Lens profiles that contains given words by providing "<given-words>" directly to the _regex operator in Socials API:

Try Demo

{% embed url="https://app.airstack.xyz/query/wBDukQXH3E" %} show me all Lens profiles containing with "abc" {% endembed %}

Code

{% tabs %} {% tab title="Query" %}

query MyQuery {
  Socials(
    input: {
      filter: {
        # This regex pattern will search all Lens profiles
        # containing "abc"
        profileName: {_regex: "abc"},
        dappName: {_eq: lens}
      },
      blockchain: ethereum
    }
  ) {
    Social {
      dappName
      profileName
    }
  }
}

{% endtab %}

{% tab title="Response" %}

{
  "data": {
    "Socials": {
      "Social": [
        {
          "dappName": "lens",
          "profileName": "lens/@abcoathup"
        },
        {
          "dappName": "lens",
          "profileName": "lens/@phabc"
        },
        {
          "dappName": "lens",
          "profileName": "lens/@abc888"
        }
        // Other Lens profiles containing with "abc"
      ]
    }
  }
}

{% endtab %} {% endtabs %}

Get All Lens Profiles That Has Certain Number of Letters

You can fetch all Lens profiles that has certain number of letters in its profile name by providing "^.{min_number_of_letters, max_number_of_letters}$" directly to the _regex operator in Socials API, where the minimum should always be less than or equal to the maximum:

Try Demo

{% embed url="https://app.airstack.xyz/query/EocCe2Et9c" %} show me all Lens profiles that has 3 letters or less {% endembed %}

Code

{% tabs %} {% tab title="Query" %}

query MyQuery {
  Socials(
    input: {
      filter: {
        # This regex pattern search all Lens profiles that have 1-3
        # letters in its profile name
        profileName: {_regex: "^lens/@.{1,3}$"},
        dappName: {_eq: lens}
      },
      blockchain: ethereum
    }
  ) {
    Social {
      dappName
      profileName
    }
  }
}

{% endtab %}

{% tab title="Response" %}

{
  "data": {
    "Socials": {
      "Social": [
        {
          "dappName": "lens",
          "profileName": "lens/@emi"
        },
        {
          "dappName": "lens",
          "profileName": "lens/@dev"
        },
        {
          "dappName": "lens",
          "profileName": "lens/@bak"
        }
        // Other lens profiles with less than 3 letters
      ]
    }
  }
}

{% endtab %} {% endtabs %}

Get All Farcaster Users Starting With Given Words

You can fetch all Farcaster users that starts with given words by providing the regex pattern "^<given-words>" to the _regex operator in Socials API:

Try Demo

{% embed url="https://app.airstack.xyz/query/mXuUlbGPnI" %} show me all Farcaster users starting with "a" {% endembed %}

Code

{% tabs %} {% tab title="Query" %}

query MyQuery {
  Socials(
    input: {
      filter: {
        # This regex pattern will search all Farcaster users
        # starting with "a"
        profileName: {_regex: "^a"},
        dappName: {_eq: farcaster}
      },
      blockchain: ethereum
    }
  ) {
    Social {
      dappName
      profileName
    }
  }
}

{% endtab %}

{% tab title="Response" %}

{
  "data": {
    "Socials": {
      "Social": [
        {
          "dappName": "farcaster",
          "profileName": "atty"
        },
        {
          "dappName": "farcaster",
          "profileName": "anita-mpf"
        },
        {
          "dappName": "farcaster",
          "profileName": "amarraghu"
        }
        // Other Farcaster users starting with "a"
      ]
    }
  }
}

{% endtab %} {% endtabs %}

Get All Farcaster Users Containing Given Words

You can fetch all Farcaster users that contains given words by providing "<given-words>" directly to the _regex operator in Socials API:

Try Demo

{% embed url="https://app.airstack.xyz/query/yuolzNgcAR" %} show me all Farcaster users containing with "abc" {% endembed %}

Code

{% tabs %} {% tab title="Query" %}

query MyQuery {
  Socials(
    input: {
      filter: {
        # This regex pattern will search all Farcaster users
        # containing "abc"
        profileName: {_regex: "abc"},
        dappName: {_eq: farcaster}
      },
      blockchain: ethereum
    }
  ) {
    Social {
      dappName
      profileName
    }
  }
}

{% endtab %}

{% tab title="Response" %}

{
  "data": {
    "Socials": {
      "Social": [
        {
          "dappName": "farcaster",
          "profileName": "abcabc"
        },
        {
          "dappName": "farcaster",
          "profileName": "krabchinski"
        },
        {
          "dappName": "farcaster",
          "profileName": "861213abcc"
        }
        // Other Farcaster users containing with "abc"
      ]
    }
  }
}

{% endtab %} {% endtabs %}

Get All Farcaster Users That Has Certain Number of Letters

You can fetch all Farcaster users that has certain number of letters in its profile name by providing "^.{min_number_of_letters, max_number_of_letters}$" directly to the _regex operator in Socials API, where the minimum should always be less than or equal to the maximum:

Try Demo

{% embed url="https://app.airstack.xyz/query/9bEUw4msj1" %} show me all Farcaster users that has 3 letters or less {% endembed %}

Code

{% tabs %} {% tab title="Query" %}

query MyQuery {
  Socials(
    input: {
      filter: {
        # This regex pattern search all Farcaster users that have 1-3
        # letters in its profile name
        profileName: {_regex: "^.{1,3}$"}
        dappName: {_eq: farcaster}
      },
      blockchain: ethereum
    }
  ) {
    Social {
      dappName
      profileName
    }
  }
}

{% endtab %}

{% tab title="Response" %}

{
  "data": {
    "Socials": {
      "Social": [
        {
          "dappName": "farcaster",
          "profileName": "977"
        },
        {
          "dappName": "farcaster",
          "profileName": "nem"
        },
        {
          "dappName": "farcaster",
          "profileName": "vw"
        }
        // Other Farcaster users with less than 3 letters
      ]
    }
  }
}

{% endtab %} {% endtabs %}

Developer Support

If you have any questions or need help regarding searching for social profiles on Lens and Farcaster, please join our Airstack's Telegram group.

More Resources

Socials API Reference
Resolve Lens Profiles
Lens Profile Details
Lens Followers
Lens Following
Resolve Farcaster Users
Farcaster Users Details
Farcaster Followers
Farcaster Following

Files

search-social-profiles.md

Latest commit

History

search-social-profiles.md

File metadata and controls

🔍 Search Social Profiles

Table Of Contents

Pre-requisites

Get Started

JavaScript/TypeScript/Python

Other Programming Languages

🤖 AI Natural Language​

Get All Social Profiles Starting With Given Words

Try Demo

Code

Get All Social Profiles Containing Given Words

Try Demo

Code

Get All Social Profiles That Has Certain Number of Letters

Try Demo

Code

Get All Lens Profiles Starting With Given Words

Try Demo

Code

Get All Lens Profiles Containing Given Words

Try Demo

Code

Get All Lens Profiles That Has Certain Number of Letters

Try Demo

Code

Get All Farcaster Users Starting With Given Words

Try Demo

Code

Get All Farcaster Users Containing Given Words

Try Demo

Code

Get All Farcaster Users That Has Certain Number of Letters

Try Demo

Code

Developer Support

More Resources

🤖 AI Natural Language