SEARCH_ACCOUNTS

Search accounts with a powerful filter built on top of Elasticsearch

Overview

This method allows you to search through program accounts with a robust filter object. There are many types of filters you can apply and you can find information regarding those in the Filters section of the docs. The endpoint example here shows off one of the many filters.

SEARCH_ACCOUNTS

post

Search accounts with a powerful filter built on top of Elasticsearch

Header parameters

x-api-keystringRequired

the API key

Body

typestringRequired

Should be set to 'SEARCH_ACCOUNTS'. This is the type of query you want to perform.

Example: SEARCH_ACCOUNTS

Responses

200

Successful Response

application/json

post

HTTPcURLJavaScriptPython

POST /query/solana HTTP/1.1
Host: mainnet.carpool.dev
x-api-key: text
Content-Type: application/json
Accept: */*
Content-Length: 396

"{\n    \"type\": \"SEARCH_ACCOUNTS\",\n    \"query\": {\n        \"programId\": \"CndyV3LdqHUfDLmE5naZjVN8rBZz4tqhdefbAnjHG3JR\",\n        \"accountName\": \"CandyMachine\",\n        \"filter\": {\n            \"type\": \"ACCOUNT_DATA_NUMERIC\",\n            \"path\": \"data.creators.percentageShare\",\n            \"range\": {\n                \"eq\": 100\n            }\n        }\n    }\n}"

200

Successful Response

{
  "response": {
    "accounts": [
      {
        "slot": 187917056,
        "lamports": 7182720,
        "writeVersion": 669468401339,
        "data": {
          "authority": "5D818k9MDVwk6b1kap3pr5wGK8uio7HaECy5oRfZhjZd",
          "collectionMint": "CcnJKcN2t2ZWRdR5Zfunh4S59TP3eyt9aouduU1BwTxG",
          "data": {
            "configLineSettings": {
              "isSequential": true,
              "nameLength": 1,
              "prefixName": "text",
              "prefixUri": "text",
              "uriLength": 1
            },
            "creators": [
              {
                "address": "5D818k9MDVwk6b1kap3pr5wGK8uio7HaECy5oRfZhjZd",
                "percentageShare": 100,
                "verified": false
              }
            ],
            "hiddenSettings": {},
            "isMutable": true,
            "itemsAvailable": 1,
            "maxSupply": 1,
            "sellerFeeBasisPoints": 1,
            "symbol": "text"
          },
          "features": [
            1
          ],
          "itemsRedeemed": 1,
          "mintAuthority": "text",
          "tokenStandard": 1,
          "version": {
            "v1": {}
          }
        },
        "pubKey": "J7W8sRdriBuxCC5WfQPndpAQCronUkrkgzSbBd4RpSwj",
        "programId": "CndyV3LdqHUfDLmE5naZjVN8rBZz4tqhdefbAnjHG3JR"
      }
    ]
  }
}

Filters

As mentioned above, the api definition here illustrates one of Carpool's many filter types. All queries that accept a filter object in the POST body can make use of any of the potential filters. Please see the Account Filters section of the documentation to better understand how they are implemented for account related queries.

🎛️Account Filters

Example - Basic

Program - Candy Machine

Description - Return all CandyMachine accounts where the value at data.creators.percentageShare is equal to 100

Javascript

var myHeaders = new Headers();
myHeaders.append("x-api-key", "<API_KEY>");
myHeaders.append("Content-Type", "application/json");

var raw = JSON.stringify({
  "type": "SEARCH_ACCOUNTS",
  "query": {
    "programId": "CndyV3LdqHUfDLmE5naZjVN8rBZz4tqhdefbAnjHG3JR",
    "accountName": "CandyMachine",
    "filter": {
      "type": "ACCOUNT_DATA_NUMERIC",
      "path": "data.creators.percentageShare",
      "range": {
        "eq": 100
      }
    }
  }
});

var requestOptions = {
  method: 'POST',
  headers: myHeaders,
  body: raw,
  redirect: 'follow'
};

fetch("https://mainnet.carpool.dev/query/solana", requestOptions)
  .then(response => response.text())
  .then(result => console.log(result))
  .catch(error => console.log('error', error));

cURL

curl --location 'https://mainnet.carpool.dev/query/solana' \
--header 'x-api-key: <API_KEY>' \
--header 'Content-Type: application/json' \
--data '{
    "type": "SEARCH_ACCOUNTS",
    "query": {
        "programId": "CndyV3LdqHUfDLmE5naZjVN8rBZz4tqhdefbAnjHG3JR",
        "accountName": "CandyMachine",
        "filter": {
            "type": "ACCOUNT_DATA_NUMERIC",
            "path": "data.creators.percentageShare",
            "range": {
                "eq": 100
            }
        }
    }
}'

Example - Advanced

Program - Candy Machine

Description - Return all CandyMachine accounts where the value at data.creators.percentageShare is equal to 100. Include up to 20 objects in the response body, but only include fields: slot, lamports. Filter for accounts that fall in the specified time range.

Javascript

var myHeaders = new Headers();
myHeaders.append("x-api-key", "<API_KEY>");
myHeaders.append("Content-Type", "application/json");

var raw = JSON.stringify({
  "type": "SEARCH_ACCOUNTS",
  "query": {
    "programId": "CndyV3LdqHUfDLmE5naZjVN8rBZz4tqhdefbAnjHG3JR",
    "accountName": "CandyMachine",
    "filter": {
      "type": "ACCOUNT_DATA_NUMERIC",
      "path": "data.creators.percentageShare",
      "range": {
        "eq": 100
      }
    },
    "pagination": {
      "offset": 0,
      "limit": 20
    },
    "sort": {
      "order": "asc"
    },
    "fields": [
      "slot",
      "lamports"
    ],
    "timeRange": {
      "before": "2023-07-17T22:53:09+0000",
      "after": "2023-07-11T22:53:09+0000"
    }
  }
});

var requestOptions = {
  method: 'POST',
  headers: myHeaders,
  body: raw,
  redirect: 'follow'
};

fetch("https://mainnet.carpool.dev/query/solana", requestOptions)
  .then(response => response.text())
  .then(result => console.log(result))
  .catch(error => console.log('error', error));

cURL

curl --location 'https://mainnet.carpool.dev/query/solana' \
--header 'x-api-key: <API_KEY>' \
--header 'Content-Type: application/json' \
--data '{
    "type": "SEARCH_ACCOUNTS",
    "query": {
        "programId": "CndyV3LdqHUfDLmE5naZjVN8rBZz4tqhdefbAnjHG3JR",
        "accountName": "CandyMachine",
        "filter": {
            "type": "ACCOUNT_DATA_NUMERIC",
            "path": "data.creators.percentageShare",
            "range": {
                "eq": 100
            }
        },
        "pagination": {
            "offset": 0,
            "limit": 20
        },
        "sort": {
            "order": "asc"
        },
        "fields": [
            "slot",
            "lamports"
        ],
        "timeRange": {
            "before": "2023-07-17T22:53:09+0000",
            "after": "2023-07-11T22:53:09+0000"
        }
    }
}'