Deposit or withdraw networks info

GET

/ver1/accounts/:account_id/networks_info

Permission: ACCOUNTS_READ

Security: SIGNED

Shows information about the currency and each supported network for deposits and withdrawals available on the exchange account.

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 Parameter

purposeinteger

Filter currencies with deposit or withdraw enabled.

Example Request

GET

/ver1/accounts/12345678/networks_info

Response Parameters

currencyinteger

The name of currency.

nameinteger

The full name of the currency.

deposit_enableboolean

Indicates whether currency deposit is available for this account.

withdraw_enableboolean

Indicates whether currency withdrawal is available for this account.

network_listobject

Details about available networks for deposits and withdrawals.

Hide child parametersShow child parameters

networkstring

The name of the network.

defaultboolean

Indicates whether this network is the main one for deposits and withdrawals.

deposit_enableboolean

Indicates whether currency deposit is available for this network.

withdraw_enableboolean

Indicates whether currency withdrawal is available for this network.

deposit_tipstring or null

Tip or notice related to deposits.

withdraw_tipstring or null

Tip or notice related to withdrawals.

special_tipstring or null

Additional information regarding specific network requirements.

network_namestring or null

The full name of the network.

network_urlstring or null

The URL of the network.

address_regexpstring or null

Regular expression regex used to validate addresses.

withdraw_feestring or null

Fee charged for withdrawals.

withdraw_minstring or null

Minimum withdrawal amount.

withdrawMaxstring or null

The maximum possible withdrawal amount.

withdrawMultiplestring or null

Minimum increment for withdrawal amount.

memo_regexpstring or null

Regular expression (regex) used to validate MEMO.

labelstring or null

Label for the additional field. For example, MEMO or Tag

require_address_tagboolean

Specifies whether an additional field is required when depositing or withdrawing. For example, MEMO or Tag.

Example Responses

200 OK

{
  "currency": "BTC",
  "name": "Bitcoin",
  "deposit_enable": true,
  "withdraw_enable": true,
  "network_list": [
    {
      "network": "BNB",
      "default": false,
      "deposit_enable": false,
      "withdraw_enable": false,
      "deposit_tip": "Wallet Maintenance, Deposit Suspended",
      "withdraw_tip": "Wallet Maintenance, Withdrawal Suspended",
      "special_tip": "Both a MEMO and an Address are required to successfully deposit your BEP2-BTCB tokens to Binance.",
      "network_name": "BNB Beacon Chain (BEP2)",
      "network_url": null,
      "address_regexp": "^(bnb1)[0-9a-z]{38}$",
      "withdraw_fee": "0.0000093",
      "withdraw_min": "0.000019",
      "withdrawMax": "10000000000",
      "withdrawMultiple": "0.00000001",
      "memo_regexp": "^[0-9A-Za-z\\-_]{1,120}$",
      "label": "MEMO/Tag",
      "require_address_tag": false
    },
    {
      "network": "BTC",
      "default": true,
      "deposit_enable": true,
      "withdraw_enable": true,
      "deposit_tip": "",
      "withdraw_tip": "",
      "special_tip": "",
      "network_name": "Bitcoin",
      "network_url": null,
      "address_regexp": "^[13][a-km-zA-HJ-NP-Z1-9]{25,34}$|^[(bc1q)|(bc1p)][0-9A-Za-z]{37,62}$",
      "withdraw_fee": "0.0004",
      "withdraw_min": "0.0008",
      "withdrawMax": "10000000000",
      "withdrawMultiple": "0.00000001",
      "memo_regexp": "",
      "label": "",
      "require_address_tag": false
    }
  ]
}

400 Bad Request

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

403 Forbidden

{
  "error": "Forbidden. Unavailable for this account."
}