All pages
Powered by GitBook
1 of 24

Photon RPC Endpoints

getCompressedAccount

Returns the compressed account with the given address or hash.

post
Body
idstring · enumrequired

An ID to identify the request.

Options: test-account
jsonrpcstring · enumrequired

The version of the JSON-RPC protocol.

Options: 2.0
methodstring · enumrequired

The name of the method to invoke.

Options: getCompressedAccount
paramsobject · default: {"address":null,"hash":"11111111111111111111111111111111"}required

Request for compressed account data

Example: {"address":null,"hash":"11111112cMQwSC9qirWGjZM6gLGwW69X22mqwLLGP"}

Responses
curl -L \
  --request POST \
  --url 'https://mainnet.helius-rpc.com/?api-key=<api_key>' \
  --header 'Content-Type: application/json' \
  --data '{
    "id": "test-account",
    "jsonrpc": "2.0",
    "method": "getCompressedAccount",
    "params": {
      "address": null,
      "hash": "11111112cMQwSC9qirWGjZM6gLGwW69X22mqwLLGP"
    }
  }'
{
  "context": {
    "slot": 100
  },
  "value": {
    "address": "11111112D1oxKts8YPdTJRG5FzxTNpMtWmq8hkVx3",
    "data": {
      "data": "SGVsbG8sIFdvcmxkIQ==",
      "dataHash": "11111112cMQwSC9qirWGjZM6gLGwW69X22mqwLLGP",
      "discriminator": 100
    },
    "hash": "11111112cMQwSC9qirWGjZM6gLGwW69X22mqwLLGP",
    "lamports": 100,
    "leafIndex": 100,
    "owner": "11111112D1oxKts8YPdTJRG5FzxTNpMtWmq8hkVx3",
    "seq": 100,
    "slotCreated": 100,
    "tree": "11111112D1oxKts8YPdTJRG5FzxTNpMtWmq8hkVx3"
  }
}

getCompressedAccountBalance

Returns the balance for the compressed account with the given address or hash.

post
Body
idstring · enumrequired

An ID to identify the request.

Options: test-account
jsonrpcstring · enumrequired

The version of the JSON-RPC protocol.

Options: 2.0
methodstring · enumrequired

The name of the method to invoke.

Options: getCompressedAccountBalance
paramsobject · default: {"address":null,"hash":"11111111111111111111111111111111"}required

Request for compressed account data

Example: {"address":null,"hash":"11111111111111111111111111111111"}

Responses
curl -L \
  --request POST \
  --url 'https://mainnet.helius-rpc.com/?api-key=<api_key>' \
  --header 'Content-Type: application/json' \
  --data '{
    "id": "test-account",
    "jsonrpc": "2.0",
    "method": "getCompressedAccountBalance",
    "params": {
      "address": null,
      "hash": "11111111111111111111111111111111"
    }
  }'
{
  "context": {
    "slot": 100
  },
  "value": 100
}

getCompressedTokenAccountBalance

Returns the balance for a given token account.

post
Body
idstring · enumrequired

An ID to identify the request.

Options: test-account
jsonrpcstring · enumrequired

The version of the JSON-RPC protocol.

Options: 2.0
methodstring · enumrequired

The name of the method to invoke.

Options: getCompressedTokenAccountBalance
paramsobject · default: {"address":null,"hash":"11111111111111111111111111111111"}required

Request for compressed account data

Example: {"address":null,"hash":"11111111111111111111111111111111"}

Responses
curl -L \
  --request POST \
  --url 'https://mainnet.helius-rpc.com/?api-key=<api_key>' \
  --header 'Content-Type: application/json' \
  --data '{
    "id": "test-account",
    "jsonrpc": "2.0",
    "method": "getCompressedTokenAccountBalance",
    "params": {
      "address": null,
      "hash": "11111111111111111111111111111111"
    }
  }'
{
  "context": {
    "slot": 100
  },
  "value": {
    "amount": 100
  }
}

getCompressedBalanceByOwner

