Three methods of authentication are supported (selected with grant_type):
client_credentials - Using the client id and client secret that can be found on the API page on the website. This is the simplest method, suitable for server-to-server applications and quick setup.
client_signature - Enhanced security method using a cryptographic signature instead of sending the client secret directly. The signature is calculated over <timestamp>\n<nonce>\n<data> (the three values joined with line-feed characters, timestamp exactly as sent). Keys with a shared secret use an HMAC-SHA256 signature encoded as hexadecimal; asymmetric (RSA / Ed25519) keys use a digital signature over the same string encoded as URL-safe base64 without padding. This method requires client_id, timestamp and signature; nonce and data are optional (nonce is strongly recommended for replay protection). See the Client Signature (WebSocket) guide for detailed signature calculation instructions.
refresh_token - Using a refresh token that was received from an earlier invocation. This allows you to obtain a new access token without re-supplying your Client ID and Client Secret. Best for long-lived sessions, token renewal, and avoiding re-authentication.
Refresh token behavior:
Every successful refresh issues a new access token and a new refresh token, and invalidates the previously issued token pair. Always store the newest refresh_token; reusing an older one fails with -32602 (invalid token), which also affects concurrent refreshes with the same token.
The scope parameter is ignored for this grant type: the new tokens keep the scope, session and lifetime of the original token.
A token with connection scope is bound to the connection it was issued on and cannot be refreshed or used from another connection.
Scope behavior (client_credentials and client_signature):
Without a session: or connection scope item, a WebSocket request gets a connection scope token. An HTTP (REST) request gets a session scope token with a generated rest-... session name, unless connection was requested explicitly.
connection and session:name cannot be combined (-32602).
Requested permission scopes (trade, wallet, account, block_trade, block_rfq) never exceed the permissions of the API key: higher levels are silently reduced to the key’s level, and permission scopes that are not requested inherit the key’s permissions. This is not reported as an error.
Response:
The response will contain an access token, expiration period (number of seconds that the token is valid) and a refresh token that can be used to get a new set of tokens. Over WebSocket, a successful call also authenticates the current connection, so later private requests on it need no access_token.
Errors (JSON-RPC error.code):
13004invalid_credentials - unknown client_id, wrong client_secret, invalid signature, or client_id longer than 16 bytes.
13009unauthorized - timestamp outside the allowed window, nonce longer than 128 bytes or already used, connecting IP not in the key’s IP whitelist (reason: bad_ip).
-32602Invalid params - missing required parameter for the chosen grant_type, unknown grant_type, invalid scope, or an invalid / expired / already-replaced refresh_token (including session_not_found).
Required for grant types client_credentials and client_signature. Maximum length is 16 bytes.
Example:
"fo7WAPRm4P"
client_secret
string
Required for grant type client_credentials.
Example:
"W0H6FJW4IRPZ1MOQ8FP6KMC5RZDUUKXS"
refresh_token
string
Required for grant type refresh_token. The token pair it belongs to is replaced by the new tokens returned (see above).
timestamp
integer
Required for grant type client_signature.
Time when the request was generated, in milliseconds since the UNIX epoch. Must be within ±60 seconds (±60,000 ms) of the server time, otherwise the request is rejected with error 13009 (unauthorized).
signature
string
Required for grant type client_signature.
Signature calculated over <timestamp>\n<nonce>\n<data>:
Shared-secret API keys: HMAC-SHA256 with the client secret as key, encoded as hexadecimal (letter case is ignored).
Asymmetric (RSA / Ed25519) API keys: digital signature made with your private key (SHA-256), encoded as URL-safe base64 without padding.
An invalid signature is rejected with error 13004 (invalid_credentials).
nonce
string
Optional for grant type client_signature, but strongly recommended. Defaults to an empty string.
User-generated random string, up to 128 bytes. A non-empty nonce can be used only once for the same client_id and timestamp (a repeat is rejected with 13009). With an empty or omitted nonce the timestamp window is still enforced but replay detection is not.
data
string
Optional for grant type client_signature. Defaults to an empty string.
Contains any user specific value; it is part of the signed string.
state
string
Will be passed back in the response.
scope
string
Describes type of the access for assigned token. Ignored for grant type refresh_token.
Possible values:
connection
session:name (names longer than 64 bytes are truncated)
trade:[read, read_write, none]
wallet:[read, read_write, none]
account:[read, read_write, none]
block_trade:[read, read_write, none]
block_rfq:[read, read_write, none]
expires:NUMBER
ip:ADDR
connection and session:name are mutually exclusive. Permission scopes cannot exceed the permissions of the API key.
OAuth access token to be used for authentication of 'private' requests
Example:
"843SehgeX5n6XxEU4XbABx4Cny5Akai5iHiJePTsvUw7"
result.token_type
enum<string>
required
Authorization type, allowed value - bearer
Available options:
bearer
result.expires_in
integer
required
Token lifetime in seconds
Example:
31536000
result.refresh_token
string
required
Can be used to request a new token (with a new lifetime)
Example:
"6faf8L36JdaSqsjCEEiwqifPpj6JB18RWwiWHrsGTZ91"
result.scope
string
required
Type of the access for assigned token
result.state
string
Copied from the input (if applicable)
result.sid
string
Optional Session id
result.enabled_features
string[]
List of enabled advanced on-key features.
Available options: - restricted_block_trades: Limit the block_trade read scope of the API key to Block Trades that have been made using this specific API key - block_trade_approval: Block Trades created using this API key require additional user approval. Methods that use block_rfq scope are not affected by Block Trade approval feature
result.mandatory_tfa_status
string
2FA is required for privileged methods
Example:
"enabled"
result.google_login
boolean
The access token was acquired by logging in through Google.
result.apple_login
boolean
The access token was acquired by logging in through Apple.
result.coinbase_login
boolean
The access token was acquired by logging in through Coinbase.
id
integer
The id that was sent in the request
Was this page helpful?
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Deribit API Documentation","colors":{"primary":"#0052FF","light":"#FFFFFF","dark":"#0A0B0D"},"logo":{"light":"https://mintcdn.com/deribit/jU8dKQ0mWmFd1NVE/images/deribit_cb_logo_main_black_rgb.svg?fit=max\u0026auto=format\u0026n=jU8dKQ0mWmFd1NVE\u0026q=85\u0026s=f6995f51656093856017582bb557e0ff","dark":"https://mintcdn.com/deribit/jU8dKQ0mWmFd1NVE/images/deribit_cb_logo_main_white_rgb.svg?fit=max\u0026auto=format\u0026n=jU8dKQ0mWmFd1NVE\u0026q=85\u0026s=54d8347f0cac32c775a460a4d7e569f4"},"favicon":{"light":"https://mintcdn.com/deribit/WDohEFxcHZWhzVUu/images/deribit_cb_emblem_blue_rgb@2x.png?fit=max\u0026auto=format\u0026n=WDohEFxcHZWhzVUu\u0026q=85\u0026s=0a53f4ec20c46d3d11d95a63fb1758aa","dark":"https://mintcdn.com/deribit/WDohEFxcHZWhzVUu/images/deribit_cb_emblem_blue_rgb@2x.png?fit=max\u0026auto=format\u0026n=WDohEFxcHZWhzVUu\u0026q=85\u0026s=0a53f4ec20c46d3d11d95a63fb1758aa"},"api":{"params":{"expanded":"all"},"playground":{"display":"none"},"examples":{"autogenerate":false}},"footer":{"socials":{"x":"https://x.com/DeribitOfficial","linkedin":"https://www.linkedin.com/company/deribit"}},"seo":{"metatags":{"canonical":"https://docs.deribit.com/","description":"Complete API documentation for Deribit cryptocurrency derivatives exchange. Learn how to integrate with our JSON-RPC, WebSocket, and FIX APIs for trading futures, perpetuals, and options.","keywords":"Deribit API, cryptocurrency API, derivatives API, trading API, WebSocket API, FIX API, Bitcoin futures, options trading, API documentation","author":"Deribit","robots":"index, follow","og:type":"website","og:site_name":"Deribit API Documentation","og:locale":"en_US","twitter:card":"summary_large_image","twitter:site":"@DeribitOfficial","application-name":"Deribit API Documentation","theme-color":"#0052FF","color-scheme":"light dark"}},"integrations":{"ga4":{"measurementId":"G-3TPTYKFQQ7"}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"deribit","hasAudioNarration":false,"actualSubdomain":"deribit","customDomains":["docs.deribit.com"],"gitSource":{"type":"github","owner":"deribit","repo":"api-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"feedback":{"thumbs":true,"edits":true,"issues":true,"contextualFeedback":{"allowEmail":true},"agentFeedback":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"REMOVE_BRANDING":{"status":"ENABLED"},"CONTEXTUAL_FEEDBACK":{"status":"ENABLED"},"CODE_SNIPPET_FEEDBACK":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6b0072fede75caffbb0284e0","clientVersion":"0.0.4270","searchFilterCounts":[{"language":"default","tag":"API Reference","count":606},{"language":"default","tag":"JSON-RPC API","count":376},{"language":"default","tag":"Methods","count":373},{"language":"default","tag":"Market Data","count":103},{"language":"default","tag":"Subscription Channels","count":87},{"language":"default","tag":"Websockets","count":86},{"language":"default","tag":"Account Management","count":82},{"language":"default","tag":"FIX API","count":78},{"language":"default","tag":"Trading","count":74},{"language":"default","tag":"Wallet","count":50}],"searchSettings":{"maxResults":10}},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableAskAiSearchBar":true,"deflection":{"enabled":true,"email":"dev@deribit.com","showHelpButton":true}},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"site-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"treatment","enabled":true,"payload":{"type":"string","value":"treatment"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"public/style.css","content":".method-pill,.method-nav-pill{display:none!important}.tryit-button{display:none!important}.api-section-heading-subtitle{display:none!important}.api-section[data-section=\"body\"]{display:none!important}li[data-title] button.group>div{font-weight:700!important}body:has(a[aria-current=\"page\"][href*=\"/fix-api/\"]) table th:nth-child(1),body:has(a[aria-current=\"page\"][href*=\"/fix-api/\"]) table td:nth-child(1){width:6%!important;min-width:50px}body:has(a[aria-current=\"page\"][href*=\"/fix-api/\"]) table th:nth-child(2),body:has(a[aria-current=\"page\"][href*=\"/fix-api/\"]) table td:nth-child(2){width:12%!important;min-width:90px}body:has(a[aria-current=\"page\"][href*=\"/fix-api/\"]) table th:nth-child(3),body:has(a[aria-current=\"page\"][href*=\"/fix-api/\"]) table td:nth-child(3){width:8%!important;min-width:70px}body:has(a[aria-current=\"page\"][href*=\"/fix-api/\"]) table th:nth-child(4),body:has(a[aria-current=\"page\"][href*=\"/fix-api/\"]) table td:nth-child(4){width:8%!important;min-width:70px}body:has(a[aria-current=\"page\"][href*=\"/fix-api/\"]) table th:nth-child(5),body:has(a[aria-current=\"page\"][href*=\"/fix-api/\"]) table td:nth-child(5){width:66%!important;min-width:350px}.rate-limit-methods{margin-top:0.75rem}.rate-limit-method-labels,.rate-limit-method-values{display:grid;grid-template-columns:minmax(4.5rem, 0.7fr) minmax(5rem, 0.9fr) minmax(8rem, 1.4fr) minmax(6rem, 1fr);column-gap:1rem;align-items:baseline}.rate-limit-method-labels{padding-bottom:0.35rem;border-bottom:1px solid color-mix(in srgb, currentColor 16%, transparent);font-size:0.8125rem;font-weight:600}.rate-limit-method{padding:0.7rem 0;border-bottom:1px solid color-mix(in srgb, currentColor 12%, transparent)}.rate-limit-method:last-child{border-bottom:none;padding-bottom:0.15rem}.rate-limit-method-name{margin-bottom:0.3rem}.rate-limit-method-name code{white-space:nowrap!important;word-break:normal!important;overflow-wrap:normal!important}.rate-limit-metric-label{display:none}.rate-limit-tiers table{table-layout:fixed;width:100%}.rate-limit-tiers th,.rate-limit-tiers td{min-width:0!important;width:auto!important}.rate-limit-tiers th:nth-child(1),.rate-limit-tiers td:nth-child(1){width:11%!important}.rate-limit-tiers th:nth-child(2),.rate-limit-tiers td:nth-child(2){width:18%!important}.rate-limit-tiers th:nth-child(3),.rate-limit-tiers td:nth-child(3){width:18%!important}.rate-limit-tiers th:nth-child(4),.rate-limit-tiers td:nth-child(4){width:16%!important}.rate-limit-tiers th:nth-child(5),.rate-limit-tiers td:nth-child(5){width:37%!important}@media (max-width: 640px){.rate-limit-method-labels{display:none}.rate-limit-method-values{grid-template-columns:1fr 1fr;row-gap:0.45rem}.rate-limit-metric-label{display:block;font-size:0.75rem;font-weight:600;opacity:0.7}}"}]}
{"page":{"pagePath":"api-reference/upcoming/authentication/public-auth","slug":"/api-reference/upcoming/authentication/public-auth","pageMetadata":{"title":"public/auth","description":"Retrieve an OAuth access token, to be used for authentication of 'private' requests.\n\n**📖 Related Article:** [Authentication](https://docs.deribit.com/articles/authentication)\n\n**Authentication Methods:**\n\nThree methods of authentication are supported (selected with `grant_type`):\n\n- `client_credentials` - Using the client id and client secret that can be found on the API page on the website. This is the simplest method, suitable for server-to-server applications and quick setup.\n\n- `client_signature` - Enhanced security method using a cryptographic signature instead of sending the client secret directly. The signature is calculated over `\u003ctimestamp>\\n\u003cnonce>\\n\u003cdata>` (the three values joined with line-feed characters, `timestamp` exactly as sent). Keys with a shared secret use an HMAC-SHA256 signature encoded as hexadecimal; asymmetric (RSA / Ed25519) keys use a digital signature over the same string encoded as URL-safe base64 without padding. This method requires `client_id`, `timestamp` and `signature`; `nonce` and `data` are optional (`nonce` is strongly recommended for replay protection). See the [Client Signature (WebSocket) guide](https://docs.deribit.com/articles/authentication#client-signature-websocket) for detailed signature calculation instructions.\n\n- `refresh_token` - Using a refresh token that was received from an earlier invocation. This allows you to obtain a new access token without re-supplying your Client ID and Client Secret. Best for long-lived sessions, token renewal, and avoiding re-authentication.\n\n**Refresh token behavior:**\n\n- Every successful refresh issues a **new** access token **and** a new refresh token, and invalidates the previously issued token pair. Always store the newest `refresh_token`; reusing an older one fails with `-32602` (`invalid token`), which also affects concurrent refreshes with the same token.\n- The `scope` parameter is ignored for this grant type: the new tokens keep the scope, session and lifetime of the original token.\n- A token with `connection` scope is bound to the connection it was issued on and cannot be refreshed or used from another connection.\n\n**Scope behavior (`client_credentials` and `client_signature`):**\n\n- Without a `session:` or `connection` scope item, a WebSocket request gets a `connection` scope token. An HTTP (REST) request gets a `session` scope token with a generated `rest-...` session name, unless `connection` was requested explicitly.\n- `connection` and `session:name` cannot be combined (`-32602`).\n- Requested permission scopes (`trade`, `wallet`, `account`, `block_trade`, `block_rfq`) never exceed the permissions of the API key: higher levels are silently reduced to the key's level, and permission scopes that are not requested inherit the key's permissions. This is not reported as an error.\n\n**Response:**\n\nThe response will contain an access token, expiration period (number of seconds that the token is valid) and a refresh token that can be used to get a new set of tokens. Over WebSocket, a successful call also authenticates the current connection, so later private requests on it need no `access_token`.\n\n**Errors** (JSON-RPC `error.code`):\n\n- `13004` `invalid_credentials` - unknown `client_id`, wrong `client_secret`, invalid `signature`, or `client_id` longer than 16 bytes.\n- `13009` `unauthorized` - `timestamp` outside the allowed window, `nonce` longer than 128 bytes or already used, connecting IP not in the key's IP whitelist (`reason: bad_ip`).\n- `-32602` `Invalid params` - missing required parameter for the chosen `grant_type`, unknown `grant_type`, invalid `scope`, or an invalid / expired / already-replaced `refresh_token` (including `session_not_found`).\n\n[Try in API console](https://test.deribit.com/api_console?method=%2Fpublic%2Fauth)\n\n","deprecated":null,"version":null,"og:title":"public/auth","keywords":["public/auth","grant_type","client_id","client_secret","refresh_token","timestamp","signature","nonce","data","state","scope"],"openapi":"/specifications/deribit_upcoming_openapi.json get /public/auth","href":"/api-reference/upcoming/authentication/public-auth","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n a: \"a\",\n code: \"code\",\n li: \"li\",\n p: \"p\",\n strong: \"strong\",\n ul: \"ul\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"Retrieve an OAuth access token, to be used for authentication of ‘private’ requests.\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.strong, {\n children: \"📖 Related Article:\"\n }), \" \", _jsx(_components.a, {\n href: \"https://docs.deribit.com/articles/authentication\",\n children: \"Authentication\"\n })]\n }), \"\\n\", _jsx(_components.p, {\n children: _jsx(_components.strong, {\n children: \"Authentication Methods:\"\n })\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"Three methods of authentication are supported (selected with \", _jsx(_components.code, {\n children: \"grant_type\"\n }), \"):\"]\n }), \"\\n\", _jsxs(_components.ul, {\n children: [\"\\n\", _jsxs(_components.li, {\n children: [\"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.code, {\n children: \"client_credentials\"\n }), \" - Using the client id and client secret that can be found on the API page on the website. This is the simplest method, suitable for server-to-server applications and quick setup.\"]\n }), \"\\n\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [\"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.code, {\n children: \"client_signature\"\n }), \" - Enhanced security method using a cryptographic signature instead of sending the client secret directly. The signature is calculated over \", _jsx(_components.code, {\n children: \"\u003ctimestamp>\\\\n\u003cnonce>\\\\n\u003cdata>\"\n }), \" (the three values joined with line-feed characters, \", _jsx(_components.code, {\n children: \"timestamp\"\n }), \" exactly as sent). Keys with a shared secret use an HMAC-SHA256 signature encoded as hexadecimal; asymmetric (RSA / Ed25519) keys use a digital signature over the same string encoded as URL-safe base64 without padding. This method requires \", _jsx(_components.code, {\n children: \"client_id\"\n }), \", \", _jsx(_components.code, {\n children: \"timestamp\"\n }), \" and \", _jsx(_components.code, {\n children: \"signature\"\n }), \"; \", _jsx(_components.code, {\n children: \"nonce\"\n }), \" and \", _jsx(_components.code, {\n children: \"data\"\n }), \" are optional (\", _jsx(_components.code, {\n children: \"nonce\"\n }), \" is strongly recommended for replay protection). See the \", _jsx(_components.a, {\n href: \"https://docs.deribit.com/articles/authentication#client-signature-websocket\",\n children: \"Client Signature (WebSocket) guide\"\n }), \" for detailed signature calculation instructions.\"]\n }), \"\\n\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [\"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.code, {\n children: \"refresh_token\"\n }), \" - Using a refresh token that was received from an earlier invocation. This allows you to obtain a new access token without re-supplying your Client ID and Client Secret. Best for long-lived sessions, token renewal, and avoiding re-authentication.\"]\n }), \"\\n\"]\n }), \"\\n\"]\n }), \"\\n\", _jsx(_components.p, {\n children: _jsx(_components.strong, {\n children: \"Refresh token behavior:\"\n })\n }), \"\\n\", _jsxs(_components.ul, {\n children: [\"\\n\", _jsxs(_components.li, {\n children: [\"Every successful refresh issues a \", _jsx(_components.strong, {\n children: \"new\"\n }), \" access token \", _jsx(_components.strong, {\n children: \"and\"\n }), \" a new refresh token, and invalidates the previously issued token pair. Always store the newest \", _jsx(_components.code, {\n children: \"refresh_token\"\n }), \"; reusing an older one fails with \", _jsx(_components.code, {\n children: \"-32602\"\n }), \" (\", _jsx(_components.code, {\n children: \"invalid token\"\n }), \"), which also affects concurrent refreshes with the same token.\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [\"The \", _jsx(_components.code, {\n children: \"scope\"\n }), \" parameter is ignored for this grant type: the new tokens keep the scope, session and lifetime of the original token.\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [\"A token with \", _jsx(_components.code, {\n children: \"connection\"\n }), \" scope is bound to the connection it was issued on and cannot be refreshed or used from another connection.\"]\n }), \"\\n\"]\n }), \"\\n\", _jsx(_components.p, {\n children: _jsxs(_components.strong, {\n children: [\"Scope behavior (\", _jsx(_components.code, {\n children: \"client_credentials\"\n }), \" and \", _jsx(_components.code, {\n children: \"client_signature\"\n }), \"):\"]\n })\n }), \"\\n\", _jsxs(_components.ul, {\n children: [\"\\n\", _jsxs(_components.li, {\n children: [\"Without a \", _jsx(_components.code, {\n children: \"session:\"\n }), \" or \", _jsx(_components.code, {\n children: \"connection\"\n }), \" scope item, a WebSocket request gets a \", _jsx(_components.code, {\n children: \"connection\"\n }), \" scope token. An HTTP (REST) request gets a \", _jsx(_components.code, {\n children: \"session\"\n }), \" scope token with a generated \", _jsx(_components.code, {\n children: \"rest-...\"\n }), \" session name, unless \", _jsx(_components.code, {\n children: \"connection\"\n }), \" was requested explicitly.\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.code, {\n children: \"connection\"\n }), \" and \", _jsx(_components.code, {\n children: \"session:name\"\n }), \" cannot be combined (\", _jsx(_components.code, {\n children: \"-32602\"\n }), \").\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [\"Requested permission scopes (\", _jsx(_components.code, {\n children: \"trade\"\n }), \", \", _jsx(_components.code, {\n children: \"wallet\"\n }), \", \", _jsx(_components.code, {\n children: \"account\"\n }), \", \", _jsx(_components.code, {\n children: \"block_trade\"\n }), \", \", _jsx(_components.code, {\n children: \"block_rfq\"\n }), \") never exceed the permissions of the API key: higher levels are silently reduced to the key’s level, and permission scopes that are not requested inherit the key’s permissions. This is not reported as an error.\"]\n }), \"\\n\"]\n }), \"\\n\", _jsx(_components.p, {\n children: _jsx(_components.strong, {\n children: \"Response:\"\n })\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"The response will contain an access token, expiration period (number of seconds that the token is valid) and a refresh token that can be used to get a new set of tokens. Over WebSocket, a successful call also authenticates the current connection, so later private requests on it need no \", _jsx(_components.code, {\n children: \"access_token\"\n }), \".\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.strong, {\n children: \"Errors\"\n }), \" (JSON-RPC \", _jsx(_components.code, {\n children: \"error.code\"\n }), \"):\"]\n }), \"\\n\", _jsxs(_components.ul, {\n children: [\"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.code, {\n children: \"13004\"\n }), \" \", _jsx(_components.code, {\n children: \"invalid_credentials\"\n }), \" - unknown \", _jsx(_components.code, {\n children: \"client_id\"\n }), \", wrong \", _jsx(_components.code, {\n children: \"client_secret\"\n }), \", invalid \", _jsx(_components.code, {\n children: \"signature\"\n }), \", or \", _jsx(_components.code, {\n children: \"client_id\"\n }), \" longer than 16 bytes.\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.code, {\n children: \"13009\"\n }), \" \", _jsx(_components.code, {\n children: \"unauthorized\"\n }), \" - \", _jsx(_components.code, {\n children: \"timestamp\"\n }), \" outside the allowed window, \", _jsx(_components.code, {\n children: \"nonce\"\n }), \" longer than 128 bytes or already used, connecting IP not in the key’s IP whitelist (\", _jsx(_components.code, {\n children: \"reason: bad_ip\"\n }), \").\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.code, {\n children: \"-32602\"\n }), \" \", _jsx(_components.code, {\n children: \"Invalid params\"\n }), \" - missing required parameter for the chosen \", _jsx(_components.code, {\n children: \"grant_type\"\n }), \", unknown \", _jsx(_components.code, {\n children: \"grant_type\"\n }), \", invalid \", _jsx(_components.code, {\n children: \"scope\"\n }), \", or an invalid / expired / already-replaced \", _jsx(_components.code, {\n children: \"refresh_token\"\n }), \" (including \", _jsx(_components.code, {\n children: \"session_not_found\"\n }), \").\"]\n }), \"\\n\"]\n }), \"\\n\", _jsx(_components.p, {\n children: _jsx(_components.a, {\n href: \"https://test.deribit.com/api_console?method=%2Fpublic%2Fauth\",\n children: \"Try in API console\"\n })\n })]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"public/auth","description":"Retrieve an OAuth access token, to be used for authentication of 'private' requests.\n\n**📖 Related Article:** [Authentication](https://docs.deribit.com/articles/authentication)\n\n**Authentication Methods:**\n\nThree methods of authentication are supported (selected with `grant_type`):\n\n- `client_credentials` - Using the client id and client secret that can be found on the API page on the website. This is the simplest method, suitable for server-to-server applications and quick setup.\n\n- `client_signature` - Enhanced security method using a cryptographic signature instead of sending the client secret directly. The signature is calculated over `\u003ctimestamp>\\n\u003cnonce>\\n\u003cdata>` (the three values joined with line-feed characters, `timestamp` exactly as sent). Keys with a shared secret use an HMAC-SHA256 signature encoded as hexadecimal; asymmetric (RSA / Ed25519) keys use a digital signature over the same string encoded as URL-safe base64 without padding. This method requires `client_id`, `timestamp` and `signature`; `nonce` and `data` are optional (`nonce` is strongly recommended for replay protection). See the [Client Signature (WebSocket) guide](https://docs.deribit.com/articles/authentication#client-signature-websocket) for detailed signature calculation instructions.\n\n- `refresh_token` - Using a refresh token that was received from an earlier invocation. This allows you to obtain a new access token without re-supplying your Client ID and Client Secret. Best for long-lived sessions, token renewal, and avoiding re-authentication.\n\n**Refresh token behavior:**\n\n- Every successful refresh issues a **new** access token **and** a new refresh token, and invalidates the previously issued token pair. Always store the newest `refresh_token`; reusing an older one fails with `-32602` (`invalid token`), which also affects concurrent refreshes with the same token.\n- The `scope` parameter is ignored for this grant type: the new tokens keep the scope, session and lifetime of the original token.\n- A token with `connection` scope is bound to the connection it was issued on and cannot be refreshed or used from another connection.\n\n**Scope behavior (`client_credentials` and `client_signature`):**\n\n- Without a `session:` or `connection` scope item, a WebSocket request gets a `connection` scope token. An HTTP (REST) request gets a `session` scope token with a generated `rest-...` session name, unless `connection` was requested explicitly.\n- `connection` and `session:name` cannot be combined (`-32602`).\n- Requested permission scopes (`trade`, `wallet`, `account`, `block_trade`, `block_rfq`) never exceed the permissions of the API key: higher levels are silently reduced to the key's level, and permission scopes that are not requested inherit the key's permissions. This is not reported as an error.\n\n**Response:**\n\nThe response will contain an access token, expiration period (number of seconds that the token is valid) and a refresh token that can be used to get a new set of tokens. Over WebSocket, a successful call also authenticates the current connection, so later private requests on it need no `access_token`.\n\n**Errors** (JSON-RPC `error.code`):\n\n- `13004` `invalid_credentials` - unknown `client_id`, wrong `client_secret`, invalid `signature`, or `client_id` longer than 16 bytes.\n- `13009` `unauthorized` - `timestamp` outside the allowed window, `nonce` longer than 128 bytes or already used, connecting IP not in the key's IP whitelist (`reason: bad_ip`).\n- `-32602` `Invalid params` - missing required parameter for the chosen `grant_type`, unknown `grant_type`, invalid `scope`, or an invalid / expired / already-replaced `refresh_token` (including `session_not_found`).\n\n[Try in API console](https://test.deribit.com/api_console?method=%2Fpublic%2Fauth)\n\n","deprecated":null,"version":null,"og:title":"public/auth","keywords":["public/auth","grant_type","client_id","client_secret","refresh_token","timestamp","signature","nonce","data","state","scope"],"openapi":"/specifications/deribit_upcoming_openapi.json get /public/auth","href":"/api-reference/upcoming/authentication/public-auth","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/deribit/a355478acb7a8697/public/replace-query-params.js"],"openApiReferenceData":{"operation":{"tags":["Authentication","Public"],"parameters":["ddb00ba7-c4fb-4331-9ce0-102d03fe3c9d","e37b271f-892f-410d-8a94-2b562ee95396","64e24816-5f84-4243-a508-5b742d470405","b27ef9cc-7240-47bd-8d82-986c7b5bb4d4","799d37a0-fb1a-4ed0-bb6a-9f212b276712","05b1836c-f793-4ac8-bd1b-647722312e1e","b99410c4-69c2-4293-b3ed-29145c390c51","6cca837b-04ee-41c7-b1eb-aff34d26b504","b2f1c869-8e6c-419d-b853-c8f005991f03","cc7e6317-1d3f-4409-8d52-3bc87e4a778c"],"responses":{"200":"28def5df-3bad-4156-854e-6531d630096b"},"requestBody":"6924a527-12ee-44d3-b50f-5e23072b337a","description":"Retrieve an OAuth access token, to be used for authentication of 'private' requests.\n\n**📖 Related Article:** [Authentication](https://docs.deribit.com/articles/authentication)\n\n**Authentication Methods:**\n\nThree methods of authentication are supported (selected with `grant_type`):\n\n- `client_credentials` - Using the client id and client secret that can be found on the API page on the website. This is the simplest method, suitable for server-to-server applications and quick setup.\n\n- `client_signature` - Enhanced security method using a cryptographic signature instead of sending the client secret directly. The signature is calculated over `\u003ctimestamp>\\n\u003cnonce>\\n\u003cdata>` (the three values joined with line-feed characters, `timestamp` exactly as sent). Keys with a shared secret use an HMAC-SHA256 signature encoded as hexadecimal; asymmetric (RSA / Ed25519) keys use a digital signature over the same string encoded as URL-safe base64 without padding. This method requires `client_id`, `timestamp` and `signature`; `nonce` and `data` are optional (`nonce` is strongly recommended for replay protection). See the [Client Signature (WebSocket) guide](https://docs.deribit.com/articles/authentication#client-signature-websocket) for detailed signature calculation instructions.\n\n- `refresh_token` - Using a refresh token that was received from an earlier invocation. This allows you to obtain a new access token without re-supplying your Client ID and Client Secret. Best for long-lived sessions, token renewal, and avoiding re-authentication.\n\n**Refresh token behavior:**\n\n- Every successful refresh issues a **new** access token **and** a new refresh token, and invalidates the previously issued token pair. Always store the newest `refresh_token`; reusing an older one fails with `-32602` (`invalid token`), which also affects concurrent refreshes with the same token.\n- The `scope` parameter is ignored for this grant type: the new tokens keep the scope, session and lifetime of the original token.\n- A token with `connection` scope is bound to the connection it was issued on and cannot be refreshed or used from another connection.\n\n**Scope behavior (`client_credentials` and `client_signature`):**\n\n- Without a `session:` or `connection` scope item, a WebSocket request gets a `connection` scope token. An HTTP (REST) request gets a `session` scope token with a generated `rest-...` session name, unless `connection` was requested explicitly.\n- `connection` and `session:name` cannot be combined (`-32602`).\n- Requested permission scopes (`trade`, `wallet`, `account`, `block_trade`, `block_rfq`) never exceed the permissions of the API key: higher levels are silently reduced to the key's level, and permission scopes that are not requested inherit the key's permissions. This is not reported as an error.\n\n**Response:**\n\nThe response will contain an access token, expiration period (number of seconds that the token is valid) and a refresh token that can be used to get a new set of tokens. Over WebSocket, a successful call also authenticates the current connection, so later private requests on it need no `access_token`.\n\n**Errors** (JSON-RPC `error.code`):\n\n- `13004` `invalid_credentials` - unknown `client_id`, wrong `client_secret`, invalid `signature`, or `client_id` longer than 16 bytes.\n- `13009` `unauthorized` - `timestamp` outside the allowed window, `nonce` longer than 128 bytes or already used, connecting IP not in the key's IP whitelist (`reason: bad_ip`).\n- `-32602` `Invalid params` - missing required parameter for the chosen `grant_type`, unknown `grant_type`, invalid `scope`, or an invalid / expired / already-replaced `refresh_token` (including `session_not_found`).\n\n[Try in API console](https://test.deribit.com/api_console?method=%2Fpublic%2Fauth)\n\n","x-mint":{"metadata":{"title":"public/auth","og:title":"public/auth","keywords":["public/auth","grant_type","client_id","client_secret","refresh_token","timestamp","signature","nonce","data","state","scope"]},"href":"/api-reference/upcoming/authentication/public-auth"},"x-codeSamples":[{"lang":"bash","label":"cURL","source":"curl --request POST \\\n --url https://test.deribit.com/api/v2/public/auth \\\n --header 'Content-Type: application/json' \\\n --data '{\n \"jsonrpc\": \"2.0\",\n \"id\": 9929,\n \"method\": \"public/auth\",\n \"params\": {\n \"grant_type\": \"client_credentials\",\n \"client_id\": \"fo7WAPRm4P\",\n \"client_secret\": \"W0H6FJW4IRPZ1MOQ8FP6KMC5RZDUUKXS\"\n }\n}'"},{"lang":"bash","label":"cURL (Client signature)","source":"curl --request POST \\\n --url https://test.deribit.com/api/v2/public/auth \\\n --header 'Content-Type: application/json' \\\n --data '{\n \"jsonrpc\": \"2.0\",\n \"id\": 9930,\n \"method\": \"public/auth\",\n \"params\": {\n \"grant_type\": \"client_signature\",\n \"client_id\": \"fo7WAPRm4P\",\n \"timestamp\": 1582628593469,\n \"signature\": \"f22e7089f592213ca51ad051b26fe835bce7edd284bc5eb9fe6e7d7ed3cb4430\",\n \"nonce\": \"fm8Kq3xPd2\"\n }\n}'"},{"lang":"bash","label":"cURL (Refresh token)","source":"curl --request POST \\\n --url https://test.deribit.com/api/v2/public/auth \\\n --header 'Content-Type: application/json' \\\n --data '{\n \"jsonrpc\": \"2.0\",\n \"id\": 9931,\n \"method\": \"public/auth\",\n \"params\": {\n \"grant_type\": \"refresh_token\",\n \"refresh_token\": \"1582628593469.1GP4rQd0.A9Wa78o5kFRIUP49mScaD1CqHgiK50HOl2VA6kCtWa8BQZU5Dr03BhcbXPNvEh3I_MVixKZXnyoBeKJwLl8LXnfo180ckAiPj3zOclcUu4zkXuF3NNP3sTPcDf1B3C1CwMKkJ1NOcf1yPmRbsrd7hbgQ-hLa40tfx6Oa-85ymm_3Z65LZcnCeLrqlj_A9jM\"\n }\n}'"},{"lang":"bash","label":"cURL (Session)","source":"curl --request POST \\\n --url https://test.deribit.com/api/v2/public/auth \\\n --header 'Content-Type: application/json' \\\n --data '{\n \"jsonrpc\": \"2.0\",\n \"id\": 9932,\n \"method\": \"public/auth\",\n \"params\": {\n \"grant_type\": \"client_credentials\",\n \"client_id\": \"fo7WAPRm4P\",\n \"client_secret\": \"W0H6FJW4IRPZ1MOQ8FP6KMC5RZDUUKXS\",\n \"scope\": \"session:my_bot trade:read\"\n }\n}'"}],"method":"get","type":"path","servers":["664f4fbb-b57f-4e03-8c19-f187cd931be6"],"security":[],"path":"/public/auth","baseUrlOptions":["https://test.deribit.com/api/v2"],"title":"","codeSamples":[{"label":"cURL","lang":"bash","source":"curl --request POST \\\n --url https://test.deribit.com/api/v2/public/auth \\\n --header 'Content-Type: application/json' \\\n --data '{\n \"jsonrpc\": \"2.0\",\n \"id\": 9929,\n \"method\": \"public/auth\",\n \"params\": {\n \"grant_type\": \"client_credentials\",\n \"client_id\": \"fo7WAPRm4P\",\n \"client_secret\": \"W0H6FJW4IRPZ1MOQ8FP6KMC5RZDUUKXS\"\n }\n}'"},{"label":"cURL (Client signature)","lang":"bash","source":"curl --request POST \\\n --url https://test.deribit.com/api/v2/public/auth \\\n --header 'Content-Type: application/json' \\\n --data '{\n \"jsonrpc\": \"2.0\",\n \"id\": 9930,\n \"method\": \"public/auth\",\n \"params\": {\n \"grant_type\": \"client_signature\",\n \"client_id\": \"fo7WAPRm4P\",\n \"timestamp\": 1582628593469,\n \"signature\": \"f22e7089f592213ca51ad051b26fe835bce7edd284bc5eb9fe6e7d7ed3cb4430\",\n \"nonce\": \"fm8Kq3xPd2\"\n }\n}'"},{"label":"cURL (Refresh token)","lang":"bash","source":"curl --request POST \\\n --url https://test.deribit.com/api/v2/public/auth \\\n --header 'Content-Type: application/json' \\\n --data '{\n \"jsonrpc\": \"2.0\",\n \"id\": 9931,\n \"method\": \"public/auth\",\n \"params\": {\n \"grant_type\": \"refresh_token\",\n \"refresh_token\": \"1582628593469.1GP4rQd0.A9Wa78o5kFRIUP49mScaD1CqHgiK50HOl2VA6kCtWa8BQZU5Dr03BhcbXPNvEh3I_MVixKZXnyoBeKJwLl8LXnfo180ckAiPj3zOclcUu4zkXuF3NNP3sTPcDf1B3C1CwMKkJ1NOcf1yPmRbsrd7hbgQ-hLa40tfx6Oa-85ymm_3Z65LZcnCeLrqlj_A9jM\"\n }\n}'"},{"label":"cURL (Session)","lang":"bash","source":"curl --request POST \\\n --url https://test.deribit.com/api/v2/public/auth \\\n --header 'Content-Type: application/json' \\\n --data '{\n \"jsonrpc\": \"2.0\",\n \"id\": 9932,\n \"method\": \"public/auth\",\n \"params\": {\n \"grant_type\": \"client_credentials\",\n \"client_id\": \"fo7WAPRm4P\",\n \"client_secret\": \"W0H6FJW4IRPZ1MOQ8FP6KMC5RZDUUKXS\",\n \"scope\": \"session:my_bot trade:read\"\n }\n}'"}],"requiredOnlyExamples":false,"disableCodeSampleGeneration":true,"requestExampleType":"codeSamples","responseExampleType":"generated"},"dependencies":{"parameters":{"ddb00ba7-c4fb-4331-9ce0-102d03fe3c9d":{"name":"grant_type","in":"query","schema":{"type":"string","enum":["client_credentials","client_signature","refresh_token"],"example":"client_credentials","isRequired":true,"description":"Method of authentication","uniqueKey":"","typeLabel":"enum\u003cstring>"},"required":true,"description":"Method of authentication"},"e37b271f-892f-410d-8a94-2b562ee95396":{"name":"client_id","in":"query","schema":{"type":"string","example":"fo7WAPRm4P","isRequired":false,"description":"Required for grant types `client_credentials` and `client_signature`. Maximum length is 16 bytes.","uniqueKey":"","typeLabel":"string"},"description":"Required for grant types `client_credentials` and `client_signature`. Maximum length is 16 bytes.","required":false},"64e24816-5f84-4243-a508-5b742d470405":{"name":"client_secret","in":"query","schema":{"type":"string","example":"W0H6FJW4IRPZ1MOQ8FP6KMC5RZDUUKXS","isRequired":false,"description":"Required for grant type `client_credentials`.","uniqueKey":"","typeLabel":"string"},"description":"Required for grant type `client_credentials`.","required":false},"b27ef9cc-7240-47bd-8d82-986c7b5bb4d4":{"name":"refresh_token","in":"query","schema":{"type":"string","isRequired":false,"description":"Required for grant type `refresh_token`. The token pair it belongs to is replaced by the new tokens returned (see above).","uniqueKey":"","typeLabel":"string"},"description":"Required for grant type `refresh_token`. The token pair it belongs to is replaced by the new tokens returned (see above).","required":false},"799d37a0-fb1a-4ed0-bb6a-9f212b276712":{"name":"timestamp","in":"query","schema":{"type":"integer","isRequired":false,"description":"Required for grant type `client_signature`.\n\nTime when the request was generated, in milliseconds since the UNIX epoch. Must be within ±60 seconds (±60,000 ms) of the server time, otherwise the request is rejected with error `13009` (`unauthorized`).\n","uniqueKey":"","typeLabel":"integer"},"description":"Required for grant type `client_signature`.\n\nTime when the request was generated, in milliseconds since the UNIX epoch. Must be within ±60 seconds (±60,000 ms) of the server time, otherwise the request is rejected with error `13009` (`unauthorized`).\n","required":false},"05b1836c-f793-4ac8-bd1b-647722312e1e":{"name":"signature","in":"query","schema":{"type":"string","isRequired":false,"description":"Required for grant type `client_signature`.\n\nSignature calculated over `\u003ctimestamp>\\n\u003cnonce>\\n\u003cdata>`:\n- **Shared-secret API keys:** HMAC-SHA256 with the client secret as key, encoded as hexadecimal (letter case is ignored).\n- **Asymmetric (RSA / Ed25519) API keys:** digital signature made with your private key (SHA-256), encoded as URL-safe base64 without padding.\n\nAn invalid signature is rejected with error `13004` (`invalid_credentials`).\n","uniqueKey":"","typeLabel":"string"},"description":"Required for grant type `client_signature`.\n\nSignature calculated over `\u003ctimestamp>\\n\u003cnonce>\\n\u003cdata>`:\n- **Shared-secret API keys:** HMAC-SHA256 with the client secret as key, encoded as hexadecimal (letter case is ignored).\n- **Asymmetric (RSA / Ed25519) API keys:** digital signature made with your private key (SHA-256), encoded as URL-safe base64 without padding.\n\nAn invalid signature is rejected with error `13004` (`invalid_credentials`).\n","required":false},"b99410c4-69c2-4293-b3ed-29145c390c51":{"name":"nonce","in":"query","schema":{"type":"string","isRequired":false,"description":"Optional for grant type `client_signature`, but strongly recommended. Defaults to an empty string.\n\nUser-generated random string, up to 128 bytes. A non-empty nonce can be used only once for the same `client_id` and `timestamp` (a repeat is rejected with `13009`). With an empty or omitted nonce the timestamp window is still enforced but replay detection is not.\n","uniqueKey":"","typeLabel":"string"},"description":"Optional for grant type `client_signature`, but strongly recommended. Defaults to an empty string.\n\nUser-generated random string, up to 128 bytes. A non-empty nonce can be used only once for the same `client_id` and `timestamp` (a repeat is rejected with `13009`). With an empty or omitted nonce the timestamp window is still enforced but replay detection is not.\n","required":false},"6cca837b-04ee-41c7-b1eb-aff34d26b504":{"name":"data","in":"query","schema":{"type":"string","isRequired":false,"description":"Optional for grant type `client_signature`. Defaults to an empty string.\n\nContains any user specific value; it is part of the signed string.\n","uniqueKey":"","typeLabel":"string"},"description":"Optional for grant type `client_signature`. Defaults to an empty string.\n\nContains any user specific value; it is part of the signed string.\n","required":false},"b2f1c869-8e6c-419d-b853-c8f005991f03":{"name":"state","in":"query","schema":{"type":"string","isRequired":false,"description":"Will be passed back in the response.","uniqueKey":"","typeLabel":"string"},"description":"Will be passed back in the response.","required":false},"cc7e6317-1d3f-4409-8d52-3bc87e4a778c":{"name":"scope","in":"query","schema":{"type":"string","example":"connection","isRequired":false,"description":"Describes type of the access for assigned token. Ignored for grant type `refresh_token`.\n\n\n**Possible values:**\n\n- `connection`\n- `session:name` (names longer than 64 bytes are truncated)\n- `trade:[read, read_write, none]`\n- `wallet:[read, read_write, none]`\n- `account:[read, read_write, none]`\n- `block_trade:[read, read_write, none]`\n- `block_rfq:[read, read_write, none]`\n- `expires:NUMBER`\n- `ip:ADDR`\n\n\n`connection` and `session:name` are mutually exclusive. Permission scopes cannot exceed the permissions of the API key.\n\n\nDetails are elucidated in [Access scope](https://docs.deribit.com/articles/access-scope)\n","uniqueKey":"","typeLabel":"string"},"description":"Describes type of the access for assigned token. Ignored for grant type `refresh_token`.\n\n\n**Possible values:**\n\n- `connection`\n- `session:name` (names longer than 64 bytes are truncated)\n- `trade:[read, read_write, none]`\n- `wallet:[read, read_write, none]`\n- `account:[read, read_write, none]`\n- `block_trade:[read, read_write, none]`\n- `block_rfq:[read, read_write, none]`\n- `expires:NUMBER`\n- `ip:ADDR`\n\n\n`connection` and `session:name` are mutually exclusive. Permission scopes cannot exceed the permissions of the API key.\n\n\nDetails are elucidated in [Access scope](https://docs.deribit.com/articles/access-scope)\n","required":false}},"requestBody":{"content":{"application/json":{"examples":{"request":{"title":"request","summary":"JSON-RPC Request Example","value":{"jsonrpc":"2.0","id":9929,"method":"public/auth","params":{"grant_type":"client_credentials","client_id":"fo7WAPRm4P","client_secret":"W0H6FJW4IRPZ1MOQ8FP6KMC5RZDUUKXS"}}},"client_signatureRequest":{"title":"client_signatureRequest","summary":"Client signature Request","value":{"jsonrpc":"2.0","id":9930,"method":"public/auth","params":{"grant_type":"client_signature","client_id":"fo7WAPRm4P","timestamp":1582628593469,"signature":"f22e7089f592213ca51ad051b26fe835bce7edd284bc5eb9fe6e7d7ed3cb4430","nonce":"fm8Kq3xPd2"}}},"refresh_tokenRequest":{"title":"refresh_tokenRequest","summary":"Refresh token Request","value":{"jsonrpc":"2.0","id":9931,"method":"public/auth","params":{"grant_type":"refresh_token","refresh_token":"1582628593469.1GP4rQd0.A9Wa78o5kFRIUP49mScaD1CqHgiK50HOl2VA6kCtWa8BQZU5Dr03BhcbXPNvEh3I_MVixKZXnyoBeKJwLl8LXnfo180ckAiPj3zOclcUu4zkXuF3NNP3sTPcDf1B3C1CwMKkJ1NOcf1yPmRbsrd7hbgQ-hLa40tfx6Oa-85ymm_3Z65LZcnCeLrqlj_A9jM"}}},"sessionRequest":{"title":"sessionRequest","summary":"Session Request","value":{"jsonrpc":"2.0","id":9932,"method":"public/auth","params":{"grant_type":"client_credentials","client_id":"fo7WAPRm4P","client_secret":"W0H6FJW4IRPZ1MOQ8FP6KMC5RZDUUKXS","scope":"session:my_bot trade:read"}}}},"exampleType":"examples"}},"description":"JSON-RPC request body","exampleType":"examples"},"responses":{"28def5df-3bad-4156-854e-6531d630096b":{"content":{"application/json":{"schema":{"properties":{"jsonrpc":{"type":"string","enum":["2.0"],"description":"The JSON-RPC version (2.0)","isRequired":true,"uniqueKey":"jsonrpc","typeLabel":"enum\u003cstring>"},"result":{"type":"object","properties":{"access_token":{"type":"string","example":"843SehgeX5n6XxEU4XbABx4Cny5Akai5iHiJePTsvUw7","description":"OAuth access token to be used for authentication of 'private' requests","isRequired":true,"uniqueKey":"result.access_token","typeLabel":"string"},"token_type":{"type":"string","enum":["bearer"],"description":"Authorization type, allowed value - `bearer`","isRequired":true,"uniqueKey":"result.token_type","typeLabel":"enum\u003cstring>"},"expires_in":{"type":"integer","example":31536000,"description":"Token lifetime in seconds","isRequired":true,"uniqueKey":"result.expires_in","typeLabel":"integer"},"refresh_token":{"type":"string","example":"6faf8L36JdaSqsjCEEiwqifPpj6JB18RWwiWHrsGTZ91","description":"Can be used to request a new token (with a new lifetime)","isRequired":true,"uniqueKey":"result.refresh_token","typeLabel":"string"},"scope":{"type":"string","description":"Type of the access for assigned token","isRequired":true,"uniqueKey":"result.scope","typeLabel":"string"},"state":{"type":"string","description":"Copied from the input (if applicable)","uniqueKey":"result.state","typeLabel":"string"},"sid":{"type":"string","description":"Optional Session id","uniqueKey":"result.sid","typeLabel":"string"},"enabled_features":{"items":{"type":"string","uniqueKey":"result.enabled_features.items.[INDEX]","typeLabel":"string"},"type":"array","description":"List of enabled advanced on-key features.\u003cbr>\u003cbr>\u003cb>Available options:\u003c/b>\u003cbr>- \u003ccode>restricted_block_trades\u003c/code>: Limit the block_trade read scope of the API key to Block Trades that have been made using this specific API key\u003cbr>- \u003ccode>block_trade_approval\u003c/code>: Block Trades created using this API key require additional user approval. Methods that use \u003ccode>block_rfq\u003c/code> scope are not affected by Block Trade approval feature","uniqueKey":"result.enabled_features","typeLabel":"string[]"},"mandatory_tfa_status":{"type":"string","example":"enabled","description":"2FA is required for privileged methods","uniqueKey":"result.mandatory_tfa_status","typeLabel":"string"},"google_login":{"type":"boolean","description":"The access token was acquired by logging in through Google.","uniqueKey":"result.google_login","typeLabel":"boolean"},"apple_login":{"type":"boolean","description":"The access token was acquired by logging in through Apple.","uniqueKey":"result.apple_login","typeLabel":"boolean"},"coinbase_login":{"type":"boolean","description":"The access token was acquired by logging in through Coinbase.","uniqueKey":"result.coinbase_login","typeLabel":"boolean"}},"required":["access_token","token_type","expires_in","refresh_token","scope"],"isRequired":true,"uniqueKey":"result","typeLabel":"object"},"id":{"type":"integer","description":"The id that was sent in the request","uniqueKey":"id","typeLabel":"integer"}},"required":["result","jsonrpc"],"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"response":{"title":"response","summary":"Response example","value":{"jsonrpc":"2.0","id":9929,"result":{"access_token":"1582628593469.1MbQ-J_4.CBP-OqOwm_FBdMYj4cRK2dMXyHPfBtXGpzLxhWg31nHu3H_Q60FpE5_vqUBEQGSiMrIGzw3nC37NMb9d1tpBNqBOM_Ql9pXOmgtV9Yj3Pq1c6BqC6dU6eTxHMFO67x8GpJxqw_QcKP5IepwGBD-gfKSHfAv9AEnLJkNu3JkMJBdLToY1lrBnuedF3dU_uARm","expires_in":31536000,"refresh_token":"1582628593469.1GP4rQd0.A9Wa78o5kFRIUP49mScaD1CqHgiK50HOl2VA6kCtWa8BQZU5Dr03BhcbXPNvEh3I_MVixKZXnyoBeKJwLl8LXnfo180ckAiPj3zOclcUu4zkXuF3NNP3sTPcDf1B3C1CwMKkJ1NOcf1yPmRbsrd7hbgQ-hLa40tfx6Oa-85ymm_3Z65LZcnCeLrqlj_A9jM","scope":"connection mainaccount","enabled_features":[],"token_type":"bearer"}}},"client_signatureResponse":{"title":"client_signatureResponse","summary":"Client_signature response example","value":{"jsonrpc":"2.0","id":9930,"result":{"access_token":"1582628593469.1MbQ-J_4.CBP-OqOwm_FBdMYj4cRK2dMXyHPfBtXGpzLxhWg31nHu3H_Q60FpE5_vqUBEQGSiMrIGzw3nC37NMb9d1tpBNqBOM_Ql9pXOmgtV9Yj3Pq1c6BqC6dU6eTxHMFO67x8GpJxqw_QcKP5IepwGBD-gfKSHfAv9AEnLJkNu3JkMJBdLToY1lrBnuedF3dU_uARm","expires_in":31536000,"refresh_token":"1582628593469.1GP4rQd0.A9Wa78o5kFRIUP49mScaD1CqHgiK50HOl2VA6kCtWa8BQZU5Dr03BhcbXPNvEh3I_MVixKZXnyoBeKJwLl8LXnfo180ckAiPj3zOclcUu4zkXuF3NNP3sTPcDf1B3C1CwMKkJ1NOcf1yPmRbsrd7hbgQ-hLa40tfx6Oa-85ymm_3Z65LZcnCeLrqlj_A9jM","scope":"connection mainaccount","enabled_features":[],"token_type":"bearer"}}},"refresh_tokenResponse":{"title":"refresh_tokenResponse","summary":"Refresh_token response example","value":{"jsonrpc":"2.0","id":9931,"result":{"access_token":"1582628593470.2NcR-K_5.DBQ-PrPxn_GCeNZk5dSL3eNYzIQgCuYHyMyMxiXh42oIv4I_R71GqF6_wrVCFRIjNsJH0x4oDc48ONc0e2uqCOrCPN_Rm0qYPnhtW0Zk4Qr2d7CrD7eV7fUyINFP78y9HqKyrc_RdLQ6JfqxHCE-hgLTIfBw0BFmMLkOv4KlNKCeMUoZ2msCovfeG4eV_vBSn","expires_in":31536000,"refresh_token":"1582628593470.2HQ5sRe1.B0Xb89p6lGSJVQ50nTdbE2DrIhjL61IPm3WB7lDuXb9CRaV6Es14CidbYQOwFi4J_NWjyLZozyCPeLKxMmL9MYogp291dlQjQk0zPmdlVv50lYvG4OOQ4tUQdEg24D2DxNLlK2OPdg2zQnScsteeichR-iMb51ugy7Pb-96znn_4a76MadnDfMsnmk_B0kN","scope":"connection mainaccount","enabled_features":[],"token_type":"bearer"}}},"sessionResponse":{"title":"sessionResponse","summary":"Session response example","value":{"jsonrpc":"2.0","id":9932,"result":{"access_token":"1582628600120.3PdS-L_6.CBP-OqOwm_FBdMYj4cRK2dMXyHPfBtXGpzLxhWg31nHu3H_Q60FpE5_vqUBEQGSiMrIGzw3nC37NMb9d1tpBNqBOM_Ql9pXOmgtV9Yj3Pq1c6BqC6dU6eTxHMFO67x8GpJxqw_QcKP5IepwGBD-gfKSHfAv9AEnLJkNu3JkMJBdLToY1lrBnuedF3dU_uARm","expires_in":900,"refresh_token":"1582628600120.3IR6tSf2.A9Wa78o5kFRIUP49mScaD1CqHgiK50HOl2VA6kCtWa8BQZU5Dr03BhcbXPNvEh3I_MVixKZXnyoBeKJwLl8LXnfo180ckAiPj3zOclcUu4zkXuF3NNP3sTPcDf1B3C1CwMKkJ1NOcf1yPmRbsrd7hbgQ-hLa40tfx6Oa-85ymm_3Z65LZcnCeLrqlj_A9jM","scope":"session:my_bot trade:read mainaccount","enabled_features":[],"token_type":"bearer","sid":"3571.fo7WAPRm4P.my_bot"}}}},"exampleType":"examples"}},"description":"Success response","exampleType":"examples"}},"security":{},"servers":{"664f4fbb-b57f-4e03-8c19-f187cd931be6":{"url":"https://test.deribit.com/api/v2"}}},"originalFileLocation":"specifications/deribit_upcoming_openapi.json"},"subdomain":"deribit","siteName":"Deribit API Documentation","title":"public/auth","relatedPagesConfig":{"enabled":true,"limit":5,"mode":"automatic"},"navMaps":{"firstHrefInVersion":{"Production":{"href":"/","matchLevel":4},"Upcoming":{"href":"/api-reference/upcoming/authentication/public-auth","matchLevel":0}},"firstHrefInLanguage":{}},"lastModified":"2026-11-19T14:42:27.833Z","originalFileLocation":"api-reference/upcoming/authentication/public-auth.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Retrieve an OAuth access token, to be used for authentication of \u0026#x27;private\u0026#x27; requests. 📖 Related Article: Authentication Authentication Methods: Three methods of authentication are supported (selected with grant_type): - client_credentials - Using the client id and client secret that can be found on the API page on the website. This is the simplest method, suitable for server-to-server applications and quick setup. - client_signature - Enhanced security method using a cryptographic signature instead of sending the client secret directly. The signature is calculated over \\n\\n (the three values joined with line-feed characters, timestamp exactly as sent). Keys with a shared secret use an HMAC-SHA256 signature encoded as hexadecimal; asymmetric (RSA / Ed25519) keys use a digital signature over the same string encoded as URL-safe base64 without padding. This method requires client_id, timestamp and signature; nonce and data are optional (nonce is strongly recommended for replay protection). See the Client Signature (WebSocket) guide for detailed signature calculation instructions. - refresh_token - Using a refresh token that was received from an earlier invocation. This allows you to obtain a new access token without re-supplying your Client ID and Client Secret. Best for long-lived sessions, token renewal, and avoiding re-authentication. Refresh token behavior: - Every successful refresh issues a new access token and a new refresh token, and invalidates the previously issued token pair. Always store the newest refresh_token; reusing an older one fails with -32602 (invalid token), which also affects concurrent refreshes with the same token. - The scope parameter is ignored for this grant type: the new tokens keep the scope, session and lifetime of the original token. - A token with connection scope is bound to the connection it was issued on and cannot be refreshed or used from another connection. Scope behavior (client_credentials and client_signature): - Without a session: or connection scope item, a WebSocket request gets a connection scope token. An HTTP (REST) request gets a session scope token with a generated rest-... session name, unless connection was requested explicitly. - connection and session:name cannot be combined (-32602). - Requested permission scopes (trade, wallet, account, block_trade, block_rfq) never exceed the permissions of the API key: higher levels are silently reduced to the key\u0026#x27;s level, and permission scopes that are not requested inherit the key\u0026#x27;s permissions. This is not reported as an error. Response: The response will contain an access token, expiration period (number of seconds that the token is valid) and a refresh token that can be used to get a new set of tokens. Over WebSocket, a successful call also authenticates the current connection, so later private requests on it need no access_token. Errors (JSON-RPC error.code): - 13004 invalid_credentials - unknown client_id, wrong client_secret, invalid signature, or client_id longer than 16 bytes. - 13009 unauthorized - timestamp outside the allowed window, nonce longer than 128 bytes or already used, connecting IP not in the key\u0026#x27;s IP whitelist (reason: bad_ip). - -32602 Invalid params - missing required parameter for the chosen grant_type, unknown grant_type, invalid scope, or an invalid / expired / already-replaced refresh_token (including session_not_found). Try in API console\">\u003cmeta data-mint-head name=\"keywords\" content=\"Deribit API, cryptocurrency API, derivatives API, trading API, WebSocket API, FIX API, Bitcoin futures, options trading, API documentation\">\u003cmeta data-mint-head name=\"application-name\" content=\"Deribit API Documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003cmeta data-mint-head name=\"robots\" content=\"index, follow\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/deribit/pu9BhCQUYFueUXtn/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/deribit/pu9BhCQUYFueUXtn/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/deribit/pu9BhCQUYFueUXtn/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/deribit/pu9BhCQUYFueUXtn/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/deribit/pu9BhCQUYFueUXtn/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/deribit/pu9BhCQUYFueUXtn/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/deribit/pu9BhCQUYFueUXtn/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/deribit/pu9BhCQUYFueUXtn/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/deribit/pu9BhCQUYFueUXtn/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"public/auth\">\u003cmeta data-mint-head property=\"og:description\" content=\"Retrieve an OAuth access token, to be used for authentication of \u0026#x27;private\u0026#x27; requests. 📖 Related Article: Authentication Authentication Methods: Three methods of authentication are supported (selected with grant_type): - client_credentials - Using the client id and client secret that can be found on the API page on the website. This is the simplest method, suitable for server-to-server applications and quick setup. - client_signature - Enhanced security method using a cryptographic signature instead of sending the client secret directly. The signature is calculated over \\n\\n (the three values joined with line-feed characters, timestamp exactly as sent). Keys with a shared secret use an HMAC-SHA256 signature encoded as hexadecimal; asymmetric (RSA / Ed25519) keys use a digital signature over the same string encoded as URL-safe base64 without padding. This method requires client_id, timestamp and signature; nonce and data are optional (nonce is strongly recommended for replay protection). See the Client Signature (WebSocket) guide for detailed signature calculation instructions. - refresh_token - Using a refresh token that was received from an earlier invocation. This allows you to obtain a new access token without re-supplying your Client ID and Client Secret. Best for long-lived sessions, token renewal, and avoiding re-authentication. Refresh token behavior: - Every successful refresh issues a new access token and a new refresh token, and invalidates the previously issued token pair. Always store the newest refresh_token; reusing an older one fails with -32602 (invalid token), which also affects concurrent refreshes with the same token. - The scope parameter is ignored for this grant type: the new tokens keep the scope, session and lifetime of the original token. - A token with connection scope is bound to the connection it was issued on and cannot be refreshed or used from another connection. Scope behavior (client_credentials and client_signature): - Without a session: or connection scope item, a WebSocket request gets a connection scope token. An HTTP (REST) request gets a session scope token with a generated rest-... session name, unless connection was requested explicitly. - connection and session:name cannot be combined (-32602). - Requested permission scopes (trade, wallet, account, block_trade, block_rfq) never exceed the permissions of the API key: higher levels are silently reduced to the key\u0026#x27;s level, and permission scopes that are not requested inherit the key\u0026#x27;s permissions. This is not reported as an error. Response: The response will contain an access token, expiration period (number of seconds that the token is valid) and a refresh token that can be used to get a new set of tokens. Over WebSocket, a successful call also authenticates the current connection, so later private requests on it need no access_token. Errors (JSON-RPC error.code): - 13004 invalid_credentials - unknown client_id, wrong client_secret, invalid signature, or client_id longer than 16 bytes. - 13009 unauthorized - timestamp outside the allowed window, nonce longer than 128 bytes or already used, connecting IP not in the key\u0026#x27;s IP whitelist (reason: bad_ip). - -32602 Invalid params - missing required parameter for the chosen grant_type, unknown grant_type, invalid scope, or an invalid / expired / already-replaced refresh_token (including session_not_found). Try in API console\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Deribit API Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.deribit.com//api-reference/upcoming/authentication/public-auth\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://deribit.mintlify.site/_mintlify/api/og/v2?division=Authentication\u0026amp;title=public%2Fauth\u0026amp;description=Retrieve+an+OAuth+access+token%2C+to+be+used+for+authentication+of+%27private%27+requests.%0A%0A**%F0%9F%93%96+Related+Article%3A**+%5BAuthentication%5D%28https%3A%2F%2Fdocs.deribit.com%2Farticles%2F\u0026amp;theme=ac8885f98fec5a1d80cab062\u0026amp;signature=9d65da324085f64364137f1ee50a207d805de8f87acf6df5d5f42b052e7bb290\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"public/auth\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Retrieve an OAuth access token, to be used for authentication of \u0026#x27;private\u0026#x27; requests. 📖 Related Article: Authentication Authentication Methods: Three methods of authentication are supported (selected with grant_type): - client_credentials - Using the client id and client secret that can be found on the API page on the website. This is the simplest method, suitable for server-to-server applications and quick setup. - client_signature - Enhanced security method using a cryptographic signature instead of sending the client secret directly. The signature is calculated over \\n\\n (the three values joined with line-feed characters, timestamp exactly as sent). Keys with a shared secret use an HMAC-SHA256 signature encoded as hexadecimal; asymmetric (RSA / Ed25519) keys use a digital signature over the same string encoded as URL-safe base64 without padding. This method requires client_id, timestamp and signature; nonce and data are optional (nonce is strongly recommended for replay protection). See the Client Signature (WebSocket) guide for detailed signature calculation instructions. - refresh_token - Using a refresh token that was received from an earlier invocation. This allows you to obtain a new access token without re-supplying your Client ID and Client Secret. Best for long-lived sessions, token renewal, and avoiding re-authentication. Refresh token behavior: - Every successful refresh issues a new access token and a new refresh token, and invalidates the previously issued token pair. Always store the newest refresh_token; reusing an older one fails with -32602 (invalid token), which also affects concurrent refreshes with the same token. - The scope parameter is ignored for this grant type: the new tokens keep the scope, session and lifetime of the original token. - A token with connection scope is bound to the connection it was issued on and cannot be refreshed or used from another connection. Scope behavior (client_credentials and client_signature): - Without a session: or connection scope item, a WebSocket request gets a connection scope token. An HTTP (REST) request gets a session scope token with a generated rest-... session name, unless connection was requested explicitly. - connection and session:name cannot be combined (-32602). - Requested permission scopes (trade, wallet, account, block_trade, block_rfq) never exceed the permissions of the API key: higher levels are silently reduced to the key\u0026#x27;s level, and permission scopes that are not requested inherit the key\u0026#x27;s permissions. This is not reported as an error. Response: The response will contain an access token, expiration period (number of seconds that the token is valid) and a refresh token that can be used to get a new set of tokens. Over WebSocket, a successful call also authenticates the current connection, so later private requests on it need no access_token. Errors (JSON-RPC error.code): - 13004 invalid_credentials - unknown client_id, wrong client_secret, invalid signature, or client_id longer than 16 bytes. - 13009 unauthorized - timestamp outside the allowed window, nonce longer than 128 bytes or already used, connecting IP not in the key\u0026#x27;s IP whitelist (reason: bad_ip). - -32602 Invalid params - missing required parameter for the chosen grant_type, unknown grant_type, invalid scope, or an invalid / expired / already-replaced refresh_token (including session_not_found). Try in API console\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://deribit.mintlify.site/_mintlify/api/og/v2?division=Authentication\u0026amp;title=public%2Fauth\u0026amp;description=Retrieve+an+OAuth+access+token%2C+to+be+used+for+authentication+of+%27private%27+requests.%0A%0A**%F0%9F%93%96+Related+Article%3A**+%5BAuthentication%5D%28https%3A%2F%2Fdocs.deribit.com%2Farticles%2F\u0026amp;theme=ac8885f98fec5a1d80cab062\u0026amp;signature=9d65da324085f64364137f1ee50a207d805de8f87acf6df5d5f42b052e7bb290\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/deribit/pu9BhCQUYFueUXtn/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Deribit API Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0052FF\">\u003cmeta data-mint-head name=\"og:locale\" content=\"en_US\">\u003cmeta data-mint-head name=\"author\" content=\"Deribit\">\u003cmeta data-mint-head name=\"application-name\" content=\"Deribit API Documentation\">\u003cmeta data-mint-head name=\"theme-color\" content=\"#0052FF\">\u003cmeta data-mint-head name=\"color-scheme\" content=\"light dark\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.deribit.com//api-reference/upcoming/authentication/public-auth\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/upcoming/authentication/public-auth.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.deribit.com/#organization\",\"name\":\"Deribit API Documentation\",\"url\":\"https://docs.deribit.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/deribit/jU8dKQ0mWmFd1NVE/images/deribit_cb_logo_main_black_rgb.svg?fit=max\u0026auto=format\u0026n=jU8dKQ0mWmFd1NVE\u0026q=85\u0026s=f6995f51656093856017582bb557e0ff\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.deribit.com#website\",\"name\":\"Deribit API Documentation\",\"url\":\"https://docs.deribit.com\",\"publisher\":{\"@id\":\"https://docs.deribit.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.deribit.com//api-reference/upcoming/authentication/public-auth#webpage\",\"url\":\"https://docs.deribit.com//api-reference/upcoming/authentication/public-auth\",\"name\":\"public/auth\",\"description\":\"Retrieve an OAuth access token, to be used for authentication of 'private' requests. 📖 Related Article: Authentication Authentication Methods: Three methods of authentication are supported (selected with grant_type): - client_credentials - Using the client id and client secret that can be found on the API page on the website. This is the simplest method, suitable for server-to-server applications and quick setup. - client_signature - Enhanced security method using a cryptographic signature instead of sending the client secret directly. The signature is calculated over \\\\n\\\\n (the three values joined with line-feed characters, timestamp exactly as sent). Keys with a shared secret use an HMAC-SHA256 signature encoded as hexadecimal; asymmetric (RSA / Ed25519) keys use a digital signature over the same string encoded as URL-safe base64 without padding. This method requires client_id, timestamp and signature; nonce and data are optional (nonce is strongly recommended for replay protection). See the Client Signature (WebSocket) guide for detailed signature calculation instructions. - refresh_token - Using a refresh token that was received from an earlier invocation. This allows you to obtain a new access token without re-supplying your Client ID and Client Secret. Best for long-lived sessions, token renewal, and avoiding re-authentication. Refresh token behavior: - Every successful refresh issues a new access token and a new refresh token, and invalidates the previously issued token pair. Always store the newest refresh_token; reusing an older one fails with -32602 (invalid token), which also affects concurrent refreshes with the same token. - The scope parameter is ignored for this grant type: the new tokens keep the scope, session and lifetime of the original token. - A token with connection scope is bound to the connection it was issued on and cannot be refreshed or used from another connection. Scope behavior (client_credentials and client_signature): - Without a session: or connection scope item, a WebSocket request gets a connection scope token. An HTTP (REST) request gets a session scope token with a generated rest-... session name, unless connection was requested explicitly. - connection and session:name cannot be combined (-32602). - Requested permission scopes (trade, wallet, account, block_trade, block_rfq) never exceed the permissions of the API key: higher levels are silently reduced to the key's level, and permission scopes that are not requested inherit the key's permissions. This is not reported as an error. Response: The response will contain an access token, expiration period (number of seconds that the token is valid) and a refresh token that can be used to get a new set of tokens. Over WebSocket, a successful call also authenticates the current connection, so later private requests on it need no access_token. Errors (JSON-RPC error.code): - 13004 invalid_credentials - unknown client_id, wrong client_secret, invalid signature, or client_id longer than 16 bytes. - 13009 unauthorized - timestamp outside the allowed window, nonce longer than 128 bytes or already used, connecting IP not in the key's IP whitelist (reason: bad_ip). - -32602 Invalid params - missing required parameter for the chosen grant_type, unknown grant_type, invalid scope, or an invalid / expired / already-replaced refresh_token (including session_not_found). Try in API console\",\"dateModified\":\"2026-11-19T14:42:27.833Z\",\"isPartOf\":{\"@id\":\"https://docs.deribit.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.deribit.com//api-reference/upcoming/authentication/public-auth#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.deribit.com//api-reference/upcoming/authentication/public-auth#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Methods\",\"item\":\"https://docs.deribit.com/api-reference/upcoming/authentication/public-auth\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Authentication\",\"item\":\"https://docs.deribit.com/api-reference/upcoming/authentication/public-auth\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"public/auth\",\"item\":\"https://docs.deribit.com//api-reference/upcoming/authentication/public-auth\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.deribit.com//api-reference/upcoming/authentication/public-auth#apireference\",\"headline\":\"public/auth\",\"name\":\"public/auth\",\"description\":\"Retrieve an OAuth access token, to be used for authentication of 'private' requests. 📖 Related Article: Authentication Authentication Methods: Three methods of authentication are supported (selected with grant_type): - client_credentials - Using the client id and client secret that can be found on the API page on the website. This is the simplest method, suitable for server-to-server applications and quick setup. - client_signature - Enhanced security method using a cryptographic signature instead of sending the client secret directly. The signature is calculated over \\\\n\\\\n (the three values joined with line-feed characters, timestamp exactly as sent). Keys with a shared secret use an HMAC-SHA256 signature encoded as hexadecimal; asymmetric (RSA / Ed25519) keys use a digital signature over the same string encoded as URL-safe base64 without padding. This method requires client_id, timestamp and signature; nonce and data are optional (nonce is strongly recommended for replay protection). See the Client Signature (WebSocket) guide for detailed signature calculation instructions. - refresh_token - Using a refresh token that was received from an earlier invocation. This allows you to obtain a new access token without re-supplying your Client ID and Client Secret. Best for long-lived sessions, token renewal, and avoiding re-authentication. Refresh token behavior: - Every successful refresh issues a new access token and a new refresh token, and invalidates the previously issued token pair. Always store the newest refresh_token; reusing an older one fails with -32602 (invalid token), which also affects concurrent refreshes with the same token. - The scope parameter is ignored for this grant type: the new tokens keep the scope, session and lifetime of the original token. - A token with connection scope is bound to the connection it was issued on and cannot be refreshed or used from another connection. Scope behavior (client_credentials and client_signature): - Without a session: or connection scope item, a WebSocket request gets a connection scope token. An HTTP (REST) request gets a session scope token with a generated rest-... session name, unless connection was requested explicitly. - connection and session:name cannot be combined (-32602). - Requested permission scopes (trade, wallet, account, block_trade, block_rfq) never exceed the permissions of the API key: higher levels are silently reduced to the key's level, and permission scopes that are not requested inherit the key's permissions. This is not reported as an error. Response: The response will contain an access token, expiration period (number of seconds that the token is valid) and a refresh token that can be used to get a new set of tokens. Over WebSocket, a successful call also authenticates the current connection, so later private requests on it need no access_token. Errors (JSON-RPC error.code): - 13004 invalid_credentials - unknown client_id, wrong client_secret, invalid signature, or client_id longer than 16 bytes. - 13009 unauthorized - timestamp outside the allowed window, nonce longer than 128 bytes or already used, connecting IP not in the key's IP whitelist (reason: bad_ip). - -32602 Invalid params - missing required parameter for the chosen grant_type, unknown grant_type, invalid scope, or an invalid / expired / already-replaced refresh_token (including session_not_found). Try in API console\",\"url\":\"https://docs.deribit.com//api-reference/upcoming/authentication/public-auth\",\"mainEntityOfPage\":{\"@id\":\"https://docs.deribit.com//api-reference/upcoming/authentication/public-auth#webpage\"},\"dateModified\":\"2026-11-19T14:42:27.833Z\",\"keywords\":\"public/auth, grant_type, client_id, client_secret, refresh_token, timestamp, signature, nonce, data, state, scope\",\"publisher\":{\"@id\":\"https://docs.deribit.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.deribit.com#website\"}}]}\u003c/script>","agentPointerHref":"/api-reference/upcoming/authentication/public-auth.md","siteName":"Deribit API Documentation","nav":{"global":null,"versions":[{"version":"Production","pages":[{"title":"Production","href":"/"}]},{"version":"Upcoming","tabs":[{"tab":"Overview","pages":[{"title":"Overview","href":""}]},{"tab":"API Reference","dropdowns":[{"dropdown":"JSON-RPC API","icon":"code","pages":[{"group":"Methods overview","pages":[{"title":"JSON-RPC 2.0 Protocol","href":"/articles/json-rpc-overview"},{"title":"Error Codes","href":"/articles/errors"},{"title":"Using the currency Parameter","description":"Discover supported currencies with get_currencies, learn what currency selects on each Deribit method, and avoid invalid currency and spot routing errors.","href":"/articles/currency-parameter"}]},{"group":"Methods","pages":[{"group":"Authentication","pages":[{"title":"public/auth","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /public/auth","href":"/api-reference/upcoming/authentication/public-auth"},{"title":"public/exchange_token","description":"Generates a token for a new subject id. This method can be used to switch between subaccounts.\n\n**Rules:**\n\n- `subject_id` must differ from the subject of the supplied refresh token (otherwise `-32602`) and must identify an active user (otherwise `-32602`).\n- Regular clients can only switch within their own account family (the main account and its subaccounts). A token issued directly for a subaccount cannot switch to the main account or to sibling subaccounts (`-32602` on `subject_id`). Vault subaccounts are rejected with `14049` (`vault_subaccount_not_allowed`).\n- Without `scope`, the new token inherits the scope of the supplied refresh token. A supplied `scope` **replaces** it (it is not merged), and cannot exceed the scope of the refresh token (`13403` `scope_exceeded`). If it contains neither `session:` nor `connection`, a session with a generated name is created.\n- The new access token's lifetime is counted from the issue time of the supplied refresh token.\n- Over WebSocket, the returned access token is also installed on the current connection, so subsequent private requests act as the new subject.\n- An invalid, expired or already-replaced refresh token (or one bound to another connection) returns `-32602` on `refresh_token`; `session_not_found` means the session of the token no longer exists.\n\n**📖 Related Articles:** \n- [Fork and Exchange Tokens](https://docs.deribit.com/articles/authentication#fork-and-exchange-tokens)\n- [Managing Subaccounts](https://docs.deribit.com/articles/managing-subaccounts-api)\n\n[Try in API console](https://test.deribit.com/api_console?method=%2Fpublic%2Fexchange_token)\n\n","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /public/exchange_token","href":"/api-reference/upcoming/authentication/public-exchange_token"},{"title":"public/fork_token","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /public/fork_token","href":"/api-reference/upcoming/authentication/public-fork_token"},{"title":"private/logout","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/logout","href":"/api-reference/upcoming/authentication/private-logout"}]},{"group":"Account Management","pages":[{"title":"private/change_api_key_name","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/change_api_key_name","href":"/api-reference/upcoming/account-management/private-change_api_key_name"},{"title":"private/change_margin_model","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/change_margin_model","href":"/api-reference/upcoming/account-management/private-change_margin_model"},{"title":"private/change_scope_in_api_key","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/change_scope_in_api_key","href":"/api-reference/upcoming/account-management/private-change_scope_in_api_key"},{"title":"private/change_subaccount_name","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/change_subaccount_name","href":"/api-reference/upcoming/account-management/private-change_subaccount_name"},{"title":"private/create_api_key","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/create_api_key","href":"/api-reference/upcoming/account-management/private-create_api_key"},{"title":"private/create_subaccount","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/create_subaccount","href":"/api-reference/upcoming/account-management/private-create_subaccount"},{"title":"private/delete_member","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/delete_member","href":"/api-reference/upcoming/account-management/private-delete_member"},{"title":"private/disable_api_key","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/disable_api_key","href":"/api-reference/upcoming/account-management/private-disable_api_key"},{"title":"private/edit_api_key","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/edit_api_key","href":"/api-reference/upcoming/account-management/private-edit_api_key"},{"title":"private/enable_affiliate_program","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/enable_affiliate_program","href":"/api-reference/upcoming/account-management/private-enable_affiliate_program"},{"title":"private/enable_api_key","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/enable_api_key","href":"/api-reference/upcoming/account-management/private-enable_api_key"},{"title":"private/get_access_log","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/get_access_log","href":"/api-reference/upcoming/account-management/private-get_access_log"},{"title":"private/get_account_summaries","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/get_account_summaries","href":"/api-reference/upcoming/account-management/private-get_account_summaries"},{"title":"private/get_account_summary","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/get_account_summary","href":"/api-reference/upcoming/account-management/private-get_account_summary"},{"title":"private/get_affiliate_program_info","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/get_affiliate_program_info","href":"/api-reference/upcoming/account-management/private-get_affiliate_program_info"},{"title":"private/get_currencies","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/get_currencies","href":"/api-reference/upcoming/account-management/private-get_currencies"},{"title":"private/get_email_language","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/get_email_language","href":"/api-reference/upcoming/account-management/private-get_email_language"},{"title":"private/get_members","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/get_members","href":"/api-reference/upcoming/account-management/private-get_members"},{"title":"private/get_new_announcements","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/get_new_announcements","href":"/api-reference/upcoming/account-management/private-get_new_announcements"},{"title":"private/get_position","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/get_position","href":"/api-reference/upcoming/account-management/private-get_position"},{"title":"private/get_positions","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/get_positions","href":"/api-reference/upcoming/account-management/private-get_positions"},{"title":"private/get_subaccounts","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/get_subaccounts","href":"/api-reference/upcoming/account-management/private-get_subaccounts"},{"title":"private/get_subaccounts_details","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/get_subaccounts_details","href":"/api-reference/upcoming/account-management/private-get_subaccounts_details"},{"title":"private/get_transaction_log","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/get_transaction_log","href":"/api-reference/upcoming/account-management/private-get_transaction_log"},{"title":"private/get_user_locks","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/get_user_locks","href":"/api-reference/upcoming/account-management/private-get_user_locks"},{"title":"private/list_api_keys","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/list_api_keys","href":"/api-reference/upcoming/account-management/private-list_api_keys"},{"title":"private/list_custody_accounts","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/list_custody_accounts","href":"/api-reference/upcoming/account-management/private-list_custody_accounts"},{"title":"private/pme/simulate","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/pme/simulate","href":"/api-reference/upcoming/account-management/private-simulate"},{"title":"private/remove_api_key","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/remove_api_key","href":"/api-reference/upcoming/account-management/private-remove_api_key"},{"title":"private/remove_subaccount","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/remove_subaccount","href":"/api-reference/upcoming/account-management/private-remove_subaccount"},{"title":"private/reset_api_key","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/reset_api_key","href":"/api-reference/upcoming/account-management/private-reset_api_key"},{"title":"private/set_announcement_as_read","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/set_announcement_as_read","href":"/api-reference/upcoming/account-management/private-set_announcement_as_read"},{"title":"private/set_disabled_trading_products","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/set_disabled_trading_products","href":"/api-reference/upcoming/account-management/private-set_disabled_trading_products"},{"title":"private/set_email_for_subaccount","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/set_email_for_subaccount","href":"/api-reference/upcoming/account-management/private-set_email_for_subaccount"},{"title":"private/set_email_language","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/set_email_language","href":"/api-reference/upcoming/account-management/private-set_email_language"},{"title":"private/set_member","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/set_member","href":"/api-reference/upcoming/account-management/private-set_member"},{"title":"private/set_self_trading_config","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/set_self_trading_config","href":"/api-reference/upcoming/account-management/private-set_self_trading_config"},{"title":"private/simulate_portfolio","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/simulate_portfolio","href":"/api-reference/upcoming/account-management/private-simulate_portfolio"},{"title":"private/toggle_notifications_from_subaccount","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/toggle_notifications_from_subaccount","href":"/api-reference/upcoming/account-management/private-toggle_notifications_from_subaccount"},{"title":"private/toggle_subaccount_login","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/toggle_subaccount_login","href":"/api-reference/upcoming/account-management/private-toggle_subaccount_login"},{"title":"public/get_announcements","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /public/get_announcements","href":"/api-reference/upcoming/account-management/public-get_announcements"}]},{"group":"Block RFQ","pages":[{"title":"private/accept_block_rfq","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/accept_block_rfq","href":"/api-reference/upcoming/block-rfq/private-accept_block_rfq"},{"title":"private/add_block_rfq_quote","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/add_block_rfq_quote","href":"/api-reference/upcoming/block-rfq/private-add_block_rfq_quote"},{"title":"private/cancel_all_block_rfq_quotes","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/cancel_all_block_rfq_quotes","href":"/api-reference/upcoming/block-rfq/private-cancel_all_block_rfq_quotes"},{"title":"private/cancel_block_rfq","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/cancel_block_rfq","href":"/api-reference/upcoming/block-rfq/private-cancel_block_rfq"},{"title":"private/cancel_block_rfq_quote","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/cancel_block_rfq_quote","href":"/api-reference/upcoming/block-rfq/private-cancel_block_rfq_quote"},{"title":"private/cancel_block_rfq_trigger","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/cancel_block_rfq_trigger","href":"/api-reference/upcoming/block-rfq/private-cancel_block_rfq_trigger"},{"title":"private/create_block_rfq","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/create_block_rfq","href":"/api-reference/upcoming/block-rfq/private-create_block_rfq"},{"title":"private/edit_block_rfq_quote","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/edit_block_rfq_quote","href":"/api-reference/upcoming/block-rfq/private-edit_block_rfq_quote"},{"title":"private/get_block_rfq_makers","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/get_block_rfq_makers","href":"/api-reference/upcoming/block-rfq/private-get_block_rfq_makers"},{"title":"private/get_block_rfq_quotes","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/get_block_rfq_quotes","href":"/api-reference/upcoming/block-rfq/private-get_block_rfq_quotes"},{"title":"private/get_block_rfq_user_info","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/get_block_rfq_user_info","href":"/api-reference/upcoming/block-rfq/private-get_block_rfq_user_info"},{"title":"private/get_block_rfqs","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/get_block_rfqs","href":"/api-reference/upcoming/block-rfq/private-get_block_rfqs"},{"title":"public/get_block_rfq_trades","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /public/get_block_rfq_trades","href":"/api-reference/upcoming/block-rfq/public-get_block_rfq_trades"}]},{"group":"Block Trade","pages":[{"title":"private/approve_block_trade","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/approve_block_trade","href":"/api-reference/upcoming/block-trade/private-approve_block_trade"},{"title":"private/execute_block_trade","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/execute_block_trade","href":"/api-reference/upcoming/block-trade/private-execute_block_trade"},{"title":"private/get_block_trade","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/get_block_trade","href":"/api-reference/upcoming/block-trade/private-get_block_trade"},{"title":"private/get_block_trade_requests","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/get_block_trade_requests","href":"/api-reference/upcoming/block-trade/private-get_block_trade_requests"},{"title":"private/get_block_trades","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/get_block_trades","href":"/api-reference/upcoming/block-trade/private-get_block_trades"},{"title":"private/get_broker_clients","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/get_broker_clients","href":"/api-reference/upcoming/block-trade/private-get_broker_clients"},{"title":"private/get_broker_trade_requests","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/get_broker_trade_requests","href":"/api-reference/upcoming/block-trade/private-get_broker_trade_requests"},{"title":"private/get_broker_trades","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/get_broker_trades","href":"/api-reference/upcoming/block-trade/private-get_broker_trades"},{"title":"private/invalidate_block_trade_signature","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/invalidate_block_trade_signature","href":"/api-reference/upcoming/block-trade/private-invalidate_block_trade_signature"},{"title":"private/reject_block_trade","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/reject_block_trade","href":"/api-reference/upcoming/block-trade/private-reject_block_trade"},{"title":"private/simulate_block_trade","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/simulate_block_trade","href":"/api-reference/upcoming/block-trade/private-simulate_block_trade"},{"title":"private/verify_block_trade","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/verify_block_trade","href":"/api-reference/upcoming/block-trade/private-verify_block_trade"}]},{"group":"Combo Books","pages":[{"title":"private/create_combo","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/create_combo","href":"/api-reference/upcoming/combo-books/private-create_combo"},{"title":"private/get_leg_prices","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/get_leg_prices","href":"/api-reference/upcoming/combo-books/private-get_leg_prices"},{"title":"public/get_combo_details","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /public/get_combo_details","href":"/api-reference/upcoming/combo-books/public-get_combo_details"},{"title":"public/get_combo_ids","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /public/get_combo_ids","href":"/api-reference/upcoming/combo-books/public-get_combo_ids"},{"title":"public/get_combos","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /public/get_combos","href":"/api-reference/upcoming/combo-books/public-get_combos"}]},{"group":"LSP","pages":[{"title":"private/get_lsp_participant_config","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/get_lsp_participant_config","href":"/api-reference/upcoming/lsp/private-get_lsp_participant_config"},{"title":"private/get_lsp_participants","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/get_lsp_participants","href":"/api-reference/upcoming/lsp/private-get_lsp_participants"},{"title":"private/get_lsp_participants_usage","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/get_lsp_participants_usage","href":"/api-reference/upcoming/lsp/private-get_lsp_participants_usage"},{"title":"private/get_lsp_usage","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/get_lsp_usage","href":"/api-reference/upcoming/lsp/private-get_lsp_usage"}]},{"group":"Market Data","pages":[{"title":"public/get_apr_history","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /public/get_apr_history","href":"/api-reference/upcoming/market-data/public-get_apr_history"},{"title":"public/get_basket_index_composition","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /public/get_basket_index_composition","href":"/api-reference/upcoming/market-data/public-get_basket_index_composition"},{"title":"public/get_book_summary_by_currency","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /public/get_book_summary_by_currency","href":"/api-reference/upcoming/market-data/public-get_book_summary_by_currency"},{"title":"public/get_book_summary_by_instrument","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /public/get_book_summary_by_instrument","href":"/api-reference/upcoming/market-data/public-get_book_summary_by_instrument"},{"title":"public/get_contract_size","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /public/get_contract_size","href":"/api-reference/upcoming/market-data/public-get_contract_size"},{"title":"public/get_currencies","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /public/get_currencies","href":"/api-reference/upcoming/market-data/public-get_currencies"},{"title":"public/get_delivery_prices","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /public/get_delivery_prices","href":"/api-reference/upcoming/market-data/public-get_delivery_prices"},{"title":"public/get_expirations","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /public/get_expirations","href":"/api-reference/upcoming/market-data/public-get_expirations"},{"title":"public/get_funding_chart_data","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /public/get_funding_chart_data","href":"/api-reference/upcoming/market-data/public-get_funding_chart_data"},{"title":"public/get_funding_rate_history","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /public/get_funding_rate_history","href":"/api-reference/upcoming/market-data/public-get_funding_rate_history"},{"title":"public/get_funding_rate_value","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /public/get_funding_rate_value","href":"/api-reference/upcoming/market-data/public-get_funding_rate_value"},{"title":"public/get_historical_volatility","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /public/get_historical_volatility","href":"/api-reference/upcoming/market-data/public-get_historical_volatility"},{"title":"public/get_index_price","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /public/get_index_price","href":"/api-reference/upcoming/market-data/public-get_index_price"},{"title":"public/get_index_price_names","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /public/get_index_price_names","href":"/api-reference/upcoming/market-data/public-get_index_price_names"},{"title":"public/get_instrument","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /public/get_instrument","href":"/api-reference/upcoming/market-data/public-get_instrument"},{"title":"public/get_instruments","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /public/get_instruments","href":"/api-reference/upcoming/market-data/public-get_instruments"},{"title":"public/get_last_settlements_by_currency","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /public/get_last_settlements_by_currency","href":"/api-reference/upcoming/market-data/public-get_last_settlements_by_currency"},{"title":"public/get_last_settlements_by_instrument","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /public/get_last_settlements_by_instrument","href":"/api-reference/upcoming/market-data/public-get_last_settlements_by_instrument"},{"title":"public/get_last_trades_by_currency","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /public/get_last_trades_by_currency","href":"/api-reference/upcoming/market-data/public-get_last_trades_by_currency"},{"title":"public/get_last_trades_by_currency_and_time","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /public/get_last_trades_by_currency_and_time","href":"/api-reference/upcoming/market-data/public-get_last_trades_by_currency_and_time"},{"title":"public/get_last_trades_by_instrument","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /public/get_last_trades_by_instrument","href":"/api-reference/upcoming/market-data/public-get_last_trades_by_instrument"},{"title":"public/get_last_trades_by_instrument_and_time","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /public/get_last_trades_by_instrument_and_time","href":"/api-reference/upcoming/market-data/public-get_last_trades_by_instrument_and_time"},{"title":"public/get_mark_price_history","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /public/get_mark_price_history","href":"/api-reference/upcoming/market-data/public-get_mark_price_history"},{"title":"public/get_order_book","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /public/get_order_book","href":"/api-reference/upcoming/market-data/public-get_order_book"},{"title":"public/get_order_book_by_instrument_id","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /public/get_order_book_by_instrument_id","href":"/api-reference/upcoming/market-data/public-get_order_book_by_instrument_id"},{"title":"public/get_supported_index_names","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /public/get_supported_index_names","href":"/api-reference/upcoming/market-data/public-get_supported_index_names"},{"title":"public/get_trade_volumes","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /public/get_trade_volumes","href":"/api-reference/upcoming/market-data/public-get_trade_volumes"},{"title":"public/get_tradingview_chart_data","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /public/get_tradingview_chart_data","href":"/api-reference/upcoming/market-data/public-get_tradingview_chart_data"},{"title":"public/get_volatility_index_data","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /public/get_volatility_index_data","href":"/api-reference/upcoming/market-data/public-get_volatility_index_data"},{"title":"public/ticker","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /public/ticker","href":"/api-reference/upcoming/market-data/public-ticker"},{"title":"public/get_index_chart_data","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /public/get_index_chart_data","href":"/api-reference/upcoming/market-data/public-get_index_chart_data"}]},{"group":"Session Management","pages":[{"title":"private/disable_cancel_on_disconnect","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/disable_cancel_on_disconnect","href":"/api-reference/upcoming/session-management/private-disable_cancel_on_disconnect"},{"title":"private/enable_cancel_on_disconnect","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/enable_cancel_on_disconnect","href":"/api-reference/upcoming/session-management/private-enable_cancel_on_disconnect"},{"title":"private/get_cancel_on_disconnect","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/get_cancel_on_disconnect","href":"/api-reference/upcoming/session-management/private-get_cancel_on_disconnect"},{"title":"public/disable_heartbeat","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /public/disable_heartbeat","href":"/api-reference/upcoming/session-management/public-disable_heartbeat"},{"title":"public/set_heartbeat","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /public/set_heartbeat","href":"/api-reference/upcoming/session-management/public-set_heartbeat"}]},{"group":"Subscription Management","pages":[{"title":"private/subscribe","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/subscribe","href":"/api-reference/upcoming/subscription-management/private-subscribe"},{"title":"private/unsubscribe","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/unsubscribe","href":"/api-reference/upcoming/subscription-management/private-unsubscribe"},{"title":"private/unsubscribe_all","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/unsubscribe_all","href":"/api-reference/upcoming/subscription-management/private-unsubscribe_all"},{"title":"public/subscribe","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /public/subscribe","href":"/api-reference/upcoming/subscription-management/public-subscribe"},{"title":"public/unsubscribe","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /public/unsubscribe","href":"/api-reference/upcoming/subscription-management/public-unsubscribe"},{"title":"public/unsubscribe_all","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /public/unsubscribe_all","href":"/api-reference/upcoming/subscription-management/public-unsubscribe_all"}]},{"group":"Supporting","pages":[{"title":"public/get_time","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /public/get_time","href":"/api-reference/upcoming/supporting/public-get_time"},{"title":"public/hello","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /public/hello","href":"/api-reference/upcoming/supporting/public-hello"},{"title":"public/status","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /public/status","href":"/api-reference/upcoming/supporting/public-status"},{"title":"public/test","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /public/test","href":"/api-reference/upcoming/supporting/public-test"}]},{"group":"Trading","pages":[{"title":"private/buy","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/buy","href":"/api-reference/upcoming/trading/private-buy"},{"title":"private/cancel","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/cancel","href":"/api-reference/upcoming/trading/private-cancel"},{"title":"private/cancel_all","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/cancel_all","href":"/api-reference/upcoming/trading/private-cancel_all"},{"title":"private/cancel_all_by_currency","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/cancel_all_by_currency","href":"/api-reference/upcoming/trading/private-cancel_all_by_currency"},{"title":"private/cancel_all_by_currency_pair","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/cancel_all_by_currency_pair","href":"/api-reference/upcoming/trading/private-cancel_all_by_currency_pair"},{"title":"private/cancel_all_by_instrument","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/cancel_all_by_instrument","href":"/api-reference/upcoming/trading/private-cancel_all_by_instrument"},{"title":"private/cancel_all_by_kind_or_type","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/cancel_all_by_kind_or_type","href":"/api-reference/upcoming/trading/private-cancel_all_by_kind_or_type"},{"title":"private/cancel_by_label","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/cancel_by_label","href":"/api-reference/upcoming/trading/private-cancel_by_label"},{"title":"private/cancel_quotes","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/cancel_quotes","href":"/api-reference/upcoming/trading/private-cancel_quotes"},{"title":"private/close_position","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/close_position","href":"/api-reference/upcoming/trading/private-close_position"},{"title":"private/edit","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/edit","href":"/api-reference/upcoming/trading/private-edit"},{"title":"private/edit_by_label","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/edit_by_label","href":"/api-reference/upcoming/trading/private-edit_by_label"},{"title":"private/get_margins","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/get_margins","href":"/api-reference/upcoming/trading/private-get_margins"},{"title":"private/get_mmp_config","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/get_mmp_config","href":"/api-reference/upcoming/trading/private-get_mmp_config"},{"title":"private/get_mmp_status","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/get_mmp_status","href":"/api-reference/upcoming/trading/private-get_mmp_status"},{"title":"private/get_open_orders","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/get_open_orders","href":"/api-reference/upcoming/trading/private-get_open_orders"},{"title":"private/get_open_orders_by_currency","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/get_open_orders_by_currency","href":"/api-reference/upcoming/trading/private-get_open_orders_by_currency"},{"title":"private/get_open_orders_by_instrument","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/get_open_orders_by_instrument","href":"/api-reference/upcoming/trading/private-get_open_orders_by_instrument"},{"title":"private/get_open_orders_by_label","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/get_open_orders_by_label","href":"/api-reference/upcoming/trading/private-get_open_orders_by_label"},{"title":"private/get_order_history_by_currency","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/get_order_history_by_currency","href":"/api-reference/upcoming/trading/private-get_order_history_by_currency"},{"title":"private/get_order_history_by_instrument","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/get_order_history_by_instrument","href":"/api-reference/upcoming/trading/private-get_order_history_by_instrument"},{"title":"private/get_order_margin_by_ids","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/get_order_margin_by_ids","href":"/api-reference/upcoming/trading/private-get_order_margin_by_ids"},{"title":"private/get_order_state","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/get_order_state","href":"/api-reference/upcoming/trading/private-get_order_state"},{"title":"private/get_order_state_by_label","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/get_order_state_by_label","href":"/api-reference/upcoming/trading/private-get_order_state_by_label"},{"title":"private/get_settlement_history_by_currency","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/get_settlement_history_by_currency","href":"/api-reference/upcoming/trading/private-get_settlement_history_by_currency"},{"title":"private/get_settlement_history_by_instrument","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/get_settlement_history_by_instrument","href":"/api-reference/upcoming/trading/private-get_settlement_history_by_instrument"},{"title":"private/get_trigger_order_history","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/get_trigger_order_history","href":"/api-reference/upcoming/trading/private-get_trigger_order_history"},{"title":"private/get_user_trades_by_currency","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/get_user_trades_by_currency","href":"/api-reference/upcoming/trading/private-get_user_trades_by_currency"},{"title":"private/get_user_trades_by_currency_and_time","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/get_user_trades_by_currency_and_time","href":"/api-reference/upcoming/trading/private-get_user_trades_by_currency_and_time"},{"title":"private/get_user_trades_by_instrument","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/get_user_trades_by_instrument","href":"/api-reference/upcoming/trading/private-get_user_trades_by_instrument"},{"title":"private/get_user_trades_by_instrument_and_time","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/get_user_trades_by_instrument_and_time","href":"/api-reference/upcoming/trading/private-get_user_trades_by_instrument_and_time"},{"title":"private/get_user_trades_by_order","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/get_user_trades_by_order","href":"/api-reference/upcoming/trading/private-get_user_trades_by_order"},{"title":"private/mass_quote","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/mass_quote","href":"/api-reference/upcoming/trading/private-mass_quote"},{"title":"private/move_positions","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/move_positions","href":"/api-reference/upcoming/trading/private-move_positions"},{"title":"private/reset_mmp","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/reset_mmp","href":"/api-reference/upcoming/trading/private-reset_mmp"},{"title":"private/sell","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/sell","href":"/api-reference/upcoming/trading/private-sell"},{"title":"private/set_mmp_config","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/set_mmp_config","href":"/api-reference/upcoming/trading/private-set_mmp_config"}]},{"group":"Wallet","pages":[{"title":"private/add_to_address_book","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/add_to_address_book","href":"/api-reference/upcoming/wallet/private-add_to_address_book"},{"title":"private/cancel_transfer_by_id","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/cancel_transfer_by_id","href":"/api-reference/upcoming/wallet/private-cancel_transfer_by_id"},{"title":"private/cancel_withdrawal","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/cancel_withdrawal","href":"/api-reference/upcoming/wallet/private-cancel_withdrawal"},{"title":"private/coinbase/estimate_withdrawal_fee","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/coinbase/estimate_withdrawal_fee","href":"/api-reference/upcoming/wallet/private-estimate_withdrawal_fee"},{"title":"private/create_deposit_address","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/create_deposit_address","href":"/api-reference/upcoming/wallet/private-create_deposit_address"},{"title":"private/delete_address_beneficiary","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/delete_address_beneficiary","href":"/api-reference/upcoming/wallet/private-delete_address_beneficiary"},{"title":"private/get_address_beneficiary","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/get_address_beneficiary","href":"/api-reference/upcoming/wallet/private-get_address_beneficiary"},{"title":"private/get_address_book","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/get_address_book","href":"/api-reference/upcoming/wallet/private-get_address_book"},{"title":"private/get_ctn_id","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/get_ctn_id","href":"/api-reference/upcoming/wallet/private-get_ctn_id"},{"title":"private/get_current_deposit_address","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/get_current_deposit_address","href":"/api-reference/upcoming/wallet/private-get_current_deposit_address"},{"title":"private/get_deposits","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/get_deposits","href":"/api-reference/upcoming/wallet/private-get_deposits"},{"title":"private/get_reward_eligibility","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/get_reward_eligibility","href":"/api-reference/upcoming/wallet/private-get_reward_eligibility"},{"title":"private/get_transfers","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/get_transfers","href":"/api-reference/upcoming/wallet/private-get_transfers"},{"title":"private/get_withdrawals","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/get_withdrawals","href":"/api-reference/upcoming/wallet/private-get_withdrawals"},{"title":"private/list_address_beneficiaries","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/list_address_beneficiaries","href":"/api-reference/upcoming/wallet/private-list_address_beneficiaries"},{"title":"private/remove_from_address_book","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/remove_from_address_book","href":"/api-reference/upcoming/wallet/private-remove_from_address_book"},{"title":"private/save_address_beneficiary","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/save_address_beneficiary","href":"/api-reference/upcoming/wallet/private-save_address_beneficiary"},{"title":"private/set_address_requires_security_key","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/set_address_requires_security_key","href":"/api-reference/upcoming/wallet/private-set_address_requires_security_key"},{"title":"private/set_clearance_originator","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/set_clearance_originator","href":"/api-reference/upcoming/wallet/private-set_clearance_originator"},{"title":"private/set_coinbase_subaccount_withdrawals_allowed","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/set_coinbase_subaccount_withdrawals_allowed","href":"/api-reference/upcoming/wallet/private-set_coinbase_subaccount_withdrawals_allowed"},{"title":"private/submit_transfer_between_subaccounts","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/submit_transfer_between_subaccounts","href":"/api-reference/upcoming/wallet/private-submit_transfer_between_subaccounts"},{"title":"private/submit_transfer_to_subaccount","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/submit_transfer_to_subaccount","href":"/api-reference/upcoming/wallet/private-submit_transfer_to_subaccount"},{"title":"private/submit_transfer_to_user","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/submit_transfer_to_user","href":"/api-reference/upcoming/wallet/private-submit_transfer_to_user"},{"title":"private/update_in_address_book","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/update_in_address_book","href":"/api-reference/upcoming/wallet/private-update_in_address_book"},{"title":"private/withdraw","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/withdraw","href":"/api-reference/upcoming/wallet/private-withdraw"}]}]}]},{"dropdown":"Subscription Channels","icon":"rss","groups":[{"group":"Introduction","pages":[{"title":"Notifications","href":"/articles/notifications"}]},{"group":"Websockets","pages":[{"group":"Platform","pages":[{"asyncapi":"specifications/deribit_upcoming_asyncapi.json platform_state","href":"/subscriptions/upcoming/platform/platform_state","title":"platform_state ","version":null},{"asyncapi":"specifications/deribit_upcoming_asyncapi.json platform_state.public_methods_state","href":"/subscriptions/upcoming/platform/platform_statepublic_methods_state","title":"platform_state.public_methods_state ","version":null}]},{"group":"Announcements","pages":[{"asyncapi":"specifications/deribit_upcoming_asyncapi.json announcements","href":"/subscriptions/upcoming/announcements/announcements","title":"announcements ","version":null}]},{"group":"Orderbook","pages":[{"asyncapi":"specifications/deribit_upcoming_asyncapi.json book.(instrument_name).(interval)","href":"/subscriptions/upcoming/orderbook/bookinstrument_nameinterval","title":"book.(instrument_name).(interval) ","version":null},{"asyncapi":"specifications/deribit_upcoming_asyncapi.json book.(instrument_name).(group).(depth).(interval)","href":"/subscriptions/upcoming/orderbook/bookinstrument_namegroupdepthinterval","title":"book.(instrument_name).(group).(depth).(interval) ","version":null}]},{"group":"Market Data","pages":[{"asyncapi":"specifications/deribit_upcoming_asyncapi.json ticker.(instrument_name).(interval)","href":"/subscriptions/upcoming/market-data/tickerinstrument_nameinterval","title":"ticker.(instrument_name).(interval) ","version":null},{"asyncapi":"specifications/deribit_upcoming_asyncapi.json incremental_ticker.(instrument_name)","href":"/subscriptions/upcoming/market-data/incremental_tickerinstrument_name","title":"incremental_ticker.(instrument_name) ","version":null},{"asyncapi":"specifications/deribit_upcoming_asyncapi.json perpetual.(instrument_name).(interval)","href":"/subscriptions/upcoming/market-data/perpetualinstrument_nameinterval","title":"perpetual.(instrument_name).(interval) ","version":null},{"asyncapi":"specifications/deribit_upcoming_asyncapi.json quote.(instrument_name)","href":"/subscriptions/upcoming/market-data/quoteinstrument_name","title":"quote.(instrument_name) ","version":null},{"asyncapi":"specifications/deribit_upcoming_asyncapi.json deribit_price_index.(index_name)","href":"/subscriptions/upcoming/market-data/deribit_price_indexindex_name","title":"deribit_price_index.(index_name) ","version":null},{"asyncapi":"specifications/deribit_upcoming_asyncapi.json deribit_price_ranking.(index_name)","href":"/subscriptions/upcoming/market-data/deribit_price_rankingindex_name","title":"deribit_price_ranking.(index_name) ","version":null},{"asyncapi":"specifications/deribit_upcoming_asyncapi.json deribit_price_statistics.(index_name)","href":"/subscriptions/upcoming/market-data/deribit_price_statisticsindex_name","title":"deribit_price_statistics.(index_name) ","version":null},{"asyncapi":"specifications/deribit_upcoming_asyncapi.json deribit_volatility_index.(index_name)","href":"/subscriptions/upcoming/market-data/deribit_volatility_indexindex_name","title":"deribit_volatility_index.(index_name) ","version":null},{"asyncapi":"specifications/deribit_upcoming_asyncapi.json markprice.options.(index_name)","href":"/subscriptions/upcoming/market-data/markpriceoptionsindex_name","title":"markprice.options.(index_name) ","version":null},{"asyncapi":"specifications/deribit_upcoming_asyncapi.json estimated_expiration_price.(index_name)","href":"/subscriptions/upcoming/market-data/estimated_expiration_priceindex_name","title":"estimated_expiration_price.(index_name) ","version":null},{"asyncapi":"specifications/deribit_upcoming_asyncapi.json chart.trades.(instrument_name).(resolution)","href":"/subscriptions/upcoming/market-data/charttradesinstrument_nameresolution","title":"chart.trades.(instrument_name).(resolution) ","version":null},{"asyncapi":"specifications/deribit_upcoming_asyncapi.json instrument.creation.(kind).(currency)","href":"/subscriptions/upcoming/market-data/instrumentcreationkindcurrency","title":"instrument.creation.(kind).(currency) ","version":null},{"asyncapi":"specifications/deribit_upcoming_asyncapi.json instrument.state.(kind).(currency)","href":"/subscriptions/upcoming/market-data/instrumentstatekindcurrency","title":"instrument.state.(kind).(currency) ","version":null}]},{"group":"Trades","pages":[{"asyncapi":"specifications/deribit_upcoming_asyncapi.json trades.(instrument_name).(interval)","href":"/subscriptions/upcoming/trades/tradesinstrument_nameinterval","title":"trades.(instrument_name).(interval) ","version":null},{"asyncapi":"specifications/deribit_upcoming_asyncapi.json trades.(kind).(currency).(interval)","href":"/subscriptions/upcoming/trades/tradeskindcurrencyinterval","title":"trades.(kind).(currency).(interval) ","version":null}]},{"group":"Block Trade","pages":[{"asyncapi":"specifications/deribit_upcoming_asyncapi.json block_trade_confirmations","href":"/subscriptions/upcoming/block-trade/block_trade_confirmations","title":"block_trade_confirmations ","version":null},{"asyncapi":"specifications/deribit_upcoming_asyncapi.json block_trade_confirmations.(currency)","href":"/subscriptions/upcoming/block-trade/block_trade_confirmationscurrency","title":"block_trade_confirmations.(currency) ","version":null}]},{"group":"User","pages":[{"asyncapi":"specifications/deribit_upcoming_asyncapi.json user.mmp_trigger.(index_name)","href":"/subscriptions/upcoming/user/usermmp_triggerindex_name","title":"user.mmp_trigger.(index_name) ","version":null},{"asyncapi":"specifications/deribit_upcoming_asyncapi.json user.portfolio.(currency)","href":"/subscriptions/upcoming/user/userportfoliocurrency","title":"user.portfolio.(currency) ","version":null},{"asyncapi":"specifications/deribit_upcoming_asyncapi.json user.trades.(instrument_name).(interval)","href":"/subscriptions/upcoming/user/usertradesinstrument_nameinterval","title":"user.trades.(instrument_name).(interval) ","version":null},{"asyncapi":"specifications/deribit_upcoming_asyncapi.json user.trades.(kind).(currency).(interval)","href":"/subscriptions/upcoming/user/usertradeskindcurrencyinterval","title":"user.trades.(kind).(currency).(interval) ","version":null},{"asyncapi":"specifications/deribit_upcoming_asyncapi.json user.combo_trades.(instrument_name).(interval)","href":"/subscriptions/upcoming/user/usercombo_tradesinstrument_nameinterval","title":"user.combo_trades.(instrument_name).(interval) ","version":null},{"asyncapi":"specifications/deribit_upcoming_asyncapi.json user.combo_trades.(kind).(currency).(interval)","href":"/subscriptions/upcoming/user/usercombo_tradeskindcurrencyinterval","title":"user.combo_trades.(kind).(currency).(interval) ","version":null},{"asyncapi":"specifications/deribit_upcoming_asyncapi.json user.orders.(instrument_name).raw","href":"/subscriptions/upcoming/user/userordersinstrument_nameraw","title":"user.orders.(instrument_name).raw ","version":null},{"asyncapi":"specifications/deribit_upcoming_asyncapi.json user.orders.(instrument_name).(interval)","href":"/subscriptions/upcoming/user/userordersinstrument_nameinterval","title":"user.orders.(instrument_name).(interval) ","version":null},{"asyncapi":"specifications/deribit_upcoming_asyncapi.json user.orders.(kind).(currency).raw","href":"/subscriptions/upcoming/user/userorderskindcurrencyraw","title":"user.orders.(kind).(currency).raw ","version":null},{"asyncapi":"specifications/deribit_upcoming_asyncapi.json user.orders.(kind).(currency).(interval)","href":"/subscriptions/upcoming/user/userorderskindcurrencyinterval","title":"user.orders.(kind).(currency).(interval) ","version":null},{"asyncapi":"specifications/deribit_upcoming_asyncapi.json user.changes.(instrument_name).(interval)","href":"/subscriptions/upcoming/user/userchangesinstrument_nameinterval","title":"user.changes.(instrument_name).(interval) ","version":null},{"asyncapi":"specifications/deribit_upcoming_asyncapi.json user.changes.(kind).(currency).(interval)","href":"/subscriptions/upcoming/user/userchangeskindcurrencyinterval","title":"user.changes.(kind).(currency).(interval) ","version":null},{"asyncapi":"specifications/deribit_upcoming_asyncapi.json user.access_log","href":"/subscriptions/upcoming/user/useraccess_log","title":"user.access_log ","version":null},{"asyncapi":"specifications/deribit_upcoming_asyncapi.json user.lock","href":"/subscriptions/upcoming/user/userlock","title":"user.lock ","version":null},{"asyncapi":"specifications/deribit_upcoming_asyncapi.json user.liquidation","href":"/subscriptions/upcoming/user/userliquidation","title":"user.liquidation ","version":null},{"asyncapi":"specifications/deribit_upcoming_asyncapi.json user.isolated.liquidation","href":"/subscriptions/upcoming/user/userisolatedliquidation","title":"user.isolated.liquidation ","version":null},{"asyncapi":"specifications/deribit_upcoming_asyncapi.json user.lsp","href":"/subscriptions/upcoming/user/userlsp","title":"user.lsp ","version":null}]},{"group":"Block RFQ","pages":[{"asyncapi":"specifications/deribit_upcoming_asyncapi.json block_rfq.maker.(currency)","href":"/subscriptions/upcoming/block-rfq/block_rfqmakercurrency","title":"block_rfq.maker.(currency) ","version":null},{"asyncapi":"specifications/deribit_upcoming_asyncapi.json block_rfq.taker.(currency)","href":"/subscriptions/upcoming/block-rfq/block_rfqtakercurrency","title":"block_rfq.taker.(currency) ","version":null},{"asyncapi":"specifications/deribit_upcoming_asyncapi.json block_rfq.maker.quotes.(currency)","href":"/subscriptions/upcoming/block-rfq/block_rfqmakerquotescurrency","title":"block_rfq.maker.quotes.(currency) ","version":null},{"asyncapi":"specifications/deribit_upcoming_asyncapi.json block_rfq.trades.(currency)","href":"/subscriptions/upcoming/block-rfq/block_rfqtradescurrency","title":"block_rfq.trades.(currency) ","version":null}]}]}]},{"dropdown":"FIX API","icon":"bolt","pages":[{"group":"Overview","pages":[{"title":"Deribit Upcoming FIX API Overview","mode":"wide","href":"/fix-api/upcoming/overview"}]},{"group":"Session Management","pages":[{"title":"Logon(A) (Upcoming FIX API)","mode":"wide","href":"/fix-api/upcoming/logon"},{"title":"Logout(5) (Upcoming FIX API)","mode":"wide","href":"/fix-api/upcoming/logout"},{"title":"Heartbeat(0) (Upcoming FIX API)","mode":"wide","href":"/fix-api/upcoming/heartbeat"},{"title":"Test Request(1) (Upcoming FIX API)","mode":"wide","href":"/fix-api/upcoming/test-request"},{"title":"Resend Request(2) (Upcoming FIX API)","mode":"wide","href":"/fix-api/upcoming/resend-request"},{"title":"Reject(3) (Upcoming FIX API)","mode":"wide","href":"/fix-api/upcoming/reject"},{"title":"Sequence Reset(4) (Upcoming FIX API)","mode":"wide","href":"/fix-api/upcoming/sequence-reset"}]},{"group":"Market Data","pages":[{"title":"Security List Request(x) (Upcoming FIX API)","mode":"wide","href":"/fix-api/upcoming/security-list-request"},{"title":"Security List(y) (Upcoming FIX API)","mode":"wide","href":"/fix-api/upcoming/security-list"},{"title":"Market Data Request(V) (Upcoming FIX API)","mode":"wide","href":"/fix-api/upcoming/market-data-request"},{"title":"Market Data Request Reject(Y) (Upcoming FIX API)","mode":"wide","href":"/fix-api/upcoming/market-data-request-reject"},{"title":"Market Data Snapshot/Full Refresh(W) (Upcoming FIX API)","mode":"wide","href":"/fix-api/upcoming/market-data-snapshot"},{"title":"Market Data Incremental Refresh(X) (Upcoming FIX API)","mode":"wide","href":"/fix-api/upcoming/market-data-incremental"},{"title":"Security Status Request(e) (Upcoming FIX API)","mode":"wide","href":"/fix-api/upcoming/security-status-request"},{"title":"Security Status(f) (Upcoming FIX API)","mode":"wide","href":"/fix-api/upcoming/security-status"}]},{"group":"Order Management","pages":[{"title":"New Order Single(D) (Upcoming FIX API)","mode":"wide","href":"/fix-api/upcoming/new-order-single"},{"title":"Order Cancel Request(F) (Upcoming FIX API)","mode":"wide","href":"/fix-api/upcoming/order-cancel-request"},{"title":"Order Cancel Reject(9) (Upcoming FIX API)","mode":"wide","href":"/fix-api/upcoming/order-cancel-reject"},{"title":"Order Cancel/Replace Request(G) (Upcoming FIX API)","mode":"wide","href":"/fix-api/upcoming/order-cancel-replace"},{"title":"Order Mass Cancel Request(q) (Upcoming FIX API)","mode":"wide","href":"/fix-api/upcoming/order-mass-cancel-request"},{"title":"Order Mass Cancel Report(r) (Upcoming FIX API)","mode":"wide","href":"/fix-api/upcoming/order-mass-cancel-report"},{"title":"Order Mass Status Request(AF) (Upcoming FIX API)","mode":"wide","href":"/fix-api/upcoming/order-mass-status-request"},{"title":"Execution Reports(8) (Upcoming FIX API)","mode":"wide","href":"/fix-api/upcoming/execution-reports"}]},{"group":"Position Management","pages":[{"title":"Request For Positions(AN) (Upcoming FIX API)","mode":"wide","href":"/fix-api/upcoming/request-for-positions"},{"title":"Position Report(AP) (Upcoming FIX API)","mode":"wide","href":"/fix-api/upcoming/position-report"}]},{"group":"User Management","pages":[{"title":"User Request(BE) (Upcoming FIX API)","mode":"wide","href":"/fix-api/upcoming/user-request"},{"title":"User Response(BF) (Upcoming FIX API)","mode":"wide","href":"/fix-api/upcoming/user-response"}]},{"group":"Market Maker Protection","pages":[{"title":"MMProtection Limits (MM) (Upcoming FIX API)","mode":"wide","href":"/fix-api/upcoming/mmprotection-limits"},{"title":"MMProtection Limits Result/Reject(MR) (Upcoming FIX API)","mode":"wide","href":"/fix-api/upcoming/mmprotection-limits-result"},{"title":"MMProtection Reset(MZ) (Upcoming FIX API)","mode":"wide","href":"/fix-api/upcoming/mmprotection-reset"}]},{"group":"Mass Quoting","pages":[{"title":"Mass Quote(i) (Upcoming FIX API)","mode":"wide","href":"/fix-api/upcoming/mass-quote"},{"title":"Mass Quote Acknowledgement(b) (Upcoming FIX API)","mode":"wide","href":"/fix-api/upcoming/mass-quote-acknowledgement"},{"title":"Quote Cancel(Z) (Upcoming FIX API)","mode":"wide","href":"/fix-api/upcoming/quote-cancel"}]},{"group":"Trade Capture","pages":[{"title":"TradeCaptureReportRequest(AD) (Upcoming FIX API)","mode":"wide","href":"/fix-api/upcoming/trade-capture-report-request"},{"title":"TradeCaptureReportRequestAck(AQ) (Upcoming FIX API)","mode":"wide","href":"/fix-api/upcoming/trade-capture-report-request-ack"},{"title":"TradeCaptureReport(AE) (Upcoming FIX API)","mode":"wide","href":"/fix-api/upcoming/trade-capture-report"}]},{"group":"Security Definition","pages":[{"title":"Security Definition Request(c) (Upcoming FIX API)","mode":"wide","href":"/fix-api/upcoming/security-definition-request"},{"title":"Security Definition(d) (Upcoming FIX API)","mode":"wide","href":"/fix-api/upcoming/security-definition"}]}]},{"dropdown":"Starbase API","icon":"rocket","pages":[{"group":"Introduction","pages":[{"title":"Starbase API Overview","mode":"wide","href":"/starbase/overview"},{"title":"Starbase Connectivity Quickstart","mode":"wide","href":"/starbase/quickstart"},{"title":"Creating and Assigning a Member","mode":"wide","href":"/starbase/creating-member"},{"title":"Creating a Starbase API Key","mode":"wide","href":"/starbase/creating-api-key"},{"title":"Production Readiness Checklist","mode":"wide","href":"/starbase/production-readiness-checklist"},{"title":"Infrastructure, Connectivity \u0026 Best Practices","mode":"wide","href":"/starbase/connectivity-best-practices"}]},{"group":"API Reference","pages":[{"title":"Binary API Reference","mode":"wide","href":"/starbase/upcoming/binary-api-reference"},{"group":"Session Messages","expanded":false,"pages":[{"title":"Starbase Session Messages","mode":"wide","href":"/starbase/session-messages"}]},{"group":"Order Entry Messages","expanded":false,"pages":[{"title":"Placing a New Order","mode":"wide","href":"/starbase/placing-new-order"},{"title":"Amending an Order","mode":"wide","href":"/starbase/upcoming/amending-order"},{"title":"Cancelling an Order","mode":"wide","href":"/starbase/cancelling-order"},{"title":"Mass Quotes","mode":"wide","href":"/starbase/upcoming/mass-quotes"},{"title":"Starbase Mass Cancel Messages","mode":"wide","href":"/starbase/mass-cancel"}]},{"group":"Market Data Messages","expanded":false,"pages":[{"title":"Maintaining the order book","mode":"wide","href":"/starbase/order-book-maintenance"},{"title":"Trades","mode":"wide","href":"/starbase/trades"},{"title":"Starbase Reference Data and Instrument Definitions","mode":"wide","href":"/starbase/reference-data"}]},{"group":"Unsolicited Events","expanded":false,"pages":[{"title":"Starbase Unsolicited Events","mode":"wide","href":"/starbase/unsolicited-events"}]},{"group":"REST API","expanded":true,"pages":[{"title":"REST Order Gateway Authentication","mode":"wide","href":"/starbase/rest-authentication"},{"title":"Get Open Orders","deprecated":null,"version":null,"openapi":"/specifications/starbase_rest_openapi.json get /api/v2/private/get_open_orders","href":"/api-reference/trading/get-open-orders"},{"title":"Get Starbase Risk Limits","deprecated":null,"version":null,"openapi":"/specifications/starbase_rest_openapi.json get /api/v2/private/get_starbase_risk_limits","href":"/api-reference/portfolio-management/get-starbase-risk-limits"},{"title":"Mass Cancel","deprecated":null,"version":null,"openapi":"/specifications/starbase_rest_openapi.json get /api/v2/private/cancel_all","href":"/api-reference/portfolio-management/mass-cancel"},{"title":"Lock Portfolio","deprecated":null,"version":null,"openapi":"/specifications/starbase_rest_openapi.json get /api/v2/private/lock_portfolio","href":"/api-reference/portfolio-management/lock-portfolio"},{"title":"Unlock Portfolio","deprecated":null,"version":null,"openapi":"/specifications/starbase_rest_openapi.json get /api/v2/private/unlock_portfolio","href":"/api-reference/portfolio-management/unlock-portfolio"},{"title":"List Instruments","deprecated":null,"version":null,"openapi":"/specifications/starbase_rest_openapi.json get /api/v2/public/get_instruments","href":"/api-reference/market-data/list-instruments"}]},{"group":"FIX Drop Copy","expanded":false,"pages":[{"title":"Starbase FIX Drop Copy API","mode":"wide","href":"/starbase/fix-drop-copy-api"}]}]},{"group":"Core Concepts","pages":[{"title":"Market Model","mode":"wide","href":"/starbase/market-model"},{"title":"Account Model","mode":"wide","href":"/starbase/account-model"},{"title":"Underlying Tiers","mode":"wide","href":"/starbase/underlying-tiers"},{"title":"Speed Bumps","mode":"wide","href":"/starbase/upcoming/speed-bumps"},{"title":"Starbase Market Maker Protection (MMP)","mode":"wide","href":"/starbase/mmp"},{"title":"Self Match Prevention (SMP)","mode":"wide","href":"/starbase/smp"},{"title":"Portfolio Management","mode":"wide","href":"/starbase/portfolio-management"}]},{"group":"Technical Information","pages":[{"title":"Starbase API Rate Limits","href":"/starbase/api-rate-limits"},{"title":"Risk Bypass","mode":"wide","href":"/starbase/risk-bypass"},{"title":"Cancel on Disconnect","mode":"wide","href":"/starbase/cancel-on-disconnect"},{"title":"Gateway Connectivity","mode":"wide","href":"/starbase/gateway-connectivity"},{"title":"Multicast Channels","mode":"wide","href":"/starbase/multicast-channels"},{"title":"Multicast Subscription Guide","href":"/starbase/multicast-subscription-guide"},{"title":"Multicast Retransmit Gateway","href":"/starbase/retransmit-gateway"}]}]}]},{"tab":"Changelogs","pages":[{"title":"Changelogs","href":"/changelogs/jsonrpc"}]}]}]},"basePath":"","title":"public/auth","deploymentId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","buildId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CiUHMMOm.js","snippetPresets-BgfXU7Bw.js","utils-DWvOwgy_.js","style-to-object-BY3JEAdk.js","utils-BN7RXSMJ.js","v4-DIgz8zy6.js","addUniqueKeysToSchema-CFw8bq89.js","conditional-requirements-CFM0id0Q.js","cloneDeep-CAwdfOU2.js","_Uint8Array-BJr8e-ZL.js","isObject-FP1Yky1u.js","ApiExamples-XX0UgMZK.js","usePlaygroundInputsStore-DXDFSa1V.js","shallow-CdX5aREi.js","isEqual-CoOaxexF.js","CodeSnippets-Cg2wpzWm.js","CodeSnippet-D_HwgQO_.js","getApiPlaygroundDisplay-CmCoerhe.js","Page-CVJ-f_k1.js","DynamicMarkdown-CQM9Bhbv.js","SectionHeading-DpbrP8nQ.js","icon-BPCgijHy.js","MethodPill-GQ8DuY0c.js","getPastedJson-Cb5mT31m.js","Check2Icon-a7bUI6e8.js","axios-CsQoIw0U.js","Markdown-CX2QY19L.js","AssistantPageLink-CY3bFglh.js","dist-Dl6_zDnT.js","lib-DMeTj1gb.js","lib-B8HbPgcC.js","katex-Dbtb6Wk7.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js"]}