NAV Navbar

Introduction

Welcome to Address.so’s API documentation! Address.so is a simple, mostly RESTful JSON API for interacting with blockchains, accessed over HTTPS from the api.address.so domain. Currently, Address.so supports Bitcoin, Ethereum, Litecoin, Dash and Ripple.

User

Requests /user,/request-secret-token , /user/tariff-request, user/tariffs and /logout require the headerX-Auth-Token, which is generated after authorization and given in the field auth_token. This token is stored only in the cache, for 10 minutes since the last user request.

Authorization

{
    "result": {
        "user": {
            "id": 1,
            "name": null,
            "email": "[email protected]",
            "status": 10,
            "api_token": "9c1302b7088bc690ba48522943ca900c2698bae68f271433d13a76f1e0212b7ase26c4c9ccc191a68a89d5f47537ebc9d84be836dc674e353658504dbb12532c",
            "created_at": "2018-10-30 13:45:54",
            "updated_at": "2018-11-15 11:24:14",
            "tariff_id": 2,
            "tariff_expires": "2018-11-25 16:40:59",
            "google2fa_secret": "M3QGSGIJIACKAWMI",
            "auth_token": "dca71f77dff548b2c5db676da86e5d96",
            "tariff": {
                "id": 2,
                "name": "Professional",
                "price": 5000,
                "requests_per_sec": 100,
                "requests_per_hour": 100000,
                "requests_per_month": 1000000000,
                "max_wallets": 100,
                "max_accounts": 10000,
                "created_at": "2018-11-13 14:35:01",
                "updated_at": "2018-11-13 14:40:13",
                "is_default": false,
                "tariff_expires": "2018-11-25 16:40:59"
            }
        }
    },
    "errors": []
}

HTTPS Request

POST https://api.address.so/login

Query params:

Parameter Type Required Description
username string yes User email
password string yes User password

Registration

{
    "result": {
        "user": {
            "email": "[email protected]",
            "name": null,
            "api_token": "1f4c44c4b32155d6f10e17ff71c9cd89cc4e6bb9bedb464542d553d00fcfb6ce47c601e7b7d408bb9a60264ab4695d80a9b8be01668dc55bc3e9a7911d43c0d2",
            "google2fa_secret": "LQVNKAZPIGOQ2TQV",
            "updated_at": "2018-11-27 15:25:19",
            "created_at": "2018-11-27 15:25:19",
            "id": 8,
            "tariff_id": 1,
            "tariff_expires": {
                "date": "2018-12-27 15:25:19.161717",
                "timezone_type": 3,
                "timezone": "UTC"
            }
        }
    },
    "errors": []
}

HTTPS Request

POST https://api.address.so/signup

Description: After registration, a randomly generated 16-digit password is sent to the mail.

Query params:

Parameter Type Required Description
email string yes User email

Information about user

{
    "result": {
        "user": {
            "id": 1,
            "name": null,
            "email": "[email protected]",
            "status": 10,
            "api_token": "9c1302b7088bc690ba48522943ca900c2698bae68f271433d13a76f1e0212b7ase26c4c9ccc191a68a89d5f47537ebc9d84be836dc674e353658504dbb12532c",
            "created_at": "2018-10-30 13:45:54",
            "updated_at": "2018-11-15 11:24:14",
            "tariff_id": 2,
            "tariff_expires": "2018-11-25 16:40:59",
            "google2fa_secret": "M3QGSGIJIACKAWMI",
            "auth_token": "dca71f77dff548b2c5db676da86e5d96",
            "tariff": {
                "id": 2,
                "name": "Professional",
                "price": 5000,
                "requests_per_sec": 100,
                "requests_per_hour": 100000,
                "requests_per_month": 1000000000,
                "max_wallets": 100,
                "max_accounts": 10000,
                "created_at": "2018-11-13 14:35:01",
                "updated_at": "2018-11-13 14:40:13",
                "is_default": false,
                "tariff_expires": "2018-11-25 16:40:59"
            }
        }
    },
    "errors": []
}

