Search Assets

Search for assets using a variety of parameters.

Overview

This method will return assets based on the custom search criteria passed in. This can define compressed, regular NFTs, and fungible tokens. This method is optimal for most custom use cases, such as token gating.

The page parameter in the request starts at 1.

searchAssets

post

/?api-key=<api-key>

Body

idstringrequired

An ID to identify the request.

jsonrpcstring · enumrequired

The version of the JSON-RPC protocol.

Options: 2.0

methodstring · enumrequired

The name of the DAS method to invoke.

Options: searchAssets

paramsobjectrequired

Responses

application/json

application/json

application/json

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://mainnet.helius-rpc.com/?api-key=<api-key>' \
  --header 'Content-Type: application/json' \
  --data '{"id":"text","jsonrpc":"2.0","method":"searchAssets","params":{"page":1,"authorityAddress":"string","limit":100,"compressed":true,"compressible":false,"creatorAddress":"string","creatorVerified":true,"supply":0,"frozen":false,"burnt":false,"ownerAddress":"string","royaltyTargetType":"creators","royaltyTarget":null,"royaltyAmount":0,"ownerType":"single","before":"string","after":"string","interface":"Custom","tokenType":"fungible","grouping":["collection","DRiP2Pn2K6fuMLKQmt5rZWyHiUZ6WK3GChEySUpHSS4x"],"options":{"showUnverifiedCollections":false,"showCollectionMetadata":false,"showGrandTotal":false,"showNativeBalance":false,"showInscription":false,"showZeroBalance":false},"sortBy":{"sortBy":"created","sortDirection":"asc"}}}'

200

400

401

403

404

429

500

200

{
  "assets": {
    "total": 2,
    "limit": 100,
    "page": 1,
    "nativeBalance": {
      "lamports": 1,
      "price_per_sol": 1,
      "total_price": 1
    },
    "items": [
      {
        "id": "text",
        "content": {},
        "compression": {},
        "grouping": {},
        "royalty": {},
        "ownership": {},
        "mutable": true,
        "burnt": true,
        "spl20": {},
        "interface": "V1_NFT",
        "authorities": [
          {}
        ],
        "creators": [
          {}
        ],
        "supply": {
          "print_max_supply": 1,
          "print_current_supply": 1,
          "edition_nonce": 1,
          "edition_number": 1
        },
        "inscription": {
          "order": 1,
          "size": 1,
          "contentType": "text",
          "encoding": "text",
          "validationHash": "text",
          "inscriptionDataAccount": "text",
          "authority": "text"
        },
        "token_info": {
          "symbol": "text",
          "balance": 1,
          "supply": 1,
          "decimals": 1,
          "token_program": "text",
          "associated_token_address": "text",
          "price_info": {
            "price_per_token": 1,
            "total_price": 1,
            "currency": "text"
          }
        },
        "mint_extensions": {
          "confidential_transfer_mint": {
            "authority": "text",
            "auto_approve_new_accounts": true,
            "auditor_elgamal_pubkey": "text"
          },
          "confidential_transfer_fee_config": {
            "authority": "text",
            "withdraw_withheld_authority_elgamal_pubkey": "text",
            "harvest_to_mint_enabled": true,
            "withheld_amount": "text"
          },
          "metadata_pointer": {
            "authority": "text",
            "metadata_address": "text"
          },
          "mint_close_authority": {
            "close_authority": "text"
          },
          "permanent_delegate": {
            "delegate": "text"
          },
          "transfer_hook": {
            "authority": "text",
            "program_id": "text"
          },
          "interest_bearing_config": {
            "rate_authority": "text",
            "initialization_timestamp": 1,
            "pre_update_average_rate": 1,
            "last_update_timestamp": 1,
            "current_rate": 1
          },
          "default_account_state": {
            "state": "text"
          },
          "confidential_transfer_account": {
            "approved": true,
            "elgamal_pubkey": "text",
            "pending_balance_lo": "text",
            "pending_balance_hi": "text",
            "available_balance": "text",
            "decryptable_available_balance": "text",
            "allow_confidential_credits": true,
            "allow_non_confidential_credits": true,
            "pending_balance_credit_counter": 1,
            "maximum_pending_balance_credit_counter": 1,
            "expected_pending_balance_credit_counter": 1,
            "actual_pending_balance_credit_counter": 1
          },
          "transfer_fee_config": {
            "transfer_fee_config_authority": "text",
            "withdraw_withheld_authority": "text",
            "withheld_amount": 1,
            "older_transfer_fee": {
              "epoch": "text",
              "maximum_fee": "text",
              "transfer_fee_basis_points": "text"
            },
            "newer_transfer_fee": {
              "epoch": "text"
            }
          },
          "metadata": {
            "update_authority": "text",
            "mint": "text",
            "name": "text",
            "symbol": "text",
            "uri": "text",
            "additional_metadata": [
              {
                "key": "text",
                "value": "text"
              }
            ]
          }
        }
      }
    ]
  }
}

Successful response

Fungible Token Extension

Fungible tokens will include their associated information (decimals, supply, and price). Token22 tokens are also supported, and their extensions are parsed. We also display native balances if you enable the showNativeBalance flag. The options for tokenType include:

