# Account

An Apirone account is a powerful multi-currency tool designed to:

create as many addresses as you wish in any cryptocurrency we support,
accept and transfer crypto,
generate invoices for your clients,
estimate network fees.

# Create Account

# Request

HTTP Method: POST
Content Type: application/json
URL: https://apirone.com/api/v2/accounts

# Request example

curl -X POST 'https://apirone.com/api/v2/accounts'

# Success Response Reference

Parameter	Type	Description
`account`	string	Account Identifier. Account contains crypto currencies supported by service
`created`	string	Account creation date. Contains the full date, hours, minutes, seconds, decimal part of seconds in ISO-8601 (opens new window) format, for example, 2022-10-13T00:00:01.
`transfer-key`	string	Account Key for accessing protected endpoints and payment transfer

# Response example

{
    "account": "apr-f9e1211f4b52a50bcf3c36819fdc4ad3",
    "created": "2021-11-03T11:03:55.083199",
    "transfer-key": "4sSm9aeXQiqMBmeEs42NTjZidJuGrqm7"
}

# Error response

HTTP Status Code: 400 500
Content Type: application/json

Playground

# Account Info

Gets information about the account.

# Request

HTTP Method: GET
Content Type: application/json
URL: https://apirone.com/api/v2/accounts/{account}

Parameter	Type	Description	Required
`account`	string	Account Identifier	✓
`currency`	string	Cryptocurrency (btc, ltc, bch, doge, trx, usdt@trx, usdc@trx) supported by the Apirone service. This query parameter is optional. By default, the response contains information for all supported currencies in the Apirone account. Parameter currency is specified to display information for the selected currency

# Request example

curl 'https://apirone.com/api/v2/accounts/apr-e729d9982f079fa86b10a0e3aa6ff37b'

# Success Response Reference

Parameter	Type	Description
`account`	string	Account Identifier
`info`	array	Array including parameters: currency, account created date, units, destinations, fee
`currency`	string	Currency type
`created`	string	Account creation date Contains the full date, hours, minutes, seconds, decimal part of seconds in ISO-8601 (opens new window) format, for example, 2022-10-13T00:00:01
`units`	string	Cryptocurrency units
`fee`	string	Network fee strategy. Can take the value "normal", "priority" or "custom". More information about Network fee
`processing-fee-policy`	string	Processing fee plan. `Processing-fee-policy` may be `fixed` or `percentage`. You can change processing fee policy in Settings More information see on Pricing page (opens new window) or Service info
`destinations`	array	The array of objects consisting of destination addresses and amounts
`destination_rules`	array	The array of auto transfer rules

# Response example

{
    "account": "apr-e729d9982f079fa86b10a0e3aa6ff37b",
    "info": [
        {
            "currency": "btc",
            "created": "2024-07-22T08:18:41.943352",
            "units": "satoshi",
            "fee": "normal",
            "processing-fee-policy": "percentage",
            "destinations":  [
                  {
                     "address": "3N1nvw5pTR9wEZSq1GcJJjt7dXi2AUtp1Rn",
                     "amount": "100%"
                  }
            ],
            "destination_rules": null
        },
        {
            "currency": "ltc",
            "created": "2024-07-22T08:18:41.943352",
            "units": "satoshi",
            "fee": "normal",
            "processing-fee-policy": "fixed",
            "destinations": null,
            "destination_rules": null
        },
        {
            "currency": "doge",
            "created": "2024-07-22T08:18:41.943352",
            "units": "satoshi",
            "fee": "normal",
            "processing-fee-policy": "fixed",
            "destinations": null,
            "destination_rules": null
        },
        {
            "currency": "bch",
            "created": "2024-07-22T08:18:41.943352",
            "units": "satoshi",
            "fee": "normal",
            "processing-fee-policy": "fixed",
            "destinations": null,
            "destination_rules": null
        },
        {
            "currency": "trx",
            "created": "2024-07-22T08:18:41.943352",
            "units": "sun",
            "fee": "normal",
            "processing-fee-policy": "fixed",
            "destinations": null,
            "destination_rules": null
        },
        {
            "currency": "usdt@trx",
            "created": "2024-07-22T08:18:41.943352",
            "units": "",
            "fee": "normal",
            "processing-fee-policy": "fixed",
            "destinations": null,
            "destination_rules": null
        },
      {
            "currency": "usdc@trx",
            "created": "2024-07-22T08:18:41.943352",
            "units": "",
            "fee": "normal",
            "processing-fee-policy": "fixed",
            "destinations": null,
            "destination_rules": null
        }
    ]
}

# Error response

HTTP Status Code: 400 500
Content Type: application/json

Playground

# Account Balance

Checks account balance.

# Request

HTTP Method: GET
URL: https://apirone.com/api/v2/accounts/{account}/balance

Parameter	Type	Description	Required
`account`	string	Account Identifier	✓
`currency`	string	Currency type (btc, ltc, bch, doge, trx, usdt@trx, usdc@trx) supported by service
`addresses`	string	Optional parameter for checking balance of specified address or multiple comma separated addresses. In this case, parameter `currency` is required