HTTPS Request

GET https://api.address.so/user

Attention! You need to pass X-Auth-Token in the header.


Get a token to view (secret_token)

{
    "result": "success",
    "errors": null
}

HTTPS Request

POST https://api.address.so/request-secret-token

Attention! You need to pass X-Auth-Token in the header.

Description: After calling this method, a link is sent to the user in the mail of the form http://address.so/user/secret-token?request-secret-token=0d7b9aa788621d8b939e1089b910eaaa4b014b046fd09027d5201eb19c0bf6e1, whererequest-secret-tokenis A randomly generated 32-digit token which stored in the cache for 30 minutes.

This request can only be called once per minute.

You must follow the link in the letter to get the secret_token.

{
  "result": {
    "secret_token": "f2ae21635ec36c563e080618773d856b2f1d37f2f722ebfa29c221f9d39453102a82f5ae87e7bd8d8666ffb78a1ebbcd93cf45b9268519f53ed9822ed8890bf6"
  },
  "errors": [

  ]
}

HTTPS Request

GET https://api.address.so/user/secret-token

Description: After calling this method, the request-secret-token is removed from the cache, that is, you can make a request with it only once.

Query params:

Parameter Type Required Description
request-secret-token string yes Request secret token

Forgot password

{
    "result": "success",
    "errors": null
}

HTTPS Request

POST https://api.address.so/forgot-password

Description: - The result of this request is always success (except when theemail field is empty). After creating a password recovery request, a new password is sent to the mail user. You can request a password change only once a day.

Query params:

Parameter Type Required Description
email string yes User email

Plan list

{
    "result": [
        {
            "id": 1,
            "name": "Free plan",
            "price": 0,
            "requests_per_sec": 3,
            "requests_per_hour": 300,
            "requests_per_month": 300000,
            "max_wallets": 5,
            "max_accounts": 15,
            "created_at": "2018-10-30 13:38:58",
            "updated_at": "2018-10-30 13:38:58",
            "is_default": true
        },
        {
            "id": 2,
            "name": "Professional",
            "price": 5000,
            "requests_per_sec": 100,
            "requests_per_hour": 100000,
            "requests_per_month": 1000000000,
            "max_wallets": 100,
            "max_accounts": 10000,
            "created_at": "2018-11-13 14:35:01",
            "updated_at": "2018-11-13 14:40:13",
            "is_default": false
        }
    ],
    "errors": []
}

HTTPS Request

GET https://api.address.so/user/tariffs

Attention! You need to pass X-Auth-Token in the header.

Request to change the plan

{
    "result": "success",
    "errors": null
}

HTTPS Request

POST https://api.address.so/user/tariff-request

Attention! You need to pass X-Auth-Token in the header.

Query params:

Parameter Type Required Description
tariff_id int yes Plan id (from /user/tariffs method)
email string yes User contact email

Logout

{
    "result": "Token 84b12d508c5bb75b7fff1717777bdd15 removed",
    "errors": []
}

HTTPS Request

POST https://api.address.so/logout

Attention! You need to pass X-Auth-Token in the header.

Description: Instantly remove auth_token from cache.

Signing requests

Each request (except for requests from the User section) is transmitted with a header X-API-TOKEN containing the user’s api_token from the database. It is obtained by /login and /user in the "api_token" field. In addition, requests for sending from the wallet and account must contain an additional parameter sign, containing the signature of the request. The signature is implemented as follows:

You have query params:

amount=2450000

recepient=137fnrhMurXrnU7a7jLgcVoaNraUYz54Sk

You should get HMAC SHA256 from the parameters andsecret_token user:

$sign = hash_hmac('sha256', 'amount=2450000&recepient=137fnrhMurXrnU7a7jLgcVoaNraUYz54Sk', 'secret_key');

Result in this case:

