Skip to main content
GET
/
api
/
v1
/
wallet
/
history
Get wallet history
curl --request GET \
  --url https://api.example.com/api/v1/wallet/history
[
  {
    "effective_balance_sat": 123,
    "exited_vtxos": [
      "<string>"
    ],
    "id": 1,
    "input_vtxos": [
      "<string>"
    ],
    "intended_balance_sat": 123,
    "offchain_fee_sat": 1,
    "output_vtxos": [
      "<string>"
    ],
    "received_on": [
      {
        "amount_sat": 1,
        "destination": {
          "type": "ark",
          "value": "<string>"
        }
      }
    ],
    "sent_to": [
      {
        "amount_sat": 1,
        "destination": {
          "type": "ark",
          "value": "<string>"
        }
      }
    ],
    "status": "pending",
    "subsystem": {
      "kind": "<string>",
      "name": "<string>"
    },
    "time": {
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "completed_at": "2023-11-07T05:31:56Z"
    },
    "metadata": {}
  }
]

Response

Returns the wallet history

​
effective_balance_sat
integer<int64>
required

How much the wallet balance actually changed by. Positive numbers indicate an increase and negative numbers indicate a decrease. This is often inclusive of applicable fees, and it should be the most accurate number.

​
exited_vtxos
string[]
required

A list of IDs for VTXOs that were marked for unilateral exit as a result of this movement. This could happen for many reasons, e.g. an unsuccessful lightning payment which can't be revoked but is about to expire. VTXOs listed here will result in a reduction of spendable balance due to the VTXOs being managed by the [bark::exit::Exit] system.

​
id
integer<int32>
required

The internal ID of the movement.

Required range: x >= 0
​
input_vtxos
string[]
required

A list of Vtxo IDs that were consumed by this movement and are either locked or unavailable.

​
intended_balance_sat
integer<int64>
required

How much the movement was expected to increase or decrease the balance by. This is always an estimate and often discounts any applicable fees.

​
offchain_fee_sat
integer<int64>
required

How much the movement cost the user in offchain fees. If there are applicable onchain fees they will not be included in this value but, depending on the subsystem, could be found in the metadata.

Required range: x >= 0
​
output_vtxos
string[]
required

A list of IDs for new VTXOs that were produced as a result of this movement. Often change VTXOs will be found here for outbound actions unless this was an inbound action.

​
received_on
object[]
required

Describes the means by which the wallet received funds in this movement. This could include BOLT11 invoices or other useful data.

​
sent_to
object[]
required

A list of external recipients that received funds from this movement.

​
status
enum<string>
required

The status of the movement.

Available options:
pending,
successful,
failed,
canceled
​
subsystem
object
required

Contains information about the subsystem that created the movement as well as the purpose of the movement.

​
time
object
required

Contains the times at which the movement was created, updated and completed.

​
metadata
object

Miscellaneous metadata for the movement. This is JSON containing arbitrary information as defined by the subsystem that created the movement.