# Request Example

curl 'https://apirone.com/api/v2/accounts/apr-e729d9982f079fa86b10a0e3aa6ff37b/balance?currency=btc&addresses=3JH4GWtXNz7us8qw1zAtRr4zuq2nDFXTgu,3BwabT7SqorT2u3QCtTso3AHn9ayTE2mqT'

# Success Response Reference

HTTP Status Code: 200
Content Type: application/json

Parameter	Type	Description
`currency`	string	Currency type
`available`	integer	Available account balance
`total`	integer	Current account balance

# Response example

  {
    "account": "apr-e729d9982f079fa86b10a0e3aa6ff37b",
    "balance": [
      {
        "currency": "btc",
        "available": 0,
        "total": 0
      }
    ]
  }

# Error Response

HTTP Status Code: 400 500
Content type: application/json

Playground

# Generate Address

Creates unique crypto addresses in the account using provided currency.

# Request

HTTP Method: POST
Content Type: application/json
URL: https://apirone.com/api/v2/accounts/{account}/addresses

Parameter	Type	Description	Required
`account`	string	Account Identifier	✓
`currency`	string	Currency type (btc, ltc, bch, doge, trx, usdt@trx, usdc@trx) supported by service	✓
`addr-type`	string	Address type. More information about address types for all cryptocurrencies in Apirone service see here
`callback`	object	Callback url and data

Callback is an object of a callback URL, HTTP method, and user's defined data parameters.

Parameter	Type	Description	Required
`url`	string	Callback URL Сustomer callback URL to receive data about the payment. This must be a valid URL	✓
`data`	object	Data The object is based on key-value pairs. Some additional information that will be transmitted with the callback

# Request example

curl -X POST 'https://apirone.com/api/v2/accounts/apr-e729d9982f079fa86b10a0e3aa6ff37b/addresses' \
-H 'Content-Type: application/json' \
-d '{
        "currency": "btc",
        "callback": {
            "method": "POST",
            "url": "http://example.com/callback",
            "data": {
                "id": "1"
            }
        }
    }'

# Success Response Reference

Parameter	Type	Description
`account`	string	Account Identifier
`currency`	string	Currency type
`address`	string	The generated crypto address to receive a payment from a customer
`created`	string	Address creation date. Address creation date. Contains the full date, hours, minutes, seconds, decimal part of seconds in ISO-8601 (opens new window) format, for example, 2022-10-13T00:00:01
`type`	string	Address type
`callback`	object	Callback url and data

# Response example

{
    "account": "apr-e729d9982f079fa86b10a0e3aa6ff37b",
    "currency": "btc",
    "address": "3N3KxGnfcnkw7KcxeaxbBUYCUdMoYyA6vdX",
    "created": "2021-11-04T08:38:33.389076",
    "type": "p2sh-p2wpkh",
    "callback": {
        "method": "POST",
        "url": "http://example.com/callback",
        "data": {
            "id": "1"
        }
    }
}

# Error Response

HTTP Status Code: 400 500
Content type: application/json

Playground

# Address Info

Gets information about an address.

# Request

HTTP Method: GET
URL: https://apirone.com/api/v2/accounts/{account}/addresses/{address}

Parameter	Type	Description	Required
`account`	string	Account Identifier	✓
`address`	string	Cryptocurrency address	✓
`currency`	string	Currency type (btc, ltc, bch, doge, trx, usdt@trx, usdc@trx) supported by service. This parameter is required for usdt@trx, usdc@trx addresses

# Request example

curl 'https://apirone.com/api/v2/accounts/apr-e729d9982f079fa86b10a0e3aa6ff37b/addresses/3JH4GWtXNz7us8qw1zAtRr4zuq2nDFXTgu'

# Success Response Reference

Parameter	Type	Description
`account`	string	Account Identifier
`currency`	string	Currency type
`address`	string	Cryptocurrency address
`type`	string	Address type
`created`	string	Address creation date Contains the full date, hours, minutes, seconds, decimal part of seconds in ISO-8601 (opens new window) format, for example, 2022-10-13T00:00:01
`balance`	object	Information about the current balance of the address: available - the amount available for payment total - the entire balance of the address, including the one that cannot be used at the moment due to waiting for confirmation or for other reasons

# Response example

{
    "account": "apr-e729d9982f079fa86b10a0e3aa6ff37b",
    "currency": "btc",
    "address": "3JH4GWtXNz7us8qw1zAtRr4zuq2nDFXTgu",
    "type": "p2sh-p2wpkh",
    "created": "2021-12-16T11:53:14.691862",
    "balance": {
        "available": 100000,
        "total": 100000
    }
}

# Error response

HTTP Status Code: 400 500
Content Type: application/json

Playground

# Address Balance

Gets balance of a specified address.

# Request

HTTP Method: GET
Content Type: application/json
URL: https://apirone.com/api/v2/accounts/{account}/addresses/{address}/balance

