Sign in

v2

OpenAPI 3.0.02026-07-311824171.4 MB
Account Management
Private

Creates a new Direct Access member, or edits an existing one. Returns the resulting list of all members configured for the account.

This method is dedicated to Starbase. See Starbase Account Model for an explanation of Members, portfolios, and their relationship to Deribit accounts.

Omit member_id to create a new member; a non-empty accounts list is then required, and the member cannot be created inactive. Pass an existing member_id to edit that member's name or accounts list, or to toggle its is_active state — toggling is_active and changing name/accounts cannot be done in the same request.

Requires Direct Access trading to be enabled for the account.

Scope: account:read_write and mainaccount

Try in API console

get/private/set_member

Query parameters

member_idinteger
Example:195

ID of the member to edit. Omit to create a new member.

namestring required
Example:Member1

Name of the member.

is_activeboolean
Example:true

Whether the member should be active. true by default. A member cannot be created inactive.

accountsinteger[]

List of (sub)account user ids to grant the member Direct Access trading rights on.

[
  85867
]

Response

Success response

jsonrpc'2.0' required

The JSON-RPC version (2.0)

idinteger

The id that was sent in the request

Example response

{
  "result": {
    "members": [
      {
        "member_id": 195,
        "main_uid": 57874,
        "name": "Member1",
        "is_active": true,
        "accounts": [
          85867
        ],
        "m_tstamp": 1690000000000
      }
    ],
    "is_direct_access_allowed": true
  }
}