Transaction Request
The Transaction API endpoint (try it out here) receives a raw Transaction object containing the following fields:
| Field | Type | Notes |
|---|---|---|
from | string | (Required) The address of the transaction sender |
to | string | (Optional) The address of the transaction recipient. This can be empty only for contract creation transactions. |
data | string | (Optional) Transaction calldata in hex. |
value | string | (Optional) Transaction value in wei (hex). Leaving this empty is the same as setting to zero (0x0). |
gasLimit | string | (Optional) Maximum gas to be used by the transaction (hex). Computed automatically if left empty. |
gas | string | (Optional) Same as gasLimit, used interchangeably. |
gasPrice | string | (Optional) Gas price in wei (hex). Computed automatically if left empty. |
url | string | (Optional) URL of the website or dapp that originated the transaction. Used for risk assessment. |
Transaction Response
The Transaction API endpoint returns an object containing the following fields.
Base response Fields: these fields are present on both Transaction and Signature API responses.
| Field | Type | Notes |
|---|---|---|
summary | string | Required. A one-sentence summary of this transaction. |
risk | RiskResult | Required. Results of risk evaluation |
assetChanges | AssetChange[] | Required. List of assets leaving or entering the signer's wallet |
errors | string[] | Optional. List of error messages. Present if any errors were encountered. |
Transaction-specific response fields: these fields are present only on Transaction API responses.
| Field | Type | Notes |
|---|---|---|
transactionType | TransactionType | Required. Transaction type string enum |
functionType | FunctionType | Optional. Function type string enum, present if transaction is a contract interaction. |
contract | Contract | Optional. Details of contract, present if transaction is contract interaction. |
function | Function | Optional. Function arguments, present if transaction is contract interaction. |