Account

Account entities hold information about the cryptocurrency portfolio, theys balances and the set of tools that are available for this account.

Account entities hold information like:

  • Details about the connected exchange, including its type, name, and current status;

  • Profit and currency information, such as the account's balance and daily and total profit;

  • Available trading features for this account.

3Commas provides a set of methods to create new exchange account connections and manage existing accounts.

Attributes

id integer ID of the exchange account entity

name string The name for the exchange account set by the user

exchange_name string Name of this exchange account

market_icon string Icon of the exchange

market_code string 3Commas of exchange code entity

autobalance_enabled boolean Indicates whether auto-balance mode is enabled for this account

auto_balance_period null or string The interval, in hours, at which automatic portfolio balancing occurs

auto_balance_portfolio_id integer or null ID of the portfolio for which automatic balancing has been initiated

autobalance_enabled boolean Indicates whether auto-balance mode is enabled for this account

auto_balance_error string or null A description comes up to explain why auto-balance failed

last_auto_balance null or string ISO 8601 datetime string of when this auto-balance was last time

hedge_mode_available boolean Indicates whether hedge mode is available for this account

hedge_mode_enabled boolean Indicates whether hedge mode is enabled for this account

is_locked boolean Indicates if the account is locked

lock_reason null or string The reason for locking this account in case is_locked is true

smart_trading_supported boolean Indicates if smart trading is supported

stats_supported boolean Indicates whether statistic of profit are supported for this account

trading_supported boolean Indicates if trading is supported at 3Commas

market_buy_supported boolean Indicates whether creating a market buy order is supported on the exchange

market_sell_supported boolean Indicates whether creating a market sell order is supported on the exchange

conditional_buy_supported boolean Indicates whether creating a conditional buy order is supported on the exchange

bots_allowed boolean Indicates whether DCA Bot is enabled for this account

bots_ttp_allowed boolean Indicates whether the trailing take profit feature is enabled on this account

bots_tsl_allowed boolean Indicates whether the trading stop loss feature is enabled on this account

multi_bots_allowed boolean Indicates whether the Multi-Pair feature is supported for this account

fast_convert_available boolean Indicates whether the "Sell All to BTC/USD" feature is enabled for this account

grid_bots_allowed boolean Indicates whether Grid Bot is enabled for this account

api_key string API key used for the account

api_key_invalid boolean Indicates whether the API key for this account is invalid

api_keys_state string Indicates the state of the API keys

deposit_enabled boolean Indicates whether the Deposit feature is enabled for this account

available_include_in_summary boolean Indicates whether this account is available to be included in the summary

include_in_summary boolean Indicates whether this account included in the summary

supported_market_types array The type of market supported by the connected exchange account

customer_id string Unique customer ID provided by the Bitstamp exchange

btc_amount string Amount of Bitcoin in the account

usd_amount string Amount in USD in the account

day_profit_etc string Daily profit in BTC

day_profit_usd string Daily profit in USD

day_profit_btc_percentage number Daily profit percentage in BTC

day_profit_usd_percentage number Daily profit percentage in USD

btc_profit number Monthly profit in BTC

usd_profit number Monthly profit in USD

btc_profit_percentage number Monthly profit percentage in BTC

usd_profit_percentage number Monthly profit percentage in USD

total_btc_profit number Total profit in BTC

total_usd_profit number Total profit in USD

created_at string ISO 8601 datetime string of when this Account entity was created

updated_at string ISO 8601 datetime string of when this SmartTrade entity was updated

Last updated

Was this helpful?