Carpool
WebsiteTwitter
  • 👋Welcome
    • 🚘What is Carpool?
    • ☕Getting Started
  • 📘Guides
    • 🔖Onboarding Programs
    • ❓Querying
    • 🚨Alerting
    • 📖Organization Management
  • ⚙️API Reference
    • 📚About our Query API
    • 📝Instructions
      • LIST_INSTRUCTIONS
      • GET_INSTRUCTION
      • GET_INSTRUCTIONS_IN_TRANSACTION
      • GET_INSTRUCTIONS_INVOLVING_ACCOUNT
      • SEARCH_INSTRUCTION_LOGS
      • SEARCH_INSTRUCTIONS
      • COUNT_INSTRUCTIONS
      • FIELD_STATISTIC_INSTRUCTION
      • MOST_COMMON_VALUES_INSTRUCTION
      • MOST_COMMON_ACCOUNTS_INSTRUCTION
    • 🗄️Accounts
      • LIST_ACCOUNTS
      • GET_ACCOUNT
      • GET_ACCOUNTS_WITH_LAMPORTS
      • SEARCH_ACCOUNTS
      • COUNT_ACCOUNTS
      • FIELD_STATISTIC_ACCOUNT
      • MOST_COMMON_VALUES_ACCOUNT
    • ⏳Account Archive
      • GET_ACCOUNT_SNAPSHOT
      • GET_ACCOUNT_SNAPSHOT_AT_SLOT
      • LIST_ACCOUNT_SNAPSHOTS
    • 🗃️Filters
      • 👓Instruction Filters
      • 🎛️Account Filters
  • ❔Resources
    • 🔗Links
    • 📄Blog Posts
Powered by GitBook
On this page
  1. API Reference
  2. Accounts

COUNT_ACCOUNTS

Aggregate and count accounts with a powerful filter built on top of Elasticsearch

PreviousSEARCH_ACCOUNTSNextFIELD_STATISTIC_ACCOUNT

Last updated 1 year ago

Overview

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

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.

Example - Basic

Program - Candy Machine

Description - Count 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": "COUNT_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": "COUNT_ACCOUNTS",
    "query": {
        "programId": "CndyV3LdqHUfDLmE5naZjVN8rBZz4tqhdefbAnjHG3JR",
        "accountName": "CandyMachine",
        "filter": {
            "type": "ACCOUNT_DATA_NUMERIC",
            "path": "data.creators.percentageShare",
            "range": {
                "eq": 100
            }
        }
    }
}'

Example - Advanced

Program - Candy Machine

Description - Count all CandyMachine accounts where the value at data.creators.percentageShare is equal to 100. Only include accounts within the specified time range for the final count.

Javascript

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

var raw = JSON.stringify({
  "type": "COUNT_ACCOUNTS",
  "query": {
    "programId": "CndyV3LdqHUfDLmE5naZjVN8rBZz4tqhdefbAnjHG3JR",
    "accountName": "CandyMachine",
    "filter": {
      "type": "ACCOUNT_DATA_NUMERIC",
      "path": "data.creators.percentageShare",
      "range": {
        "eq": 100
      },
      "timeRange": {
        "before": "2023-07-12T22: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": "COUNT_ACCOUNTS",
    "query": {
        "programId": "CndyV3LdqHUfDLmE5naZjVN8rBZz4tqhdefbAnjHG3JR",
        "accountName": "CandyMachine",
        "filter": {
            "type": "ACCOUNT_DATA_NUMERIC",
            "path": "data.creators.percentageShare",
            "range": {
                "eq": 100
            },
            "timeRange": {
                "before": "2023-07-12T22:53:09+0000",
                "after": "2023-07-11T22:53:09+0000"
            }
        }
    }
}'
⚙️
🗄️
🎛️Account Filters
Filters
  • Overview
  • POSTCOUNT_ACCOUNTS
  • Filters
  • Example - Basic
  • Example - Advanced

COUNT_ACCOUNTS

post

Aggregate and count accounts with a powerful filter built on top of Elasticsearch

Header parameters
x-api-keystringRequired

the API key

Body
typestringRequired

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

Example: COUNT_ACCOUNTS
Responses
200
Successful Response
application/json
post
POST /query/solana HTTP/1.1
Host: mainnet.carpool.dev
x-api-key: text
Content-Type: application/json
Accept: */*
Content-Length: 395

"{\n    \"type\": \"COUNT_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": {
    "value": 2456
  }
}