Returns the total balance of the owner's compressed accounts.

post
Body
idstring · enumrequired

An ID to identify the request.

Options: test-account
jsonrpcstring · enumrequired

The version of the JSON-RPC protocol.

Options: 2.0
methodstring · enumrequired

The name of the method to invoke.

Options: getCompressedBalanceByOwner
paramsobjectrequired

Responses
curl -L \
  --request POST \
  --url 'https://mainnet.helius-rpc.com/?api-key=<api_key>' \
  --header 'Content-Type: application/json' \
  --data '{
    "id": "test-account",
    "jsonrpc": "2.0",
    "method": "getCompressedBalanceByOwner",
    "params": {
      "owner": "11111114d3RrygbPdAtMuFnDmzsN8T5fYKVQ7FVr7"
    }
  }'
{
  "context": {
    "slot": 100
  },
  "value": 100
}

getCompressedTokenBalancesByOwnerV2

Returns the token balances for a given owner. This is a paginated endpoint. The V2 version fixes a minor naming issue.

post
Body
idstring · enumrequired

An ID to identify the request.

Options: test-account
jsonrpcstring · enumrequired

The version of the JSON-RPC protocol.

Options: 2.0
methodstring · enumrequired

The name of the method to invoke.

Options: getCompressedTokenBalancesByOwnerV2
paramsobjectrequired

Responses
curl -L \
  --request POST \
  --url 'https://mainnet.helius-rpc.com?api-key=<api_key>/' \
  --header 'Content-Type: application/json' \
  --data '{
    "id": "test-account",
    "jsonrpc": "2.0",
    "method": "getCompressedTokenBalancesByOwnerV2",
    "params": {
      "cursor": "3J98t1WpEZ73CNm",
      "limit": 1,
      "mint": "11111114DhpssPJgSi1YU7hCMfYt1BJ334YgsffXm",
      "owner": "11111114DhpssPJgSi1YU7hCMfYt1BJ334YgsffXm"
    }
  }'
{
  "context": {
    "slot": 100
  },
  "value": {
    "cursor": "3J98t1WpEZ73CNm",
    "items": [
      {
        "balance": 100,
        "mint": "11111114DhpssPJgSi1YU7hCMfYt1BJ334YgsffXm"
      }
    ]
  }
}

getCompressedAccountsByOwner

Returns the owner's compressed accounts. This is a paginated endpoint.

post
Body
idstring · enumrequired

An ID to identify the request.

Options: test-account
jsonrpcstring · enumrequired

The version of the JSON-RPC protocol.

Options: 2.0
methodstring · enumrequired

The name of the method to invoke.

Options: getCompressedAccountsByOwner
paramsobjectrequired

Responses
curl -L \
  --request POST \
  --url 'https://mainnet.helius-rpc.com/?api-key=<api_key>' \
  --header 'Content-Type: application/json' \
  --data '{
    "id": "test-account",
    "jsonrpc": "2.0",
    "method": "getCompressedAccountsByOwner",
    "params": {
      "cursor": "11111116djSnXB2wXVGT4xDLsfTnkp1p4cCxHAfRq",
      "dataSlice": {
        "length": 1,
        "offset": 1
      },
      "filters": [
        {
          "memcmp": {
            "bytes": "3J98t1WpEZ73CNm",
            "offset": 1
          }
        }
      ],
      "limit": 1,
      "owner": "11111116EPqoQskEM2Pddp8KTL9JdYEBZMGF3aq7V"
    }
  }'
{
  "context": {
    "slot": 100
  },
  "value": {
    "cursor": "11111116djSnXB2wXVGT4xDLsfTnkp1p4cCxHAfRq",
    "items": [
      {
        "address": "11111116EPqoQskEM2Pddp8KTL9JdYEBZMGF3aq7V",
        "data": {
          "data": "SGVsbG8sIFdvcmxkIQ==",
          "dataHash": "11111116djSnXB2wXVGT4xDLsfTnkp1p4cCxHAfRq",
          "discriminator": 100
        },
        "hash": "11111116djSnXB2wXVGT4xDLsfTnkp1p4cCxHAfRq",
        "lamports": 100,
        "leafIndex": 100,
        "owner": "11111116EPqoQskEM2Pddp8KTL9JdYEBZMGF3aq7V",
        "seq": 100,
        "slotCreated": 100,
        "tree": "11111116EPqoQskEM2Pddp8KTL9JdYEBZMGF3aq7V"
      }
    ]
  }
}

