bus

Get wallet events

Returns all events related to the wallet.

get/bus/wallet/events

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

Changed in 5 of the 50 revisions of this API.585

  • 922f156353c911See the full diff
    • removed the media type text/plain for the response with the status 500

      response-media-type-removed

    • api tag bus added

      api-tag-added

  • 55183a7d2865111See the full diff
    • the items/index/allOf[ChainIndex]/id/allOf[BlockID]/ response's property type/format changed from object/ to / for status 200

      response-property-type-changed

    • removed the optional property items/index/allOf[ChainIndex]/id/allOf[BlockID]/id from the response with the 200 status

      response-optional-property-removed

    • added Hash256 subschema #2 to the items/index/allOf[ChainIndex]/id/allOf[BlockID]/ response property allOf list for the response status 200

      response-property-all-of-added

  • 719a1b5e14dd272See the full diff
    • the items/index/allOf[ChainIndex]/height response's property type/format changed from integer/uint64 to / for status 200

      response-property-type-changed

    • the items/maturityHeight response's property type/format changed from integer/uint64 to / for status 200

      response-property-type-changed

    • added the new foundation enum value to the items/type response property for the response status 200

      response-property-enum-value-added

    • added the new miner enum value to the items/type response property for the response status 200

      response-property-enum-value-added

    • added the new siafundClaim enum value to the items/type response property for the response status 200

      response-property-enum-value-added

    • added the new v1ContractResolution enum value to the items/type response property for the response status 200

      response-property-enum-value-added

    • added the new v1Transaction enum value to the items/type response property for the response status 200

      response-property-enum-value-added

    • added the new v2ContractResolution enum value to the items/type response property for the response status 200

      response-property-enum-value-added

    • added the new v2Transaction enum value to the items/type response property for the response status 200

      response-property-enum-value-added

    • added BlockHeight subschema #2 to the items/index/allOf[ChainIndex]/height response property allOf list for the response status 200

      response-property-all-of-added

    • added BlockHeight subschema #2 to the items/maturityHeight response property allOf list for the response status 200

      response-property-all-of-added

    • endpoint added

      endpoint-added

    • api path removed without deprecation

      api-path-removed-without-deprecation

    This revision also has 99 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog