MOST_COMMON_VALUES_INSTRUCTION

List the most common instruction values for the given body parameters

Overview

This method returns the most common instruction values based on the given argument path and an optional 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.

MOST_COMMON_VALUES_INSTRUCTION

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_INSTRUCTION' This is the type of query you want to perform.

Example: MOST_COMMON_VALUES_INSTRUCTION

Responses

200

Successful Response

application/json; charset=utf-8

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: 363

"{\n    \"type\": \"MOST_COMMON_VALUES_INSTRUCTION\",\n    \"query\": {\n        \"programId\": \"CndyV3LdqHUfDLmE5naZjVN8rBZz4tqhdefbAnjHG3JR\",\n        \"path\": \"data.creators.percentageShare\",\n        \"limit\": \"\",\n        \"timeRange\": {\n            \"before\": \"\",\n            \"after\": \"\"\n        },\n        \"failures\": false\n    }\n}"

200

Successful Response

{
  "response": {
    "values": [
      {
        "value": 1,
        "count": 1
      }
    ]
  }
}

Filters

As mentioned above, the api definition here implements an optional filter object. All queries that accept a filter object in the POST body can make use of any of the potential filters. Please see the Instruction Filters section of the documentation to better understand how they are implemented for instruction queries.

👓Instruction Filters

Example - Basic

Program - Candy Machine

Description - Return the most common values for argument data.creators.percentageShare. Default to 5 returned values.

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_INSTRUCTION",
  "query": {
    "programId": "CndyV3LdqHUfDLmE5naZjVN8rBZz4tqhdefbAnjHG3JR",
    "path": "data.creators.percentageShare"
  }
});

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_INSTRUCTION",
    "query": {
        "programId": "CndyV3LdqHUfDLmE5naZjVN8rBZz4tqhdefbAnjHG3JR",
        "path": "data.creators.percentageShare"
    }
}'

Example - Advanced

Program - Candy Machine

Description - Return the 10 most common values for argument data.creators.percentageShare. Filter for only instructions that have "metaqbxxUerdq28cj1RbAWkYQm3ybzjb6a8bt518x1s" within their logs and they must be in the set 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_INSTRUCTION",
  "query": {
    "programId": "CndyV3LdqHUfDLmE5naZjVN8rBZz4tqhdefbAnjHG3JR",
    "path": "data.creators.percentageShare",
    "limit": "10",
    "filter": {
      "type": "INSTRUCTION_LOGS",
      "searchText": "metaqbxxUerdq28cj1RbAWkYQm3ybzjb6a8bt518x1s"
    },
    "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": "MOST_COMMON_VALUES_INSTRUCTION",
    "query": {
        "programId": "CndyV3LdqHUfDLmE5naZjVN8rBZz4tqhdefbAnjHG3JR",
        "path": "data.creators.percentageShare",
        "limit": "10",
        "filter": {
            "type": "INSTRUCTION_LOGS",
            "searchText": "metaqbxxUerdq28cj1RbAWkYQm3ybzjb6a8bt518x1s"
        },
        "timeRange": {
            "before": "2023-07-17T22:53:09+0000",
            "after": "2023-07-11T22:53:09+0000"
        }
    }
}'