πŸ”Search Social Profiles

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.

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.

Table Of Contents

In this guide you will learn how to use Airstack to:

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:

React

npm install @airstack/airstack-react

Node

npm install @airstack/node

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

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

Code

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

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

Code

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

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

Code

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

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

Code

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

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

Code

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

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

Code

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

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

Code

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

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

Code

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

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

Code

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

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

Last updated

Was this helpful?