Parameter	Type	Description	Required
`account`	string	Account Identifier	✓
`address`	string	Cryptocurrency address	✓
`currency`	string	Currency type (btc, ltc, bch, doge, trx, usdt@trx, usdc@trx) supported by service. This parameter is required for usdt@trx, usdc@trx addresses

# Request Example

curl 'https://apirone.com/api/v2/accounts/apr-e729d9982f079fa86b10a0e3aa6ff37b/addresses/3JH4GWtXNz7us8qw1zAtRr4zuq2nDFXTgu/balance'

# Success Response Reference

HTTP Status Code: 200
Content Type: application/json

Parameter	Type	Description
`account`	string	Account Identifier
`currency`	string	Currency type
`address`	string	Cryptocurrency address
`available`	integer	Available address balance
`total`	integer	Current address balance

# Response example

{
    "account": "apr-e729d9982f079fa86b10a0e3aa6ff37b",
    "currency": "btc",
    "address": "3JH4GWtXNz7us8qw1zAtRr4zuq2nDFXTgu",
    "available": 100000,
    "total": 100000
}

# Error Response

HTTP Status Code: 400 500
Content type: application/json

Playground

# Account Addresses

Shows a list of all the account addresses, depending on the provided currency. Contains short information about each address.

# Request

HTTP Method: GET
URL: https://apirone.com/api/v2/accounts/{account}/addresses

Parameter	Type	Description	Required
`account`	string	Account Identifier	✓
`currency`	string	Currency type (btc, ltc, bch, doge, trx, usdt@trx, usdc@trx) supported by service	✓
`limit`	integer	Maximum number of addresses returned by response. Default value: 10
`offset`	integer	Sequential number of the element from which the counting starts Default value: 0
`q`	string	Filter items by specific criteria

The filter q is assembled into a string by bare listing of 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:3BntRGKDUxxSjnFjfzDNeAziAgUtGhbkcF,empty:false

Can contain the following options:

Parameter	Description
`address`	Cryptocurrency address (or part of it)
`empty`	When false, addresses with zero total balance are excluded from the server response. Takes the only false value

# Request Example

curl 'https://apirone.com/api/v2/accounts/apr-e729d9982f079fa86b10a0e3aa6ff37b/addresses?currency=btc&q=empty:false,address:3JH4GWtXNz7us8qw1zAtRr4zuq2nDFXTgu'

# Success Response Reference

HTTP Status Code: 200
Content Type: application/json

Parameter	Type	Description
`account`	string	Account Identifier
`addresses`	array	An array containing information about addresses
`pagination`	object	Pagination info

addresses contains the following data:

Parameter	Type	Description
`address`	string	Cryptocurrency address
`currency`	string	Currency type
`type`	string	Address type
`created`	string	Address creation date. Timestamp when the account was created (UTC date, ISO-8601 (opens new window) format, for example, 2022-10-13T00:00:010 )
`balance`	object	Information about the current balance of the address: available - the amount available for payment; total - 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.

Elements pagination:

Parameter	Description
`total`	Total number of addresses
`offset`	The sequence number of the element from which the counting starts. Default value: 0
`limit`	Maximum number of items that request will return. Default value: 10

# Response example

  {
    "account": "apr-e729d9982f079fa86b10a0e3aa6ff37b",
    "currency": "btc",
    "addresses": [
        {
            "address": "3JH4GWtXNz7us8qw1zAtRr4zuq2nDFXTgu",
            "type": "p2sh-p2wpkh",
            "created": "2021-11-04T15:08:25.078103",
            "balance": {
                "available": 1218381,
                "total": 1218381
            }
        }
    ],
    "pagination": {
        "total": 23,
        "offset": 0,
        "limit": 10
    }
  }

# Error Response

HTTP Status Code: 400 500
Content Type: application/json

Playground

# Estimation

Estimates a transaction before sending. It allows finding out the amounts of network and processing fees and checks the destinations of transfer in advance. The processing fee is calculated according to the fee plan chosen (opens new window).

# Request

HTTP Method: GET
URL: https://apirone.com/api/v2/accounts/{account}/transfer

Parameter	Type	Description	Required
`account`	string	Account Identifier	✓
`currency`	string	Currency type (btc, ltc, bch, doge, trx, usdt@trx, usdc@trx) supported by service	✓
`destinations`	array	Comma separated address and colon separated amount pairs. An amount can be integer or percentage. If amount is integer it is specified in minor currency units (e.g. 0.005 BTC shall be specified as 500,000, e.g. for usdt@trx 50 usd shall be specified as 50,000000). e.g.,`destinations=3N2aXAebXqvV8TDXBabknmi9Gma7HxeMDdZ:10000,3BntRGKDUxxSjnFjfzDNeAziAgUtGhbkcF:50%`	✓
`fee`	string	Network fee strategy. Can take the value "normal", "priority" (Network Fee) or "custom". With a custom fee strategy you can specify a network fee using the additional field `fee-rate`
`addresses`	string	Optional parameter for estimation of a transfer from specified address or multiple comma separated addresses

