Account

private/get_account

Returns account-level information for a given wallet address: the list of its subaccount IDs, WebSocket rate limits (matching, non-matching, perp, and option messages per second) and any per-endpoint overrides, cancel-on-disconnect and RFQ-maker flags, the account creation timestamp, and a fee_info block with fee discounts and per-instrument maker/taker fee overrides expressed as decimals. Returns an account-not-found error if the wallet has never been registered.

post/private/get_account

Request

  • Base URL: https://api.derive.xyz/v3
  • URL: https://api.derive.xyz/v3/private/get_account
  • Auth: none declared

Request body

walletstring required

20-byte Ethereum address as a 0x-prefixed lowercase hex string.

Response

Success

cancel_on_disconnectboolean required
creation_timestamp_secinteger nullable
fallback_subaccount_idinteger required

Subaccount that receives deposits whose requested destination is unusable — unknown manager id, or the per-wallet subaccount cap already reached. Allocated with the account, and always in the fallback risk universe (id 0).

is_rfq_makerboolean required
per_endpoint_tpsobject required
referral_codestring nullable
subaccount_idsinteger[] required
walletstring required
websocket_matching_tpsinteger required
websocket_non_matching_tpsinteger required
websocket_option_tpsinteger required
websocket_perp_tpsinteger required
whitelisted_recipientsstring[] required

Recipients that session keys may withdraw or transfer ERC-20s to. The owner and Admin-scoped session keys bypass this list.

Changes

No recorded changes to this operation across all 1 revision of this API.