bus

Get wallet events

Changed on

Returns all events related to the wallet.

get/bus/wallet/events

Request

  • The document declares no server URL.
  • Auth
    none declared

Query parameters

limitinteger

The maximum number of events to return

offsetinteger

The number of events to skip

Response

Successfully retrieved wallet events

idstring

The event's ID

confirmationsinteger

The number of blocks on top of the block that triggered the creation of this event

type'miner' | 'foundation' | 'siafundClaim' | 'v1Transaction' | 'v1ContractResolution' | 'v2Transaction' | 'v2ContractResolution'

The type of the event

dataobject
maturityHeightinteger

The block height at which the payout matures.

timestampstring date-time

The time the event was created

relevantAddress[]

Example response

[
  {
    "index": {
      "height": 92813
    },
    "maturityHeight": 92813
  }
]

Changes

  • 922f156353c9Revision changes
    • breaking

      removed the media type text/plain for the response with the status

    • info

      api tag bus added

  • 55183a7d2865Revision changes
    • breaking

      the ////////// response's property type changed from object to no type for status

    • warning

      removed the optional property /////////// from the response with the status

    • info

      added subschema #2 to the ////////// response property allOf list for the response status