20d801b1e24fe216f2f9f3687fec98cfc3ff8c1fc8a34605d9adace4ea8d2b92

After that, the sign parameter is added to the request with the hash result.

curl -i
-H "Accept: application/json"
-H "Content-Type: application/json"
-H "X-API-TOKEN: %your_token_here%"
-X POST -d '{"amount":"2450000","recepient":"137fnrhMurXrnU7a7jLgcVoaNraUYz54Sk","sign":"20d801b1e24fe216f2f9f3687fec98cfc3ff8c1fc8a34605d9adace4ea8d2b92"}
https://api.address.so/api/coins/btc/wallets/5/accounts/1/send

Example:

Rate limits

The following headers are added to every server response when requesting with X-API-TOKEN:

X-RateLimit-Limit: 60

X-RateLimit-Remaining: 56

X-RateLimit-Reset: 1372700873

where X-RateLimit-Limit is the limit of user requests per month

X-RateLimit-Remaining - the number of remaining requests

X-RateLimit-Reset - the timestamp of the date when the limit" restarts ".

Coins

List of available labels

{
    "result": [
        {
            "id": 1,
            "coin": "eth",
            "name": "Ethereum",
            "precision": 18
        },
        {
            "id": 2,
            "coin": "btc",
            "name": "Bitcoin",
            "precision": 8
        },
        {
            "id": 3,
            "coin": "ltc",
            "name": "Litcoin",
            "precision": 8
        },
        {
            "id": 4,
            "coin": "dash",
            "name": "Dash",
            "precision": 8
        }
    ],
    "errors": null
}

HTTPS Request

GET https://api.address.so/api/coins

Permission

Attention!

You need to pass X-API-TOKEN in the header for all requests in this section.

Set user permissions

{
    "result": {
        "id": 1,
        "coin": "eth",
        "label": "simple eth wallet",
        "balance_int": "2328456499980010000",
        "balance_float": 2.32845649998001,
        "receiving_address": "0x0e623fa668ef408c83dc6ccefaf97ccc01a7f6ca",
        "permissions": [
            {
                "user_id": 1,
                "roles": [
                    "admin",
                    "view",
                    "order",
                    "transfer"
                ]
            },
            {
                "user_id": 3,
                "roles": [
                    "admin"
                ]
            }
        ]
    },
    "errors": null
}

HTTPS Request

POST https://api.address.so/api/coins/:coin_name/wallets/:wallet_id/permissions

Query params:

Parameter Type Required Description
user_id int yes User id
permissions array yes Permissions list

Available permissions:

Label Description
view View wallet transactions
transfer Sending transactions from the wallet
admin Control permissions on the wallet (with the ability to add admins and delete, but only assigned to his own)

Wallets

Attention!

You need to pass X-API-TOKEN in the header for all requests in this section.

Create wallet

{
    "result": {
        "id": 83,
        "coin": "btc",
        "label": "simple btc wallet",
        "balance_int": "0",
        "balance_float": 0,
        "receiving_address": "1C8gm2Sk6aWrj7TuTdX842gETjc5qvsCeL",
        "permissions": [
            {
                "user_id": 1,
                "roles": [
                    "admin",
                    "view",
                    "order",
                    "transfer"
                ]
            }
        ]
    },
    "errors": null
}

HTTPS Request

POST https://api.address.so/api/coins/:coin_name/wallets

Query params:

Parameter Type Required Description
label string yes The human-readable name of the wallet

Get a list of all wallets