getMultipleCompressedAccounts

Returns multiple compressed accounts with the given addresses or hashes.

post
Body
idstring · enumrequired

An ID to identify the request.

Options: test-account
jsonrpcstring · enumrequired

The version of the JSON-RPC protocol.

Options: 2.0
methodstring · enumrequired

The name of the method to invoke.

Options: getMultipleCompressedAccounts
paramsobject · default: {"addresses":null,"hashes":["1111111QLbz7JHiBTspS962RLKV8GndWFwiEaqKM","1111111ogCyDbaRMvkdsHB3qfdyFYaG1WtRUAfdh"]}required

Request for compressed account data

Example: {"addresses":null,"hashes":["1111111QLbz7JHiBTspS962RLKV8GndWFwiEaqKM","1111111ogCyDbaRMvkdsHB3qfdyFYaG1WtRUAfdh"]}

Responses
curl -L \
  --request POST \
  --url 'https://mainnet.helius-rpc.com/?api-key=<api_key>' \
  --header 'Content-Type: application/json' \
  --data '{
    "id": "test-account",
    "jsonrpc": "2.0",
    "method": "getMultipleCompressedAccounts",
    "params": {
      "addresses": null,
      "hashes": [
        "1111111QLbz7JHiBTspS962RLKV8GndWFwiEaqKM",
        "1111111ogCyDbaRMvkdsHB3qfdyFYaG1WtRUAfdh"
      ]
    }
  }'
{
  "context": {
    "slot": 100
  },
  "value": {
    "items": [
      {
        "address": "11111117353mdUKehx9GW6JNHznGt5oSZs9fWkVkB",
        "data": {
          "data": "SGVsbG8sIFdvcmxkIQ==",
          "dataHash": "11111117SQekjmcMtR25wEPPiL6m1Mb5586NkLL4X",
          "discriminator": 100
        },
        "hash": "11111117SQekjmcMtR25wEPPiL6m1Mb5586NkLL4X",
        "lamports": 100,
        "leafIndex": 100,
        "owner": "11111117353mdUKehx9GW6JNHznGt5oSZs9fWkVkB",
        "seq": 100,
        "slotCreated": 100,
        "tree": "11111117353mdUKehx9GW6JNHznGt5oSZs9fWkVkB"
      }
    ]
  }
}

getCompressedTokenAccountsByOwner

Returns the compressed token accounts owned by a certain account.

post
Body
idstring · enumrequired

An ID to identify the request.

Options: test-account
jsonrpcstring · enumrequired

The version of the JSON-RPC protocol.

Options: 2.0
methodstring · enumrequired

The name of the method to invoke.

Options: getCompressedTokenAccountsByOwner
paramsobjectrequired

