Skip to main content

Get Account List

  • GET /capi/v2/account/accounts

Required permission: Futures trading read permissions

Weight(IP): 5, Weight(UID): 5

Request parameters

NONE

Request example

curl "https://api-contract.weex.com/capi/v2/account/accounts" \
   -H "ACCESS-KEY:*******" \
   -H "ACCESS-SIGN:*******" \
   -H "ACCESS-PASSPHRASE:*****" \
   -H "ACCESS-TIMESTAMP:1659076670000" \
   -H "locale:zh-CN" \
   -H "Content-Type: application/json"

Response parameters

ParameterTypeDescription
accountobjectAccount information
> idstringAccount ID
> user_idstringAssociated user ID
> client_account_idstringClient account ID
> is_system_accountbooleanWhether the account is a system account
> default_fee_settingobjectDefault fee configuration
> > is_set_fee_ratebooleanWhether fee rates are set
> > taker_fee_ratestringTaker fee rate
> > maker_fee_ratestringMaker fee rate
> > is_set_fee_discountbooleanWhether fee discounts are enabled
> > fee_discountstringFee rate discount
> > is_set_taker_maker_fee_discountbooleanWhether to apply separate fee discounts for takers and makers
> > taker_fee_discountstringTaker fee rate discount
> > maker_fee_discountstringMaker fee rate discount
> contract_id_to_fee_settingobjectFee settings for futures ID
> > contract_idstringFutures ID. For example, 10000001.
> > is_set_fee_ratebooleanWhether fee rates are set
> > taker_fee_ratestringTaker fee rate
> > maker_fee_ratestringMaker fee rate
> > is_set_fee_discountbooleanWhether fee discounts are enabled
> > fee_discountstringFee rate discount
> > is_set_taker_maker_fee_discountbooleanWhether to apply separate fee discounts for takers and makers
> > taker_fee_discountstringTaker fee rate discount
> > maker_fee_discountstringMaker fee rate discount
> contract_id_to_mode_settingobjectMode settings for futures ID
> > contract_idstringFutures ID
> > margin_modestringMargin mode
> > separated_modestringPosition segregation mode
> > position_modestringPosition mode
> contract_id_to_leverage_settingobjectLeverage settings for futures ID
> > contract_idstringFutures ID
> > isolated_long_leveragestringIsolated long position leverage
> > isolated_short_leveragestringIsolated short position leverage
> > cross_leveragestringCross margin leverage
> > shared_leveragestringShared leverage
> create_order_rate_limit_per_minuteintegerOrder creation rate limit per minute
> create_order_delay_millisecondsintegerOrder creation delay (milliseconds)
> extra_typestringAppend type
> extra_data_jsonstringAppend data
> statusstringAccount status
> created_timestringCreation time
> updated_timestringUpdate time
collateralarray objectCollateral information
> account_idstringUser ID
> coin_idintegerCrypto ID
> margin_modestringMargin mode
> cross_contract_idintegerRepresents futures ID associated with cross margin mode when margin_mode=CROSS.Value is 0 in other scenarios.
> isolated_position_idstringRepresents futures ID associated with isolated margin mode when margin_mode=ISOLATED.Value is 0 in other scenarios.
> amountstringCollateral amount
> pending_deposit_amountstringPending deposit amount
> pending_withdraw_amountstringPending withdrawal amount
> pending_transfer_in_amountstringPending inbound transfer amount
> pending_transfer_out_amountstringPending outbound transfer amount
> is_liquidatingbooleanWhether liquidation is triggered (in progress)
> legacy_amountstringLegacy balance (display only)
> cum_deposit_amountstringAccumulated deposit amount
> cum_withdraw_amountstringAccumulated withdrawal amount
> cum_transfer_in_amountstringAccumulated inbound transfer amount
> cum_transfer_out_amountstringAccumulated outbound transfer amount
> cum_margin_move_in_amountstringAccumulated margin deposit amount
> cum_margin_move_out_amountstringAccumulated margin withdrawal amount
> cum_position_open_long_amountstringAccumulated collateral amount for long position openings
> cum_position_open_short_amountstringAccumulated collateral amount for short position openings
> cum_position_close_long_amountstringAccumulated collateral amount for long position closings.
> cum_position_close_short_amountstringAccumulated collateral amount for short position closings.
> cum_position_fill_fee_amountstringAccumulated trading fees for filled orders
> cum_position_liquidate_fee_amountstringAccumulated liquidation fees
> cum_position_funding_amountstringAccumulated funding fees
> cum_order_fill_fee_income_amountstringAccumulated order fee income
> cum_order_liquidate_fee_income_amountstringAccumulated liquidation fee income
> created_timestringCreation time
> updated_timestringUpdate time
positionarray objectPosition Information
> idstringPosition ID
> account_idstringAssociated account ID
> coin_idintegerAssociated collateral currency ID
> contract_idintegerAssociated futures ID
> sidestringPosition direction
> margin_modestringMargin mode of current position
> separated_modestringCurrent position's separated mode
> separated_open_order_idstringOpening order ID of separated position
> leveragestringPosition leverage
> sizestringCurrent position size
> open_valuestringInitial value at position opening
> open_feestringOpening fee
> funding_feestringFunding fee
> isolated_marginstringIsolated margin
> is_auto_append_isolated_marginbooleanWhether the auto-adding of funds for the isolated margin is enabled (only for isolated mode)
> cum_open_sizestringAccumulated opened positions
> cum_open_valuestringAccumulated value of opened positions
> cum_open_feestringAccumulated fees paid for opened positions
> cum_close_sizestringAccumulated closed positions
> cum_close_valuestringAccumulated value of closed positions
> cum_close_feestringAccumulated fees paid for closing positions
> cum_funding_feestringAccumulated settled funding fees
> cum_liquidate_feestringAccumulated liquidation fees
> created_match_sequence_idstringMatching engine sequence ID at creation
> updated_match_sequence_idstringMatching engine sequence ID at last update
> created_timestringCreation time
> updated_timestringUpdate time
versionstringVersion

