Wallet addresses

Shows a list of all wallet addresses, using page navigation. Contains short information about each address.

Bitcoin QR code icon

Contents

Request:

Parameters

{WalletID},
string
Wallet Identificator. Required
{limit},
integer
Maximum number of transactions displayed on the page, Default value: 10. Optional
{offset},
integer
Sequential number of the element from which the counting starts Default value: 0. Optional
{q},
string
Filter items by specific criteria (address, balance). 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}:

address:35Gnk75DbehHXkshBX1QzpKdq4AJDW6KKv,empty:false

Contains the following options:

{q: address}
Cryptocurrency address (or part of it). Optional
{q: empty}
When false, addresses with zero total balance are excluded from the server response. Takes the only false value. Optional
Sample request:

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

Success Response Reference:

{wallet},
string
Wallet Identifier. Wallet contains cryptocurrency addresses. Required
{addresses},
array
An array containing information about addresses. Required
{pagination},
array
Page array. Optional

{addresses} contains the following data:

{wallet},
string
Wallet Identifier to which the address is assigned. Required
{address},
string
Cryptocurrency address. Required
{type},
string
Address type in the network. For example, in the Bitcoin network the default address type is p2sh-p2wpkh. Required
{created},
string
Address creation date.
Contains the full date, hours, minutes, seconds, decimal part of seconds: yyyy-mm-ddTh:mm:ss.s
Required
{balance},
array
Contains information about the current balance of the address:
available - the amount available for payment
total - shows the entire balance of the address, including the one that cannot be used at the moment due to pending transaction confirmation or for other reasons.
Required

Pagination {pagination}:

{pagination: total}
Total number of pages. Required
{pagination: offset}
The sequence number of the element from which the counting starts. Required
{pagination: limit}
Number of items displayed per page. Optional
Response example:
    {
      "wallet": "btc-c70afacf0b7d7808e8be36bfd7ceed71",
      "addresses": [ {
        "wallet": "btc-c70afacf0b7d7808e8be36bfd7ceed71",
        "address": "35Gnk75DbehHXkshBX1QzpKdq4AJDW6KKv",
        "type": "p2sh-p2wpkh",
        "created": "2021-01-12T18:14:55.664397",
        "balance": {
          "available": 115182,
          "total": 115182
        }
      } ],
      "pagination": {
        "total": 24,
        "offset": 0,
        "limit": 10
      }
    }
    
  

Error Response: