HomeDocumentationAPI Reference
Log In
API Reference

Get Account

Method Name

private/get_account

Account details getter
Required minimum session key permission level is read_only

Parameters

walletstringrequired
Ethereum wallet address of account

Response

idstring or integerrequired
resultobjectrequired
result.cancel_on_disconnectbooleanrequired
Whether cancel on disconnect is enabled for the account
result.is_rfq_makerbooleanrequired
Whether account allowed to market make RFQs
result.walletstringrequired
Ethereum wallet address
result.websocket_matching_tpsintegerrequired
Max transactions per second for matching requests over websocket (see Rate Limiting in docs)
result.websocket_non_matching_tpsintegerrequired
Max transactions per second for non-matching requests over websocket (see Rate Limiting in docs)
result.websocket_option_tpsintegerrequired
Max transactions per second for EACH option instrument over websocket (see Rate Limiting in docs)
result.websocket_perp_tpsintegerrequired
Max transactions per second for EACH perp instrument over websocket (see Rate Limiting in docs)
result.fee_infoobjectrequired
Fee information for the account
result.fee_info.base_fee_discountstringrequired
Base fee discount
result.fee_info.option_maker_feestring or nullrequired
Option maker fee - uses default instrument fee rate if None
result.fee_info.option_taker_feestring or nullrequired
Option taker fee - uses default instrument fee rate if None
result.fee_info.perp_maker_feestring or nullrequired
Perp maker fee - uses default instrument fee rate if None
result.fee_info.perp_taker_feestring or nullrequired
Perp taker fee - uses default instrument fee rate if None
result.fee_info.rfq_maker_discountstringrequired
RFQ maker fee discount
result.fee_info.rfq_taker_discountstringrequired
RFQ taker fee discount
result.fee_info.spot_maker_feestring or nullrequired
Spot maker fee - uses default instrument fee rate if None
result.fee_info.spot_taker_feestring or nullrequired
Spot taker fee - uses default instrument fee rate if None
result.per_endpoint_tpsobjectrequired
If a particular endpoint has a different max TPS, it will be specified here
result.subaccount_idsarray of integersrequired
List of subaccount_ids owned by the wallet in SubAccounts.sol
result.creation_timestamp_secinteger or null
Account creation timestamp in seconds
result.referral_codestring or null
Referral code for the account (must register with broker program first)

Example

{request_example_shell}
{request_example_javascript}
{request_example_python}

The above command returns JSON structured like this:

{response_example_json}