Submit transaction

This endpoint accepts transaction submissions in two formats.

To submit a transaction as JSON, you must submit a SubmitTransactionRequest. To build this request, do the following:

Encode the transaction as BCS. If you are using a language that has native BCS support, make sure of that library. If not, you may take advantage of /transactions/encode_submission. When using this endpoint, make sure you trust the node you’re talking to, as it is possible they could manipulate your request.
Sign the encoded transaction and use it to create a TransactionSignature.
Submit the request. Make sure to use the “application/json” Content-Type.

To submit a transaction as BCS, you must submit a SignedTransaction encoded as BCS. See SignedTransaction in types/src/transaction/mod.rs. Make sure to use the application/x.aptos.signed_transaction+bcs Content-Type.

POST

transactions

curl --request POST \
  --url https://aptos-mainnet.s.chainbase.online/{api-key}/v1/transactions \
  --header 'Content-Type: application/json' \
  --data '{
  "sender": "0xc739507214d0e1bf9795485299d709e00024e92f7c0d055a4c2c39717882bdfd",
  "sequence_number": "32425224034",
  "max_gas_amount": "32425224034",
  "gas_unit_price": "32425224034",
  "expiration_timestamp_secs": "32425224034",
  "payload": {
    "type": "entry_function_payload",
    "function": "0x1::aptos_coin::transfer",
    "type_arguments": [
      "<string>"
    ],
    "arguments": [
      "<any>"
    ]
  },
  "signature": {
    "type": "ed25519_signature",
    "public_key": "0xc739507214d0e1bf9795485299d709e00024e92f7c0d055a4c2c39717882bdfd",
    "signature": "0xc739507214d0e1bf9795485299d709e00024e92f7c0d055a4c2c39717882bdfd"
  }
}'

{
  "hash": "<string>",
  "sender": "0xc739507214d0e1bf9795485299d709e00024e92f7c0d055a4c2c39717882bdfd",
  "sequence_number": "32425224034",
  "max_gas_amount": "32425224034",
  "gas_unit_price": "32425224034",
  "expiration_timestamp_secs": "32425224034",
  "payload": {
    "type": "entry_function_payload",
    "function": "0x1::aptos_coin::transfer",
    "type_arguments": [
      "<string>"
    ],
    "arguments": [
      "<any>"
    ]
  },
  "signature": {
    "type": "ed25519_signature",
    "public_key": "0xc739507214d0e1bf9795485299d709e00024e92f7c0d055a4c2c39717882bdfd",
    "signature": "0xc739507214d0e1bf9795485299d709e00024e92f7c0d055a4c2c39717882bdfd"
  }
}

Body

A request to submit a transaction

This requires a transaction and a signature of it

sender

string

required

A hex encoded 32 byte Aptos account address.

This is represented in a string as a 64 character hex string, sometimes shortened by stripping leading 0s, and adding a 0x.

For example, address 0x0000000000000000000000000000000000000000000000000000000000000001 is represented as 0x1.

Example:

"0xc739507214d0e1bf9795485299d709e00024e92f7c0d055a4c2c39717882bdfd"

sequence_number

string

required

A string containing a 64-bit unsigned integer.

We represent u64 values as a string to ensure compatibility with languages such as JavaScript that do not parse u64s in JSON natively.

Example:

"32425224034"

max_gas_amount

string

required

A string containing a 64-bit unsigned integer.

We represent u64 values as a string to ensure compatibility with languages such as JavaScript that do not parse u64s in JSON natively.

Example:

"32425224034"

gas_unit_price

string

required

A string containing a 64-bit unsigned integer.

We represent u64 values as a string to ensure compatibility with languages such as JavaScript that do not parse u64s in JSON natively.

Example:

"32425224034"

expiration_timestamp_secs

string

required

A string containing a 64-bit unsigned integer.

We represent u64 values as a string to ensure compatibility with languages such as JavaScript that do not parse u64s in JSON natively.

Example:

"32425224034"

payload

object

required

An enum of the possible transaction payloads

payload.type

string

required

Example:

"entry_function_payload"

payload.function

string

required

Entry function id is string representation of a entry function defined on-chain.

Format: {address}::{module name}::{function name}

Both module name and function name are case-sensitive.

Example:

"0x1::aptos_coin::transfer"

payload.type_arguments

string[]

required

Type arguments of the function

String representation of an on-chain Move type tag that is exposed in transaction payload. Values: - bool - u8 - u16 - u32 - u64 - u128 - u256 - address - signer - vector: vector<{non-reference MoveTypeId}> - struct: {address}::{module_name}::{struct_name}::<{generic types}>

Vector type value examples:
  - `vector<u8>`
  - `vector<vector<u64>>`
  - `vector<0x1::coin::CoinStore<0x1::aptos_coin::AptosCoin>>`

