User deposit data

GET

/ver1/accounts/:account_id/deposit_data

Permission: ACCOUNTS_READ

Security: SIGNED

Returns the data of deposit for a specific account using its ID.

This endpoint works for the following exchanges: Binance Spot, Binance US, OKX Spot.

---

Path Parameter

account_idintegerrequired

Unique 3Commas ID of this exchange account entity.

Query Parameters

currencystringrequired

Currency code for what you want to get a data.

Example: BTC

address_tagstringrequired

Name of Network for this currency.

Example Request

GET

/ver1/accounts/76543210/deposit_data?currency=BTC&network=BTC

Response Parameters

addressstring

The cryptocurrency wallet address for deposits and withdrawals.

address_tagstring

Tag of address for this deposits.

currencystring

The amount of this currency currently locked in active orders.

in_ordersstring

The amount of this currency currently placed in active orders.

total_balancestring

The total balance in this currency and account.

Example Responses

200 OK

{
  "address": "1J6jZDFSeGfwfwJpS4SLqhVo7eo2DgkT9Q",
  "address_tag": "",
  "available_balance": "0.00031872",
  "in_orders": "0.0",
  "total_balance": "0.00031872"
}

400 Bad Request

{
  "error": "record_invalid",
  "error_description": "Invalid parameters",
  "error_attributes": {
    "currency": [
      "is missing"
    ],
    "network": [
      "is missing"
    ]
  }
}

422 Unprocessable Entity

{
  "error_description": "{\"code\"=>-9000, \"msg\"=>\"Deposits for this network are currently closed\"}",
  "error": "unknown_market_api_error"
}