LIST_INSTRUCTIONS

List Instructions for a program

Overview

This method will return instruction data for a program. Running with only required body params will return all recent instructions and default to 10 objects. Feel free to make use of all non-required body params for more advanced queries. Refer to the Body "Schema" tab for help

LIST_INSTRUCTIONS

post

List instructions for a program

Header parameters

x-api-keystringRequired

the API key

Body

typestringRequired

should be set to 'LIST_INSTRUCTIONS' This is the type of query you want to perform.

Example: LIST_INSTRUCTIONS

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

"{\n  \"type\": \"LIST_INSTRUCTIONS\",\n  \"query\": {\n    \"programId\": \"CYPH3o83JX6jY6NkbproSpdmQ5VWJtxjfJ5P8veyYVu3\",\n    \"instructionName\": \"depositFunds\",\n    \"failures\": false,\n    \"pagination\": {\n      \"offset\": 0,\n      \"limit\": 10\n    },\n    \"sort\": {\n      \"order\": \"desc\"\n    },\n    \"fields\": [],\n    \"timeRange\": {\n      \"before\": \"2023-07-12T22:53:09+0000\",\n      \"after\": \"2023-07-11T22:53:09+0000\"\n    }\n  }\n}"

200

Successful Response

{
  "response": {
    "instructions": [
      {
        "txSignature": "text",
        "slot": 1,
        "args": {},
        "logs": [
          "text"
        ],
        "timestamp": 1,
        "isFailure": true,
        "errorCode": "text",
        "balances": [
          {
            "pubKey": "text",
            "lamports": {
              "pre": 1,
              "post": 1,
              "delta": 1
            },
            "token": {
              "owner": "text",
              "mint": "text",
              "pre": 1,
              "post": 1,
              "delta": 1,
              "decimals": 1
            }
          }
        ],
        "accounts": {
          "subAccount": "text",
          "cacheAccount": "text",
          "pool": "text",
          "poolNode": "text",
          "tokenVault": "text",
          "tokenMint": "text",
          "authority": "text",
          "masterAccount": "text",
          "tokenProgram": "text",
          "clearing": "text",
          "sourceTokenAccount": "text"
        },
        "programId": "text",
        "instructionName": "text",
        "txIndex": 1
      }
    ]
  },
  "warning": [
    "text"
  ]
}

Example - Basic

Program - Cypher Protocol

Description - Return recent instructions

Javascript

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

var raw = JSON.stringify({
  "type": "LIST_INSTRUCTIONS",
  "query": {
    "programId": "CYPH3o83JX6jY6NkbproSpdmQ5VWJtxjfJ5P8veyYVu3"
  }
});

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": "LIST_INSTRUCTIONS",
    "query": {
        "programId": "CYPH3o83JX6jY6NkbproSpdmQ5VWJtxjfJ5P8veyYVu3"
    }
}'

Example - Advanced

Program - Cypher Protocol

Description - Return up to 10 depositFunds instructions within a 24 hr period. Do not include failed transactions, return all fields in the response body

Javascript

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

var raw = JSON.stringify({
  "type": "LIST_INSTRUCTIONS",
  "query": {
    "programId": "CYPH3o83JX6jY6NkbproSpdmQ5VWJtxjfJ5P8veyYVu3",
    "instructionName": "depositFunds",
    "timeRange": {
      "before": "2023-07-12T22:53:09+0000",
      "after": "2023-07-11T22:53:09+0000"
    },
    "failures": false,
    "fields": [],
    "sort": {
      "order": "desc"
    },
    "pagination": {
      "limit": 10,
      "offset": 0
    }
  }
});

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": "LIST_INSTRUCTIONS",
    "query": {
        "programId": "CYPH3o83JX6jY6NkbproSpdmQ5VWJtxjfJ5P8veyYVu3",
        "instructionName": "depositFunds",
        "timeRange": {
            "before": "2023-07-12T22:53:09+0000",
            "after": "2023-07-11T22:53:09+0000"
        },
        "failures": false,
        "fields": [],
        "sort": {
            "order": "desc"
        },
        "pagination": {
            "limit": 10,
            "offset": 0
        }
    }
}'