• fungible : Returns all fungible tokens.

• nonFungible: Returns all NFTs (compressed and regular NFTs).

• regularNFT : Returns only the regular NFTs.

• compressedNFT: Returns only the compressed NFTs.

• all : Returns all the tokens.

When using the tokenType as a filter, it is mandatory to also include the ownerAddress filter.

If the tokenType field is set to fungible or all the following filters can't be used

creatorAddress

creatorVerified

grouping

ownerType

specificationAssetClass

compressed

compressible

specificationVersion

authorityAddress

delegate

frozen

supply

supplyMint

royalty (and related fields: royaltyTargetType, royaltyTarget, royaltyAmount)

burnt

jsonUri

collections

name

Inscriptions & SPL-20

You can optionally display inscription and SPL-20 token data with the showInscription flag. You can learn more about inscriptions and SPL-20 here.

Please note that this is an experimental feature.

The Helius API does not verify SPL-20 tokens. Trade at your own risk. For more information, please use the validator tool or join the Libreplex Discord channel.

Code Examples

Searching for all Fungible Tokens in a wallet

const url = `https://mainnet.helius-rpc.com/?api-key=<api_key>`

const searchAssets = async () => {
  const response = await fetch(url, {
    method: 'POST',
    headers: {
      'Content-Type': 'application/json',
    },
    body: JSON.stringify({
      jsonrpc: '2.0',
      id: 'my-id',
      method: 'searchAssets',
      params: {
        ownerAddress: '86xCnPeV69n6t3DnyGvkKobf9FdN2H9oiVDdaMpo2MMY',
	    tokenType: 'fungible',
      },
    }),
  });
  const { result } = await response.json();
  console.log("Search Assets: ", result);
};
searchAssets();

Searching for all Fungible Tokens (showing native balance and token info)

const url = `https://mainnet.helius-rpc.com/?api-key=<api_key>`

const searchAssetsTokenInfo = async () => {
    const response = await fetch(url, {
        method: 'POST',
        headers: {
            'Content-Type': 'application/json',
        },
        body: JSON.stringify({
            jsonrpc: '2.0',
            id: 'my-id',
            method: 'searchAssets',
            params: {
                ownerAddress: '86xCnPeV69n6t3DnyGvkKobf9FdN2H9oiVDdaMpo2MMY',
                tokenType: 'fungible',
                displayOptions: {
                    showNativeBalance: true,
                },
            },
        }),
    });

    const { result } = await response.json();

    result.items.forEach(item => {  // for each item in the result, log the token_info
      console.log(item.token_info);
  });

    console.log("Native Balance: ", result.nativeBalance); // logging native balance
};

searchAssetsTokenInfo();

Searching for Drip NFTs owned by vibhu.sol

const url = `https://mainnet.helius-rpc.com/?api-key=<api_key>`

const searchAssetsDrip = async () => {
  const response = await fetch(url, {
    method: 'POST',
    headers: {
      'Content-Type': 'application/json',
    },
    body: JSON.stringify({
      jsonrpc: '2.0',
      id: 'my-id',
      method: 'searchAssets',
      params: {
        ownerAddress: 'BAVjpySHMMGDpq3whU7qaqCCRE8ksCeGwxa53Qv2i8jS',
        grouping: ["collection", "DRiP2Pn2K6fuMLKQmt5rZWyHiUZ6WK3GChEySUpHSS4x"],
        page: 1, // Starts at 1
        limit: 1000
      },
    }),
  });
  const { result } = await response.json();
  console.log("Drip Haus Assets: ", result);
};
searchAssetsDrip();

Searching for Compressed Assets in a wallet

const url = `https://mainnet.helius-rpc.com/?api-key=<api_key>`

const searchAssetsCompressed = async () => {
  const response = await fetch(url, {
    method: 'POST',
    headers: {
      'Content-Type': 'application/json',
    },
    body: JSON.stringify({
      jsonrpc: '2.0',
      id: 'my-id',
      method: 'searchAssets',
      params: {
        ownerAddress: '2k5AXX4guW9XwRQ1AKCpAuUqgWDpQpwFfpVFh3hnm2Ha',
        compressed: true,
      },
    }),
  });
  const { result } = await response.json();
  console.log("Search Assets: ", result);
};
searchAssetsCompressed();

Searching for Inscriptions & SPL-20 data

const url = `https://mainnet.helius-rpc.com/?api-key=<api-key>`

const searchAssetsInscriptions = async () => {
    const response = await fetch(url, {
        method: 'POST',
        headers: {
            'Content-Type': 'application/json',
        },
        body: JSON.stringify({
            jsonrpc: '2.0',
            id: 'my-id',
            method: 'searchAssets',
            params: {
                ownerAddress: '6GmTFg5SCs4zGfDEidUAJjS5pSrXEPwW8Rpfs3RHrbc5',
                tokenType: 'regularNft',
                displayOptions: {
                    showInscription: true, // display inscription & spl-20 data
                },
            },
        }),
    });

    const { result } = await response.json();
    console.log(result.items.map((i) => [i.id, i.inscription, i.spl20]));
};
searchAssetsInscriptions();