{
    "result": [
         {
            "id": 1,
            "coin": "eth",
            "label": "simple eth wallet",
            "balance_int": "28456499980010000",
            "balance_float": 0.02845649998001,
            "receiving_address": "0x0e623fa668ef408c83dc6ccefaf37ccc01a7f6ca",
            "permissions": [
                {
                    "user_id": 1,
                    "roles": [
                        "admin",
                        "view",
                        "order",
                        "transfer"
                    ]
                },
                {
                    "user_id": 3,
                    "roles": [
                        "admin"
                    ]
                }
            ]
        },
        {
            "id": 3,
            "coin": "ltc",
            "label": "simple btc wallet",
            "balance_int": "0",
            "balance_float": 0,
            "receiving_address": "mhg8VptPetk7swRozzzLFHbyicY1BnYR3N",
            "permissions": [
                {
                    "user_id": 1,
                    "roles": [
                        "admin",
                        "view",
                        "order",
                        "transfer"
                    ]
                }
            ]
        }
    ],
    "errors": null
}

HTTPS Request

GET https://api.address.so/api/wallets

Get a list of wallets by coin label

{
    "result": [
        {
            "id": 5,
            "coin": "btc",
            "label": "simple btc wallet",
            "balance_int": "0",
            "balance_float": 0,
            "receiving_address": "17mCK6XYvXEitMcsTWToDa32ac8u47aLFC",
            "permissions": [
                {
                    "user_id": 1,
                    "roles": [
                        "admin",
                        "view",
                        "order",
                        "transfer"
                    ]
                }
            ]
        },
        {
            "id": 12,
            "coin": "btc",
            "label": "simple btc wallet 2",
            "balance_int": "0",
            "balance_float": 0,
            "receiving_address": "myqJ7W7yLZ0BMoCYUMnc6MewitLZXw7K7v",
            "permissions": [
                {
                    "user_id": 1,
                    "roles": [
                        "admin",
                        "view",
                        "order",
                        "transfer"
                    ]
                }
            ]
        }
    ],
    "errors": null
}

HTTPS Request

GET https://api.address.so/api/coins/:coin_name/wallets

Get wallet by ID

{
    "result": {
        "id": 80,
        "coin": "dash",
        "label": "simple dash wallet",
        "balance_int": "43700600",
        "balance_float": 0.437006,
        "receiving_address": "Xgr9Lqrva776cMFhqvu56AcmP5BXP62uta",
        "permissions": [
            {
                "user_id": 1,
                "roles": [
                    "admin",
                    "view",
                    "order",
                    "transfer"
                ]
            }
        ]
    },
    "errors": null
}

HTTPS Request

GET https://api.address.so/api/coins/:coin_name/wallets/:wallet_id

Update wallet

{
    "result": {
        "id": 83,
        "coin": "btc",
        "label": "This label was changed!",
        "balance_int": "0",
        "balance_float": 0,
        "receiving_address": "1C8gm2Sk6aWrj7TuTdX842gETjc5qvsCeL",
        "permissions": [
            {
                "user_id": 1,
                "roles": [
                    "admin",
                    "view",
                    "order",
                    "transfer"
                ]
            }
        ]
    },
    "errors": null
}

HTTPS Request

PUT https://api.address.so/api/coins/:coin_name/wallets/:wallet_id

Query params:

Parameter Type Required Description
label string no The human-readable name of the wallet

Delete wallet

{
    "result": {
        "id": 64,
        "deleted": true
    },
    "errors": null
}

HTTPS Request

DELETE https://api.address.so/api/coins/:coin_name/wallets/:wallet_id

Get a list of wallet's transactions

{
    "result": [
        {
            "uuid": "cdf20c05-9d17-4239-95ae-fbee632a75b6",
            "hash": "62f32dae12041e01b3d934389eef98694eee66c7136bc533b22b21617ab7e9d5",
            "address": "mp85znVAxg3GigYTHUy7Xgog3tK2UQjies",
            "amount_int": 9986919,
            "amount_float": 0.09986919,
            "timestamp": 1540484881
        },
        {
            "uuid": "adf20c05-9d17-4239-95ae-fbee632a75b6",
            "hash": "72f32dae12041e01b3d934389eef98694eee66c7136bc533b22b21617ab7e9d5",
            "address": "lp85znVAxg3GigYTHUy7Xgog3tK2UQjies",
            "amount_int": 7986919,
            "amount_float": 0.07986919,
            "timestamp": 1540486881
        },
    ],
    "errors": null
}