Struct type value examples:
  - `0x1::coin::CoinStore<0x1::aptos_coin::AptosCoin>
  - `0x1::account::Account`

Note:
  1. Empty chars should be ignored when comparing 2 struct tag ids.
  2. When used in an URL path, should be encoded by url-encoding (AKA percent-encoding).

payload.arguments

any[]

required

Arguments of the function

signature

object

required

An enum representing the different transaction signatures available

Response

202

application/json

A transaction waiting in mempool

hash

string

required

sender

string

required

A hex encoded 32 byte Aptos account address.

This is represented in a string as a 64 character hex string, sometimes shortened by stripping leading 0s, and adding a 0x.

For example, address 0x0000000000000000000000000000000000000000000000000000000000000001 is represented as 0x1.

Example:

"0xc739507214d0e1bf9795485299d709e00024e92f7c0d055a4c2c39717882bdfd"

sequence_number

string

required

A string containing a 64-bit unsigned integer.

We represent u64 values as a string to ensure compatibility with languages such as JavaScript that do not parse u64s in JSON natively.

Example:

"32425224034"

max_gas_amount

string

required

A string containing a 64-bit unsigned integer.

We represent u64 values as a string to ensure compatibility with languages such as JavaScript that do not parse u64s in JSON natively.

Example:

"32425224034"

gas_unit_price

string

required

A string containing a 64-bit unsigned integer.

We represent u64 values as a string to ensure compatibility with languages such as JavaScript that do not parse u64s in JSON natively.

Example:

"32425224034"

expiration_timestamp_secs

string

required

A string containing a 64-bit unsigned integer.

We represent u64 values as a string to ensure compatibility with languages such as JavaScript that do not parse u64s in JSON natively.

Example:

"32425224034"

payload

object

required

An enum of the possible transaction payloads

payload.type

string

required

Example:

"entry_function_payload"

payload.function

string

required

Entry function id is string representation of a entry function defined on-chain.

Format: {address}::{module name}::{function name}

Both module name and function name are case-sensitive.

Example:

"0x1::aptos_coin::transfer"

payload.type_arguments

string[]

required

Type arguments of the function

Vector type value examples:
  - `vector<u8>`
  - `vector<vector<u64>>`
  - `vector<0x1::coin::CoinStore<0x1::aptos_coin::AptosCoin>>`

Struct type value examples:
  - `0x1::coin::CoinStore<0x1::aptos_coin::AptosCoin>
  - `0x1::account::Account`

Note:
  1. Empty chars should be ignored when comparing 2 struct tag ids.
  2. When used in an URL path, should be encoded by url-encoding (AKA percent-encoding).

payload.arguments

any[]

required

Arguments of the function

signature

object

An enum representing the different transaction signatures available

curl --request POST \
  --url https://aptos-mainnet.s.chainbase.online/{api-key}/v1/transactions \
  --header 'Content-Type: application/json' \
  --data '{
  "sender": "0xc739507214d0e1bf9795485299d709e00024e92f7c0d055a4c2c39717882bdfd",
  "sequence_number": "32425224034",
  "max_gas_amount": "32425224034",
  "gas_unit_price": "32425224034",
  "expiration_timestamp_secs": "32425224034",
  "payload": {
    "type": "entry_function_payload",
    "function": "0x1::aptos_coin::transfer",
    "type_arguments": [
      "<string>"
    ],
    "arguments": [
      "<any>"
    ]
  },
  "signature": {
    "type": "ed25519_signature",
    "public_key": "0xc739507214d0e1bf9795485299d709e00024e92f7c0d055a4c2c39717882bdfd",
    "signature": "0xc739507214d0e1bf9795485299d709e00024e92f7c0d055a4c2c39717882bdfd"
  }
}'

{
  "hash": "<string>",
  "sender": "0xc739507214d0e1bf9795485299d709e00024e92f7c0d055a4c2c39717882bdfd",
  "sequence_number": "32425224034",
  "max_gas_amount": "32425224034",
  "gas_unit_price": "32425224034",
  "expiration_timestamp_secs": "32425224034",
  "payload": {
    "type": "entry_function_payload",
    "function": "0x1::aptos_coin::transfer",
    "type_arguments": [
      "<string>"
    ],
    "arguments": [
      "<any>"
    ]
  },
  "signature": {
    "type": "ed25519_signature",
    "public_key": "0xc739507214d0e1bf9795485299d709e00024e92f7c0d055a4c2c39717882bdfd",
    "signature": "0xc739507214d0e1bf9795485299d709e00024e92f7c0d055a4c2c39717882bdfd"
  }
}

API Reference

Web3 API

SQL API

Submit transaction

Body

Response