Skip to main content

private/get-account-settings

POST 
/private/get-account-settings
Get account settings.

Request​

Body

required
    id int64required

    Request id (echoed in response)

    method stringrequired

    Must be "private/get-account-settings"

    api_key stringrequired

    Your API key (only required for private REST)

    sig stringrequired

    HMAC-SHA256 signature in hex (only required for private REST)

    nonce int64required

    Current timestamp in milliseconds, e.g. "1771761038000".

    params objectrequired
    No parameters; use empty object
Success.
Schema
    id int64

    Echoed request id

    method string

    Method invoked

    code int32

    0 for successful changes.

    result object[]
    Present when code === 0. result[] has leverage, stp_id, stp_scope, stp_inst per docs.
  • Array [
    • leverage decimal

    The max leverage user set on the account. When account effective leverage exceeds this, further risk increasing orders will be rejected.

    stp_id int64

    Optional. 0 to 32767. If stp_scope and stp_inst not specified, REJECT. If stp_scope specified, default 0. Orderbook-specific settings take higher precedence.

    stp_scope StpScope (string)

    Possible values: [M, S, D]

    Self-trade prevention scope. Used in private/change-account-settings (params) and private/get-account-settings (result).

    • ➖ M: Matches Master or Sub a/c
    • ➖ S: Matches Sub a/c only
    • ➖ D: reset all STP fields to default (stp_inst and stp_id in same request are ignored).
    stp_inst StpInst (string)

    Possible values: [M, T, B]

    Self-trade prevention instruction. Used in private/change-account-settings (params) and private/get-account-settings (result). Mandatory if stp_scope is set.

    • ➖ M: Cancel Maker
    • ➖ T: Cancel Taker
    • ➖ B: Cancel Both Maker and Taker
  • ]
    • message string

    Present when code !== 0.

    original string

    Present when code !== 0.