Skip to content

Latest commit

 

History

History
367 lines (284 loc) · 7.7 KB

erc20.md

File metadata and controls

367 lines (284 loc) · 7.7 KB
description layout
Learn how to fetch ERC20 token holders of a specific contract address(es) and how to use the same query to check whether a given user holds a specific ERC20 token.
title description tableOfContents outline pagination
visible
true
visible
true
visible
true
visible
visible
true

🪙 ERC20

Airstack provides easy-to-use ERC20 token APIs for enriching Web3 applications with onchain and offchain ERC20 token data from Ethereum, Base, Degen Chain, and other Airstack-supported chains.

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:

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

Get ERC20 Token Holders

You can use Airstack to fetch ERC20 token holders of a given contract address(es) by using the TokenBalances API and providing the token contract address(es) to tokenAddress input:

Try Demo

{% embed url="https://app.airstack.xyz/query/EDX15sLWg1" %} Show me holders of @Wrapped Ether {% endembed %}

Code

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

query MyQuery {
  TokenBalances(
    input: {
      filter: {
        tokenAddress: { _in: ["0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2"] }
      }
      blockchain: ethereum
      limit: 200
    }
  ) {
    TokenBalance {
      owner {
        addresses
        domains {
          name
          isPrimary
        }
        socials {
          dappName
          profileName
          userAssociatedAddresses
        }
        xmtp {
          isXMTPEnabled
        }
      }
    }
    pageInfo {
      nextCursor
      prevCursor
    }
  }
}

{% endtab %}

{% tab title="Response" %}

 {
  "data": {
    "TokenBalances": {
      "TokenBalance": [
        {
          "owner": {
            "addresses": [
              "0xdef1c0ded9bec7f1a1670819833240f027b25eff"
            ],
            "domains": [
              {
                "name": "0x.merklejerk.eth",
                "isPrimary": false
              },
              {
                "name": "zeroex.eth",
                "isPrimary": false
              }
            ],
            "socials": null,
            "xmtp": null
          }
        },
        // Other WETH holders
      ],
      "pageInfo": {
        "nextCursor": "eyJMYXN0VmFsdWVzTWFwIjp7Il9pZCI6eyJWYWx1ZSI6IjEweGJjNGNhMGVkYTc2NDdhOGFiN2MyMDYxYzJlMTE4YTE4YTkzNmYxM2QweGFhYTJkYTI1NWRmOWVlNzRjNzA3NWJjYjZkODFmOTc5NDA5MDhhNWQxNTYiLCJEYXRhVHlwZSI6InN0cmluZyJ9LCJsYXN0VXBkYXRlZFRpbWVzdGFtcCI6eyJWYWx1ZSI6IjE3MDA0MTA5MTkiLCJEYXRhVHlwZSI6IkRhdGVUaW1lIn19LCJQYWdpbmF0aW9uRGlyZWN0aW9uIjoiTkVYVCJ9",
        "prevCursor": ""
      }
    }
  }
]

{% endtab %} {% endtabs %}

Check If User Hold A Specific ERC20 Token

You can use Airstack to check if a user hold a given ERC20 token by using the TokenBalances API.

For inputs, provide the token contract address(es) to tokenAddress and user's 0x address, ENS domain, cb.id, Lens profile, or Farcaster fname/fid to owner as an input:

Try Demo

{% embed url="https://app.airstack.xyz/query/kp1lhkNlLq" %} Check if 0xdef1c0ded9bec7f1a1670819833240f027b25eff hold any Wrapped Ether {% endembed %}

Code

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

query MyQuery {
  TokenBalances(
    input: {
      filter: {
        tokenAddress: { _eq: "0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2" }
        owner: { _eq: "0xdef1c0ded9bec7f1a1670819833240f027b25eff" }
      }
      blockchain: ethereum
    }
  ) {
    TokenBalance {
      owner {
        addresses
        domains {
          name
          isPrimary
        }
        socials {
          dappName
          profileName
          userAssociatedAddresses
        }
        xmtp {
          isXMTPEnabled
        }
      }
    }
  }
}

{% endtab %}

{% tab title="Response" %}

{
  "data": {
    "TokenBalances": {
      "TokenBalance": [
        {
          "owner": {
            "addresses": ["0xdef1c0ded9bec7f1a1670819833240f027b25eff"],
            "domains": [
              {
                "name": "0x.merklejerk.eth",
                "isPrimary": false
              },
              {
                "name": "zeroex.eth",
                "isPrimary": false
              }
            ],
            "socials": null,
            "xmtp": null
          }
        }
      ],
      "pageInfo": {
        "nextCursor": "",
        "prevCursor": ""
      }
    }
  }
}

{% endtab %} {% endtabs %}

If the given user hold the specified ERC20 token, then TokenBalances will have non-null value as a response. Otherwise, the API will return null.

Developer Support

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

More Resources