Alephium API
v3.3.0https://alephium.nownodes.ioAuthentication
api-keyAuthapiKeyAPI Key: api-key in header
Node
Infos
Get basic ALPH node information
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
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
Get ALPH Node Software Version
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
Returns the current version of the ALPH node software.
Response
Version information retrieved successfully.
BadRequest
Unauthorized
NotFound
InternalServerError
ServiceUnavailable
Get Chain Parameters
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
Returns various blockchain configuration parameters used by the ALPH node.
Response
Chain parameters retrieved successfully.
BadRequest
Unauthorized
NotFound
InternalServerError
ServiceUnavailable
Get Self Clique Information
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
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
Get Inter-Clique Peer Information
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
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
Get Discovered Neighboring Peers
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
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
Get Misbehaving Peers
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
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
Get Unreachable Peers
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
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
Get Historical Hashrate Summary
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
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
Get Current Hashrate
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
Returns the current hashrate of the node as a string with units.
Response
Current hashrate retrieved successfully.
BadRequest
Unauthorized
NotFound
InternalServerError
ServiceUnavailable
Get Current Difficulty
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
Returns the current network difficulty as a string.
Response
Current difficulty retrieved successfully.
BadRequest
Unauthorized
NotFound
InternalServerError
ServiceUnavailable
Blockflow
List blocks on the given time interval
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
Returns blocks produced within the specified time range.
Parameters
fromTsinteger<int64>>= 0requiredquerytoTsinteger<int64>>= 0queryResponse
Valid response
BadRequest
Unauthorized
NotFound
InternalServerError
ServiceUnavailable
List blocks with events on the given time interval
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
Parameters
fromTsinteger<int64>>= 0requiredquerytoTsinteger<int64>>= 0queryResponse
Valid response
BadRequest
Unauthorized
NotFound
InternalServerError
ServiceUnavailable
Get Block by Hash
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
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
Get a mainchain block by ghost uncle hash
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
Parameters
ghost_uncle_hashstring<block-hash>requiredpathResponse
Valid response
BadRequest
Unauthorized
NotFound
InternalServerError
ServiceUnavailable
Get Block with Events
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
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
Check if Block is in Main Chain
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
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
Get Block Headers Hashes
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
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
Get Chain Info by Groups
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
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
Get Block Header by Hash
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
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
Addresses
Get Address Balance (with optional mempool)
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
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
Get UTXOs for Address
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
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
Get Group Number by Address
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
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
Transactions
Build Transaction
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
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
Build Transaction from Multiple Addresses
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
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
Build Sweep Transaction
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
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
Submit Signed Transaction
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
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
Decode an unsigned transaction
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
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
Get detailed information of a transaction by transaction ID
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
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
Get the status of a transaction by transaction ID and group parameters
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
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
Mempool
Get transactions currently in the mempool
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
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
Contracts
Compile a contract script
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
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
Build an unsigned script
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
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
Compile a smart contract
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
Body
codestringrequiredcompilerOptionsCompilerOptionsResponse
Valid response
BadRequest
Unauthorized
NotFound
InternalServerError
ServiceUnavailable
Compile a project
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
Body
codestringrequiredcompilerOptionsCompilerOptionsResponse
Valid response
BadRequest
Unauthorized
NotFound
InternalServerError
ServiceUnavailable
Build an unsigned contract
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
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
Get contract state
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
Parameters
addressstring<address>requiredpathResponse
Valid response
BadRequest
Unauthorized
NotFound
InternalServerError
ServiceUnavailable
Test contract
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
Body
Response
Valid response
BadRequest
Unauthorized
NotFound
InternalServerError
ServiceUnavailable
Call contract
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
Body
Response
Valid response
BadRequest
Unauthorized
NotFound
InternalServerError
ServiceUnavailable
Multiple call contract
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
Body
Response
Valid response
BadRequest
Unauthorized
NotFound
InternalServerError
ServiceUnavailable
Call TxScript
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
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
Multi-signature
Create the multisig address and unlock script
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
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
Build a multisig unsigned transaction
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
Body
fromAddressstring<address>requiredfromPublicKeysArray<string>requireddestinationsArray<Destination>requiredgasinteger<gas>gasPricestring<uint256>Response
Valid response
BadRequest
Unauthorized
NotFound
InternalServerError
ServiceUnavailable
Sweep all unlocked ALPH and token balances of a multisig address to another address
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
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
Submit a multi-signed transaction
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
Body
unsignedTxstringrequiredsignaturesArray<string>requiredResponse
Valid response
BadRequest
Unauthorized
NotFound
InternalServerError
ServiceUnavailable
Events
Get events for a contract within a counter range
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
Parameters
contractAddressstring<address>requiredpathstartinteger<int32>requiredquerylimitinteger<int32>querygroupinteger<int32>queryResponse
Valid response
BadRequest
Unauthorized
NotFound
InternalServerError
ServiceUnavailable
Get current value of the events counter for a contract
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
Parameters
contractAddressstring<address>requiredpathResponse
Valid response
BadRequest
Unauthorized
NotFound
InternalServerError
ServiceUnavailable
Get contract events for a transaction
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
Parameters
txIdstring<32-byte-hash>requiredpathgroupinteger<int32>queryResponse
Valid response
BadRequest
Unauthorized
NotFound
InternalServerError
ServiceUnavailable
Get contract events for a block
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
Parameters
blockHashstring<block-hash>requiredpathgroupinteger<int32>queryResponse
Valid response
BadRequest
Unauthorized
NotFound
InternalServerError
ServiceUnavailable
Utils
Verify the SecP256K1 signature of some data
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
Body
datastring<hex-string>requiredsignaturestring<signature>requiredpublicKeystring<public-key>requiredResponse
Valid response
BadRequest
Unauthorized
NotFound
InternalServerError
ServiceUnavailable
Convert a target to hashrate
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
Body
targetstring<hex-string>requiredResponse
Valid response
BadRequest
Unauthorized
NotFound
InternalServerError
ServiceUnavailable