Alephium API
v3.3.0https://alephium.nownodes.ioAuthentication
api-keyAuthapiKeyAPI Key: api-key in header
General
Infos
Get basic ALPH node information
Returns the build version, commit hash, UPnP configuration, and the external address (if available) of the ALPH node.
Response
Node information retrieved successfully.
BadRequest
Unauthorized
NotFound
InternalServerError
ServiceUnavailable
Authorization
api-keyAuthapiKey in headerGet ALPH Node Software Version
Returns the current version of the ALPH node software.
Response
Version information retrieved successfully.
BadRequest
Unauthorized
NotFound
InternalServerError
ServiceUnavailable
Authorization
api-keyAuthapiKey in headerGet Chain Parameters
Returns various blockchain configuration parameters used by the ALPH node.
Response
Chain parameters retrieved successfully.
BadRequest
Unauthorized
NotFound
InternalServerError
ServiceUnavailable
Authorization
api-keyAuthapiKey in headerGet Self Clique Information
Returns information about the current node's clique, including clique ID, participating nodes, and sync status.
Response
Self clique information retrieved successfully.
BadRequest
Unauthorized
NotFound
InternalServerError
ServiceUnavailable
Authorization
api-keyAuthapiKey in headerGet Inter-Clique Peer Information
Returns a list of peers from other cliques that the node is aware of, including their clique IDs, sync status, and client version.
Response
Peer information retrieved successfully.
BadRequest
Unauthorized
NotFound
InternalServerError
ServiceUnavailable
Authorization
api-keyAuthapiKey in headerGet Discovered Neighboring Peers
Returns a list of discovered neighbors from other cliques, including their clique ID, broker ID, broker number, and network address.
Response
Discovered neighbors retrieved successfully.
BadRequest
Unauthorized
NotFound
InternalServerError
ServiceUnavailable
Authorization
api-keyAuthapiKey in headerGet Misbehaving Peers
Returns a list of peers that have been flagged for misbehavior, including their status and ban information.
Response
Misbehaving peer list retrieved successfully.
BadRequest
Unauthorized
NotFound
InternalServerError
ServiceUnavailable
Authorization
api-keyAuthapiKey in headerGet Unreachable Peers
Returns a list of peer IP addresses that are currently unreachable from this node.
Response
List of unreachable peers retrieved successfully.
BadRequest
Unauthorized
NotFound
InternalServerError
ServiceUnavailable
Authorization
api-keyAuthapiKey in headerGet Historical Hashrate Summary
Returns a summary string representing the node's hashrate over the specified time range.
Parameters
fromTsinteger<int64>requiredqueryStart timestamp (Unix ms) for the requested hashrate history.
toTsinteger<int64>requiredqueryEnd timestamp (Unix ms) for the requested hashrate history.
Response
Historical hashrate summary retrieved successfully.
Invalid or missing query parameters.
Unauthorized
NotFound
InternalServerError
ServiceUnavailable
Authorization
api-keyAuthapiKey in headerGet Current Hashrate
Returns the current hashrate of the node as a string with units.
Response
Current hashrate retrieved successfully.
BadRequest
Unauthorized
NotFound
InternalServerError
ServiceUnavailable
Authorization
api-keyAuthapiKey in headerGet Current Difficulty
Returns the current network difficulty as a string.
Response
Current difficulty retrieved successfully.
BadRequest
Unauthorized
NotFound
InternalServerError
ServiceUnavailable
Authorization
api-keyAuthapiKey in headerBlockflow
List blocks on the given time interval
Returns blocks produced within the specified time range.
Parameters
fromTsinteger<int64>>= 0requiredquerytoTsinteger<int64>>= 0queryResponse
Valid response
BadRequest
Unauthorized
NotFound
InternalServerError
ServiceUnavailable
Authorization
api-keyAuthapiKey in headerList blocks with events on the given time interval
Parameters
fromTsinteger<int64>>= 0requiredquerytoTsinteger<int64>>= 0queryResponse
Valid response
BadRequest
Unauthorized
NotFound
InternalServerError
ServiceUnavailable
Authorization
api-keyAuthapiKey in headerGet Block by Hash
Retrieves detailed information about a block identified by its hash.
Parameters
block_hashstringrequiredpathThe hash of the block to retrieve.
Response
Block information retrieved successfully.
Invalid block hash supplied.
Block not found.
Internal server error.
ServiceUnavailable
Authorization
api-keyAuthapiKey in headerGet a mainchain block by ghost uncle hash
Parameters
ghost_uncle_hashstring<block-hash>requiredpathResponse
Valid response
BadRequest
Unauthorized
NotFound
InternalServerError
ServiceUnavailable
Authorization
api-keyAuthapiKey in headerGet Block with Events
Retrieves detailed block information along with any smart contract events emitted in the block.
Parameters
block_hashstringrequiredpathThe hash of the block.
Response
Block with events retrieved successfully.
Block not found.
Internal server error.
ServiceUnavailable
Authorization
api-keyAuthapiKey in headerCheck if Block is in Main Chain
Returns whether the specified block is part of the main chain.
Parameters
blockHashstringrequiredqueryThe hash of the block to check.
Response
Successfully checked block status.
Invalid or missing block hash.
Block not found.
Internal server error.
ServiceUnavailable
Authorization
api-keyAuthapiKey in headerGet Block Headers Hashes
Retrieves block header hashes filtered by source group, destination group, and block height.
Parameters
fromGroupintegerrequiredquerySource group number.
toGroupintegerrequiredqueryDestination group number.
heightintegerrequiredqueryBlock height to filter.
Response
List of block header hashes.
Invalid or missing query parameters.
Internal server error.
ServiceUnavailable
Authorization
api-keyAuthapiKey in headerGet Chain Info by Groups
Returns the current chain height filtered by fromGroup and toGroup.
Parameters
fromGroupintegerrequiredquerySource group number.
toGroupintegerrequiredqueryDestination group number.
Response
Chain information retrieved successfully.
Invalid or missing query parameters.
Internal server error.
ServiceUnavailable
Authorization
api-keyAuthapiKey in headerGet Block Header by Hash
Returns detailed information about a block header identified by its hash.
Parameters
block_hashstringrequiredpathHash of the block header to retrieve.
Response
Block header retrieved successfully.
Invalid block hash supplied.
Block header not found.
Internal server error.
ServiceUnavailable
Authorization
api-keyAuthapiKey in headerAddresses
Get Address Balance (with optional mempool)
Returns total and locked balances for the specified address.
If mempool=true, balances will include the effect of unconfirmed transactions.
Parameters
addressstringrequiredpathThe address to query.
mempoolbooleanfalsequeryWhether to include unconfirmed (mempool) transactions in the balance calculation.
Response
Address balance retrieved successfully.
Invalid address or query parameter.
Address not found.
Internal server error.
ServiceUnavailable
Authorization
api-keyAuthapiKey in headerGet UTXOs for Address
Returns all unspent outputs (UTXOs) associated with a specific address.
Parameters
addressstringrequiredpathThe address whose UTXOs are requested.
Response
List of UTXOs retrieved successfully.
Invalid address format.
Address not found or has no UTXOs.
Internal server error.
ServiceUnavailable
Authorization
api-keyAuthapiKey in headerGet Group Number by Address
Returns the group number for the specified address.
Parameters
addressstringrequiredpathThe address to query.
Response
Group number retrieved successfully.
Invalid address format.
Address not found.
Internal server error.
ServiceUnavailable
Authorization
api-keyAuthapiKey in headerTransactions
Build Transaction
Creates a new unsigned transaction from the sender’s public key to specified destinations.
Body
fromPublicKeystringrequiredSender’s public key in hex format.
destinationsArray<object>requiredList of destination addresses with amounts.
Response
Transaction built successfully.
Invalid request payload.
Unauthorized
NotFound
InternalServerError
ServiceUnavailable
Authorization
api-keyAuthapiKey in headerBuild Transaction from Multiple Addresses
Creates a new unsigned transaction from multiple senders each with their own destinations.
Body
fromArray<object>requiredList of sender public keys with their destinations.
Response
Transaction built successfully.
BadRequest
Unauthorized
NotFound
InternalServerError
ServiceUnavailable
Authorization
api-keyAuthapiKey in headerBuild Sweep Transaction
Creates unsigned transaction(s) to sweep all funds from the specified public key’s address to a destination address.
Body
fromPublicKeystringrequiredPublic key of the source address to sweep funds from.
toAddressstringrequiredDestination ALPH address where all funds will be sent.
Response
Sweep transaction(s) built successfully.
BadRequest
Unauthorized
NotFound
InternalServerError
ServiceUnavailable
Authorization
api-keyAuthapiKey in headerSubmit Signed Transaction
Submits a signed transaction to the ALPH network for processing.
Body
unsignedTxstringrequiredSerialized unsigned transaction data in hex or base64 format.
signaturestringrequiredSignature of the unsigned transaction.
Response
Transaction successfully submitted.
BadRequest
Unauthorized
NotFound
InternalServerError
ServiceUnavailable
Authorization
api-keyAuthapiKey in headerDecode an unsigned transaction
Decodes a serialized unsigned transaction string and returns the detailed transaction data, including groups involved, inputs, outputs, gas parameters, and token information.
Body
unsignedTxstringrequiredSerialized unsigned transaction string to decode.
Response
Successfully decoded unsigned transaction details.
BadRequest
Unauthorized
NotFound
InternalServerError
ServiceUnavailable
Authorization
api-keyAuthapiKey in headerGet detailed information of a transaction by transaction ID
Retrieves detailed information about a specific transaction, including unsigned transaction data, script execution status, contract inputs and outputs, and signatures.
Parameters
txIdstringrequiredpathTransaction ID (hash) to get details for.
fromGroupintegerqueryOriginating group number of the transaction.
toGroupintegerqueryTarget group number of the transaction.
Response
Successful transaction detail retrieval
BadRequest
Unauthorized
NotFound
InternalServerError
ServiceUnavailable
Authorization
api-keyAuthapiKey in headerGet the status of a transaction by transaction ID and group parameters
Returns the current status of a transaction, including confirmation status, block hash where it is included, index within the block, and confirmation counts across groups.
Parameters
txIdstringrequiredqueryTransaction ID (hash) to check status for
fromGroupintegerrequiredqueryOriginating group number of the transaction
toGroupintegerrequiredqueryTarget group number of the transaction
Response
Transaction status information
BadRequest
Unauthorized
NotFound
InternalServerError
ServiceUnavailable
Authorization
api-keyAuthapiKey in headerMempool
Get transactions currently in the mempool
Returns a list of transactions currently waiting in the mempool, grouped by source and destination groups.
Response
A list of mempool transactions grouped by fromGroup and toGroup
BadRequest
Unauthorized
NotFound
InternalServerError
ServiceUnavailable
Authorization
api-keyAuthapiKey in headerContracts
Compile a contract script
Compiles a contract script written in ALPH TxScript language. Returns metadata about the compiled bytecode, fields, functions, and any warnings.
Body
codestringThe contract script source code in TxScript language
compilerOptionsobjectCompiler options to control the compilation behavior
Response
Compilation result with bytecode and metadata
BadRequest
Unauthorized
NotFound
InternalServerError
ServiceUnavailable
Authorization
api-keyAuthapiKey in headerBuild an unsigned script
Body
fromPublicKeystring<hex-string>requiredfromPublicKeyTypestring<hex-string>bytecodestring<hex-string>requiredattoAlphAmountstring<uint256>tokensArray<Token>gasAmountinteger<gas>gasPricestring<uint256>targetBlockHashstring<block-hash>gasEstimationMultipliernumber<double>Response
Valid response
BadRequest
Unauthorized
NotFound
InternalServerError
ServiceUnavailable
Authorization
api-keyAuthapiKey in headerCompile a smart contract
Body
codestringrequiredcompilerOptionsCompilerOptionsResponse
Valid response
BadRequest
Unauthorized
NotFound
InternalServerError
ServiceUnavailable
Authorization
api-keyAuthapiKey in headerCompile a project
Body
codestringrequiredcompilerOptionsCompilerOptionsResponse
Valid response
BadRequest
Unauthorized
NotFound
InternalServerError
ServiceUnavailable
Authorization
api-keyAuthapiKey in headerBuild an unsigned contract
Body
fromPublicKeystring<hex-string>requiredfromPublicKeyTypestring<hex-string>bytecodestring<hex-string>requiredinitialAttoAlphAmountstring<uint256>initialTokenAmountsArray<Token>issueTokenAmountstring<uint256>issueTokenTostring<address>gasAmountinteger<gas>gasPricestring<uint256>targetBlockHashstring<block-hash>Response
Valid response
BadRequest
Unauthorized
NotFound
InternalServerError
ServiceUnavailable
Authorization
api-keyAuthapiKey in headerGet contract state
Parameters
addressstring<address>requiredpathResponse
Valid response
BadRequest
Unauthorized
NotFound
InternalServerError
ServiceUnavailable
Authorization
api-keyAuthapiKey in headerTest contract
Body
Response
Valid response
BadRequest
Unauthorized
NotFound
InternalServerError
ServiceUnavailable
Authorization
api-keyAuthapiKey in headerCall contract
Body
Response
Valid response
BadRequest
Unauthorized
NotFound
InternalServerError
ServiceUnavailable
Authorization
api-keyAuthapiKey in headerMultiple call contract
Body
Response
Valid response
BadRequest
Unauthorized
NotFound
InternalServerError
ServiceUnavailable
Authorization
api-keyAuthapiKey in headerCall TxScript
Body
groupinteger<int32>requiredbytecodestring<hex-string>requiredcallerAddressstring<address>worldStateBlockHashstring<block-hash>txIdstring<32-byte-hash>inputAssetsArray<TestInputAsset>interestedContractsArray<string>Response
Valid response
BadRequest
Unauthorized
NotFound
InternalServerError
ServiceUnavailable
Authorization
api-keyAuthapiKey in headerMulti-signature
Create the multisig address and unlock script
Body
Format 1: 1000000000000000000
Format 2: x.y ALPH, where `1 ALPH = 1000000000000000000
Field fromPublicKeyType can be default or bip340-schnorr
keysArray<string>requiredmrequiredinteger<int32>requiredResponse
Valid response
BadRequest
Unauthorized
NotFound
InternalServerError
ServiceUnavailable
Authorization
api-keyAuthapiKey in headerBuild a multisig unsigned transaction
Body
fromAddressstring<address>requiredfromPublicKeysArray<string>requireddestinationsArray<Destination>requiredgasinteger<gas>gasPricestring<uint256>Response
Valid response
BadRequest
Unauthorized
NotFound
InternalServerError
ServiceUnavailable
Authorization
api-keyAuthapiKey in headerSweep all unlocked ALPH and token balances of a multisig address to another address
Body
fromAddressstring<address>requiredfromPublicKeysArray<string>requiredtoAddressstring<address>requiredmaxAttoAlphPerUTXOstring<uint256>lockTimeinteger<int64>gasAmountinteger<gas>gasPricestring<uint256>utxosLimitinteger<int32>targetBlockHashstring<block-hash>Response
Valid response
BadRequest
Unauthorized
NotFound
InternalServerError
ServiceUnavailable
Authorization
api-keyAuthapiKey in headerSubmit a multi-signed transaction
Body
unsignedTxstringrequiredsignaturesArray<string>requiredResponse
Valid response
BadRequest
Unauthorized
NotFound
InternalServerError
ServiceUnavailable
Authorization
api-keyAuthapiKey in headerEvents
Get events for a contract within a counter range
Parameters
contractAddressstring<address>requiredpathstartinteger<int32>requiredquerylimitinteger<int32>querygroupinteger<int32>queryResponse
Valid response
BadRequest
Unauthorized
NotFound
InternalServerError
ServiceUnavailable
Authorization
api-keyAuthapiKey in headerGet current value of the events counter for a contract
Parameters
contractAddressstring<address>requiredpathResponse
Valid response
BadRequest
Unauthorized
NotFound
InternalServerError
ServiceUnavailable
Authorization
api-keyAuthapiKey in headerGet contract events for a transaction
Parameters
txIdstring<32-byte-hash>requiredpathgroupinteger<int32>queryResponse
Valid response
BadRequest
Unauthorized
NotFound
InternalServerError
ServiceUnavailable
Authorization
api-keyAuthapiKey in headerGet contract events for a block
Parameters
blockHashstring<block-hash>requiredpathgroupinteger<int32>queryResponse
Valid response
BadRequest
Unauthorized
NotFound
InternalServerError
ServiceUnavailable
Authorization
api-keyAuthapiKey in headerUtils
Verify the SecP256K1 signature of some data
Body
datastring<hex-string>requiredsignaturestring<signature>requiredpublicKeystring<public-key>requiredResponse
Valid response
BadRequest
Unauthorized
NotFound
InternalServerError
ServiceUnavailable
Authorization
api-keyAuthapiKey in headerConvert a target to hashrate
Body
targetstring<hex-string>requiredResponse
Valid response
BadRequest
Unauthorized
NotFound
InternalServerError
ServiceUnavailable
Authorization
api-keyAuthapiKey in header