HTTPS Request

GET https://api.address.so/api/coins/:coin_name/wallets/:wallet_id/transactions

Query params:

Parameter Type Required Description
limit int no By default, shows the last 100 transactions

Send funds from wallet

{
    "result": [
        {
            "txid": "c9d3fa9858fe2231b6e546e970b7e25e817bf4f6b03e2540db853c0a60bb35cf"
        }
    ],
    "errors": null
}

HTTPS Request

GET https://api.address.so/api/coins/:coin_name/wallets/:wallet_id/send

Query params:

Parameter Type Required Description
amount float yes The number of sent coins
recepient string yes Address of the recipient
sign string yes Look at the signing requests

Accounts

Attention!

You need to pass X-API-TOKEN in the header for all requests in this section.

Create account

{
    "result": {
        "id": 436,
        "coin": "ltc",
        "wallet_id": 17,
        "address": "LhBSU6WJvxZ4UCZ7Z1GRCC9EJxzU9wnHEe",
        "balance_int": "0",
        "balance_float": 0
    },
    "errors": null
}

HTTPS Request

POST https://api.address.so/api/coins/:coin_name/wallets/accounts

Get a list of accounts

{
    "result": [
        {
            "id": 382,
            "coin": "btc",
            "wallet_id": 15,
            "address": "136fnrhMyrXrnU7a7jLgcVoaNraUYz54Sk",
            "balance_int": "280433",
            "balance_float": 0.00280433
        },
        {
            "id": 42,
            "coin": "btc",
            "wallet_id": 15,
            "address": "15NqJDZPyhBSQAshCfENeDU3aYGB8KgSPx",
            "balance_int": "202112",
            "balance_float": 0.00202112
        }
    ],
    "errors": null
}

HTTPS Request

GET https://api.address.so/api/coins/:coin_name/wallets/:wallet_id/accounts

Get account by ID

{
    "result": {
        "id": 41,
        "coin": "btc",
        "wallet_id": 14,
        "address": "14VnCHaKEidir5uTMVaSCQp4bunbiP1WQN",
        "balance_int": "0",
        "balance_float": 0
    },
    "errors": null
}

HTTPS Request

GET https://api.address.so/api/coins/:coin_name/wallets/:wallet_id/accounts/:account_id

Delete account

{
    "result": {
        "id": 41,
        "deleted": true
    },
    "errors": null
}

HTTPS Request

DELETE https://api.address.so/api/coins/:coin_name/wallets/:wallet_id/accounts/:account_id

Get a list of account's transactions

{
    "result": [
        {
            "uuid": "c541121c-96ba-40a4-87cf-2d084fd39570",
            "hash": "c8d3fa9858fe2231b6e546e970b7e25e817bf4f6b03e2540db853c0a60bb35cf",
            "address": "15NqJDZPyhBSQAshCfENeDU3aYGB8KgSPx",
            "amount_int": "202112",
            "amount_float": 0.00202112,
            "timestamp": 1543402103
        }
    ],
    "errors": null
}

HTTPS Request

GET https://api.address.so/api/coins/:coin_name/wallets/:wallet_id/accounts/:account_id/transactions

Query params:

Parameter Type Required Description
limit int no By default, shows the last 100 transactions

Send funds from account

{
    "result": [
        {
            "txid": "c8d3fa9758fe2231b6e546e970b7e25e817bf4f6b03e2540db853c0a60bb35cf"
        }
    ],
    "errors": null
}

HTTPS Request

GET https://api.address.so/api/coins/:coin_name/wallets/:wallet_id/accounts/:account_id/send

Query params:

Parameter Type Required Description
amount float yes The number of sent coins
recepient string yes Address of the recipient
sign string yes Look at the signing requests

Webhooks

Attention!

You need to pass X-API-TOKEN in the header for all requests in this section.

How to work with webhooks?

