/sendAssetHubTransaction

1 min

POST

Send an AssetHub (DOT) transaction using the specified parameters.

Use getSuggestedFee to get the current suggested fee before running the transaction.

NOTE: Success or failure in this API call does not necessarily mean success or failure in the transaction itself. For example, the transaction may succeed, but the "success" response to the client can be lost if the client's internet connection is down.

To verify the status of the transaction:

Call getCurrentToken and store it.
Send your transaction. The transaction will use the token from step 1.
Call getTransactionByToken using the stored token to track the status of the transaction.

-------------------- Request -------------------- sendAssetHubTransaction( "account_id"=1, "outputs"=[("5CBy...Jtf", 1000000)], "tip"=1, "description"="example", "ignore_aml"=False, aml_note="" ) -------------------- Response --------------------

{ "FunctionData": { "ApprovalRequestStatus": 3, "CoinType": "DOT", "Transactions": [ { "AmountToTransfer": "1000000", "DestinationAddress": "5CBy...Jtf" } ] }, "Meta": { "AccessToken": "f192762c...", "Destination": "045bd19d...", "Source": "6f8fd2e8...", "Time": "2024-09-29 20:48

.158" } }

account_idintegerThe account ID to use for this transaction.

outputsarrayList of tuples representing the destination address and amount to transfer. Format: [(destination_address: str, amount_to_transfer: str)] All Starknet addresses should be in hex format starting with "0x".

descriptionstringInternal description for transaction records. Not sent to the blockchain.

specificFromAddressstringThe specific deposit address to send from. Cannot be used if the account is defined as an Omnibus account.

ignore_amlbooleanIf True, the AML (Anti-Money Laundering) check will be bypassed.

aml_notestringRequired note explaining why AML decision is being overridden. Only applicable when ignore_aml is True.

tipintegerThe tip to transfer, if any.

coin_typearrayList of currency symbols.

acceptstringGenerated from available response content types

200success

curl --request POST \
     --url '/sendAssetHubTransaction?account_id=1&outputs=array&description=Test&specificFromAddress=None&ignore_aml=boolean&aml_note=string&tip=5&coin_type=' \
     --header 'accept: application/json'