For the complete documentation index, see llms.txt. This page is also available as Markdown.

Transactions

Build Transaction

post

Creates a new unsigned transaction from the sender’s public key to specified destinations.

Authorizations
api-keystringRequired
Body
fromPublicKeystringRequired

Sender’s public key in hex format.

Example: d1b70d2226308b46da297486adb6b4f1a8c1842cb159ac5ec04f384fe2d6f5da28
Responses
200

Transaction built successfully.

application/json
unsignedTxstringOptional

Serialized unsigned transaction in hex.

Example: 35d1b2a520a0da34c5eb8d712aa9cc
gasAmountintegerOptional

Gas amount estimated for the transaction.

Example: 20000
gasPricestringOptional

Gas price per unit in attoALPH.

Example: 100000000000
txIdstringOptional

Transaction identifier hash.

Example: 503bfb16230888af4924aa8f8250d7d348b862e267d75d3147f1998050b6da69
fromGroupintegerOptional

Source group ID.

Example: 2
toGroupintegerOptional

Destination group ID.

Example: 1
post/transactions/build

Build Transaction from Multiple Addresses

post

Creates a new unsigned transaction from multiple senders each with their own destinations.

Authorizations
api-keystringRequired
Body
Responses
200

Transaction built successfully.

application/json
unsignedTxstringOptional

Serialized unsigned transaction in hex.

Example: 35d1b2a520a0da34c5eb8d712aa9cc
gasAmountintegerOptional

Gas amount estimated for the transaction.

Example: 20000
gasPricestringOptional

Gas price per unit in attoALPH.

Example: 100000000000
txIdstringOptional

Transaction identifier hash.

Example: 503bfb16230888af4924aa8f8250d7d348b862e267d75d3147f1998050b6da69
fromGroupintegerOptional

Source group ID.

Example: 2
toGroupintegerOptional

Destination group ID.

Example: 1
post/transactions/build-multi-addresses

Build Sweep Transaction

post

Creates unsigned transaction(s) to sweep all funds from the specified public key’s address to a destination address.

Authorizations
api-keystringRequired
Body
fromPublicKeystringRequired

Public key of the source address to sweep funds from.

Example: d1b70d2226308b46da297486adb6b4f1a8c1842cb159ac5ec04f384fe2d6f5da28
toAddressstringRequired

Destination ALPH address where all funds will be sent.

Example: 1AujpupFP4KWeZvqA7itsHY9cLJmx4qTzojVZrg8W9y
Responses
200

Sweep transaction(s) built successfully.

application/json
fromGroupintegerOptional

Source group ID.

Example: 2
toGroupintegerOptional

Destination group ID.

Example: 1
post/transactions/sweep-address/build

Submit Signed Transaction

post

Submits a signed transaction to the ALPH network for processing.

Authorizations
api-keystringRequired
Body
unsignedTxstringRequired

Serialized unsigned transaction data in hex or base64 format.

Example: 35d1b2a520a0da34c5eb8d712aa9cc
signaturestringRequired

Signature of the unsigned transaction.

Example: 9e1a35b2931bd04e6780d01c36e3e5337941aa80f173cfe4f4e249c44ab135272b834c1a639db9c89d673a8a30524042b0469672ca845458a5a0cf2cad53221b
Responses
200

Transaction successfully submitted.

application/json
txIdstringOptional

Transaction ID of the submitted transaction.

Example: 503bfb16230888af4924aa8f8250d7d348b862e267d75d3147f1998050b6da69
fromGroupintegerOptional

Source group number from which the transaction was sent.

Example: 2
toGroupintegerOptional

Destination group number to which the transaction is targeted.

Example: 1
post/transactions/submit

Decode an unsigned transaction

post

Decodes a serialized unsigned transaction string and returns the detailed transaction data, including groups involved, inputs, outputs, gas parameters, and token information.

Authorizations
api-keystringRequired
Body
unsignedTxstringRequired

Serialized unsigned transaction string to decode.

Example: 35d1b2a520a0da34c5eb8d712aa9cc
Responses
200

Successfully decoded unsigned transaction details.

application/json
fromGroupintegerRequired

Group number from which the transaction originates.

Example: 1
toGroupintegerRequired

Group number to which the transaction is sent.

Example: 2
post/transactions/decode-unsigned-tx

Get detailed information of a transaction by transaction ID

get

Retrieves detailed information about a specific transaction, including unsigned transaction data, script execution status, contract inputs and outputs, and signatures.

Authorizations
api-keystringRequired
Path parameters
txIdstringRequired

Transaction ID (hash) to get details for.

Example: 98401002e2d85e8be4765ae29ac768f4f110ee46e3a0fab3e7a754e4bcffa3c4
Query parameters
fromGroupintegerOptional

Originating group number of the transaction.

Example: 3
toGroupintegerOptional

Target group number of the transaction.

Example: 1
Responses
200

Successful transaction detail retrieval

application/json
scriptExecutionOkbooleanOptional

Indicates if the transaction’s scripts executed successfully

Example: true
contractInputsobject[]Optional

Inputs related to smart contract calls

generatedOutputsobject[]Optional

Outputs generated by contract execution

inputSignaturesobject[]Optional

Signatures on inputs

scriptSignaturesobject[]Optional

Signatures related to script execution

get/transactions/details/{txId}

Get the status of a transaction by transaction ID and group parameters

get

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.

Authorizations
api-keystringRequired
Query parameters
txIdstringRequired

Transaction ID (hash) to check status for

Example: 98401002e2d85e8be4765ae29ac768f4f110ee46e3a0fab3e7a754e4bcffa3c4
fromGroupintegerRequired

Originating group number of the transaction

Example: 3
toGroupintegerRequired

Target group number of the transaction

Example: 1
Responses
200

Transaction status information

application/json
typestringOptional

Status type of the transaction (e.g., Confirmed, Pending, Failed)

Example: Confirmed
blockHashstringOptional

Hash of the block that contains this transaction

Example: 0000000000005c8d2761b8c0967d5e0dcbfe47a5678a80f676a54276d956e3ed
txIndexintegerOptional

Index of the transaction within the block

Example: 0
chainConfirmationsintegerOptional

Number of confirmations on the blockchain for this transaction

Example: 208
fromGroupConfirmationsintegerOptional

Number of confirmations on the originating group

Example: 202
toGroupConfirmationsintegerOptional

Number of confirmations on the target group

Example: 209
get/transactions/status

Last updated