πŸš€
Aleo RPC API
  • Aleo RPC API
  • endpoints
    • NFTs
      • getPublicNFTsForAddress
      • getPublicTokenProgramsForAddress
    • blocks
      • block
      • blocks
      • getAleoBlocks
      • getStateRoot
      • latest/block
      • latest/hash
      • latest/height
    • mappings
      • getMappingValue
    • programs
      • generateDeployment
      • getGeneratedDeployment
      • getProgramTypes
      • program
      • transactionsForProgram
      • transactionsForProgramCount
    • records
      • getStatePath
      • records/all
      • records/byTransitionAndIndex
      • records/isOwner
      • serialNumbers
    • staking
      • getStakedBalanceForAddress
    • status
      • chainStatus
    • transactions
      • aleoTransaction
      • generateTransaction
      • getGeneratedTransaction
      • getPublicTransactionsForAddress
      • transaction
      • transactions
    • transitions
      • getTransactionId
      • transitionsWithoutRecordInputs
Powered by GitBook
On this page
  • Available methods
  • πŸ“š Blocks
  • πŸ’Έ Transactions
  • πŸ”„ Transitions
  • πŸ“ Records
  • πŸ“‘ Programs
  • πŸ—ΊοΈ Mappings
  • 🎨 NFTs
  • 🏦 Staking
  • πŸ“Š Status
  • Usage
  • Call a method
  • Networks
  • Disclaimer

Aleo RPC API

Nextendpoints

Last updated 4 months ago

An RPC API made to enable more diverse use cases and support many DApps in the Aleo ecosystem. It is currently used to support the and follows the

Available methods

πŸ“š Blocks

  • - Get latest block height.

  • - Get latest block hash.

  • - Get latest block details.

  • - Get current state root.

  • - Get a specific block details.

  • - Get specific blocks details within a range of heights.

  • - Get specific blocks full content within a range of heights.

πŸ’Έ Transactions

  • - Get transaction details with a specific transaction ID.

  • - Get transaction full content corresponding to a specific transaction ID.

  • - Get transactions details included in a specific block.

  • - Get IDs of public transactions associated with a given address within a range of block heights.

  • - Delegate generation of a transaction proof by providing an authorization and transaction inputs.

  • - Get transaction generation job status, result, error message.

πŸ”„ Transitions

πŸ“ Records

πŸ“‘ Programs

πŸ—ΊοΈ Mappings

🎨 NFTs

🏦 Staking

πŸ“Š Status

Usage

Call a method

This request should include a body with the following structure:

{ 
  "jsonrpc": "2.0", 
  "id": 1, 
  "method": "...",
  (optional) "params": [...]
}

Example

Here is an example of such a request using curl command line program:

curl \
  --request POST \
  --location 'https://testnet3.aleorpc.com' \
  --header 'Content-Type: application/json' \
  --data-raw '{ 
    "jsonrpc": "2.0", 
    "id": 1, 
    "method": "getHeight",
  }'

Which corresponding response is:

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": 1470801
}

Networks

Networks supported by the API:

Network
RPC Endpoint URL

Testnet 3

https://testnet3.aleorpc.com

Testnet Beta

https://testnetbeta.aleorpc.com

Disclaimer

This API is free to use but rate limiting may be introduced to prevent spamming at any point.

- Get transaction ID from a transition ID.

- Get details of transitions that do not have record inputs within a range of heights from Aleo blockchain.

- Get all records generated within a range of blocks from the server.

- Get minimal information needed to verify ownership for records within a given block range on the Aleo blockchain.

- Get a specific record from id of transition where it got generarated and output index of it in this transition.

- Get information for a list of serial numbers.

- Get state path for a specific commitment.

- Get program source code corresponding to a specific program ID.

- Get type of multiple programs from their IDs, ie: which standard they implement.

- Get all transactions involving a specific program ID and function name.

- Get the amount of transactions involving a specific program ID and function name.

- Delegate proof generation of a program deployment.

- Get deployment job status, result, error message.

- Get value of a mapping at a specific key.

- Get public NFTs associated with a given address from Aleo blockchain.

- Get all the IDs of token programs that an address interracted with publicly.

- Get the amount of Aleo credits a specific address has staked.

- Get blockchain status details.

Any method above can be called by submitting a POST HTTP request to the unique endpoint corresponding to desired network, as described in

Status of these endpoints is available on the

getTransactionId
transitionsWithoutRecordInputs
records/all
records/isOwner
records/byTransitionAndIndex
serialNumbers
getStatePath
program
getProgramTypes
transactionsForProgram
transactionsForProgramCount
generateDeployment
getGeneratedDeployment
getMappingValue
getPublicNFTsForAddress
getPublicTokenProgramsForAddress
getStakedBalanceForAddress
chainStatus
JSON-RPC 2.0 specification.
Official Leo Status Page.
Leo Wallet
JSON-RPC 2.0 specification.
latest/height
latest/hash
latest/block
getStateRoot
block
blocks
getAleoBlocks
transaction
aleoTransaction
transactions
getPublicTransactionsForAddress
generateTransaction
getGeneratedTransaction