Responses
curl -L \
  --request POST \
  --url 'https://mainnet.helius-rpc.com/?api-key=<api_key>' \
  --header 'Content-Type: application/json' \
  --data '{
    "id": "test-account",
    "jsonrpc": "2.0",
    "method": "getCompressedTokenAccountsByOwner",
    "params": {
      "cursor": "3J98t1WpEZ73CNm",
      "limit": 1,
      "mint": "11111117qkFjr4u54stuNNUR8fRF8dNhaP35yvANs",
      "owner": "11111117qkFjr4u54stuNNUR8fRF8dNhaP35yvANs"
    }
  }'
{
  "context": {
    "slot": 100
  },
  "value": {
    "cursor": "3J98t1WpEZ73CNm",
    "items": [
      {
        "account": {
          "address": "11111117qkFjr4u54stuNNUR8fRF8dNhaP35yvANs",
          "data": {
            "data": "SGVsbG8sIFdvcmxkIQ==",
            "dataHash": "11111118F5rixNBnFLmioWZSYzjjFuAL5dyoDVzhD",
            "discriminator": 100
          },
          "hash": "11111118F5rixNBnFLmioWZSYzjjFuAL5dyoDVzhD",
          "lamports": 100,
          "leafIndex": 100,
          "owner": "11111117qkFjr4u54stuNNUR8fRF8dNhaP35yvANs",
          "seq": 100,
          "slotCreated": 100,
          "tree": "11111117qkFjr4u54stuNNUR8fRF8dNhaP35yvANs"
        },
        "tokenData": {
          "amount": 100,
          "delegate": "11111117qkFjr4u54stuNNUR8fRF8dNhaP35yvANs",
          "mint": "11111117qkFjr4u54stuNNUR8fRF8dNhaP35yvANs",
          "owner": "11111117qkFjr4u54stuNNUR8fRF8dNhaP35yvANs",
          "state": "initialized",
          "tlv": "SGVsbG8sIFdvcmxkIQ=="
        }
      }
    ]
  }
}

getCompressedTokenAccountsByDelegate

Returns the compressed token accounts that are partially or fully delegated to the given delegate. This is a paginated endpoint.

post
Body
idstring · enumrequired

An ID to identify the request.

Options: test-account
jsonrpcstring · enumrequired

The version of the JSON-RPC protocol.

Options: 2.0
methodstring · enumrequired

The name of the method to invoke.

Options: getCompressedTokenAccountsByDelegate
paramsobjectrequired

Responses
curl -L \
  --request POST \
  --url 'https://mainnet.helius-rpc.com/?api-key=<api_key>' \
  --header 'Content-Type: application/json' \
  --data '{
    "id": "test-account",
    "jsonrpc": "2.0",
    "method": "getCompressedTokenAccountsByDelegate",
    "params": {
      "cursor": "3J98t1WpEZ73CNm",
      "delegate": "11111118eRTi4fUVRoeYEeeTyL4DPAwxatvWT5q1Z",
      "limit": 1,
      "mint": "11111118eRTi4fUVRoeYEeeTyL4DPAwxatvWT5q1Z"
    }
  }'
{
  "context": {
    "slot": 100
  },
  "value": {
    "cursor": "3J98t1WpEZ73CNm",
    "items": [
      {
        "account": {
          "address": "11111118eRTi4fUVRoeYEeeTyL4DPAwxatvWT5q1Z",
          "data": {
            "data": "SGVsbG8sIFdvcmxkIQ==",
            "dataHash": "111111193m4hAxmCcGXMfnjVPfNhWSjb69sDgffKu",
            "discriminator": 100
          },
          "hash": "111111193m4hAxmCcGXMfnjVPfNhWSjb69sDgffKu",
          "lamports": 100,
          "leafIndex": 100,
          "owner": "11111118eRTi4fUVRoeYEeeTyL4DPAwxatvWT5q1Z",
          "seq": 100,
          "slotCreated": 100,
          "tree": "11111118eRTi4fUVRoeYEeeTyL4DPAwxatvWT5q1Z"
        },
        "tokenData": {
          "amount": 100,
          "delegate": "11111118eRTi4fUVRoeYEeeTyL4DPAwxatvWT5q1Z",
          "mint": "11111118eRTi4fUVRoeYEeeTyL4DPAwxatvWT5q1Z",
          "owner": "11111118eRTi4fUVRoeYEeeTyL4DPAwxatvWT5q1Z",
          "state": "initialized",
          "tlv": "SGVsbG8sIFdvcmxkIQ=="
        }
      }
    ]
  }
}

getTransactionWithCompressionInfo

Returns the transaction data for the transaction with the given signature along with parsed compression info.