# Request Example

curl 'https://apirone.com/api/v2/accounts/apr-e729d9982f079fa86b10a0e3aa6ff37b/transfer?currency=btc&destinations=3N2aXAebXqvV8TDXBabknmi9Gma7HxeMDdZ:100%&fee=normal&subtract-fee-from-amount=true&addresses=3JH4GWtXNz7us8qw1zAtRr4zuq2nDFXTgu,3BwabT7SqorT2u3QCtTso3AHn9ayTE2mqT'

# Success Response Reference

Parameter	Type	Description
`account`	string	Account Identifier
`currency`	string	Currency type
`destinations`	array	Destinations array. If a value of all destinations' amounts exceeds the free limit (opens new window), then a commission address is added to the destination array
`amount`	integer	Transfer amount. The amount is indicated in minor units
`total`	integer	Total amount of transfer. Includes the amount of all fees and the amount of transfer
`fee`	object	Network fee strategy

Network fee is an object consisting of the following parameters:

Parameter	Type	Description
`subtract-from-amount`	boolean	Indicates whether the fee was charged proportionally from the final transfer amounts
`network`	object	Network fee data: strategy - strategy of the fee choice, amount - amount of fee; rate - the rate by which the cryptocurrency network's fee was calculated. (learn more)

# Response example

{
    "account": "apr-e729d9982f079fa86b10a0e3aa6ff37b",
    "currency": "btc",
    "destinations": [
        {
            "address": "3MdDCprfFhBv17GfcEp3YZXHZjnWYcUuNv",
            "amount": 50000
        },
        {
            "address": "3N6aXAebXqvV8TDXBabknmi9Gma7HxeMDdZ",
            "amount": 2183465
        }
    ],
    "amount": 2233465,
    "total": 2233630,
    "fee": {
        "subtract-from-amount": true,
        "processing": {
            "address": "3MdDCprfFhBv17GfcEp3YZXHZjnWYcUuNv",
            "amount": 50000
        },
        "network": {
            "strategy": "normal",
            "amount": 165,
            "rate": 1.0
        }
    }
}

# Error Response

HTTP Status Code: 400 500
Content type: application/json

Playground

# Transfer

Sends currency amount or percentage from the balance in the provided currency. Authorization is required. The processing fee is calculated according to the fee plan chosen (opens new window).

Note: Payment processing fees will be subtracted at the moment of transfer, according to the fee plan chosen (opens new window).

# Request

HTTP Method: POST
Content Type: application/json
URL: https://apirone.com/api/v2/accounts/{account}/transfer

Parameter	Type	Description	Required
`account`	string	Account Identifier	✓
`transfer-key`	string	Key for payment transfer	*
`currency`	string	Currency type (btc, ltc, bch, doge, trx, usdt@trx, usdc@trx) supported by service	✓
`addresses`	array	Optional parameter for transfer from specified addresses only (comma separated)
`destinations`	array	The array of objects of destination addresses and amounts. An amount can be integer or percentage. More information here	✓
`subtract-fee-from-amount`	boolean	If it takes "true", the fee will be proportionally subtracted from each destination's amount
`fee`	string	Network fee strategy
`fee-rate`	integer	The parameter is only used when "custom" is set to `fee`. It's used to set the value of the network fee

* transfer-key is required unless access token is applied

# Destinations [array]

Parameter	Type	Description	Required
`address`	string	Destination(s) crypto address(es) for payment	✓
`amount`	integer/string	Destination addresses shall either have amounts specified in integer or percentage values. The amount is indicated in minor currency units (e.g. 0.005 BTC shall be specified as 500,000, e.g. for usdt@trx: 50 usd shall be specified as 50,000000). e.g.,`38cSD2nhmfVbXb9gRu8qVcLtyW6q8NVLQb:500000`	✓

# Request Example

curl -X POST 'https://apirone.com/api/v2/accounts/apr-e729d9982f079fa86b10a0e3aa6ff37b/transfer' \
-H 'Content-Type: application/json' \
-d '{
    "currency": "btc",
    "transfer-key": "82ookirnTwWNXXqFwdOQMVZIamt8s1uT",
    "addresses": [
        "3JH4GWtXNz7us8qw1zAtRr4zuq2nDFXTgu",
        "3BwabT7SqorT2u3QCtTso3AHn9ayTE2mqT"
   ],
    "destinations": [
        {
            "address": "3MzEcYvGbWZNCt83AizrmeQkjr1iHE6xrMm",
            "amount": 10000
        }
    ],
    "fee": "normal",
    "subtract-fee-from-amount": true
    }'

# Success Response Reference

HTTP Status Code: 200
Content Type: application/json

Parameter	Type	Description
`account`	string	Account Identifier
`currency`	string	Currency type
`created`	string	Item creation date
`type`	string	Item type (payment)
`id`	string	Payment Id
`txs`	array	The array of transactions hash
`destinations`	array	Destinations array. If a value of all destinations' amounts exceeds the free limit (opens new window), then a commission address is added to the destination array
`amount`	integer	Transfer amount
`total`	integer	Total amount of transfer. Includes the amount of transfer and the amount of all the fees
`fee`	object	Information about the network fee see here
`change-address`	string	If sent transaction has a change, then the latter will be sent to the new wallet address

