Get Self-Custodial Wallet Balance

View as Markdown

Using this endpoint you can fetch the Payout Wallet address balance for your API Key and the ticker provided.

Method: GET

Path: https://api.blockbee.io/{ticker}/payout/balance/

Parameters

Path Parameters

tickerstring•Required

The ticker parameter in this API request refers to the unique identifier of the cryptocurrency to which you are making the request. It is included in the URL of the request and helps to specify the exact cryptocurrency that you want to retrieve data for. The ticker is typically a short code that uniquely identifies the cryptocurrency, or the token and it's network/blockchain.

For example, btc is the ticker for Bitcoin, and trc20/usdt is the ticker for USDT over TRC-20. Having this in mind, a request for USDT over TRC-20 will look like this: https://api.blockbee.io/trc20/usdt/create/.

Notes:

  • You can find all our tickers in our cryptocurrencies page.
  • Our Payouts system does not support doge.

Query Parameters

apikeystring•Required

API Key provided by BlockBee's Dashboard. Unsure how to get yours? Check this tutorial.

Note: The API key can also be sent as a header named apikey.

Returns

Returns the balance of the Payout Wallet for the provided ticker.

statusstring

Status of the request. Should be success if the request didn't fail.

balancenumber

Balance of your Payout Wallet address for the selected ticker.