post
Body
idstring · enumrequired

An ID to identify the request.

Options: test-account
jsonrpcstring · enumrequired

The version of the JSON-RPC protocol.

Options: 2.0
methodstring · enumrequired

The name of the method to invoke.

Options: getTransactionWithCompressionInfo
paramsobjectrequired

Responses
curl -L \
  --request POST \
  --url 'https://mainnet.helius-rpc.com/?api-key=<api_key>' \
  --header 'Content-Type: application/json' \
  --data '{
    "id": "test-account",
    "jsonrpc": "2.0",
    "method": "getTransactionWithCompressionInfo",
    "params": {
      "signature": "5J8H5sTvEhnGcB4R8K1n7mfoiWUD9RzPVGES7e3WxC7c"
    }
  }'
{
  "compression_info": {
    "closedAccounts": [
      {
        "account": {
          "address": "11111119T6fgHG3unjQB6vpWozhBdiXDbQovvFVeF",
          "data": {
            "data": "SGVsbG8sIFdvcmxkIQ==",
            "dataHash": "11111119rSGfPZLcyCGzY4uYEL1fkzJr6fke9qKxb",
            "discriminator": 100
          },
          "hash": "11111119rSGfPZLcyCGzY4uYEL1fkzJr6fke9qKxb",
          "lamports": 100,
          "leafIndex": 100,
          "owner": "11111119T6fgHG3unjQB6vpWozhBdiXDbQovvFVeF",
          "seq": 100,
          "slotCreated": 100,
          "tree": "11111119T6fgHG3unjQB6vpWozhBdiXDbQovvFVeF"
        },
        "optionalTokenData": {
          "amount": 100,
          "delegate": "11111119T6fgHG3unjQB6vpWozhBdiXDbQovvFVeF",
          "mint": "11111119T6fgHG3unjQB6vpWozhBdiXDbQovvFVeF",
          "owner": "11111119T6fgHG3unjQB6vpWozhBdiXDbQovvFVeF",
          "state": "initialized",
          "tlv": "SGVsbG8sIFdvcmxkIQ=="
        }
      }
    ],
    "openedAccounts": [
      {
        "account": {
          "address": "11111119T6fgHG3unjQB6vpWozhBdiXDbQovvFVeF",
          "data": {
            "data": "SGVsbG8sIFdvcmxkIQ==",
            "dataHash": "11111119rSGfPZLcyCGzY4uYEL1fkzJr6fke9qKxb",
            "discriminator": 100
          },
          "hash": "11111119rSGfPZLcyCGzY4uYEL1fkzJr6fke9qKxb",
          "lamports": 100,
          "leafIndex": 100,
          "owner": "11111119T6fgHG3unjQB6vpWozhBdiXDbQovvFVeF",
          "seq": 100,
          "slotCreated": 100,
          "tree": "11111119T6fgHG3unjQB6vpWozhBdiXDbQovvFVeF"
        },
        "optionalTokenData": {
          "amount": 100,
          "delegate": "11111119T6fgHG3unjQB6vpWozhBdiXDbQovvFVeF",
          "mint": "11111119T6fgHG3unjQB6vpWozhBdiXDbQovvFVeF",
          "owner": "11111119T6fgHG3unjQB6vpWozhBdiXDbQovvFVeF",
          "state": "initialized",
          "tlv": "SGVsbG8sIFdvcmxkIQ=="
        }
      }
    ]
  },
  "transaction": {}
}

getCompressedAccountProof

Returns a proof the compression program uses to verify that the account is valid.

post
Body
idstring · enumrequired

An ID to identify the request.

Options: test-account
jsonrpcstring · enumrequired

The version of the JSON-RPC protocol.

Options: 2.0
methodstring · enumrequired

The name of the method to invoke.

Options: getCompressedAccountProof
paramsobjectrequired