Network fee is an object consisting of the following parameters:

Parameter	Type	Description
`subtract-from-amount`	boolean	Indicates whether the fee was charged proportionally from the final transfer amounts
`network`	object	Network fee data: amount - amount of fee; rate - the rate by which the cryptocurrency network's fee was calculated; strategy - strategy for the fee choice, see more

# Response example

{
    "account": "apr-e729d9982f079fa86b10a0e3aa6ff37b",
    "currency": "btc",
    "created": "2021-12-10T14:04:15.102174",
    "type": "payment",
    "id": "5fe79fb866bb3b9b297f3935f6ab1b029f74d59629a19a8c028812d26642b108",
    "txs": [
        "0dcb43459dd8895c935f43a756ed14c56cddfc79bf5a82a508f94418514b9393"
    ],
    "destinations": [
        {
            "address": "3MzEcYvGbWZNCt83AizrmeQkjr1iHE6xrMm",
            "amount": 9744
        }
    ],
    "amount": 9744,
    "total": 10000,
    "fee": {
        "subtract-from-amount": true,
        "network": {
            "strategy": "normal",
            "amount": 256,
            "rate": 1.0
        }
    },
    "change-address": "3Mzma4RhoZVh2Y3D7hkGQHi797TTq43eMHc"
}

# Error Response

HTTP Status Code: 400 500
Content Type: application/json

Playground

# Account History

Allows viewing the account's transaction history, including the opportunity to filter by transfer type, address, and transfer date.

Note: All transactions are transparent and synchronized with the blockchain network.

# Request

HTTP Method: GET
URL: https://apirone.com/api/v2/accounts/{account}/history

Parameter	Type	Description	Required
`account`	string	Account Identifier	✓
`currency`	string	Currency type (btc, ltc, bch, doge, trx, usdt@trx, usdc@trx) supported by service
`q`	string	Contains a list of filter variables: address, transfer type, calendar period
`limit`	integer	The maximum number of transactions displayed on the page. Default value: 10
`offset`	integer	The sequence number of the item from which the counting starts. Default value: 0

Filters can be included in q:

Parameter	Type	Description
`address`	string	The whole or the part of a crypto address
`date-from`	string	The start date of the calendar period in which the transfer occurred. Contains the full date in ISO-8601 (opens new window), for example, 2022-10-13T00:00:01
`date-to`	string	The end date of the calendar period. It is the full date in ISO-8601 (opens new window), for example, 2022-10-15T00:00:01+04:00
`item-type`	string	Item type: `payment` or `receipt`

# Example of `q` string

q=item-type:receipt,address:35Gnk75DbehHXkshBX1QzpKdq4AJDW6KKv,date-from:2021-02-01T00:00:01+01:00,date-to:2021-12-01T23:59:59+01:00

# Request Example

curl 'https://apirone.com/api/v2/accounts/apr-e729d9982f079fa86b10a0e3aa6ff37b/history?addresses=3JH4GWtXNz7us8qw1zAtRr4zuq2nDFXTgu,3BwabT7SqorT2u3QCtTso3AHn9ayTE2mqT&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'

# Success Response Reference

HTTP Status Code: 200
Content Type: application/json

Parameter	Type	Description
`account`	string	Account Identifier
`items`	array	Elements array
`pagination`	object	Pagination info

Element items:

Parameter	Type	Description
`date`	string	Date of the transfer
`type`	string	Item type: payment or receipt
`txs`	array	Array of Transaction identifiers
`id`	string	Payment or receipt identifier
`is_confirmed`	boolean	Element indicating transaction confirmation: true - if the transaction is confirmed false - if the transaction is not confirmed
`amount`	integer	Transfer amount

Element pagination:

Parameter	Type	Description
`total`	integer	Total number of items
`offset`	integer	The sequence number of the element from which the counting starts. Default value: 0
`limit`	integer	Maximum number of items that request will return. Default value: 10

# Response Example

{
    "account": "apr-e729d9982f079fa86b10a0e3aa6ff37b",
    "items": [
        {
            "id": "f4d4bf52750db2c5f0af01f0933ed760d54a2e90b08acdbab19bbdb2551d1e5d",
            "date": "2022-02-08T12:35:49.027991",
            "type": "receipt",
            "currency": "tbtc",
            "txs": [
                "f4d4bf52750db2c5f0af01f0933ed760d54a2e90b08acdbab19bbdb2551d1e5d"
            ],
            "is_confirmed": true,
            "amount": 20000
        },
        {
            "id": "aa2ebb45733152ebf6c573ffd16dca18515c7f399137d9c0c589bea3023044c2",
            "date": "2022-01-27T06:43:44.994261",
            "type": "payment",
            "currency": "tbtc",
            "txs": [
                "0ecb0f0ff789e1f448087c2d7791920be143bc6f6b05b42c7f73bf8f447c2994"
            ],
            "is_confirmed": true,
            "amount": -10000
        }
    ],
    "pagination": {
        "total": 17,
        "offset": 0,
        "limit": 10
    }
}

