Deribit Account Management API
The Account Management API from Deribit — 37 operation(s) for account management.
Deribit Account Management API is one of 14 APIs that Deribit publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Account Management. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, and rate-limit docs.
This API exposes 37 operations across 37 paths, and defines 103 schemas. It is described by OpenAPI 3.2.0, at version 2.1.1.
Requests are made against a single base URL, https://test.deribit.com/api/v2.
37 operations
37 paths
103 schemas
37 GET
Metadata
The identity and technical contract details declared by the specification.
Paths & Operations 37
Across 37 paths, the API surfaces 37 operations — 37 GET. Each is listed below with its method, path, parameters, and response codes.
Account Management 37
GET
/private/get_positions
Get private get positions
GET
/private/get_position
Get private get position
GET
/private/get_account_summary
Get private get account summary
GET
/private/get_account_summaries
Get private get account summaries
GET
/private/pme/simulate
Get private pme simulate
GET
/private/simulate_portfolio
Get private simulate portfolio
GET
/private/get_access_log
Get private get access log
GET
/private/get_affiliate_program_info
Get private get affiliate program info
GET
/private/enable_affiliate_program
Get private enable affiliate program
GET
/private/change_margin_model
Get private change margin model
GET
/private/get_user_locks
Get private get user locks
GET
/private/set_self_trading_config
Get private set self trading config
GET
/private/set_disabled_trading_products
Get private set disabled trading products
GET
/private/disable_api_key
Get private disable api key
GET
/private/enable_api_key
Get private enable api key
GET
/private/create_api_key
Get private create api key
GET
/private/change_scope_in_api_key
Get private change scope in api key
GET
/private/change_api_key_name
Get private change api key name
GET
/private/list_api_keys
Get private list api keys
GET
/private/reset_api_key
Get private reset api key
GET
/private/remove_api_key
Get private remove api key
GET
/private/edit_api_key
Get private edit api key
GET
/public/get_announcements
Get public get announcements
GET
/private/get_new_announcements
Get private get new announcements
GET
/private/set_announcement_as_read
Get private set announcement as read
GET
/private/get_email_language
Get private get email language
GET
/private/create_subaccount
Get private create subaccount
GET
/private/change_subaccount_name
Get private change subaccount name
GET
/private/set_email_language
Get private set email language
GET
/private/set_email_for_subaccount
Get private set email for subaccount
GET
/private/toggle_subaccount_login
Get private toggle subaccount login
GET
/private/toggle_notifications_from_subaccount
Get private toggle notifications from subaccount
GET
/private/get_subaccounts
Get private get subaccounts
GET
/private/get_subaccounts_details
Get private get subaccounts details
GET
/private/remove_subaccount
Get private remove subaccount
GET
/private/get_transaction_log
Get private get transaction log
GET
/private/list_custody_accounts
Get private list custody accounts
Schemas 103
The contract defines 103 schemas that model the data the API accepts and returns. The most detailed are order (52 properties), transaction_log (34 properties), position (23 properties), custody_account (11 properties). Each schema is shown below with its type and property counts.
kind
string
Instrument kind: "future", "option", "spot", "futurecombo", "optioncombo"
display_amount
number
The actual display amount of iceberg order. Absent for other types of orders.
triggered
boolean
Whether the trigger order has been triggered
api_key_name
string
Api key name that can be displayed in transaction log
position_direction
string
Direction: buy, sell or zero
role
string
Trade role of the user: maker or taker
direction
string
Direction: buy, or sell
currency_portfolio
object
10 properties
10 required
label
string
User defined label (up to 64 characters)
ErrorMessageResponse
object
4 properties
3 required
custody_name
string
Custody name
order
object
52 properties
12 required
advanced
string
advanced type: "usd" or "implv" (Only for options; field is omitted if not applicable).
fee_role
string
Fee role of the user: maker or taker. Can be different from trade role of the user when iceberg order was involved in matching.
ErrorResponse
object
Generic error response for broken references
2 properties
2 required
PrivateApiKeyResponse
object
3 properties
2 required
PrivateGetSubaccountsDetailsResponse
object
3 properties
2 required
api_limits
object
Returned object is described in [separate document](https://support.deribit.com/hc/en-us/articles/25944617523357-Rate-Limits).
refresh_amount
number
The initial display amount of iceberg order. Iceberg order display amount will be refreshed to that value after match consuming actual display amount. Absent f…
api_key_enabled
boolean
Informs whether api key is enabled and can be used for authentication
continuation_with_null
integer
Continuation token for pagination. NULL when no continuation.
additional_reserve
number
The account's balance reserved in other orders
projected_delta_total
number
The sum of position deltas without positions that will expire during closest expiration
average_price
number
Average fill price of the order
PublicListApiKeysResponse
object
3 properties
2 required
access_log
object
7 properties
6 required
client_id
string
Client identifier used for authentication
PrivateGetEmailLanguageResponse
object
3 properties
2 required
PrivateCreateSubaccountResponse
object
3 properties
2 required
oco_ref
string
Unique reference that identifies a onecancelsothers (OCO) pair.
PrivateGetPositionResponse
object
3 properties
2 required
post_only
boolean
true for post-only orders only
is_secondary_oto
boolean
true if the order is an order that can be triggered by another order, otherwise not present.
trigger_price
number
Trigger price (Only for future trigger orders)
GetlistCustodyAccounts200response
user_id
integer
Unique user identifier
fee_balance
number
The account's fee balance (it can be used to pay for fees)
trigger_reference_price
number
The price of the given trigger at the time when the order was placed (Only for trailing trigger orders)
kind_without_spot
string
Instrument kind: "future", "option", "futurecombo", "optioncombo" (spot is excluded as spot trades are settled immediately and have no open positions)
pme_currency
string
The currency for which the Extended Risk Matrix will be calculated. Use CROSS for Cross Collateral simulation.
public_key
string
PEM encoded public key (Ed25519/RSA) used for asymmetric signatures (optional)
trade_id
string
Unique (per currency) trade identifier
reduce_only
boolean
Optional (not added for spot). 'true for reduce-only orders only'
PrivateAccountSummariesResponse
object
3 properties
2 required
block_trade_order
boolean
true if order made from blocktrade trade, added only in that case.
rpl
number
Session realized profit and loss
PrivatePmeSimulateResponse
object
3 properties
2 required
filled_amount
number
Filled amount of the order. For perpetual and futures the filledamount is in USD units, for options - in units or corresponding cryptocurrency contracts, e.g.,…
api_key_features
array
List of enabled advanced on-key features. Available options: - restrictedblocktrades : Limit the blocktrade read the scope of the API key to block trades that…
position
object
23 properties
14 required
order_state
string
Order state: "open", "filled", "rejected", "cancelled", "untriggered"
trigger_offset
number
The maximum deviation from the price peak beyond which the order will be triggered (Only for trailing trigger orders)
order_id
string
Unique order identifier
api_key
object
11 properties
6 required
PrivateGetSubaccountsResponse
object
3 properties
2 required
external_id
string
User ID in external systems
commission
number
Commission paid so far (in base currency)
currency
string
Currency, i.e "BTC", "ETH", "USDC"
wallet_currency
string
Currency, i.e "BTC", "ETH", "USDC"
PrivateGetAccessLogResponse
object
3 properties
2 required
transaction_log
object
34 properties
10 required
upl
number
Session unrealized profit and loss
original_order_type
string
Original order type. Optional field
contracts
number
It represents the order size in contract units. (Optional, may be absent in historical data).
web
boolean
true if created via Deribit frontend (optional)
api
boolean
true if created with API
client_secret
string
Client secret or MD5 fingerprint of public key used for authentication
PublicGetAnnouncementsResponse
object
3 properties
2 required
trigger_fill_condition
string
The fill condition of the linked order (Only for linked order types), default: firsthit. "firsthit" - any execution of the primary order will fully cancel/plac…
mobile
boolean
Optional field with value true added only when created with Mobile Application
currency_amount
number
Amount of funds in given currency
key_id
integer
Key identifier
custody_account
object
Custody account
11 properties
3 required
order_type
string
Order type: "limit", "market", "stoplimit", "stopmarket", "takelimit", "takemarket", "trailingstop"
implv
number
Implied volatility in percent. (Only if advanced="implv")
trigger
string
Trigger type (only for trigger orders). Allowed values: "indexprice", "markprice", "lastprice".
api_key_default
boolean
Informs whether this api key is default (field is deprecated and will be removed in the future)
PrivateGetPositionsResponse
object
3 properties
2 required
amount
number
It represents the requested order size. For perpetual and inverse futures the amount is in USD units. For options and linear futures it is the underlying base…
id
integer
Unique identifier
projected_maintenance_margin
number
Projected maintenance margin. When cross collateral is enabled, this aggregated value is calculated by converting the sum of each cross collateral currency's v…
username
string
System name or user defined subaccount alias
OkResponse
object
3 properties
2 required
timestamp
integer
The timestamp (milliseconds since the Unix epoch)
delta_total
number
The sum of position deltas. DeltaTotal = Net Transaction Delta of options + BTC Position of Futures The DeltaTotal uses the Net Transaction Delta (or price adj…
cancel_reason
string
Enumerated reason behind cancel "userrequest", "autoliquidation", "cancelondisconnect", "riskmitigation", "pmeriskreduction" (portfolio margining risk reductio…
estimated_liquidation_ratio
number
Estimated Liquidation Ratio is returned only for users without portfolio margining enabled. Multiplying it by future position's market price returns its estima…
time_in_force
string
Order time in force: "goodtilcancelled", "goodtilday", "fillorkill" or "immediateorcancel"
reject_post_only
boolean
true if order has rejectpostonly flag (field is present only when postonly is true)
PrivateChangeMarginModelResponse
object
3 properties
2 required
PrivateGetUserLocksResponse
object
3 properties
2 required
position_with_elp
open_order_price
Price in base currency or "marketprice" in case of open trigger market orders
usd
number
Option price in USD (Only if advanced="usd")
PrivateSimulatePortfolioResponse
object
3 properties
2 required
portfolio
object
1 property
PrivateAccountResponse
object
3 properties
2 required
currency_with_any
string
Currency name or "any" if don't care
instrument_name
string
Unique instrument identifier
PrivateGetTransactionLogResponse
object
3 properties
2 required
PrivateGetAffiliateProgramInfoResponse
object
3 properties
2 required
max_scope
array
Describes maximal access for tokens generated with given key. If scope is not provided, its value is set as none. 📖 Related Article: [Access Scope](https://doc…
projected_initial_margin
number
Projected initial margin. When cross collateral is enabled, this aggregated value is calculated by converting the sum of each cross collateral currency's value…
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Deribit 12
Other APIs Deribit publishes across the network.
Deribit WebSocket API
Deribit FIX API
Deribit Authentication API
Deribit Block RFQ API
Deribit Block Trade API
Deribit Combo Books API
Deribit Market Data API
Deribit Portfolio Management API
Deribit Session Management API
Deribit Subscription Management API
Deribit Supporting API
Deribit Trading API
#Account Management
Where this information came from
This is an independent, third-party profile of Deribit Account Management API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.