MOST_COMMON_VALUES_ACCOUNT

List the most common account values for the given body parameters

Overview

This method returns the most common account values based on the given data path and 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.

MOST_COMMON_VALUES_ACCOUNT

post

https://mainnet.carpool.devhttps://devnet.carpool.dev

/query/solana

List the most common instruction values for the given body parameters

Header parameters

x-api-keystringRequired

the API key

Body

application/json

typestringRequired

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

Example: MOST_COMMON_VALUES_ACCOUNT

Responses

200

Successful Response

application/json

post

/query/solana

HTTPcURLJavaScriptPython

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

"{\n    \"type\": \"MOST_COMMON_VALUES_ACCOUNT\",\n    \"query\": {\n        \"programId\": \"CndyV3LdqHUfDLmE5naZjVN8rBZz4tqhdefbAnjHG3JR\",\n        \"accountName\": \"CandyMachine\",\n        \"path\": \"data.creators.percentageShare\",\n        \"filter\": {\n            \"type\": \"ACCOUNT_DATA_KEYWORD\",\n            \"path\": \"data.isMutable\",\n            \"value\": \"true\"\n        },\n        \"limit\": 10\n    }\n}"

200

Successful Response

{
    "response": {
        "values": [
            {
                "value": 100,
                "count": 2362
            },
            {
                "value": 50,
                "count": 100
            },
            {
                "value": 10,
                "count": 89
            },
            {
                "value": 30,
                "count": 71
            },
            {
                "value": 0,
                "count": 64
            }
        ]
    }
}

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 the most common account values at the given path data.creators.percentageShare for all CandyMachine accounts. Filter for only mutable accounts.

Javascript

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

var raw = JSON.stringify({
  "type": "MOST_COMMON_VALUES_ACCOUNT",
  "query": {
    "programId": "CndyV3LdqHUfDLmE5naZjVN8rBZz4tqhdefbAnjHG3JR",
    "accountName": "CandyMachine",
    "path": "data.creators.percentageShare",
    "filter": {
      "type": "ACCOUNT_DATA_KEYWORD",
      "path": "data.isMutable",
      "value": "true"
    }
  }
});

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": "MOST_COMMON_VALUES_ACCOUNT",
    "query": {
        "programId": "CndyV3LdqHUfDLmE5naZjVN8rBZz4tqhdefbAnjHG3JR",
        "accountName": "CandyMachine",
        "path": "data.creators.percentageShare",
         "filter": {
            "type": "ACCOUNT_DATA_KEYWORD",
            "path": "data.isMutable",
            "value": "true"
        }
    }
}'

Example - Advanced

Program - Candy Machine

Description - Return the most common account values at the given path data.creators.percentageShare for all CandyMachine accounts. Filter for only mutable accounts. Return up to 10 objects and only look 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": "MOST_COMMON_VALUES_ACCOUNT",
  "query": {
    "programId": "CndyV3LdqHUfDLmE5naZjVN8rBZz4tqhdefbAnjHG3JR",
    "accountName": "CandyMachine",
    "path": "data.creators.percentageShare",
    "filter": {
      "type": "ACCOUNT_DATA_KEYWORD",
      "path": "data.isMutable",
      "value": "true"
    },
    "limit": 10,
    "timeRange": {
      "before": "2023-07-19T22: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": "MOST_COMMON_VALUES_ACCOUNT",
    "query": {
        "programId": "CndyV3LdqHUfDLmE5naZjVN8rBZz4tqhdefbAnjHG3JR",
        "accountName": "CandyMachine",
        "path": "data.creators.percentageShare",
        "filter": {
            "type": "ACCOUNT_DATA_KEYWORD",
            "path": "data.isMutable",
            "value": "true"
        },
        "limit": 10,
        "timeRange": {
            "before": "2023-07-19T22:53:09+0000",
            "after": "2023-07-11T22:53:09+0000"
        }
    }
}'