Aptos · Example Payload

Get_Account_Transaction_Summaries

Retrieves summaries of on-chain committed transactions (both sequence number based and orderless transactions) from an account. Each transaction summary contains the sender addresss, transaction hash, version, and replay protector. If start_version is provided, the output consists of transaction summaries starting form that version. If start_version is not provided but the end_version is provided, the output consists of transaction summaries ending at the end_version. If both start_version and end_version are not provided, the output consists of the summaries of most recent committed transaction from the account. The output always consists of transaction summaries ordered in ascending order by version. To retrieve a pending transaction, use /transactions/by_hash.

Transactions

Get_Account_Transaction_Summaries is an example object payload from Aptos, with 9 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

methodpathoperationIdsummarydescriptiontagsparametersrequestBodyresponses

Example Payload

{
  "method": "GET",
  "path": "/accounts/{address}/transaction_summaries",
  "operationId": "get_account_transaction_summaries",
  "summary": "Get account transaction summaries",
  "description": "Retrieves summaries of on-chain committed transactions (both sequence number based\nand orderless transactions) from an account.\nEach transaction summary contains the sender addresss, transaction hash, version, and replay protector.\n\nIf start_version is provided, the output consists of transaction summaries starting form that version.\n\nIf start_version is not provided but the end_version is provided, the output consists of transaction summaries\nending at the end_version.\n\nIf both start_version and end_version are not provided, the output consists of the summaries of\nmost recent committed transaction from the account.\n\nThe output always consists of transaction summaries ordered in ascending order by version.\n\nTo retrieve a pending transaction, use /transactions/by_hash.",
  "tags": [
    "Transactions"
  ],
  "parameters": [
    {
      "name": "address",
      "in": "path",
      "required": true,
      "description": "Address of account with or without a `0x` prefix",
      "schema": {
        "$ref": "#/components/schemas/Address"
      }
    },
    {
      "name": "start_version",
      "in": "query",
      "required": false,
      "description": "Transaction version to start list of transactions\n\nIf not provided, defaults to showing the latest transactions",
      "schema": {
        "$ref": "#/components/schemas/U64"
      }
    },
    {
      "name": "end_version",
      "in": "query",
      "required": false,
      "description": "Transaction version to end list of transactions\n\nIf not provided, defaults to showing the latest transactions",
      "schema": {
        "$ref": "#/components/schemas/U64"
      }
    },
    {
      "name": "limit",
      "in": "query",
      "required": false,
      "description": "Max number of transactions to retrieve.\n\nIf not provided, defaults to default page size",
      "schema": {
        "type": "integer",
        "format": "uint16"
      }
    }
  ],
  "requestBody": null,
  "responses": {
    "200": {
      "contentType": "application/json",
      "schema": {
        "type": "array",
        "items": {
          "$ref": "#/components/schemas/TransactionSummary"
        }
      },
      "example": {}
    },
    "400": {
      "contentType": "application/json",
      "schema": {
        "$ref": "#/components/schemas/AptosError"
      },
      "example": {}
    },
    "403": {
      "contentType": "application/json",
      "schema": {
        "$ref": "#/components/schemas/AptosError"
      },
      "example": {}
    },
    "404": {
      "contentType": "application/json",
      "schema": {
        "$ref": "#/components/schemas/AptosError"
      },
      "example": {}
    },
    "410": {
      "contentType": "application/json",
      "schema": {
        "$ref": "#/components/schemas/AptosError"
      },
      "example": {}
    },
    "500": {
      "contentType": "application/json",
      "schema": {
        "$ref": "#/components/schemas/AptosError"
      },
      "example": {}
    },
    "503": {
      "contentType": "application/json",
      "schema": {
        "$ref": "#/components/schemas/AptosError"
      },
      "example": {}
    }
  }
}