Responses
curl -L \
  --request POST \
  --url 'https://mainnet.helius-rpc.com/?api-key=<api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
    "id": "test-account",
    "jsonrpc": "2.0",
    "method": "getCompressedAccountProof",
    "params": {
      "hash": "1111111Af7Udc9v3L82dQM5b4zee1Xt77Be4czzbH"
    }
  }'
{
  "context": {
    "slot": 100
  },
  "value": {
    "hash": "1111111Af7Udc9v3L82dQM5b4zee1Xt77Be4czzbH",
    "leafIndex": 1,
    "merkleTree": "1111111AFmseVrdL9f9oyCzZefL9tG6UbvhMPRAGw",
    "proof": [
      "1111111Af7Udc9v3L82dQM5b4zee1Xt77Be4czzbH"
    ],
    "root": "1111111Af7Udc9v3L82dQM5b4zee1Xt77Be4czzbH",
    "rootSeq": 1
  }
}

getMultipleCompressedAccountProofs

Returns multiple proofs used by the compression program to verify the accounts' validity.

post
Body
idstring · enumrequired

An ID to identify the request.

Options: test-account
jsonrpcstring · enumrequired

The version of the JSON-RPC protocol.

Options: 2.0
methodstring · enumrequired

The name of the method to invoke.

Options: getMultipleCompressedAccountProofs
paramsstring[]required

A 32-byte hash represented as a base58 string.

Example: 1111111BTngbpkVTh3nGGdFdufHcG5TN7hXV6AfDy
Responses
curl -L \
  --request POST \
  --url 'https://mainnet.helius-rpc.com/?api-key=<api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
    "id": "test-account",
    "jsonrpc": "2.0",
    "method": "getMultipleCompressedAccountProofs",
    "params": [
      "1111111BTngbpkVTh3nGGdFdufHcG5TN7hXV6AfDy"
    ]
  }'
{
  "context": {
    "slot": 100
  },
  "value": [
    {
      "hash": "1111111BTngbpkVTh3nGGdFdufHcG5TN7hXV6AfDy",
      "leafIndex": 1,
      "merkleTree": "1111111B4T5ciTCkWauSqVAcVKy88ofjcSamrapud",
      "proof": [
        "1111111BTngbpkVTh3nGGdFdufHcG5TN7hXV6AfDy"
      ],
      "root": "1111111BTngbpkVTh3nGGdFdufHcG5TN7hXV6AfDy",
      "rootSeq": 1
    }
  ]
}

getMultipleNewAddressProofs

Returns proofs that the new addresses are not taken already and can be created.

post
Body
idstring · enumrequired

An ID to identify the request.

Options: test-account
jsonrpcstring · enumrequired

The version of the JSON-RPC protocol.

Options: 2.0
methodstring · enumrequired

The name of the method to invoke.

Options: getMultipleNewAddressProofsV2
paramsobject[]required

Responses
curl -L \
  --request POST \
  --url 'https://mainnet.helius-rpc.com/?api-key=<api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
    "id": "test-account",
    "jsonrpc": "2.0",
    "method": "getMultipleNewAddressProofsV2",
    "params": [
      {
        "address": "1111111CfoVZ9eMbESQia3WiAfF4dtpFdUMcnvAB1",
        "tree": "1111111CfoVZ9eMbESQia3WiAfF4dtpFdUMcnvAB1"
      }
    ]
  }'
{
  "context": {
    "slot": 100
  },
  "value": [
    {
      "address": "1111111CfoVZ9eMbESQia3WiAfF4dtpFdUMcnvAB1",
      "higherRangeAddress": "1111111CfoVZ9eMbESQia3WiAfF4dtpFdUMcnvAB1",
      "lowElementLeafIndex": 1,
      "lowerRangeAddress": "1111111CfoVZ9eMbESQia3WiAfF4dtpFdUMcnvAB1",
      "merkleTree": "1111111CfoVZ9eMbESQia3WiAfF4dtpFdUMcnvAB1",
      "nextIndex": 1,
      "proof": [
        "1111111D596YFweJQuHY1BbjazZYmAbt8jJL2VzVM"
      ],
      "root": "1111111D596YFweJQuHY1BbjazZYmAbt8jJL2VzVM",
      "rootSeq": 1
    }
  ]
}

