Account entity

The Account entity represents a connected cryptocurrency exchange account, holding details about portfolio assets, profit statistics, trading permissions, and supported bot tools.

Attributes

idinteger required

ID of the exchange account entity.

exchange_namestring

Name of this exchange account.

market_codestring

Quentrade exchange code entity.

namestring

The custom label for the exchange account set by the user.

market_iconstring

Icon URL of the exchange.

last_auto_balancestring | null

ISO 8601 datetime string of when auto balance was last executed.

hedge_mode_availableboolean

Indicates whether hedge mode is available for this account.

hedge_mode_enabledboolean

Indicates whether hedge mode is currently enabled for this account.

is_lockedboolean

Indicates whether the account is currently locked.

lock_reasonstring | null

The reason for locking this account if is_locked is true.

smart_trading_supportedboolean

Indicates if the SmartTrade tool is supported for this exchange account.

stats_supportedboolean

Indicates whether profit statistics are supported for this account.

trading_supportedboolean

Indicates if trading operations are supported on Quentrade.

market_buy_supportedboolean

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

market_sell_supportedboolean

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

conditional_buy_supportedboolean

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

bots_allowedboolean

Indicates whether DCA Bot is enabled and allowed for this account.

bots_ttp_allowedboolean

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

bots_tsl_allowedboolean

Indicates whether the trailing stop loss feature is enabled on this account.

multi_bots_allowedboolean

Indicates whether the Multi-Pair Bot feature is supported for this account.

fast_convert_availableboolean

Indicates whether the 'Sell All to BTC/USD' feature is enabled for this account.

grid_bots_allowedboolean

Indicates whether Grid Bot is enabled and allowed for this account.

api_key_invalidboolean

Indicates whether the API key credentials for this account are invalid or expired.

api_keys_statestring

Indicates the state of the API keys (e.g. 'ok', 'invalid', 'restricted').

deposit_enabledboolean

Indicates whether deposit functionality is enabled for this exchange.

available_include_in_summaryboolean

Indicates whether this account is available to be included in the total portfolio summary.

include_in_summaryboolean

Indicates whether this account is currently included in the summary calculation.

supported_market_typesarray

List of market types supported by the connected account (e.g. ['spot', 'futures']).

customer_idstring | null

Unique customer ID provided by the exchange if required.

btc_amountstring

Total portfolio equivalent amount in Bitcoin (BTC).

usd_amountstring

Total portfolio equivalent amount in USD.

day_profit_btcstring

Daily profit in BTC.

day_profit_usdstring

Daily profit in USD.

day_profit_btc_percentagenumber

Daily profit percentage in BTC.

day_profit_usd_percentagenumber

Daily profit percentage in USD.

btc_profitnumber

Monthly profit in BTC.

usd_profitnumber

Monthly profit in USD.

btc_profit_percentagenumber

Monthly profit percentage in BTC.

usd_profit_percentagenumber

Monthly profit percentage in USD.

total_btc_profitnumber

All-time total profit in BTC.

total_usd_profitnumber

All-time total profit in USD.

created_atstring

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

updated_atstring

ISO 8601 datetime string of when this Account entity was last updated.

Response Example

account_entity_response.json

200 OK

{
  "id": 12345678,
  "auto_balance_period": 12,
  "auto_balance_portfolio_id": null,
  "auto_balance_portfolio": 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-26T12:24:40.064Z",
  "last_auto_balance": null,
  "fast_convert_available": true,
  "grid_bots_allowed": true,
  "api_key_invalid": false,
  "market_icon": "https://quentrade.com/img/exchanges/bybit.png",
  "deposit_enabled": false,
  "include_in_summary": true,
  "supported_market_types": [
    "spot"
  ],
  "primary_display_currency_profit_percentage": {
    "currency": "USD",
    "amount": "-0.16"
  },
  "primary_display_currency_profit": {
    "currency": "USD",
    "amount": "-0.05357667685386204725891115598750896735184205717088"
  },
  "day_profit_primary_display_currency_percentage": {
    "currency": "USD",
    "amount": "1.3645"
  },
  "day_profit_primary_display_currency": {
    "currency": "USD",
    "amount": "0.44350852268521298378869766114212066212328671783252"
  },
  "primary_display_currency_amount": {
    "currency": "USD",
    "amount": "32.94603614574163795274108884401249103264815794282912"
  },
  "total_primary_display_currency_profit": {
    "currency": "USD",
    "amount": -0.05357667685386205
  },
  "available_include_in_summary": true,
  "name": "new_name",
  "auto_balance_method": null,
  "auto_balance_error": null,
  "customer_id": null,
  "subaccount_name": null,
  "lock_reason": null,
  "btc_amount": "0.000510475159191992399632554490196496789935784848",
  "usd_amount": "32.94603614574163795274108884401249103264815794282912",
  "day_profit_btc": "-0.000001634722576662767703961411470169876729678396865648",
  "day_profit_usd": "0.44350852268521298378869766114212066212328671783252",
  "day_profit_btc_percentage": "-0.32",
  "day_profit_usd_percentage": "1.36",
  "btc_profit": "-0.000033098063328996600367445509803503210064215152",
  "usd_profit": "-0.05357667685386204725891115598750896735184205717088",
  "usd_profit_percentage": "-0.16",
  "btc_profit_percentage": "-6.09",
  "total_btc_profit": "-3.30980633289966e-05",
  "total_usd_profit": "-0.05357667685386205",
  "pretty_display_type": "BybitSpot",
  "exchange_name": "Bybit Spot",
  "market_code": "bybit_spot",
  "api_keys_state": "ok"
}

Previous Account NextAvailable market subtypes