# Error Response

HTTP Status Code: 400 500
Content Type: application/json

Playground

# Account History Item

The detailed information on the history item contains a list of transactions, fees, and a list of incoming/outgoing addresses. There are two kinds of history items: payments and receipts. Payment is outgoing transaction. Receipt is incoming transaction.

# Request

HTTP Method: GET
URL: https://apirone.com/api/v2/accounts/{account}/history/{HistoryItemID}

Parameter	Type	Description	Required
`account`	string	Account Identifier	✓
`HistoryItemID`	string	Identifier of the history item (`receipt` or `payment`)	✓

#

Receipt (incoming transaction)

# Request Example

curl 'https://apirone.com/api/v2/accounts/apr-e729d9982f079fa86b10a0e3aa6ff37b/history/5fe79fb866bb3b9b297f3935f6ab1b029f74d59629a19a8c028812d26642b108'

# Success Response Reference

HTTP Status Code: 200
Content Type: application/json

{
    "account": "apr-e729d9982f079fa86b10a0e3aa6ff37b",
    "currency": "btc",
    "created": "2022-03-26T12:16:51.456721",
    "type": "receipt",
    "id": "5fe79fb866bb3b9b297f3935f6ab1b029f74d59629a19a8c028812d26642b108",
    "items": [
        {
            "txid": "5fe79fb866bb3b9b297f3935f6ab1b029f74d59629a19a8c028812d26642b108",
            "address": "3Mv1bs2BZ1tdEJDW3jSxqVqJgxsFC6cgTo7",
            "amount": 5600,
            "block": {
                "hash": "0000000000000010b906564bfe0afdaf64bf0b1ead72104b9ac6fec2bd7f187d",
                "height": 2287951,
                "deleted": false
            },
            "is_confirmed": true
        }
    ],
    "amount": 5600
}

Parameter	Type	Description
`account`	string	Account Identifier
`currency`	string	Currency type
`created`	string	Item creation date. Contains the full date, hours, minutes, seconds, decimal part of seconds, for example, 2022-10-13T00:00:01
`type`	string	Transfer type: `receipt`
`id`	string	Item identifier
`items`	array	Elements array
`amount`	integer	Total transfer amount of items

Elements of items array:

Parameter	Type	Description
`txid`	string	Identifier of the transaction in the blockchain
`address`	string	Cryptocurrency account address
`amount`	integer	Item amount
`block`	object	Contains data about the block: hash - hash of the block height - height of the block. If the height of the block is 1, then the transaction is in the mempool and has never been confirmed
`is_confirmed`	boolean	Transaction confirmation

#

Payment (outgoing transaction)

# Request Example

curl 'https://apirone.com/api/v2/accounts/apr-e729d9982f079fa86b10a0e3aa6ff37b/history/632f1a704fc0461a9f8096aa9ec87429b47182babf2e8c4a8fc45cbbaf30a02e'

# Success Response Reference

HTTP Status Code: 200
Content Type: application/json

{
    "account": "apr-e729d9982f079fa86b10a0e3aa6ff37b",
    "currency": "btc",
    "created": "2022-01-27T06:43:44.931779",
    "type": "payment",
    "id": "632f1a704fc0461a9f8096aa9ec87429b47182babf2e8c4a8fc45cbbaf30a02e",
    "txs": [
        "0ecb0f0ff789e1f448087c2d7791920be143bc6f6b05b42c7f73bf8f447c2994"
    ],
    "destinations": [
        {
            "address": "3MzEcYvGbWZNCt83AizrmeQkjr1iHE6xrMm",
            "amount": 9866
        }
    ],
    "amount": 9866,
    "total": 10000,
    "fee": {
        "subtract-from-amount": true,
        "network": {
            "strategy": "normal",
            "amount": 134,
            "rate": 1
        }
    }
}

Parameter	Type	Description
`account`	string	Account Identifier
`currency`	string	Currency type
`created`	string	Item creation date. Contains the full date, hours, minutes, seconds, decimal part of seconds, for example, 2022-10-13T00:00:01
`type`	string	Transfer type: `payment`
`id`	string	Item identifier
`txs`	array	List of associated transactions
`destinations`	array	Destinations array
`amount`	integer	Transfer amount
`total`	integer	Total transfer amount. Includes all fees and transfer amounts
`fee`	object	Information about fees

# Error Response

HTTP Status Code: 400 500
Content Type: application/json

Playground

# Account Address History

Outputs a list of operations of a specified account address.

# Request

HTTP Method: GET
URL: https://apirone.com/api/v2/accounts/{account}/addresses/{address}/history