getValidityProof

Returns a single ZK Proof used by the compression program to verify that the given accounts are valid and that the new addresses can be created.

The newAddresses param field is supported but deprecated. Please use newAddressesWithTreesinstead.

post
Body
idstring · enumrequired

An ID to identify the request.

Options: test-account
jsonrpcstring · enumrequired

The version of the JSON-RPC protocol.

Options: 2.0
methodstring · enumrequired

The name of the method to invoke.

Options: getValidityProof
paramsobjectrequired

Responses
curl -L \
  --request POST \
  --url 'https://mainnet.helius-rpc.com/?api-key=<api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
    "id": "test-account",
    "jsonrpc": "2.0",
    "method": "getValidityProof",
    "params": {
      "hashes": [
        "1111111DspJWUYDimq3AsTmnRfCX1iB99FBkVff83"
      ],
      "newAddresses": [
        "1111111DUUhXNEw1bNAMSKgm1Kt2tSPWdzF3G5poh"
      ],
      "newAddressesWithTrees": [
        {
          "address": "1111111DUUhXNEw1bNAMSKgm1Kt2tSPWdzF3G5poh",
          "tree": "1111111DUUhXNEw1bNAMSKgm1Kt2tSPWdzF3G5poh"
        }
      ]
    }
  }'
{
  "context": {
    "slot": 100
  },
  "value": {
    "compressedProof": {
      "a": "binary",
      "b": "binary",
      "c": "binary"
    },
    "leafIndices": [
      1
    ],
    "leaves": [
      "text"
    ],
    "merkleTrees": [
      "text"
    ],
    "rootIndices": [
      1
    ],
    "roots": [
      "text"
    ]
  }
}

getCompressionSignaturesForAccount

Return the signatures of the transactions that closed or opened a compressed account with the given hash. This is a paginated endpoint.

post
Body
idstring · enumrequired

An ID to identify the request.

Options: test-account
jsonrpcstring · enumrequired

The version of the JSON-RPC protocol.

Options: 2.0
methodstring · enumrequired

The name of the method to invoke.

Options: getCompressionSignaturesForAccount
paramsobjectrequired

Responses
curl -L \
  --request POST \
  --url 'https://mainnet.helius-rpc.com/?api-key=<api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
    "id": "test-account",
    "jsonrpc": "2.0",
    "method": "getCompressionSignaturesForAccount",
    "params": {
      "hash": "1111111EgVWUh8o98knojjwqGKqVGFkQ9m5AxqKkj"
    }
  }'
{
  "context": {
    "slot": 100
  },
  "value": {
    "items": [
      {
        "blockTime": 1714081554,
        "signature": "5J8H5sTvEhnGcB4R8K1n7mfoiWUD9RzPVGES7e3WxC7c",
        "slot": 100
      }
    ]
  }
}

getCompressionSignaturesForAddress

Return the signatures of the transactions that closed or opened a compressed account with the given address. This is a paginated endpoint.

post
Body
idstring · enumrequired

An ID to identify the request.

Options: test-account
jsonrpcstring · enumrequired

The version of the JSON-RPC protocol.

Options: 2.0
methodstring · enumrequired

The name of the method to invoke.

Options: getCompressionSignaturesForAddress
paramsobjectrequired

Responses
curl -L \
  --request POST \
  --url 'https://mainnet.helius-rpc.com/?api-key=<api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
    "id": "test-account",
    "jsonrpc": "2.0",
    "method": "getCompressionSignaturesForAddress",
    "params": {
      "address": "1111111F5q7ToS5rKDfdAt2rgf9yPXY2f21tCRA55",
      "cursor": "text",
      "limit": 1
    }
  }'
{
  "context": {
    "slot": 100
  },
  "value": {
    "cursor": "text",
    "items": [
      {
        "blockTime": 1714081554,
        "signature": "5J8H5sTvEhnGcB4R8K1n7mfoiWUD9RzPVGES7e3WxC7c",
        "slot": 100
      }
    ]
  }
}

