Preferences

{
    "method": "subscribe",
    "params": {
        "channel": "preferences",
        "token": "G38a1tGFzqGiUCmnegBcm8d4nfP3tytiNQz6tkCBYXY"
    }
}

{
    "method": "subscribe",
    "result": {
        "channel": "preferences"
    },
    "success": true,
    "time_in": "2023-10-16T13:29:13.111530Z",
    "time_out": "2023-10-16T13:29:13.111775Z"
}

{
    "channel": "preferences",
    "type": "snapshot",
    "data": {
        "futures_trading": "enabled"
    }
}

{
    "channel": "preferences",
    "type": "update",
    "data": {
        "futures_trading": "reduce_only"
    }
}

{
    "method": "unsubscribe",
    "params": {
        "channel": "preferences",
        "token": "G38a1tGFzqGiUCmnegBcm8d4nfP3tytiNQz6tkCBYXY"
    }
}

{
    "method": "unsubscribe",
    "result": {
        "channel": "preferences"
    },
    "success": true,
    "time_in": "2023-10-16T13:29:13.111530Z",
    "time_out": "2023-10-16T13:29:13.111775Z"
}

{
    "method": "subscribe",
    "params": {
        "channel": "preferences",
        "token": "G38a1tGFzqGiUCmnegBcm8d4nfP3tytiNQz6tkCBYXY"
    }
}

{
    "method": "subscribe",
    "result": {
        "channel": "preferences"
    },
    "success": true,
    "time_in": "2023-10-16T13:29:13.111530Z",
    "time_out": "2023-10-16T13:29:13.111775Z"
}

{
    "channel": "preferences",
    "type": "snapshot",
    "data": {
        "futures_trading": "enabled"
    }
}

{
    "channel": "preferences",
    "type": "update",
    "data": {
        "futures_trading": "reduce_only"
    }
}

{
    "method": "unsubscribe",
    "params": {
        "channel": "preferences",
        "token": "G38a1tGFzqGiUCmnegBcm8d4nfP3tytiNQz6tkCBYXY"
    }
}

{
    "method": "unsubscribe",
    "result": {
        "channel": "preferences"
    },
    "success": true,
    "time_in": "2023-10-16T13:29:13.111530Z",
    "time_out": "2023-10-16T13:29:13.111775Z"
}

The preferences channel streams the user’s account preferences, including the account’s futures (perpetuals) trading permission. Use it to decide whether to present futures functionality. This channel contains account specific data, an authentication token is required in the request. On subscribe, preferences sends a snapshot. It then sends an update whenever a value changes. If preferences are not available yet, the subscribe fails with the error Preferences are not available yet, try again later. Retry the subscribe after a short delay. To set a derivatives market’s leverage preference, use set_preference.

Request
Response

string

required

Value: subscribe

object

required

Hide properties

string

required

Value: preferences

string

required

Authentication token. See authentication guide for details.

integer

Optional client originated request identifier sent as acknowledgment in the response.

string

required

Value: subscribe

object

Hide properties

string

required

Value: preferences

boolean

Indicates if the request was successfully processed by the engine. One of: true, false

string

Error message. Condition: if success is false.

string

The timestamp when the subscription was received on the wire, just prior to parsing data. Format: RFC3339. Example: 2022-12-25T09:30:59.123456Z

string

The timestamp when the acknowledgement was sent on the wire, just prior to transmitting data. Format: RFC3339. Example: 2022-12-25T09:30:59.123456Z

integer

Optional client originated request identifier sent as acknowledgment in the response.

Snapshot / Update

The snapshot provides the user’s current preferences. An update carries the new value after a change.

string

Value: preferences

string

One of: snapshot, update

object

Hide properties

string

One of: enabled, reduce_only, disabledThe futures (perpetuals) trading permission on the user’s account. The value is derived from the account’s verification (KYC) attributes, in this order:

enabled: the account has a futures trading permission.
reduce_only: the account has no futures trading permission, but has a reduce-only futures permission. Only orders that reduce or close existing futures positions are allowed.
disabled: the account has neither permission, or has no attributes on record. Hide futures functionality and do not attempt futures orders.

Unsubscribe

Request
Response

string

required

Value: unsubscribe

object

required

Hide properties

string

required

Value: preferences

string

required

Authentication token. See authentication guide for details.

integer

Optional client originated request identifier sent as acknowledgment in the response.

string

required

Value: unsubscribe

object

Hide properties

string

required

Value: preferences

boolean

Indicates if the request was successfully processed by the engine. One of: true, false

string

Error message. Condition: if success is false.

string

The timestamp when the subscription was received on the wire, just prior to parsing data. Format: RFC3339. Example: 2022-12-25T09:30:59.123456Z

string

The timestamp when the acknowledgement was sent on the wire, just prior to transmitting data. Format: RFC3339. Example: 2022-12-25T09:30:59.123456Z

integer

Optional client originated request identifier sent as acknowledgment in the response.

Public Channels

Trading

Account

System

Snapshot / Update

Unsubscribe

​Subscribe

​Snapshot / Update

​Unsubscribe

Subscribe

Snapshot / Update

Unsubscribe