Parameter	Type	Description	Required
`account`	string	Account Identifier	✓
`address`	string	Cryptocurrency account address	✓
`offset`	integer	The sequence number of the item from which the counting starts. Default value: 10
`limit`	integer	The maximum number of transactions displayed on the page. Default value: 0
`currency`	string	Currency type (btc, ltc, bch, doge, trx, usdt@trx, usdc@trx) supported by service. This parameter is required for usdt@trx, usdc@trx addresses

# Request Example

curl 'https://apirone.com/api/v2/accounts/apr-e729d9982f079fa86b10a0e3aa6ff37b/addresses/3JH4GWtXNz7us8qw1zAtRr4zuq2nDFXTgu/history?limit=10&offset=0'

# Success Response Reference

HTTP Status Code: 200
Content Type: application/json

{
    "account": "apr-e729d9982f079fa86b10a0e3aa6ff37b",
    "currency": "btc",
    "address": "3JH4GWtXNz7us8qw1zAtRr4zuq2nDFXTgu",
    "txs": [
        {
            "txid": "ad44fa07e253d7917b86caf4abe1d1817b1a896beaa15ec7971741f075c30e99",
            "created": "2021-12-20T14:18:33.347286",
            "amount": -30000,
            "block": {
                "hash": "00000000000000de74f3ed6e5db226dabe634e55e90e968623b9fa41a0fde513",
                "height": 2132472,
                "deleted": false
            },
            "deleted": false 
        }
    ]
}

Parameter	Type	Description
`account`	string	Account Identifier
`currency`	string	Currency type
`address`	string	Cryptocurrency account address
`txs`	array	Contains information about transactions by address from the blockchain
`pagination`	object	Pagination info

Elements of txs array:

Parameter	Type	Description
`txid`	string	Identifier of the transaction in the blockchain
`created`	string	Timestamp of the block with the transaction
`amount`	integer	Transfer amount
`block`	object	Contains data about the block: hash - hash of the block height - height of the block. If the height of the block is 1, then the transaction is in the mempool and has never been confirmed

# Error Response

HTTP Status Code: 400 500
Content Type: application/json

Playground

# Account Callback Info

Outputs information on the saved callback for the account. Authorization is required.

# Request

HTTP Method: GET
URL: https://apirone.com/api/v2/accounts/{account}/callback?currency={currency}

Parameter	Type	Description	Required
`account`	string	Account Identifier	✓
`transfer-key`	string	Key for accessing protected endpoints	*
`currency`	string	Cryptocurrency address	✓

* transfer-key is required unless access token is applied

# Request example

curl 'https://apirone.com/api/v2/accounts/apr-e729d9982f079fa86b10a0e3aa6ff37b/callback?currency=tbtc&transfer-key=82ookirnTwWNXXqFwdOQMVZIamt8s1uT'

# Success Response Reference

Parameter	Type	Description
`account`	string	Account Identifier
`callback`	object	Callback url and data
`currency`	string	Currency type

{
    "account": "apr-e729d9982f079fa86b10a0e3aa6ff37b",
    "currency": "btc",
    "callback": {
        "method": "POST",
        "url": "https://example.com",
        "data": {
            "key": "secret"
        }
    }
}

# Error response

HTTP Status Code: 400 500
Content Type: application/json

Playground

# Address Callback Info

Outputs information on the saved callback for a specified address. Authorization is required.

# Request

HTTP Method: GET
URL:https://apirone.com/api/v2/accounts/{account}/addresses/{address}/callback

Parameter	Type	Description	Required
`account`	string	Account Identifier	✓
`transfer-key`	string	Key for accessing protected endpoints	*
`address`	string	Cryptocurrency account address	✓
`currency`	string	Currency type (btc, ltc, bch, doge, trx, usdt@trx, usdc@trx) supported by service. This parameter is required for usdt@trx, usdc@trx addresses

* transfer-key is required unless access token is applied

# Request example

curl 'https://apirone.com/api/v2/accounts/apr-e729d9982f079fa86b10a0e3aa6ff37b/addresses/3N5unaGDEGnS6f2J9W9dBnA2cavymLNdqmU/callback&transfer-key=82ookirnTwWNXXqFwdOQMVZIamt8s1uT'

# Success Response Reference

Parameter	Type	Description
`account`	string	Account Identifier
`currency`	string	Currency type (btc, ltc, bch, doge, trx, usdt@trx, usdc@trx) supported by service
`address`	string	Cryptocurrency account address
`callback`	object	Callback is an object of method, URLs and user data

# Response example

{
    "account": "apr-e729d9982f079fa86b10a0e3aa6ff37b",
    "currency": "btc",
    "address": "3N5unaGDEGnS6f2J9W9dBnA2cavymLNdqmU",
    "callback": {
        "method": "POST",
        "url": "https://example.com",
        "data": {
            "key": "secret"
        }
    }
}

# Error response

HTTP Status Code: 400 500
Content Type: application/json

Playground

# Address Callback Log

Information on the Callback log in the account: which requests the service sent to you and which responses you, as a client, gave to them. This is a basic tool for debugging. Authorization is required.

# Request

