Wallet history

View your wallet's transaction history, including the abilities to filter by address, transfer date (calendar period) and type (payment or receipt).

Bitcoin QR code icon

Contents

Request:

Parameters

{WalletID}, string Wallet Identificator. Required
{limit}, integer The maximum number of transactions displayed on the page. Default value: 10. Optional
{offset}, integer The sequence number of the item from which the counting starts. Default value: 0. Optional
{q}, string Contains a list of filter variables: address, transfer type, calendar date range. Optional

The filter {q} is assembled into a string by simply listing the variables in the string, separated by commas. A colon is used as a separator between the parameter name and the value.

Example of {q} string:

item_type:receipt,address:35Gnk75DbehHXkshBX1QzpKdq4AJDW6KKv,date_from:2021-02-01T00:00:01+01:00,date_to:2021-03-01T23:59:59+01:00

Filters included in {q}:

{filter: address},
string
Part or all of the crypto-address. Required
{filter: date_from},
string
The start date of the calendar period in which the transfer occurred. Contains the full date, hours, minutes, seconds, decimal part of seconds: yyyy-mm-ddTh:mm:ss.s Date example: 2021-01-01T23:59:59+04:00 Required
{filter: date_to},
string
The end date of the calendar period. Same as {filter: date_from}. Optional
{filter: item_type},
string
Data type: “payment” or “receipt”. Optional
Request Example:

curl 'https://apirone.com/api/v2/wallets/btc-c70afacf0b7d7808e8be36bfd7ceed71/history?limit=10&offset=0'

Request example with filtering by time interval and item type:

curl 'https://apirone.com/api/v2/wallets/btc-c70afacf0b7d7808e8be36bfd7ceed71/history?limit=10&offset=0&q=date_from:2021-01-01T00:00:01+04:00,date_to:2021-01-31T23:59:59+04:00,item_type:payment'

Payments and receipts:

The Apirone service provides two types of such items - payments and receipts.
Payment is an element created as a result of transferring funds from a wallet. It combines all blockchain transactions of this payment and contains detailed information about fees and recipients.
Receipt - incoming transfer, which shows a new arrival to the wallet.

Success Response Reference:

{wallet},
string
Wallet ID. The wallet contains cryptocurrency addresses. Required
{items},
array of objects
Elements array. Required
{pagination},
array
Array (list) of pages. Optional

Element {items}:

{items: date},
string
Date of the transfer. Required
{items: type},
string
Transfer type: payment or receipt. Required
{items: txs},
string
Transaction identifier. Optional
{items: id},
string
Payment or receipt identifier. Optional
{items: is_confirmed},
boolean
Element indicating transaction confirmation: true - if the transaction is confirmed false - if the transaction is not confirmed. Optional
{items: amount},
integer
Transfer amount. Optional

Pagination {pagination}:

{pagination: total},
integer
Total number of pages. Required
{pagination: offset},
integer
The sequence number of the element from which the counting starts. Required
{pagination: limit},
integer
Number of pages displayed per page. Optional
Success example with payment type ”Payment”:
    {
      "wallet": "btc-c70afacf0b7d7808e8be36bfd7ceed71",
      "items": [ 
        {
          "date": "2021-01-12T18:15:10.237846",
          "type": "payment",
          "txs": [
            "48563c8ad8339798bc0f6d7ee0fe3f42f5721e5f989269d035ba9be0e2fd8658"
          ],
          "id": "9a5a81bcaeec9dd361bfbbdeb768d35027392301fb61b876f638f08ad58a647f",
          "is_confirmed": true,
          "amount": -10165
        }
      ],
      "pagination": {
        "total": 14,
        "offset": 0,
        "limit": 10
      }
    }
    
  
Success example with payment type ”Receipt”:
    {
      "wallet": "btc-c70afacf0b7d7808e8be36bfd7ceed71",
      "items": [
      {
        "date": "2021-02-03T18:17:50.450469",
        "type": "receipt",
        "id": "bd1e0268f5e482146a7f672d37f2936c93088e499adbd0f428561321f48f2b97",
        "is_confirmed": true,
        "amount": 100000
      },
      {
        "date": "2021-02-02T06:20:01.623701",
        "type": "payment",
        "id": "6cc5842c7a2d9c236721726311a32ceb124f83c4553b999ae2bdda8c8cc43359",
        "is_confirmed": true,
        "amount": -10165
      },
      ... ],
      "pagination": {
        "total": 9,
        "offset": 0,
        "limit": 10
      }
    }
    
  

Error Response: