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. Example: token gating.

The page parameter in the request starts at 1.

searchAssets

POSThttps://mainnet.helius-rpc.com/?api-key=<api_key>

Query parameters

Body

jsonrpc*enum

The version of the JSON-RPC protocol.

2.0

id*string

An ID to identify the request.

method*enum

The name of the DAS method to invoke.

searchAssets

paramsobject

Response

Successful response

Body

assetsobject

Request

const response = await fetch('https://mainnet.helius-rpc.com/?api-key=<api_key>', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "jsonrpc": "2.0",
      "id": "text",
      "method": "searchAssets"
    }),
});
const data = await response.json();

Response

{
  "assets": {
    "total": 2,
    "limit": 100,
    "page": 1,
    "items": [
      {
        "interface": "V1_NFT",
        "id": "text",
        "authorities": [],
        "creators": [],
        "mutable": false,
        "burnt": false,
        "mint_extensions": {
          "confidential_transfer_mint": {
            "authority": "text",
            "auto_approve_new_accounts": false,
            "auditor_elgamal_pubkey": "text"
          },
          "confidential_transfer_fee_config": {
            "authority": "text",
            "withdraw_withheld_authority_elgamal_pubkey": "text",
            "harvest_to_mint_enabled": false,
            "withheld_amount": "text"
          },
          "transfer_fee_config": {
            "transfer_fee_config_authority": "text",
            "withdraw_withheld_authority": "text",
            "withheld_amount": 0,
            "older_transfer_fee": {
              "epoch": "text",
              "maximum_fee": "text",
              "transfer_fee_basis_points": "text"
            },
            "newer_transfer_fee": {
              "epoch": "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": 0,
            "pre_update_average_rate": 0,
            "last_update_timestamp": 0,
            "current_rate": 0
          },
          "default_account_state": {
            "state": "text"
          },
          "confidential_transfer_account": {
            "approved": false,
            "elgamal_pubkey": "text",
            "pending_balance_lo": "text",
            "pending_balance_hi": "text",
            "available_balance": "text",
            "decryptable_available_balance": "text",
            "allow_confidential_credits": false,
            "allow_non_confidential_credits": false
          },
          "metadata": {
            "update_authority": "text",
            "mint": "text",
            "name": "text",
            "symbol": "text",
            "uri": "text",
            "additional_metadata": [
              {
                "key": "text",
                "value": "text"
              }
            ]
          }
        },
        "token_info": {
          "symbol": "text",
          "token_program": "text",
          "associated_token_address": "text",
          "price_info": {
            "price_per_token": 0,
            "total_price": 0,
            "currency": "text"
          }
        },
        "inscription": {
          "contentType": "text",
          "encoding": "text",
          "validationHash": "text",
          "inscriptionDataAccount": "text",
          "authority": "text"
        }
      }
    ],
    "nativeBalance": {
      "price_per_sol": 0,
      "total_price": 0
    }
  }
}

Fungible Token Extension

DAS API traditionally has only returned data for NFTs — at Helius, we've also added support for all tokens. Developers can access this feature query by setting tokenType to all. 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.

To learn more, please visit Fungible Token Extension (Beta).

Not all options within searchAssets are supported with tokenType. Please read here to learn more.

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.

Examples

Search for Drip NFTs owned by toly.sol

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',
        grouping: ["collection", "DRiP2Pn2K6fuMLKQmt5rZWyHiUZ6WK3GChEySUpHSS4x"],
        page: 1, // Starts at 1
        limit: 1000
      },
    }),
  });
  const { result } = await response.json();
  console.log("Drip Haus Assets: ", result);
};
searchAssets();

Searching for compressed assets 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: '2k5AXX4guW9XwRQ1AKCpAuUqgWDpQpwFfpVFh3hnm2Ha',
        compressed: true,
      },
    }),
  });
  const { result } = await response.json();
  console.log("Search Assets: ", result);
};
searchAssets();

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: '2k5AXX4guW9XwRQ1AKCpAuUqgWDpQpwFfpVFh3hnm2Ha',
	tokenType: fungible
      },
    }),
  });
  const { result } = await response.json();
  console.log("Search Assets: ", result);
};
searchAssets();

Searching for all assets (including native balance):

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

const getAssetsWithNativeBalance = 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();
    console.log(result.nativeBalance.lamports); // 1479920100
    console.log(result.nativeBalance.price_per_sol); // 59.98567343
    console.log(result.nativeBalance.total_price); // 88.77400382109295
};
getAssetsWithNativeBalance();

Show inscriptions & SPL-20 data

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

const getAssetsWithInscriptions = 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]));
};
getAssetsWithInscriptions();

// Example output:
// [
//     [
//         'AKo9P7S8FE9NYeAcrtZEpimwQAXJMp8Lrt8p4dMkHkY2',
//         {
//             order: 308332,
//             size: 52,
//             contentType: 'application/text',
//             encoding: 'base64',
//             validationHash: '907e00a18f952ade319c21b90764e5d0a08ec31c92e792f806a995e8524535ca',
//             inscriptionDataAccount: '9qM9ThkVPxjq4TyBjCs1qpY15VYVim2Qh7uR5yG1Da3T',
//         },
//         { p: 'spl-20', op: 'mint', tick: 'helius', amt: '1' },
//     ],
// ];

Using the Token Support Extension

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

Is your query not supported? We'd like to know! Reach out to us on Discord on Telegram, and we'll help you out.

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

PreviousGet Assets by Group NextGet Signatures For Asset

Last updated 4 months ago