LIST_ACCOUNTS

List accounts for a program

Overview

This method will return account 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_ACCOUNTS

post

List accounts for a given programId

Header parameters

x-api-keystringRequired

the API key

Body

typestringRequired

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

Example: LIST_ACCOUNTS

Responses

200

Successful Response

application/json; charset=utf-8

post

HTTPcURLJavaScriptPython

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

"{\n    \"type\": \"LIST_ACCOUNTS\",\n    \"query\": {\n        \"programId\": \"CYPH3o83JX6jY6NkbproSpdmQ5VWJtxjfJ5P8veyYVu3\",\n        \"accountName\": \"CypherAccount\"\n    }\n}"

200

Successful Response

{
  "response": {
    "accounts": [
      {
        "slot": 204624060,
        "lamports": 1000000000,
        "writeVersion": 1234,
        "data": {
          "authority": "234itWGBdtFT2VaPzoV8de9kGcDVCK33T9TNgVFmnpXN",
          "wallet": "walletPubKey",
          "tokenMint": "So11111111111111111111111111111111111111112",
          "itemsRedeemed": "5",
          "data": {
            "uuid": "a4ec9d44-9c65-4eb7-80e8-6b7cb31a7ae0",
            "price": "1.23",
            "symbol": "USD",
            "sellerFeeBasisPoints": 500,
            "maxSupply": "10000",
            "isMutable": true,
            "retainAuthority": false,
            "goLiveDate": "2023-07-25T12:00:00Z",
            "endSettings": {
              "field": "value"
            },
            "creators": [
              "[{\"address\":\"creatorPubKey\",\"verified\":true,\"share\":10}]"
            ],
            "hiddenSettings": {
              "field": "value"
            },
            "whitelistMintSettings": {
              "mode": {
                "burnEveryTime": {
                  "field": "value"
                }
              }
            },
            "itemsAvailable": "100",
            "gatekeeper": "gatekeeperPubKey"
          }
        },
        "pubKey": "accountPubKey",
        "programId": "programIdPubKey"
      }
    ]
  }
}

Example - Basic

Program - Candy Machine

Description - Return recent accounts

Javascript

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

var raw = JSON.stringify({
  "type": "LIST_ACCOUNTS",
  "query": {
    "programId": "cndy3Z4yapfJBmL3ShUp5exZKqR3z33thTzeNMm2gRZ",
    "accountName": "CandyMachine"
  }
});

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

Example - Advanced

Program - Cypher Protocol

Description - Return recent accounts within the specific time range. Only include the following fields in the response body: slot, lamports, data.

Javascript

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

var raw = JSON.stringify({
  "type": "LIST_ACCOUNTS",
  "query": {
    "programId": "CYPH3o83JX6jY6NkbproSpdmQ5VWJtxjfJ5P8veyYVu3",
    "accountName": "CypherAccount",
    "pagination": {
      "offset": 0,
      "limit": 10
    },
    "sort": {
      "order": "desc"
    },
    "fields": [
      "slot",
      "lamports",
      "data"
    ],
    "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": "LIST_ACCOUNTS",
    "query": {
        "programId": "CYPH3o83JX6jY6NkbproSpdmQ5VWJtxjfJ5P8veyYVu3",
        "accountName": "CypherAccount",
        "pagination": {
            "offset": 0,
            "limit": 10
        },
        "sort": {
            "order": "desc"
        },
        "fields": ["slot", "lamports", "data"],
        "timeRange": {
            "before": "2023-07-12T22:53:09+0000",
            "after": "2023-07-11T22:53:09+0000"
        }
    }
}'