Wallet service info

This API method is used to get information about the wallet: what cryptocurrencies are supported, payment options for network fees. For example, you may quickly renew data about availability of a particular cryptocurrency from the wallet.

Bitcoin QR code icon

Contents

Request:

Parameters

No parameters.

cURL example

curl 'https://apirone.com/api/v2/wallets' -X OPTIONS

Success Response Reference:

{supported-fee-policies},
string
A list of supported fee policies. You can read more about fee policies here. Required
{currencies},
array of objects
An array containing objects with information about each cryptocurrency. Required

Let's consider separately the parameters of the {currencies} object.

{currencies: name},
string
The full name of the cryptocurrency. For example, "Bitcoin". Required
{currencies: abbr},
string
Cryptocurrency abbreviation. For example, "btc". Required
{currencies: units},
number
The minimal unit used for cryptocurrency. For example, satoshi. Required
{currencies: units-factor},
number
A number indicating the number of digits in the decimal part. For example, 1e-08 means that the currency uses numbers up to 8 characters after the decimal separator. Required
{currencies: address-types},
string
Available types of generated addresses for this cryptocurrency. For example, if you want to receive SegWit addresses in the Bitcoin network, you can take “p2wpkh” type instead of the default type. Required
{currencies: default-address-type},
string
The default type for new addresses. If no type was set when generating the new address, the default type is used. Required
{currencies: minimal-confirmations},
number
The minimum confirmations count to enter the blockchain. This parameter can be used when receiving and processing a callback - you set it in your handler. When minimal confirmations count on the processing side is reached, the transaction is confirmed. Required
{currencies: processing-fee},
number
Processing fee. We recommend that you check the processing fee with a query instead of setting it manually in your applications, as it may change. Required
Response example:
    {
      "supported-fee-policies": 
      [
          "normal",
          "priority",
          "custom"
      ],
      "currencies": [
          {
              "name": "Bitcoin",
              "abbr": "btc",
              "units": "satoshi",
              "units-factor": 1e-08,
              "address-types": [
                  "p2pkh",
                  "p2pkh(c)",
                  "p2wpkh",
                  "p2sh-p2wpkh"
              ],
              "default-address-type": "p2sh-p2wpkh",
              "minimal-confirmations": 1,
              "processing-fee": 10000,
              "fee-free-limit": 50000
          },
          {
              "name": "Bitcoin (testnet)",
              "abbr": "tbtc",
              "units": "satoshi",
              "units-factor": 1e-08,
              "address-types": [
                  "p2pkh",
                  "p2pkh(c)",
                  "p2wpkh",
                  "p2sh-p2wpkh"
              ],
              "default-address-type": "p2sh-p2wpkh",
              "minimal-confirmations": 1,
              "processing-fee": 10000,
              "fee-free-limit": 50000
          },
          {
              "name": "Litecoin",
              "abbr": "ltc",
              "units": "satoshi",
              "units-factor": 1e-08,
              "address-types": [
                  "p2pkh",
                  "p2pkh(c)",
                  "p2wpkh",
                  "p2sh-p2wpkh"
              ],
              "default-address-type": "p2pkh",
              "minimal-confirmations": 1,
              "processing-fee": 125000,
              "fee-free-limit": 750000
          },
          {
              "name": "Bitcoin Cash",
              "abbr": "bch",
              "units": "satoshi",
              "units-factor": 1e-08,
              "address-types": [
                  "p2pkh"
              ],
              "default-address-type": "p2pkh",
              "minimal-confirmations": 1,
              "processing-fee": 100000,
              "fee-free-limit": 500000
          },
          {
              "name": "Dogecoin",
              "abbr": "doge",
              "units": "satoshi",
              "units-factor": 1e-08,
              "address-types": [
                  "p2pkh"
              ],
              "default-address-type": "p2pkh",
              "minimal-confirmations": 1,
              "processing-fee": 300000000,
              "fee-free-limit": 1000000000
          }
      ]
  }
    
  

Error Response: