Edit exchange account

Description: Updates an exchange account using its ID, including updating API keys for reconnecting the account

Permission: ACCOUNTS_WRITE Security: SIGNED

---

POST

/ver1/accounts/update

---

Parameters request

Name	Type	Mandatory	Values	Description
account_id	integer	Yes		Unique 3Commas ID of the exchange account entity
name	string	No		Name of this exchange account.
api_key	string	No		API-key from this exchange account
secret	string	No		Secret-key from this exchange account
customer_id	string	No		Unique customer ID provided by the Bitstamp exchange. This parameter is required when type is set to Bitstamp
passphrase	string	No		Secret phrase from this exchange account. This parameter is required when type is set to Coinbase
address	string	No		Address of wallet. This parameter is required when type is set to ethereumwallet
include_in_summary	boolean	No	true false	Choose whether this account should be included in the summary statistics

Parameters response

Name	Type	Description
id	integer	ID of the exchange account entity
name	string	The name for the exchange account defined 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	integer	TThe interval, in hours, at which automatic portfolio balancing occurs
auto_balance_portfolio_id	integer	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	null or string	A description comes up to explain why autobalance 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_btc	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

Example request

POST /ver1/accounts/update?account_id=12345678&name=New%20name%20exchange

Example Response and errors

Status: 201 Created

{
    "id": 12345678,
    "auto_balance_period": 12,
    "auto_balance_portfolio_id": null,
    "auto_balance_currency_change_limit": null,
    "autobalance_enabled": false,
    "hedge_mode_available": false,
    "hedge_mode_enabled": false,
    "is_locked": false,
    "smart_trading_supported": true,
    "smart_selling_supported": true,
    "available_for_trading": {},
    "stats_supported": true,
    "trading_supported": true,
    "market_buy_supported": true,
    "market_sell_supported": true,
    "conditional_buy_supported": true,
    "bots_allowed": true,
    "bots_ttp_allowed": true,
    "bots_tsl_allowed": true,
    "gordon_bots_available": true,
    "multi_bots_allowed": true,
    "created_at": "2024-08-29T14:16:10.830Z",
    "updated_at": "2024-09-12T21:17:05.627Z",
    "last_auto_balance": null,
    "fast_convert_available": true,
    "grid_bots_allowed": true,
    "api_key_invalid": false,
    "market_icon": "https://3commas.io/img/exchanges/bybit.png",
    "deposit_enabled": false,
    "include_in_summary": true,
    "supported_market_types": [
        "spot"
    ],
    "primary_display_currency_profit_percentage": {
        "currency": "USD",
        "amount": "1.27"
    },
    "primary_display_currency_profit": {
        "currency": "USD",
        "amount": "0.41977392126027012455593960354579615351317609077582"
    },
    "day_profit_primary_display_currency_percentage": {
        "currency": "USD",
        "amount": "2.1862"
    },
    "day_profit_primary_display_currency": {
        "currency": "USD",
        "amount": "0.71497909537100944606510928410135170906899572324142"
    },
    "primary_display_currency_amount": {
        "currency": "USD",
        "amount": "33.41938674385577012455593960354579615351317609077582"
    },
    "total_primary_display_currency_profit": {
        "currency": "USD",
        "amount": 0.4197739212602701
    },
    "available_include_in_summary": true,
    "api_key": "gyTAiGCgRe1hctsA1J",
    "name": "New name exchange",
    "auto_balance_method": null,
    "auto_balance_error": null,
    "customer_id": null,
    "subaccount_name": null,
    "lock_reason": null,
    "btc_amount": "0.000576100372659584112793557824740668987777435277",
    "usd_amount": "33.41938674385577012455593960354579615351317609077582",
    "day_profit_btc": "0.000008477241194296886998580144867983802592279153250469",
    "day_profit_usd": "0.71497909537100944606510928410135170906899572324142",
    "day_profit_btc_percentage": "1.49",
    "day_profit_usd_percentage": "2.19",
    "btc_profit": "0.000032527150138595112793557824740668987777435277",
    "usd_profit": "0.41977392126027012455593960354579615351317609077582",
    "usd_profit_percentage": "1.27",
    "btc_profit_percentage": "5.98",
    "total_btc_profit": "3.2527150138595115e-05",
    "total_usd_profit": "0.41977392126027013",
    "pretty_display_type": "BybitSpot",
    "exchange_name": "Bybit Spot",
    "market_code": "bybit_spot",
    "api_keys_state": "ok"
}