API Reference

Simulate transaction

post
https://aptos-mainnet.s.chainbase.online/{api-key}/v1/transactions/simulate

The output of the transaction will have the exact transaction outputs and events that running
an actual signed transaction would have. However, it will not have the associated state
hashes, as they are not updated in storage. This can be used to estimate the maximum gas
units for a submitted transaction.

To use this, you must:

  • Create a SignedTransaction with a zero-padded signature.
  • Submit a SubmitTransactionRequest containing a UserTransactionRequest containing that signature.

To use this endpoint with BCS, you must submit a SignedTransaction
encoded as BCS. See SignedTransaction in types/src/transaction/mod.rs.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
boolean

If set to true, the max gas value in the transaction will be ignored
and the maximum possible gas will be used

boolean

If set to true, the gas unit price in the transaction will be ignored
and the estimated value will be used

boolean

If set to true, the transaction will use a higher price than the original
estimate.

Body Params

A request to submit a transaction

This requires a transaction and a signature of it

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.

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.

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.

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.

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.

payload
required

An enum of the possible transaction payloads

signature
required

An enum representing the different transaction signatures available

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
string
enum
Defaults to application/json

Generated from available request content types

Allowed:
Responses

Updated about 3 years ago

Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/x-bcs

Updated about 3 years ago