HTTP Method: GET
URL:https://apirone.com/api/v2/accounts/{account}/addresses/{address}/callback-log

Parameter	Type	Description	Required
`account`	string	Account Identifier	✓
`transfer-key`	string	Key for accessing protected endpoints	*
`address`	string	Cryptocurrency account address	✓
`pagination`	object	Pagination info
`currency`	string	Currency type (btc, ltc, bch, doge, trx, usdt@trx, usdc@trx) supported by service. This parameter is required for usdt@trx, usdc@trx addresses

* transfer-key is required unless access token is applied

Elements pagination:

Parameter	Description
`total`	Total number of items.
`offset`	The sequence number of the element from which the counting starts. Default value: 0
`limit`	Maximum number of items that request will return. Default value: 10

# Request example

curl 'https://apirone.com/api/v2/accounts/apr-e729d9982f079fa86b10a0e3aa6ff37b/addresses/3N5unaGDEGnS6f2J9W9dBnA2cavymLNdqmU/callback-log&transfer-key=82ookirnTwWNXXqFwdOQMVZIamt8s1uT'

# Success Response Reference

Parameter	Type	Description
`account`	string	Account Identifier
`currency`	string	Currency type
`address`	string	Cryptocurrency account address

Callback data log:

Parameter	Type	Description
`date`	string	Date of query
`request`	object	Request from Processing to Client
`response`	object	Response from client to Processing

Request from the Processing to the client request:

Parameter	Type	Description
`method`	string	The method of sending data to the server. For example, GET, POST.
`url`	string	Callback URL
`args`	object	Arguments to sent
`account`	string	Account Identifier
`args`	object	Consists of: `value`: amount in wallet units. `input_address`: payment address. `confirmations`: the number of confirmations in the network. `currency`: currency type

Response from the client to the Processing response:

Parameter	Type	Description
`status`	integer	HTTP status code
`headers`	objects	HTTP headers
`content`	string	Response body (only 4096 bytes incl)

Elements pagination:

Parameter	Description
`total`	Total number of items.
`offset`	The sequence number of the element from which the counting starts. Default value: 0
`limit`	Maximum number of items that request will return. Default value: 10

# Response example

{
    "account": "apr-e729d9982f079fa86b10a0e3aa6ff37b",
    "currency": "btc",
    "address": "3N5unaGDEGnS6f2J9W9dBnA2cavymLNdqmU",
    "log": [
        {
            "date": "2021-12-26T08:49:24.487630",
            "request": {
                "method": "POST",
                "url": "https://example.com",
                "args": {
                    "value": 10000,
                    "input_address": "3MxnbK5gY11gKTfoybNcBLJZe4qwYMqG2FZ",
                    "confirmations": 1,
                    "input_transaction_hash": "d68a680681eebdcb407eb9ae47690b15d52bfe27a1b2f6ee7543ded4e376a6de",
                    "account": "apr-e7be0e8eabd391b499fe64647576fad5",
                    "currency": "btc"
                }
            },
            "response": {
                "status": 200,
                "headers": {
                    "Server": "nginx",
                    "Content-Type": "text/plain; charset=UTF-8",
                    "Transfer-Encoding": "chunked",
                    "Vary": "Accept-Encoding",
                    "X-Request-Id": "bf4cd064-f6ea-4ccc-afd8-455d80eeb910",
                    "X-Token-Id": "7df4ab05-494f-41d9-bd78-61424d1aee25",
                    "Cache-Control": "no-cache, private",
                    "Date": "Sun, 26 Dec 2021 08:49:24 GMT"
                },
                "content": "*ok*"
            }
        }
    ],
    "pagination": {
        "total": 1,
        "offset": 0,
        "limit": 10
    }
}

# Error response

HTTP Status Code: 400 500
Content Type: application/json

Playground

← Intro Invoices →

# Account

# Create Account

# Request

# Request example

# Success Response Reference

# Response example

# Error response

Playground

# Account Info

# Request

# Request example

# Success Response Reference

# Response example

# Error response

Playground

# Account Balance

# Request

# Request Example

# Success Response Reference

# Response example

# Error Response

Playground

# Generate Address

# Request

# Request example

# Success Response Reference

# Response example

# Error Response

Playground

# Address Info

# Request

# Request example

# Success Response Reference

# Response example

# Error response

Playground

# Address Balance

# Request

# Request Example

# Success Response Reference

# Response example

# Error Response

Playground

# Account Addresses

# Request

# Example of q:

# Request Example

# Success Response Reference

# Response example

# Error Response

Playground

# Estimation

# Request

# Request Example

# Success Response Reference

# Response example

# Error Response

Playground

# Transfer

# Request

# Destinations [array]

# Request Example

# Success Response Reference

# Response example

# Error Response

Playground

# Account History

# Request

# Example of q string

# Request Example

# Success Response Reference

# Response Example

# Error Response

Playground

# Account History Item

# Request

#

Receipt (incoming transaction)

# Request Example

# Success Response Reference

# Example of `q`:

# Example of `q` string