Response example

{
    "account": {
        "id": "421858251051630976",
        "user_id": "7718764769",
        "client_account_id": "7718764769-0508",
        "is_system_account": true,
        "default_fee_setting": null,
        "contract_id_to_fee_setting": {
            "10000001": {
                "is_set_fee_rate": true,
                "taker_fee_rate": "0.00000000",
                "maker_fee_rate": "0.00000000",
                "is_set_fee_discount": false,
                "fee_discount": "0",
                "is_set_taker_maker_fee_discount": false,
                "taker_fee_discount": "0",
                "maker_fee_discount": "0"
            }
        },
        "contract_id_to_mode_setting": {
            "10000002": {
                "margin_mode": "SHARED",
                "separated_mode": "COMBINED",
                "position_mode": "HEDGE"
            }
        },
        "contract_id_to_leverage_setting": {
            "10000001": {
                "isolated_long_leverage": "20.00",
                "isolated_short_leverage": "20.00",
                "cross_leverage": "20.00",
                "shared_leverage": "1"
            }
        },
        "create_order_rate_limit_per_minute": 0,
        "create_order_delay_milliseconds": 0,
        "extra_type": "",
        "extra_data_json": "",
        "status": "NORMAL",
        "created_time": "1700578844798",
        "updated_time": "1705391349508"
    },
    "collateral": [
        {
            "account_id": "421858251051630976",
            "coin_id": 2,
            "margin_mode": "SHARED",
            "cross_contract_id": 0,
            "isolated_position_id": "0",
            "amount": "21231909852.711513",
            "pending_deposit_amount": "0.000000",
            "pending_withdraw_amount": "0",
            "pending_transfer_in_amount": "0",
            "pending_transfer_out_amount": "0",
            "is_liquidating": false,
            "legacy_amount": "21234772049.343405",
            "cum_deposit_amount": "21234567890.000000",
            "cum_withdraw_amount": "0",
            "cum_transfer_in_amount": "0",
            "cum_transfer_out_amount": "0",
            "cum_margin_move_in_amount": "0",
            "cum_margin_move_out_amount": "0",
            "cum_position_open_long_amount": "25523349003485.201468",
            "cum_position_open_short_amount": "50774213965304.236521",
            "cum_position_close_long_amount": "25522737076815.637500",
            "cum_position_close_short_amount": "50773604699630.950000",
            "cum_position_fill_fee_amount": "0.000000",
            "cum_position_liquidate_fee_amount": "0",
            "cum_position_funding_amount": "2958.988960",
            "cum_order_fill_fee_income_amount": "0",
            "cum_order_liquidate_fee_income_amount": "0",
            "created_time": "1700581216925",
            "updated_time": "1712906917435"
        }
    ],
    "position": [
        {
            "id": "454642920734065280",
            "account_id": "421858251051630976",
            "coin_id": 2,
            "contract_id": 10000002,
            "side": "LONG",
            "margin_mode": "SHARED",
            "separated_mode": "COMBINED",
            "separated_open_order_id": "0",
            "leverage": "1",
            "size": "27274.76",
            "open_value": "96424634.945230",
            "open_fee": "0.000000",
            "funding_fee": "0.000001",
            "isolated_margin": "0",
            "is_auto_append_isolated_margin": false,
            "cum_open_size": "1008603941.11",
            "cum_open_value": "3585662573619.301769",
            "cum_open_fee": "0.000000",
            "cum_close_size": "1008576666.35",
            "cum_close_value": "3585502584783.322000",
            "cum_close_fee": "0.000000",
            "cum_funding_fee": "2084980.834006",
            "cum_liquidate_fee": "0",
            "created_match_sequence_id": "592131124",
            "updated_match_sequence_id": "1010375837",
            "created_time": "1708395319042",
            "updated_time": "1712906917435"
        }
    ],
    "version": "2231022786"
}