To each user who created the webhook, the Notificator service sends a notification of a change in balance (address, wallet). This happens in automatic mode.

GET https://mywebsite.ru/callback?coin=btc&wallet_id=3&account[id]=3&account[address]=mhWoydzK4jk4t77gN4Vws9gbN8DrsPyLLw&account[balance_int]=6000&account[balance_float]=0.00006&account[updated_at]=1539945087&last_transaction[uuid]=a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11&last_transaction[hash]=awk211kkadkawkdkAQWKDwmkak123&last_transaction[amount_int]=2000&last_transaction[amount_float]=0.00002&last_transaction[created_at]=1542278419&sign=afafmk1m23mfasmflakfl

An HTTP Request of the following type is sent to the URL specified by the user:

Request params:

Parameter Description
id Wallet's account ID
address Wallet blockchain address
balance Current account balance
updated_at Timestamp update time
sign Server signature to validate incoming data
$sign = hash_hmac('sha256', 'id=5&address=moxME8RunvkHJ5JsvDh93kUM7ewkjcNDvo&balance=10000000000000&updated_at=542101215', 'secret_key');

The sign parameter is hashed on the server as follows(look at the signing requests):

An example of processing the received data on the client

public function callback (Request $request)
{
    $secret_token = $this->getMySecretToken();

    $params = [
            'coin' => $request->get('coin'),
            'wallet_id' => $request->get('wallet_id'),
            'account_id' => $request->get('account_id'),
            'account_address' => $request->get('account_address'),
            'account_balance_int' => $request->get('account_balance_int'),
            'account_balance_float' => $request->get('account_balance_float'),
            'account_updated_at' => $request->get('account_updated_at'),
            'last_transaction_uuid' => $request->get('last_transaction_uuid'),
            'last_transaction_hash' => $request->get('last_transaction_hash'),
            'last_transaction_amount_int' => $request->get('last_transaction_amount_int'),
            'last_transaction_amount_float' => $request->get('last_transaction_amount_float'),
            'last_transaction_created_at' => $request->get('last_transaction_created_at')
            ];

    $sign = hash_hmac('sha256', http_build_query($params), $secret_token);

    if ($sign === $request->sign) {
        //do some action (for example, confirm order)
    }
}

This algorithm is implemented in PHP and presented as an example. You can write something of your own. The only main condition - serverSign and clientSign must be equal.

Create webhook

{
    "result": {
        "id": 1,
        "url": "https://mywebsite.io/callback",
        "type": "wallet",
        "entity": {
            "id": 5,
            "label": "simple btc wallet",
            "coin": "btc",
            "label":"simple btc wallet",
            "balance_int":"0",
            "balance_float":0,
            "receiving_address":"1DCyg94jxPfKZcRMRbDJgFss6NZV2THAL2",
            "permissions": [
                {
                    "user_id": 2,
                    "roles": [
                        "view",
                        "admin",
                        "transfer",
                        "order"
                    ]
                }
            ]
        }
    },
    "errors": null
} 

HTTPS Request

POST https://api.address.so/api/webhooks

Query params:

Parameter Type Required Description
url string yes User Callback (link to receive notifications)
type string yes Webhooks entity type (see table below)
entity_id int yes Webhooks entity id (id the same as entity type)

Entity types:

Type Description
account Tracks actions on a specific account
wallet Tracks actions on a specific wallet (all accounts)

Get webhooks