getCompressionSignaturesForOwner

Returns the signatures of the transactions that have modified an owner's compressed accounts. This is a paginated endpoint.

getCompressionSignaturesForTokenOwner

Returns the signatures of the transactions that have modified an owner's compressed token accounts. This is a paginated endpoint.

post
Body
idstring · enumrequired

An ID to identify the request.

Options: test-account
jsonrpcstring · enumrequired

The version of the JSON-RPC protocol.

Options: 2.0
methodstring · enumrequired

The name of the method to invoke.

Options: getCompressionSignaturesForTokenOwner
paramsobjectrequired

Responses
curl -L \
  --request POST \
  --url 'https://mainnet.helius-rpc.com/?api-key=<api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
    "id": "test-account",
    "jsonrpc": "2.0",
    "method": "getCompressionSignaturesForTokenOwner",
    "params": {
      "cursor": "text",
      "limit": 1,
      "owner": "1111111GhBXQEdEh35AtuSNxMzRutcgYg3nj8kVLT"
    }
  }'
{
  "context": {
    "slot": 100
  },
  "value": {
    "cursor": "text",
    "items": [
      {
        "blockTime": 1714081554,
        "signature": "5J8H5sTvEhnGcB4R8K1n7mfoiWUD9RzPVGES7e3WxC7c",
        "slot": 100
      }
    ]
  }
}

getLatestCompressionSignatures

Returns the signatures of the latest transactions that used the compression program. This is a paginated endpoint.

getLatestNonVotingSignatures

Returns the signatures of the latest transactions that are not voting transactions.

post
Body
idstring · enumrequired

An ID to identify the request.

Options: test-account
jsonrpcstring · enumrequired

The version of the JSON-RPC protocol.

Options: 2.0
methodstring · enumrequired

The name of the method to invoke.

Options: getLatestNonVotingSignatures
paramsobjectrequired

Responses
curl -L \
  --request POST \
  --url 'https://mainnet.helius-rpc.com/?api-key=<api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
    "id": "test-account",
    "jsonrpc": "2.0",
    "method": "getLatestNonVotingSignatures",
    "params": {
      "cursor": "text",
      "limit": 1
    }
  }'
{
  "context": {
    "slot": 100
  },
  "value": {
    "items": [
      {
        "blockTime": 1714081554,
        "error": "text",
        "signature": "5J8H5sTvEhnGcB4R8K1n7mfoiWUD9RzPVGES7e3WxC7c",
        "slot": 100
      }
    ]
  }
}

getIndexerSlot

Returns the slot of the last block indexed by the indexer.

post
Body
idstring · enumrequired

An ID to identify the request.

Options: test-account
jsonrpcstring · enumrequired

The version of the JSON-RPC protocol.

Options: 2.0
methodstring · enumrequired

The name of the method to invoke.

Options: getIndexerSlot
Responses
curl -L \
  --request POST \
  --url 'https://mainnet.helius-rpc.com/?api-key=<api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
    "id": "test-account",
    "jsonrpc": "2.0",
    "method": "getIndexerSlot"
  }'
100

getIndexerHealth

Returns an error if the indexer is stale by more than a configurable number of blocks. Else returns ok.

post
Body
idstring · enumrequired

An ID to identify the request.

Options: test-account
jsonrpcstring · enumrequired

The version of the JSON-RPC protocol.

Options: 2.0
methodstring · enumrequired

The name of the method to invoke.

Options: getIndexerHealth
Responses
curl -L \
  --request POST \
  --url 'https://mainnet.helius-rpc.com/?api-key=<api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
    "id": "test-account",
    "jsonrpc": "2.0",
    "method": "getIndexerHealth"
  }'
ok

getCompressedMintTokenHolders

Return the owner balances for a given mint in descending order. This is a paginated endpoint.