{
    "result": [
        {
            "id": 2,
            "url": "https://mywebsite.io/callback",
            "type": "wallet",
            "entity": {
                "id": 21,
                "coin": "btc",
                "label": "simple btc wallet",
                "balance_int": "460000",
                "balance_float": 0.0046,
                "receiving_address": "1Cxmi4a4L9eV1Q39WUquxYjxd2eZQabRYi",
                "permissions": [
                    {
                        "user_id": 2,
                        "roles": [
                            "admin",
                            "view",
                            "order",
                            "transfer"
                        ]
                    }
                ]
            }
        },
        {
            "id": 4,
            "url": "https://otherwebsite.io/callback",
            "type": "wallet",
            "entity": {
                "id": 77,
                "coin": "btc",
                "label": "simple btc wallet",
                "balance_int": "10000",
                "balance_float": 0.0001,
                "receiving_address": "1DCyg73jxPfKZcRMRbDJgFss6NZV2THAL2",
                "permissions": [
                    {
                        "user_id": 2,
                        "roles": [
                            "admin",
                            "view",
                            "order",
                            "transfer"
                        ]
                    }
                ]
            }
        }
    ],
    "errors": null
}

HTTPS Request

GET https://api.address.so/api/webhooks

Get webhook by ID

{
    "result": {
        "id": 2,
        "url": "https://mywebsite.io/callback",
        "type": "wallet",
        "entity": {
            "id": 21,
            "coin": "btc",
            "label": "simple btc wallet",
            "balance_int": "460000",
            "balance_float": 0.0046,
            "receiving_address": "1Cxmi4a3L6eV1Q39WUquxYjxd2eZQabRYi",
            "permissions": [
                {
                    "user_id": 2,
                    "roles": [
                        "admin",
                        "view",
                        "order",
                        "transfer"
                    ]
                }
            ]
        }
    },
    "errors": null
}

HTTPS Request

GET https://api.address.so/api/webhooks/:webhook_id

Update webhook

{
    "result": {
        "id": 2,
        "url": "https://mynewwebsite.io/callback",
        "type": "wallet",
        "entity": {
            "id": 21,
            "coin": "btc",
            "label": "simple btc wallet",
            "balance_int": "460000",
            "balance_float": 0.0046,
            "receiving_address": "1Cxmi4a3L6eV1Q39WUquxYjxd2eZQabRYi",
            "permissions": [
                {
                    "user_id": 2,
                    "roles": [
                        "admin",
                        "view",
                        "order",
                        "transfer"
                    ]
                }
            ]
        }
    },
    "errors": null
}

HTTPS Request

PUT https://api.address.so/api/webhooks/:webhook_id

Query params:

Parameter Type Required Description
url string yes User Callback (link to receive notifications)

Delete webhook

HTTPS Request

DELETE https://api.address.so/api/webhooks/:webhook_id

Result:

{
    "result": {
        "delete": true
    },
    "errors": null
}

Errors

{“result”: null,
“errors”: {
       “code”: -3005,
       “message”: “The username field is required.”
   }
}

The format of the error looks like this:

Meaning Error code
DEFAUL_CODE_ERROR -3000
WALLET_EXCEPTION -2999
CONNECTION_ERROR -3001
WALLET_CONNECTION_ERROR -3002
BROKER_CONNECTION_ERROR -3003
VALIDATION_ERROR -3005
GOOGLE_2FA_ERROR -3057
AUTH_TOKEN_ERROR -3058
API_TOKEN_ERROR -3059
LIMIT_ERROR -3060
BAD_SIGN -3061
FORBIDEN -3062
PAY_BILL_ERROR -3070
PAY_PAIR_NOT_FOUND -3071
DEFAUL_CODE_ERROR -2000
BROKER_CONNECTION_ERROR -1000
BROKER_EXCEPTION -1999
COIN_NOT_FOUND -2401
WALLET_NOT_FOUND -2402
ACCOUNT_NOT_FOUND -2403
INSUFFICIENT_FUNDS -2500
INSUFFICIENT_UNSPENTS -2501
TRANSACTION_FAILED -2560
PERMISSION_DENIED -2011
INVALID_ADDRESS -3000
INVALID_PRIVATE_KEY -3005
TRANSACTIONOT_FOUND -4001
INVALID_ADDRESS -1095
INVALID_PRIVATE_KEY -1094
TRANSACTIONOT_FOUND -1004
CONNECTION_NODES_ERROR -1010