Broker Method Returns a list of clients registered under the broker account. Each client record includes:
client_id — a numeric identifier that groups one or more linked users under a single client name. Use this value in other Broker Voice API calls (e.g. private/execute_broker_trade) to identify the client group.
links — an array of individual user connections belonging to that client. Each link contains a client_link_id that uniquely identifies a single user within the client group.
How to obtain client_id and client_link_id
Call this endpoint without parameters to retrieve all clients. Locate the client by name or company, read client_id from the top-level object, and read client_link_id from the relevant entry in the links array. Use these two values together in subsequent Broker Voice API calls to specify which user within a client should be the counterparty.
A link state of connected means the user has accepted the broker invitation and is ready to trade. Links in pending state have not yet been accepted; links in rejected state are inactive.
Optionally filter by a specific client_id to return only that client’s record, or set include_subaccounts to true to include clients managed by broker sub-accounts.
Connection state of the link: connected (user accepted the invitation and is active), pending (invitation sent, not yet accepted), or rejected (link is inactive).
{"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"}},"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":""},"chroma":{"liveDeploymentHistoryId":"6ae375449a91c5dfe406eed2","collectionId":"5fba8da8-f7a2-4da4-be0f-c1c59fec1ad4","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae375449a91c5dfe406eed2"},"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":"6ae375449a91c5dfe406eed2","clientVersion":"0.0.4021","searchFilterCounts":[{"language":"default","tag":"API Reference","count":597},{"language":"default","tag":"JSON-RPC API","count":374},{"language":"default","tag":"Methods","count":371},{"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":48}],"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":"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":"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":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","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":"per-site-search-delta","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":"editor-private-page-search","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":"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":"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":"byok-sep-25","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":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","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":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"public/style.css","content":".api-section-heading-subtitle,.api-section[data-section=body],.method-nav-pill,.method-pill,.tryit-button{display:none!important}li[data-title] button.group>div{font-weight:700!important}body:has(a[aria-current=page][href*=\"/fix-api/\"]) table td:nth-child(1),body:has(a[aria-current=page][href*=\"/fix-api/\"]) table th:nth-child(1){width:6%!important;min-width:50px}body:has(a[aria-current=page][href*=\"/fix-api/\"]) table td:nth-child(2),body:has(a[aria-current=page][href*=\"/fix-api/\"]) table th:nth-child(2){width:12%!important;min-width:90px}body:has(a[aria-current=page][href*=\"/fix-api/\"]) table td:nth-child(3),body:has(a[aria-current=page][href*=\"/fix-api/\"]) table td:nth-child(4),body:has(a[aria-current=page][href*=\"/fix-api/\"]) table th:nth-child(3),body:has(a[aria-current=page][href*=\"/fix-api/\"]) table th:nth-child(4){width:8%!important;min-width:70px}body:has(a[aria-current=page][href*=\"/fix-api/\"]) table td:nth-child(5),body:has(a[aria-current=page][href*=\"/fix-api/\"]) table th:nth-child(5){width:66%!important;min-width:350px}.rate-limit-methods{margin-top:.75rem}.rate-limit-method-labels,.rate-limit-method-values{display:grid;grid-template-columns:minmax(4.5rem,.7fr) minmax(5rem,.9fr) minmax(8rem,1.4fr) minmax(6rem,1fr);column-gap:1rem;align-items:baseline}.rate-limit-method-labels{padding-bottom:.35rem;border-bottom:1px solid color-mix(in srgb,currentColor 16%,transparent);font-size:.8125rem;font-weight:600}.rate-limit-method{padding:.7rem 0;border-bottom:1px solid color-mix(in srgb,currentColor 12%,transparent)}.rate-limit-method:last-child{border-bottom:none;padding-bottom:.15rem}.rate-limit-method-name{margin-bottom:.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 td,.rate-limit-tiers th{min-width:0!important;width:auto!important}.rate-limit-tiers td:nth-child(1),.rate-limit-tiers th:nth-child(1){width:11%!important}.rate-limit-tiers td:nth-child(2),.rate-limit-tiers td:nth-child(3),.rate-limit-tiers th:nth-child(2),.rate-limit-tiers th:nth-child(3){width:18%!important}.rate-limit-tiers td:nth-child(4),.rate-limit-tiers th:nth-child(4){width:16%!important}.rate-limit-tiers td:nth-child(5),.rate-limit-tiers th: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:.45rem}.rate-limit-metric-label{display:block;font-size:.75rem;font-weight:600;opacity:.7}}"}],"page":{"pagePath":"api-reference/block-trade/private-get_broker_clients","slug":"/api-reference/block-trade/private-get_broker_clients","pageMetadata":{"title":"private/get_broker_clients","description":"**Broker Method** Returns a list of clients registered under the broker account. Each client record includes:\n\n- `client_id` — a numeric identifier that groups one or more linked users under a single client name. Use this value in other Broker Voice API calls (e.g. `private/execute_broker_trade`) to identify the client group.\n- `links` — an array of individual user connections belonging to that client. Each link contains a `client_link_id` that uniquely identifies a single user within the client group.\n\n**How to obtain `client_id` and `client_link_id`**\n\nCall this endpoint without parameters to retrieve all clients. Locate the client by name or company, read `client_id` from the top-level object, and read `client_link_id` from the relevant entry in the `links` array. Use these two values together in subsequent Broker Voice API calls to specify which user within a client should be the counterparty.\n\nA link `state` of `connected` means the user has accepted the broker invitation and is ready to trade. Links in `pending` state have not yet been accepted; links in `rejected` state are inactive.\n\nOptionally filter by a specific `client_id` to return only that client's record, or set `include_subaccounts` to `true` to include clients managed by broker sub-accounts.\n\n**Scope:** `block_trade:read`\n\n[Try in API console](https://test.deribit.com/api_console?method=%2Fprivate%2Fget_broker_clients)\n\n","deprecated":null,"version":null,"og:title":"private/get_broker_clients","keywords":["private/get_broker_clients","client_id","include_subaccounts","client_name","company_name","broker_code","main_user_id","broker_sub_user_id","lei","brn","links","client_link_id","user_id","name","note","state","confirmations_required"],"openapi":"/specifications/deribit_openapi.json get /private/get_broker_clients","href":"/api-reference/block-trade/private-get_broker_clients","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: [_jsxs(_components.p, {\n children: [_jsx(_components.strong, {\n children: \"Broker Method\"\n }), \" Returns a list of clients registered under the broker account. Each client record includes:\"]\n }), \"\\n\", _jsxs(_components.ul, {\n children: [\"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.code, {\n children: \"client_id\"\n }), \" — a numeric identifier that groups one or more linked users under a single client name. Use this value in other Broker Voice API calls (e.g. \", _jsx(_components.code, {\n children: \"private/execute_broker_trade\"\n }), \") to identify the client group.\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.code, {\n children: \"links\"\n }), \" — an array of individual user connections belonging to that client. Each link contains a \", _jsx(_components.code, {\n children: \"client_link_id\"\n }), \" that uniquely identifies a single user within the client group.\"]\n }), \"\\n\"]\n }), \"\\n\", _jsx(_components.p, {\n children: _jsxs(_components.strong, {\n children: [\"How to obtain \", _jsx(_components.code, {\n children: \"client_id\"\n }), \" and \", _jsx(_components.code, {\n children: \"client_link_id\"\n })]\n })\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"Call this endpoint without parameters to retrieve all clients. Locate the client by name or company, read \", _jsx(_components.code, {\n children: \"client_id\"\n }), \" from the top-level object, and read \", _jsx(_components.code, {\n children: \"client_link_id\"\n }), \" from the relevant entry in the \", _jsx(_components.code, {\n children: \"links\"\n }), \" array. Use these two values together in subsequent Broker Voice API calls to specify which user within a client should be the counterparty.\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"A link \", _jsx(_components.code, {\n children: \"state\"\n }), \" of \", _jsx(_components.code, {\n children: \"connected\"\n }), \" means the user has accepted the broker invitation and is ready to trade. Links in \", _jsx(_components.code, {\n children: \"pending\"\n }), \" state have not yet been accepted; links in \", _jsx(_components.code, {\n children: \"rejected\"\n }), \" state are inactive.\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"Optionally filter by a specific \", _jsx(_components.code, {\n children: \"client_id\"\n }), \" to return only that client’s record, or set \", _jsx(_components.code, {\n children: \"include_subaccounts\"\n }), \" to \", _jsx(_components.code, {\n children: \"true\"\n }), \" to include clients managed by broker sub-accounts.\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.strong, {\n children: \"Scope:\"\n }), \" \", _jsx(_components.code, {\n children: \"block_trade:read\"\n })]\n }), \"\\n\", _jsx(_components.p, {\n children: _jsx(_components.a, {\n href: \"https://test.deribit.com/api_console?method=%2Fprivate%2Fget_broker_clients\",\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":"private/get_broker_clients","description":"**Broker Method** Returns a list of clients registered under the broker account. Each client record includes:\n\n- `client_id` — a numeric identifier that groups one or more linked users under a single client name. Use this value in other Broker Voice API calls (e.g. `private/execute_broker_trade`) to identify the client group.\n- `links` — an array of individual user connections belonging to that client. Each link contains a `client_link_id` that uniquely identifies a single user within the client group.\n\n**How to obtain `client_id` and `client_link_id`**\n\nCall this endpoint without parameters to retrieve all clients. Locate the client by name or company, read `client_id` from the top-level object, and read `client_link_id` from the relevant entry in the `links` array. Use these two values together in subsequent Broker Voice API calls to specify which user within a client should be the counterparty.\n\nA link `state` of `connected` means the user has accepted the broker invitation and is ready to trade. Links in `pending` state have not yet been accepted; links in `rejected` state are inactive.\n\nOptionally filter by a specific `client_id` to return only that client's record, or set `include_subaccounts` to `true` to include clients managed by broker sub-accounts.\n\n**Scope:** `block_trade:read`\n\n[Try in API console](https://test.deribit.com/api_console?method=%2Fprivate%2Fget_broker_clients)\n\n","deprecated":null,"version":null,"og:title":"private/get_broker_clients","keywords":["private/get_broker_clients","client_id","include_subaccounts","client_name","company_name","broker_code","main_user_id","broker_sub_user_id","lei","brn","links","client_link_id","user_id","name","note","state","confirmations_required"],"openapi":"/specifications/deribit_openapi.json get /private/get_broker_clients","href":"/api-reference/block-trade/private-get_broker_clients","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/deribit/a355478acb7a8697/public/replace-query-params.js"],"openApiReferenceData":{"operation":{"tags":["Block Trade","Private"],"parameters":["6aaa53c5-e9a1-4be9-84e3-c19b59475193","159d65fd-42c5-4cb1-b1e0-384d91ab82fc"],"responses":{"200":"3b26b898-db74-44dc-af44-37c78ae4e4fb"},"requestBody":"d91b6ae1-4b32-4002-aee0-8ddfc147955c","description":"**Broker Method** Returns a list of clients registered under the broker account. Each client record includes:\n\n- `client_id` — a numeric identifier that groups one or more linked users under a single client name. Use this value in other Broker Voice API calls (e.g. `private/execute_broker_trade`) to identify the client group.\n- `links` — an array of individual user connections belonging to that client. Each link contains a `client_link_id` that uniquely identifies a single user within the client group.\n\n**How to obtain `client_id` and `client_link_id`**\n\nCall this endpoint without parameters to retrieve all clients. Locate the client by name or company, read `client_id` from the top-level object, and read `client_link_id` from the relevant entry in the `links` array. Use these two values together in subsequent Broker Voice API calls to specify which user within a client should be the counterparty.\n\nA link `state` of `connected` means the user has accepted the broker invitation and is ready to trade. Links in `pending` state have not yet been accepted; links in `rejected` state are inactive.\n\nOptionally filter by a specific `client_id` to return only that client's record, or set `include_subaccounts` to `true` to include clients managed by broker sub-accounts.\n\n**Scope:** `block_trade:read`\n\n[Try in API console](https://test.deribit.com/api_console?method=%2Fprivate%2Fget_broker_clients)\n\n","x-mint":{"metadata":{"title":"private/get_broker_clients","og:title":"private/get_broker_clients","keywords":["private/get_broker_clients","client_id","include_subaccounts","client_name","company_name","broker_code","main_user_id","broker_sub_user_id","lei","brn","links","client_link_id","user_id","name","note","state","confirmations_required"]},"href":"/api-reference/block-trade/private-get_broker_clients"},"method":"get","type":"path","servers":["4d12e392-437a-4471-a7e4-0ed680539cd6"],"security":[],"path":"/private/get_broker_clients","baseUrlOptions":["https://test.deribit.com/api/v2"],"title":"","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"6aaa53c5-e9a1-4be9-84e3-c19b59475193":{"name":"client_id","in":"query","required":false,"schema":{"type":"integer","isRequired":false,"description":"If provided, returns only the client with this ID. Omit to return all clients.","uniqueKey":"","typeLabel":"integer"},"description":"If provided, returns only the client with this ID. Omit to return all clients."},"159d65fd-42c5-4cb1-b1e0-384d91ab82fc":{"name":"include_subaccounts","in":"query","required":false,"schema":{"type":"boolean","isRequired":false,"description":"If `true`, includes clients managed by broker sub-accounts. Default: `false`.","uniqueKey":"","typeLabel":"boolean"},"description":"If `true`, includes clients managed by broker sub-accounts. Default: `false`."}},"requestBody":{"content":{"application/json":{"examples":{"request":{"title":"request","value":{"jsonrpc":"2.0","id":1,"method":"private/get_broker_clients","params":{}}}},"exampleType":"examples"}},"description":"JSON-RPC request body","exampleType":"examples"},"responses":{"3b26b898-db74-44dc-af44-37c78ae4e4fb":{"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":"array","items":{"type":"object","properties":{"client_id":{"type":"integer","description":"Numeric identifier for the client group. Used in Broker Voice API calls to reference this client.","isRequired":true,"uniqueKey":"result.items.[INDEX].client_id","typeLabel":"integer"},"client_name":{"type":"string","description":"Name of the client.","isRequired":true,"uniqueKey":"result.items.[INDEX].client_name","typeLabel":"string"},"company_name":{"type":"string","description":"Company name of the client.","isRequired":true,"uniqueKey":"result.items.[INDEX].company_name","typeLabel":"string"},"broker_code":{"type":"string","description":"Broker-assigned code used in invitation links for this client.","isRequired":true,"uniqueKey":"result.items.[INDEX].broker_code","typeLabel":"string"},"links":{"type":"array","items":{"type":"object","properties":{"client_link_id":{"type":"integer","description":"Numeric identifier for an individual user within the client group. Used together with `client_id` in Broker Voice API calls.","isRequired":true,"uniqueKey":"result.items.[INDEX].links.items.[INDEX].client_link_id","typeLabel":"integer"},"user_id":{"type":"string","description":"Obscured user ID of the linked user.","isRequired":true,"uniqueKey":"result.items.[INDEX].links.items.[INDEX].user_id","typeLabel":"string"},"name":{"type":"string","description":"Display name for this link.","isRequired":true,"uniqueKey":"result.items.[INDEX].links.items.[INDEX].name","typeLabel":"string"},"state":{"type":"string","enum":["connected","pending","rejected"],"description":"Connection state of the link: `connected` (user accepted the invitation and is active), `pending` (invitation sent, not yet accepted), or `rejected` (link is inactive).","isRequired":true,"uniqueKey":"result.items.[INDEX].links.items.[INDEX].state","typeLabel":"enum\u003cstring>"},"confirmations_required":{"type":"integer","description":"Number of broker confirmations required for block trades involving this link.","isRequired":true,"uniqueKey":"result.items.[INDEX].links.items.[INDEX].confirmations_required","typeLabel":"integer"},"note":{"type":"string","description":"Optional note attached to this link.","uniqueKey":"result.items.[INDEX].links.items.[INDEX].note","typeLabel":"string"},"broker_sub_user_id":{"type":"integer","description":"ID of the broker sub-account managing this link, if applicable.","uniqueKey":"result.items.[INDEX].links.items.[INDEX].broker_sub_user_id","typeLabel":"integer"}},"required":["client_link_id","user_id","name","state","confirmations_required"],"uniqueKey":"result.items.[INDEX].links.items.[INDEX]","typeLabel":"object"},"description":"Array of individual user connections belonging to this client.","isRequired":true,"uniqueKey":"result.items.[INDEX].links","typeLabel":"object[]"},"main_user_id":{"type":"string","description":"Obscured user ID of the main account linked to this client, if any.","uniqueKey":"result.items.[INDEX].main_user_id","typeLabel":"string"},"broker_sub_user_id":{"type":"integer","description":"ID of the broker sub-account that manages this client, if applicable.","uniqueKey":"result.items.[INDEX].broker_sub_user_id","typeLabel":"integer"},"lei":{"type":"string","description":"Legal Entity Identifier (LEI) of the client, if provided.","uniqueKey":"result.items.[INDEX].lei","typeLabel":"string"},"brn":{"type":"string","description":"Business Registration Number (BRN) of the client, if provided.","uniqueKey":"result.items.[INDEX].brn","typeLabel":"string"}},"required":["client_id","client_name","company_name","broker_code","links"],"uniqueKey":"result.items.[INDEX]","typeLabel":"object"},"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","value":{"jsonrpc":"2.0","id":1,"result":[{"client_id":1,"client_name":"Acme Trading Ltd","company_name":"Acme Trading Ltd","broker_code":"ACME01","main_user_id":"***456","links":[{"client_link_id":1,"user_id":"***456","name":"Main Trader","note":"Primary trading account","state":"connected","confirmations_required":1},{"client_link_id":2,"user_id":"***789","name":"Sub Trader","note":"","state":"pending","confirmations_required":1}]},{"client_id":2,"client_name":"Beta Capital","company_name":"Beta Capital GmbH","broker_code":"BETA01","links":[{"client_link_id":3,"user_id":"***012","name":"Portfolio Manager","note":"","state":"connected","confirmations_required":2}]}]}}},"exampleType":"examples"}},"description":"Success response","exampleType":"examples"}},"security":{},"servers":{"4d12e392-437a-4471-a7e4-0ed680539cd6":{"url":"https://test.deribit.com/api/v2"}}},"originalFileLocation":"specifications/deribit_openapi.json"},"subdomain":"deribit","siteName":"Deribit API Documentation","title":"private/get_broker_clients","relatedPagesConfig":{"enabled":true,"limit":5,"mode":"automatic"},"navMaps":{"firstHrefInVersion":{"Production":{"href":"/api-reference/block-trade/private-get_broker_clients","matchLevel":0},"Upcoming":{"href":"/","matchLevel":4}},"firstHrefInLanguage":{}},"lastModified":"2026-10-28T14:37:17.928Z","originalFileLocation":"api-reference/block-trade/private-get_broker_clients.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=\"Broker Method Returns a list of clients registered under the broker account. Each client record includes: - client_id — a numeric identifier that groups one or more linked users under a single client name. Use this value in other Broker Voice API calls (e.g. private/execute_broker_trade) to identify the client group. - links — an array of individual user connections belonging to that client. Each link contains a client_link_id that uniquely identifies a single user within the client group. How to obtain client_id and client_link_id Call this endpoint without parameters to retrieve all clients. Locate the client by name or company, read client_id from the top-level object, and read client_link_id from the relevant entry in the links array. Use these two values together in subsequent Broker Voice API calls to specify which user within a client should be the counterparty. A link state of connected means the user has accepted the broker invitation and is ready to trade. Links in pending state have not yet been accepted; links in rejected state are inactive. Optionally filter by a specific client_id to return only that client\u0026#x27;s record, or set include_subaccounts to true to include clients managed by broker sub-accounts. Scope: block_trade:read 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=\"private/get_broker_clients\">\u003cmeta data-mint-head property=\"og:description\" content=\"Broker Method Returns a list of clients registered under the broker account. Each client record includes: - client_id — a numeric identifier that groups one or more linked users under a single client name. Use this value in other Broker Voice API calls (e.g. private/execute_broker_trade) to identify the client group. - links — an array of individual user connections belonging to that client. Each link contains a client_link_id that uniquely identifies a single user within the client group. How to obtain client_id and client_link_id Call this endpoint without parameters to retrieve all clients. Locate the client by name or company, read client_id from the top-level object, and read client_link_id from the relevant entry in the links array. Use these two values together in subsequent Broker Voice API calls to specify which user within a client should be the counterparty. A link state of connected means the user has accepted the broker invitation and is ready to trade. Links in pending state have not yet been accepted; links in rejected state are inactive. Optionally filter by a specific client_id to return only that client\u0026#x27;s record, or set include_subaccounts to true to include clients managed by broker sub-accounts. Scope: block_trade:read 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/block-trade/private-get_broker_clients\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://deribit.mintlify.app/_mintlify/api/og/v2?division=Block+Trade\u0026amp;title=private%2Fget_broker_clients\u0026amp;description=**Broker+Method**+Returns+a+list+of+clients+registered+under+the+broker+account.+Each+client+record+includes%3A%0A%0A-+%60client_id%60+%E2%80%94+a+numeric+identifier+that+groups+\u0026amp;theme=b3062dd62ef1a013b53d677f\u0026amp;signature=c52ef4999caaea14e221a588f81c496d159e13f753bc5eab944eba9be513dc5d\">\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=\"private/get_broker_clients\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Broker Method Returns a list of clients registered under the broker account. Each client record includes: - client_id — a numeric identifier that groups one or more linked users under a single client name. Use this value in other Broker Voice API calls (e.g. private/execute_broker_trade) to identify the client group. - links — an array of individual user connections belonging to that client. Each link contains a client_link_id that uniquely identifies a single user within the client group. How to obtain client_id and client_link_id Call this endpoint without parameters to retrieve all clients. Locate the client by name or company, read client_id from the top-level object, and read client_link_id from the relevant entry in the links array. Use these two values together in subsequent Broker Voice API calls to specify which user within a client should be the counterparty. A link state of connected means the user has accepted the broker invitation and is ready to trade. Links in pending state have not yet been accepted; links in rejected state are inactive. Optionally filter by a specific client_id to return only that client\u0026#x27;s record, or set include_subaccounts to true to include clients managed by broker sub-accounts. Scope: block_trade:read Try in API console\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://deribit.mintlify.app/_mintlify/api/og/v2?division=Block+Trade\u0026amp;title=private%2Fget_broker_clients\u0026amp;description=**Broker+Method**+Returns+a+list+of+clients+registered+under+the+broker+account.+Each+client+record+includes%3A%0A%0A-+%60client_id%60+%E2%80%94+a+numeric+identifier+that+groups+\u0026amp;theme=b3062dd62ef1a013b53d677f\u0026amp;signature=c52ef4999caaea14e221a588f81c496d159e13f753bc5eab944eba9be513dc5d\">\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/block-trade/private-get_broker_clients\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/block-trade/private-get_broker_clients.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/block-trade/private-get_broker_clients#webpage\",\"url\":\"https://docs.deribit.com//api-reference/block-trade/private-get_broker_clients\",\"name\":\"private/get_broker_clients\",\"description\":\"Broker Method Returns a list of clients registered under the broker account. Each client record includes: - client_id — a numeric identifier that groups one or more linked users under a single client name. Use this value in other Broker Voice API calls (e.g. private/execute_broker_trade) to identify the client group. - links — an array of individual user connections belonging to that client. Each link contains a client_link_id that uniquely identifies a single user within the client group. How to obtain client_id and client_link_id Call this endpoint without parameters to retrieve all clients. Locate the client by name or company, read client_id from the top-level object, and read client_link_id from the relevant entry in the links array. Use these two values together in subsequent Broker Voice API calls to specify which user within a client should be the counterparty. A link state of connected means the user has accepted the broker invitation and is ready to trade. Links in pending state have not yet been accepted; links in rejected state are inactive. Optionally filter by a specific client_id to return only that client's record, or set include_subaccounts to true to include clients managed by broker sub-accounts. Scope: block_trade:read Try in API console\",\"dateModified\":\"2026-10-28T14:37:17.928Z\",\"isPartOf\":{\"@id\":\"https://docs.deribit.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.deribit.com//api-reference/block-trade/private-get_broker_clients#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.deribit.com//api-reference/block-trade/private-get_broker_clients#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Methods\",\"item\":\"https://docs.deribit.com/api-reference/authentication/public-auth\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Block Trade\",\"item\":\"https://docs.deribit.com/api-reference/block-trade/private-approve_block_trade\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"private/get_broker_clients\",\"item\":\"https://docs.deribit.com//api-reference/block-trade/private-get_broker_clients\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.deribit.com//api-reference/block-trade/private-get_broker_clients#apireference\",\"headline\":\"private/get_broker_clients\",\"name\":\"private/get_broker_clients\",\"description\":\"Broker Method Returns a list of clients registered under the broker account. Each client record includes: - client_id — a numeric identifier that groups one or more linked users under a single client name. Use this value in other Broker Voice API calls (e.g. private/execute_broker_trade) to identify the client group. - links — an array of individual user connections belonging to that client. Each link contains a client_link_id that uniquely identifies a single user within the client group. How to obtain client_id and client_link_id Call this endpoint without parameters to retrieve all clients. Locate the client by name or company, read client_id from the top-level object, and read client_link_id from the relevant entry in the links array. Use these two values together in subsequent Broker Voice API calls to specify which user within a client should be the counterparty. A link state of connected means the user has accepted the broker invitation and is ready to trade. Links in pending state have not yet been accepted; links in rejected state are inactive. Optionally filter by a specific client_id to return only that client's record, or set include_subaccounts to true to include clients managed by broker sub-accounts. Scope: block_trade:read Try in API console\",\"url\":\"https://docs.deribit.com//api-reference/block-trade/private-get_broker_clients\",\"mainEntityOfPage\":{\"@id\":\"https://docs.deribit.com//api-reference/block-trade/private-get_broker_clients#webpage\"},\"dateModified\":\"2026-10-28T14:37:17.928Z\",\"keywords\":\"private/get_broker_clients, client_id, include_subaccounts, client_name, company_name, broker_code, main_user_id, broker_sub_user_id, lei, brn, links, client_link_id, user_id, name, note, state, confirmations_required\",\"publisher\":{\"@id\":\"https://docs.deribit.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.deribit.com#website\"}}]}\u003c/script>","siteName":"Deribit API Documentation","nav":{"global":null,"versions":[{"version":"Production","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","href":"/articles/currency-parameter"}]},{"group":"Methods","pages":[{"group":"Authentication","pages":[{"title":"public/auth","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /public/auth","href":"/api-reference/authentication/public-auth"},{"title":"public/exchange_token","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /public/exchange_token","href":"/api-reference/authentication/public-exchange_token"},{"title":"public/fork_token","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /public/fork_token","href":"/api-reference/authentication/public-fork_token"},{"title":"private/logout","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /private/logout","href":"/api-reference/authentication/private-logout"}]},{"group":"Account Management","pages":[{"title":"private/change_api_key_name","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /private/change_api_key_name","href":"/api-reference/account-management/private-change_api_key_name"},{"title":"private/change_margin_model","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /private/change_margin_model","href":"/api-reference/account-management/private-change_margin_model"},{"title":"private/change_scope_in_api_key","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /private/change_scope_in_api_key","href":"/api-reference/account-management/private-change_scope_in_api_key"},{"title":"private/change_subaccount_name","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /private/change_subaccount_name","href":"/api-reference/account-management/private-change_subaccount_name"},{"title":"private/create_api_key","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /private/create_api_key","href":"/api-reference/account-management/private-create_api_key"},{"title":"private/create_subaccount","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /private/create_subaccount","href":"/api-reference/account-management/private-create_subaccount"},{"title":"private/delete_member","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /private/delete_member","href":"/api-reference/account-management/private-delete_member"},{"title":"private/disable_api_key","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /private/disable_api_key","href":"/api-reference/account-management/private-disable_api_key"},{"title":"private/edit_api_key","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /private/edit_api_key","href":"/api-reference/account-management/private-edit_api_key"},{"title":"private/enable_affiliate_program","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /private/enable_affiliate_program","href":"/api-reference/account-management/private-enable_affiliate_program"},{"title":"private/enable_api_key","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /private/enable_api_key","href":"/api-reference/account-management/private-enable_api_key"},{"title":"private/get_access_log","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /private/get_access_log","href":"/api-reference/account-management/private-get_access_log"},{"title":"private/get_account_summaries","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /private/get_account_summaries","href":"/api-reference/account-management/private-get_account_summaries"},{"title":"private/get_account_summary","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /private/get_account_summary","href":"/api-reference/account-management/private-get_account_summary"},{"title":"private/get_affiliate_program_info","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /private/get_affiliate_program_info","href":"/api-reference/account-management/private-get_affiliate_program_info"},{"title":"private/get_currencies","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /private/get_currencies","href":"/api-reference/account-management/private-get_currencies"},{"title":"private/get_email_language","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /private/get_email_language","href":"/api-reference/account-management/private-get_email_language"},{"title":"private/get_members","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /private/get_members","href":"/api-reference/account-management/private-get_members"},{"title":"private/get_new_announcements","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /private/get_new_announcements","href":"/api-reference/account-management/private-get_new_announcements"},{"title":"private/get_position","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /private/get_position","href":"/api-reference/account-management/private-get_position"},{"title":"private/get_positions","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /private/get_positions","href":"/api-reference/account-management/private-get_positions"},{"title":"private/get_subaccounts","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /private/get_subaccounts","href":"/api-reference/account-management/private-get_subaccounts"},{"title":"private/get_subaccounts_details","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /private/get_subaccounts_details","href":"/api-reference/account-management/private-get_subaccounts_details"},{"title":"private/get_transaction_log","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /private/get_transaction_log","href":"/api-reference/account-management/private-get_transaction_log"},{"title":"private/get_user_locks","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /private/get_user_locks","href":"/api-reference/account-management/private-get_user_locks"},{"title":"private/list_api_keys","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /private/list_api_keys","href":"/api-reference/account-management/private-list_api_keys"},{"title":"private/list_custody_accounts","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /private/list_custody_accounts","href":"/api-reference/account-management/private-list_custody_accounts"},{"title":"private/pme/simulate","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /private/pme/simulate","href":"/api-reference/account-management/private-simulate"},{"title":"private/remove_api_key","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /private/remove_api_key","href":"/api-reference/account-management/private-remove_api_key"},{"title":"private/remove_subaccount","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /private/remove_subaccount","href":"/api-reference/account-management/private-remove_subaccount"},{"title":"private/reset_api_key","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /private/reset_api_key","href":"/api-reference/account-management/private-reset_api_key"},{"title":"private/set_announcement_as_read","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /private/set_announcement_as_read","href":"/api-reference/account-management/private-set_announcement_as_read"},{"title":"private/set_disabled_trading_products","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /private/set_disabled_trading_products","href":"/api-reference/account-management/private-set_disabled_trading_products"},{"title":"private/set_email_for_subaccount","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /private/set_email_for_subaccount","href":"/api-reference/account-management/private-set_email_for_subaccount"},{"title":"private/set_email_language","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /private/set_email_language","href":"/api-reference/account-management/private-set_email_language"},{"title":"private/set_member","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /private/set_member","href":"/api-reference/account-management/private-set_member"},{"title":"private/set_self_trading_config","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /private/set_self_trading_config","href":"/api-reference/account-management/private-set_self_trading_config"},{"title":"private/simulate_portfolio","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /private/simulate_portfolio","href":"/api-reference/account-management/private-simulate_portfolio"},{"title":"private/toggle_notifications_from_subaccount","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /private/toggle_notifications_from_subaccount","href":"/api-reference/account-management/private-toggle_notifications_from_subaccount"},{"title":"private/toggle_subaccount_login","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /private/toggle_subaccount_login","href":"/api-reference/account-management/private-toggle_subaccount_login"},{"title":"public/get_announcements","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /public/get_announcements","href":"/api-reference/account-management/public-get_announcements"}]},{"group":"Block RFQ","pages":[{"title":"private/accept_block_rfq","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /private/accept_block_rfq","href":"/api-reference/block-rfq/private-accept_block_rfq"},{"title":"private/add_block_rfq_quote","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /private/add_block_rfq_quote","href":"/api-reference/block-rfq/private-add_block_rfq_quote"},{"title":"private/cancel_all_block_rfq_quotes","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /private/cancel_all_block_rfq_quotes","href":"/api-reference/block-rfq/private-cancel_all_block_rfq_quotes"},{"title":"private/cancel_block_rfq","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /private/cancel_block_rfq","href":"/api-reference/block-rfq/private-cancel_block_rfq"},{"title":"private/cancel_block_rfq_quote","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /private/cancel_block_rfq_quote","href":"/api-reference/block-rfq/private-cancel_block_rfq_quote"},{"title":"private/cancel_block_rfq_trigger","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /private/cancel_block_rfq_trigger","href":"/api-reference/block-rfq/private-cancel_block_rfq_trigger"},{"title":"private/create_block_rfq","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /private/create_block_rfq","href":"/api-reference/block-rfq/private-create_block_rfq"},{"title":"private/edit_block_rfq_quote","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /private/edit_block_rfq_quote","href":"/api-reference/block-rfq/private-edit_block_rfq_quote"},{"title":"private/get_block_rfq_makers","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /private/get_block_rfq_makers","href":"/api-reference/block-rfq/private-get_block_rfq_makers"},{"title":"private/get_block_rfq_quotes","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /private/get_block_rfq_quotes","href":"/api-reference/block-rfq/private-get_block_rfq_quotes"},{"title":"private/get_block_rfq_user_info","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /private/get_block_rfq_user_info","href":"/api-reference/block-rfq/private-get_block_rfq_user_info"},{"title":"private/get_block_rfqs","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /private/get_block_rfqs","href":"/api-reference/block-rfq/private-get_block_rfqs"},{"title":"public/get_block_rfq_trades","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /public/get_block_rfq_trades","href":"/api-reference/block-rfq/public-get_block_rfq_trades"}]},{"group":"Block Trade","pages":[{"title":"private/approve_block_trade","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /private/approve_block_trade","href":"/api-reference/block-trade/private-approve_block_trade"},{"title":"private/execute_block_trade","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /private/execute_block_trade","href":"/api-reference/block-trade/private-execute_block_trade"},{"title":"private/get_block_trade","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /private/get_block_trade","href":"/api-reference/block-trade/private-get_block_trade"},{"title":"private/get_block_trade_requests","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /private/get_block_trade_requests","href":"/api-reference/block-trade/private-get_block_trade_requests"},{"title":"private/get_block_trades","description":"Returns a list of the user's block trades. If currency is not provided, returns block trades for all currencies. `block_rfq_id` can be provided to receive block trades related to that particular Block RFQ.\n\n**📖 Related Article:** [Block Trading](https://docs.deribit.com/articles/block-trading-api)\n\n**Scope:** `block_trade:read`\n\n[Try in API console](https://test.deribit.com/api_console?method=%2Fprivate%2Fget_block_trades)\n\n","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /private/get_block_trades","href":"/api-reference/block-trade/private-get_block_trades"},{"title":"private/get_broker_clients","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /private/get_broker_clients","href":"/api-reference/block-trade/private-get_broker_clients"},{"title":"private/get_broker_trade_requests","description":"**Broker Method** Provides a list of broker block trade requests including pending approvals, declined trades, and expired trades. `timestamp` and `nonce` received in response can be used to approve or reject the pending broker block trade. This method takes no parameters.\n\n**Scope:** `block_trade:read`\n\n[Try in API console](https://test.deribit.com/api_console?method=%2Fprivate%2Fget_broker_trade_requests)\n\n","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /private/get_broker_trade_requests","href":"/api-reference/block-trade/private-get_broker_trade_requests"},{"title":"private/get_broker_trades","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /private/get_broker_trades","href":"/api-reference/block-trade/private-get_broker_trades"},{"title":"private/invalidate_block_trade_signature","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /private/invalidate_block_trade_signature","href":"/api-reference/block-trade/private-invalidate_block_trade_signature"},{"title":"private/reject_block_trade","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /private/reject_block_trade","href":"/api-reference/block-trade/private-reject_block_trade"},{"title":"private/simulate_block_trade","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /private/simulate_block_trade","href":"/api-reference/block-trade/private-simulate_block_trade"},{"title":"private/verify_block_trade","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /private/verify_block_trade","href":"/api-reference/block-trade/private-verify_block_trade"}]},{"group":"Combo Books","pages":[{"title":"private/create_combo","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /private/create_combo","href":"/api-reference/combo-books/private-create_combo"},{"title":"private/get_leg_prices","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /private/get_leg_prices","href":"/api-reference/combo-books/private-get_leg_prices"},{"title":"public/get_combo_details","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /public/get_combo_details","href":"/api-reference/combo-books/public-get_combo_details"},{"title":"public/get_combo_ids","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /public/get_combo_ids","href":"/api-reference/combo-books/public-get_combo_ids"},{"title":"public/get_combos","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /public/get_combos","href":"/api-reference/combo-books/public-get_combos"}]},{"group":"LSP","pages":[{"title":"private/get_lsp_participant_config","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /private/get_lsp_participant_config","href":"/api-reference/lsp/private-get_lsp_participant_config"},{"title":"private/get_lsp_participants","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /private/get_lsp_participants","href":"/api-reference/lsp/private-get_lsp_participants"},{"title":"private/get_lsp_participants_usage","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /private/get_lsp_participants_usage","href":"/api-reference/lsp/private-get_lsp_participants_usage"},{"title":"private/get_lsp_usage","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /private/get_lsp_usage","href":"/api-reference/lsp/private-get_lsp_usage"}]},{"group":"Market Data","pages":[{"title":"public/get_apr_history","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /public/get_apr_history","href":"/api-reference/market-data/public-get_apr_history"},{"title":"public/get_book_summary_by_currency","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /public/get_book_summary_by_currency","href":"/api-reference/market-data/public-get_book_summary_by_currency"},{"title":"public/get_book_summary_by_instrument","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /public/get_book_summary_by_instrument","href":"/api-reference/market-data/public-get_book_summary_by_instrument"},{"title":"public/get_contract_size","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /public/get_contract_size","href":"/api-reference/market-data/public-get_contract_size"},{"title":"public/get_currencies","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /public/get_currencies","href":"/api-reference/market-data/public-get_currencies"},{"title":"public/get_delivery_prices","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /public/get_delivery_prices","href":"/api-reference/market-data/public-get_delivery_prices"},{"title":"public/get_expirations","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /public/get_expirations","href":"/api-reference/market-data/public-get_expirations"},{"title":"public/get_funding_chart_data","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /public/get_funding_chart_data","href":"/api-reference/market-data/public-get_funding_chart_data"},{"title":"public/get_funding_rate_history","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /public/get_funding_rate_history","href":"/api-reference/market-data/public-get_funding_rate_history"},{"title":"public/get_funding_rate_value","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /public/get_funding_rate_value","href":"/api-reference/market-data/public-get_funding_rate_value"},{"title":"public/get_historical_volatility","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /public/get_historical_volatility","href":"/api-reference/market-data/public-get_historical_volatility"},{"title":"public/get_index_price","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /public/get_index_price","href":"/api-reference/market-data/public-get_index_price"},{"title":"public/get_index_price_names","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /public/get_index_price_names","href":"/api-reference/market-data/public-get_index_price_names"},{"title":"public/get_instrument","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /public/get_instrument","href":"/api-reference/market-data/public-get_instrument"},{"title":"public/get_instruments","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /public/get_instruments","href":"/api-reference/market-data/public-get_instruments"},{"title":"public/get_last_settlements_by_currency","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /public/get_last_settlements_by_currency","href":"/api-reference/market-data/public-get_last_settlements_by_currency"},{"title":"public/get_last_settlements_by_instrument","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /public/get_last_settlements_by_instrument","href":"/api-reference/market-data/public-get_last_settlements_by_instrument"},{"title":"public/get_last_trades_by_currency","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /public/get_last_trades_by_currency","href":"/api-reference/market-data/public-get_last_trades_by_currency"},{"title":"public/get_last_trades_by_currency_and_time","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /public/get_last_trades_by_currency_and_time","href":"/api-reference/market-data/public-get_last_trades_by_currency_and_time"},{"title":"public/get_last_trades_by_instrument","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /public/get_last_trades_by_instrument","href":"/api-reference/market-data/public-get_last_trades_by_instrument"},{"title":"public/get_last_trades_by_instrument_and_time","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /public/get_last_trades_by_instrument_and_time","href":"/api-reference/market-data/public-get_last_trades_by_instrument_and_time"},{"title":"public/get_mark_price_history","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /public/get_mark_price_history","href":"/api-reference/market-data/public-get_mark_price_history"},{"title":"public/get_order_book","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /public/get_order_book","href":"/api-reference/market-data/public-get_order_book"},{"title":"public/get_order_book_by_instrument_id","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /public/get_order_book_by_instrument_id","href":"/api-reference/market-data/public-get_order_book_by_instrument_id"},{"title":"public/get_supported_index_names","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /public/get_supported_index_names","href":"/api-reference/market-data/public-get_supported_index_names"},{"title":"public/get_trade_volumes","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /public/get_trade_volumes","href":"/api-reference/market-data/public-get_trade_volumes"},{"title":"public/get_tradingview_chart_data","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /public/get_tradingview_chart_data","href":"/api-reference/market-data/public-get_tradingview_chart_data"},{"title":"public/get_volatility_index_data","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /public/get_volatility_index_data","href":"/api-reference/market-data/public-get_volatility_index_data"},{"title":"public/ticker","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /public/ticker","href":"/api-reference/market-data/public-ticker"},{"title":"public/get_index_chart_data","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /public/get_index_chart_data","href":"/api-reference/market-data/public-get_index_chart_data"}]},{"group":"Session Management","pages":[{"title":"private/disable_cancel_on_disconnect","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /private/disable_cancel_on_disconnect","href":"/api-reference/session-management/private-disable_cancel_on_disconnect"},{"title":"private/enable_cancel_on_disconnect","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /private/enable_cancel_on_disconnect","href":"/api-reference/session-management/private-enable_cancel_on_disconnect"},{"title":"private/get_cancel_on_disconnect","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /private/get_cancel_on_disconnect","href":"/api-reference/session-management/private-get_cancel_on_disconnect"},{"title":"public/disable_heartbeat","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /public/disable_heartbeat","href":"/api-reference/session-management/public-disable_heartbeat"},{"title":"public/set_heartbeat","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /public/set_heartbeat","href":"/api-reference/session-management/public-set_heartbeat"}]},{"group":"Subscription Management","pages":[{"title":"private/subscribe","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /private/subscribe","href":"/api-reference/subscription-management/private-subscribe"},{"title":"private/unsubscribe","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /private/unsubscribe","href":"/api-reference/subscription-management/private-unsubscribe"},{"title":"private/unsubscribe_all","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /private/unsubscribe_all","href":"/api-reference/subscription-management/private-unsubscribe_all"},{"title":"public/subscribe","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /public/subscribe","href":"/api-reference/subscription-management/public-subscribe"},{"title":"public/unsubscribe","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /public/unsubscribe","href":"/api-reference/subscription-management/public-unsubscribe"},{"title":"public/unsubscribe_all","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /public/unsubscribe_all","href":"/api-reference/subscription-management/public-unsubscribe_all"}]},{"group":"Supporting","pages":[{"title":"public/get_time","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /public/get_time","href":"/api-reference/supporting/public-get_time"},{"title":"public/hello","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /public/hello","href":"/api-reference/supporting/public-hello"},{"title":"public/status","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /public/status","href":"/api-reference/supporting/public-status"},{"title":"public/test","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /public/test","href":"/api-reference/supporting/public-test"}]},{"group":"Trading","pages":[{"title":"private/buy","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /private/buy","href":"/api-reference/trading/private-buy"},{"title":"private/cancel","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /private/cancel","href":"/api-reference/trading/private-cancel"},{"title":"private/cancel_all","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /private/cancel_all","href":"/api-reference/trading/private-cancel_all"},{"title":"private/cancel_all_by_currency","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /private/cancel_all_by_currency","href":"/api-reference/trading/private-cancel_all_by_currency"},{"title":"private/cancel_all_by_currency_pair","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /private/cancel_all_by_currency_pair","href":"/api-reference/trading/private-cancel_all_by_currency_pair"},{"title":"private/cancel_all_by_instrument","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /private/cancel_all_by_instrument","href":"/api-reference/trading/private-cancel_all_by_instrument"},{"title":"private/cancel_all_by_kind_or_type","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /private/cancel_all_by_kind_or_type","href":"/api-reference/trading/private-cancel_all_by_kind_or_type"},{"title":"private/cancel_by_label","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /private/cancel_by_label","href":"/api-reference/trading/private-cancel_by_label"},{"title":"private/cancel_quotes","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /private/cancel_quotes","href":"/api-reference/trading/private-cancel_quotes"},{"title":"private/close_position","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /private/close_position","href":"/api-reference/trading/private-close_position"},{"title":"private/edit","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /private/edit","href":"/api-reference/trading/private-edit"},{"title":"private/edit_by_label","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /private/edit_by_label","href":"/api-reference/trading/private-edit_by_label"},{"title":"private/get_margins","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /private/get_margins","href":"/api-reference/trading/private-get_margins"},{"title":"private/get_mmp_config","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /private/get_mmp_config","href":"/api-reference/trading/private-get_mmp_config"},{"title":"private/get_mmp_status","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /private/get_mmp_status","href":"/api-reference/trading/private-get_mmp_status"},{"title":"private/get_open_orders","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /private/get_open_orders","href":"/api-reference/trading/private-get_open_orders"},{"title":"private/get_open_orders_by_currency","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /private/get_open_orders_by_currency","href":"/api-reference/trading/private-get_open_orders_by_currency"},{"title":"private/get_open_orders_by_instrument","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /private/get_open_orders_by_instrument","href":"/api-reference/trading/private-get_open_orders_by_instrument"},{"title":"private/get_open_orders_by_label","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /private/get_open_orders_by_label","href":"/api-reference/trading/private-get_open_orders_by_label"},{"title":"private/get_order_history_by_currency","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /private/get_order_history_by_currency","href":"/api-reference/trading/private-get_order_history_by_currency"},{"title":"private/get_order_history_by_instrument","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /private/get_order_history_by_instrument","href":"/api-reference/trading/private-get_order_history_by_instrument"},{"title":"private/get_order_margin_by_ids","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /private/get_order_margin_by_ids","href":"/api-reference/trading/private-get_order_margin_by_ids"},{"title":"private/get_order_state","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /private/get_order_state","href":"/api-reference/trading/private-get_order_state"},{"title":"private/get_order_state_by_label","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /private/get_order_state_by_label","href":"/api-reference/trading/private-get_order_state_by_label"},{"title":"private/get_settlement_history_by_currency","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /private/get_settlement_history_by_currency","href":"/api-reference/trading/private-get_settlement_history_by_currency"},{"title":"private/get_settlement_history_by_instrument","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /private/get_settlement_history_by_instrument","href":"/api-reference/trading/private-get_settlement_history_by_instrument"},{"title":"private/get_trigger_order_history","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /private/get_trigger_order_history","href":"/api-reference/trading/private-get_trigger_order_history"},{"title":"private/get_user_trades_by_currency","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /private/get_user_trades_by_currency","href":"/api-reference/trading/private-get_user_trades_by_currency"},{"title":"private/get_user_trades_by_currency_and_time","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /private/get_user_trades_by_currency_and_time","href":"/api-reference/trading/private-get_user_trades_by_currency_and_time"},{"title":"private/get_user_trades_by_instrument","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /private/get_user_trades_by_instrument","href":"/api-reference/trading/private-get_user_trades_by_instrument"},{"title":"private/get_user_trades_by_instrument_and_time","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /private/get_user_trades_by_instrument_and_time","href":"/api-reference/trading/private-get_user_trades_by_instrument_and_time"},{"title":"private/get_user_trades_by_order","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /private/get_user_trades_by_order","href":"/api-reference/trading/private-get_user_trades_by_order"},{"title":"private/mass_quote","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /private/mass_quote","href":"/api-reference/trading/private-mass_quote"},{"title":"private/move_positions","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /private/move_positions","href":"/api-reference/trading/private-move_positions"},{"title":"private/reset_mmp","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /private/reset_mmp","href":"/api-reference/trading/private-reset_mmp"},{"title":"private/sell","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /private/sell","href":"/api-reference/trading/private-sell"},{"title":"private/set_mmp_config","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /private/set_mmp_config","href":"/api-reference/trading/private-set_mmp_config"}]},{"group":"Wallet","pages":[{"title":"private/add_to_address_book","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /private/add_to_address_book","href":"/api-reference/wallet/private-add_to_address_book"},{"title":"private/cancel_transfer_by_id","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /private/cancel_transfer_by_id","href":"/api-reference/wallet/private-cancel_transfer_by_id"},{"title":"private/cancel_withdrawal","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /private/cancel_withdrawal","href":"/api-reference/wallet/private-cancel_withdrawal"},{"title":"private/coinbase/estimate_withdrawal_fee","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /private/coinbase/estimate_withdrawal_fee","href":"/api-reference/wallet/private-estimate_withdrawal_fee"},{"title":"private/create_deposit_address","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /private/create_deposit_address","href":"/api-reference/wallet/private-create_deposit_address"},{"title":"private/delete_address_beneficiary","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /private/delete_address_beneficiary","href":"/api-reference/wallet/private-delete_address_beneficiary"},{"title":"private/get_address_beneficiary","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /private/get_address_beneficiary","href":"/api-reference/wallet/private-get_address_beneficiary"},{"title":"private/get_address_book","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /private/get_address_book","href":"/api-reference/wallet/private-get_address_book"},{"title":"private/get_current_deposit_address","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /private/get_current_deposit_address","href":"/api-reference/wallet/private-get_current_deposit_address"},{"title":"private/get_deposits","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /private/get_deposits","href":"/api-reference/wallet/private-get_deposits"},{"title":"private/get_reward_eligibility","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /private/get_reward_eligibility","href":"/api-reference/wallet/private-get_reward_eligibility"},{"title":"private/get_transfers","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /private/get_transfers","href":"/api-reference/wallet/private-get_transfers"},{"title":"private/get_withdrawals","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /private/get_withdrawals","href":"/api-reference/wallet/private-get_withdrawals"},{"title":"private/list_address_beneficiaries","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /private/list_address_beneficiaries","href":"/api-reference/wallet/private-list_address_beneficiaries"},{"title":"private/remove_from_address_book","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /private/remove_from_address_book","href":"/api-reference/wallet/private-remove_from_address_book"},{"title":"private/save_address_beneficiary","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /private/save_address_beneficiary","href":"/api-reference/wallet/private-save_address_beneficiary"},{"title":"private/set_address_requires_security_key","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /private/set_address_requires_security_key","href":"/api-reference/wallet/private-set_address_requires_security_key"},{"title":"private/set_clearance_originator","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /private/set_clearance_originator","href":"/api-reference/wallet/private-set_clearance_originator"},{"title":"private/set_coinbase_subaccount_withdrawals_allowed","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /private/set_coinbase_subaccount_withdrawals_allowed","href":"/api-reference/wallet/private-set_coinbase_subaccount_withdrawals_allowed"},{"title":"private/submit_transfer_between_subaccounts","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /private/submit_transfer_between_subaccounts","href":"/api-reference/wallet/private-submit_transfer_between_subaccounts"},{"title":"private/submit_transfer_to_subaccount","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /private/submit_transfer_to_subaccount","href":"/api-reference/wallet/private-submit_transfer_to_subaccount"},{"title":"private/submit_transfer_to_user","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /private/submit_transfer_to_user","href":"/api-reference/wallet/private-submit_transfer_to_user"},{"title":"private/update_in_address_book","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /private/update_in_address_book","href":"/api-reference/wallet/private-update_in_address_book"},{"title":"private/withdraw","deprecated":null,"version":null,"openapi":"/specifications/deribit_openapi.json get /private/withdraw","href":"/api-reference/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_asyncapi.json platform_state","href":"/subscriptions/platform/platform_state","title":"platform_state ","version":null},{"asyncapi":"specifications/deribit_asyncapi.json platform_state.public_methods_state","href":"/subscriptions/platform/platform_statepublic_methods_state","title":"platform_state.public_methods_state ","version":null}]},{"group":"Announcements","pages":[{"asyncapi":"specifications/deribit_asyncapi.json announcements","href":"/subscriptions/announcements/announcements","title":"announcements ","version":null}]},{"group":"Orderbook","pages":[{"asyncapi":"specifications/deribit_asyncapi.json book.(instrument_name).(interval)","href":"/subscriptions/orderbook/bookinstrument_nameinterval","title":"book.(instrument_name).(interval) ","version":null},{"asyncapi":"specifications/deribit_asyncapi.json book.(instrument_name).(group).(depth).(interval)","href":"/subscriptions/orderbook/bookinstrument_namegroupdepthinterval","title":"book.(instrument_name).(group).(depth).(interval) ","version":null}]},{"group":"Market Data","pages":[{"asyncapi":"specifications/deribit_asyncapi.json ticker.(instrument_name).(interval)","href":"/subscriptions/market-data/tickerinstrument_nameinterval","title":"ticker.(instrument_name).(interval) ","version":null},{"asyncapi":"specifications/deribit_asyncapi.json incremental_ticker.(instrument_name)","href":"/subscriptions/market-data/incremental_tickerinstrument_name","title":"incremental_ticker.(instrument_name) ","version":null},{"asyncapi":"specifications/deribit_asyncapi.json perpetual.(instrument_name).(interval)","href":"/subscriptions/market-data/perpetualinstrument_nameinterval","title":"perpetual.(instrument_name).(interval) ","version":null},{"asyncapi":"specifications/deribit_asyncapi.json quote.(instrument_name)","href":"/subscriptions/market-data/quoteinstrument_name","title":"quote.(instrument_name) ","version":null},{"asyncapi":"specifications/deribit_asyncapi.json deribit_price_index.(index_name)","href":"/subscriptions/market-data/deribit_price_indexindex_name","title":"deribit_price_index.(index_name) ","version":null},{"asyncapi":"specifications/deribit_asyncapi.json deribit_price_ranking.(index_name)","href":"/subscriptions/market-data/deribit_price_rankingindex_name","title":"deribit_price_ranking.(index_name) ","version":null},{"asyncapi":"specifications/deribit_asyncapi.json deribit_price_statistics.(index_name)","href":"/subscriptions/market-data/deribit_price_statisticsindex_name","title":"deribit_price_statistics.(index_name) ","version":null},{"asyncapi":"specifications/deribit_asyncapi.json deribit_volatility_index.(index_name)","href":"/subscriptions/market-data/deribit_volatility_indexindex_name","title":"deribit_volatility_index.(index_name) ","version":null},{"asyncapi":"specifications/deribit_asyncapi.json markprice.options.(index_name)","href":"/subscriptions/market-data/markpriceoptionsindex_name","title":"markprice.options.(index_name) ","version":null},{"asyncapi":"specifications/deribit_asyncapi.json estimated_expiration_price.(index_name)","href":"/subscriptions/market-data/estimated_expiration_priceindex_name","title":"estimated_expiration_price.(index_name) ","version":null},{"asyncapi":"specifications/deribit_asyncapi.json chart.trades.(instrument_name).(resolution)","href":"/subscriptions/market-data/charttradesinstrument_nameresolution","title":"chart.trades.(instrument_name).(resolution) ","version":null},{"asyncapi":"specifications/deribit_asyncapi.json instrument.creation.(kind).(currency)","href":"/subscriptions/market-data/instrumentcreationkindcurrency","title":"instrument.creation.(kind).(currency) ","version":null},{"asyncapi":"specifications/deribit_asyncapi.json instrument.state.(kind).(currency)","href":"/subscriptions/market-data/instrumentstatekindcurrency","title":"instrument.state.(kind).(currency) ","version":null}]},{"group":"Trades","pages":[{"asyncapi":"specifications/deribit_asyncapi.json trades.(instrument_name).(interval)","href":"/subscriptions/trades/tradesinstrument_nameinterval","title":"trades.(instrument_name).(interval) ","version":null},{"asyncapi":"specifications/deribit_asyncapi.json trades.(kind).(currency).(interval)","href":"/subscriptions/trades/tradeskindcurrencyinterval","title":"trades.(kind).(currency).(interval) ","version":null}]},{"group":"Block Trade","pages":[{"asyncapi":"specifications/deribit_asyncapi.json block_trade_confirmations","href":"/subscriptions/block-trade/block_trade_confirmations","title":"block_trade_confirmations ","version":null},{"asyncapi":"specifications/deribit_asyncapi.json block_trade_confirmations.(currency)","href":"/subscriptions/block-trade/block_trade_confirmationscurrency","title":"block_trade_confirmations.(currency) ","version":null}]},{"group":"User","pages":[{"asyncapi":"specifications/deribit_asyncapi.json user.mmp_trigger.(index_name)","href":"/subscriptions/user/usermmp_triggerindex_name","title":"user.mmp_trigger.(index_name) ","version":null},{"asyncapi":"specifications/deribit_asyncapi.json user.portfolio.(currency)","href":"/subscriptions/user/userportfoliocurrency","title":"user.portfolio.(currency) ","version":null},{"asyncapi":"specifications/deribit_asyncapi.json user.trades.(instrument_name).(interval)","href":"/subscriptions/user/usertradesinstrument_nameinterval","title":"user.trades.(instrument_name).(interval) ","version":null},{"asyncapi":"specifications/deribit_asyncapi.json user.trades.(kind).(currency).(interval)","href":"/subscriptions/user/usertradeskindcurrencyinterval","title":"user.trades.(kind).(currency).(interval) ","version":null},{"asyncapi":"specifications/deribit_asyncapi.json user.combo_trades.(instrument_name).(interval)","href":"/subscriptions/user/usercombo_tradesinstrument_nameinterval","title":"user.combo_trades.(instrument_name).(interval) ","version":null},{"asyncapi":"specifications/deribit_asyncapi.json user.combo_trades.(kind).(currency).(interval)","href":"/subscriptions/user/usercombo_tradeskindcurrencyinterval","title":"user.combo_trades.(kind).(currency).(interval) ","version":null},{"asyncapi":"specifications/deribit_asyncapi.json user.orders.(instrument_name).raw","href":"/subscriptions/user/userordersinstrument_nameraw","title":"user.orders.(instrument_name).raw ","version":null},{"asyncapi":"specifications/deribit_asyncapi.json user.orders.(instrument_name).(interval)","href":"/subscriptions/user/userordersinstrument_nameinterval","title":"user.orders.(instrument_name).(interval) ","version":null},{"asyncapi":"specifications/deribit_asyncapi.json user.orders.(kind).(currency).raw","href":"/subscriptions/user/userorderskindcurrencyraw","title":"user.orders.(kind).(currency).raw ","version":null},{"asyncapi":"specifications/deribit_asyncapi.json user.orders.(kind).(currency).(interval)","href":"/subscriptions/user/userorderskindcurrencyinterval","title":"user.orders.(kind).(currency).(interval) ","version":null},{"asyncapi":"specifications/deribit_asyncapi.json user.changes.(instrument_name).(interval)","href":"/subscriptions/user/userchangesinstrument_nameinterval","title":"user.changes.(instrument_name).(interval) ","version":null},{"asyncapi":"specifications/deribit_asyncapi.json user.changes.(kind).(currency).(interval)","href":"/subscriptions/user/userchangeskindcurrencyinterval","title":"user.changes.(kind).(currency).(interval) ","version":null},{"asyncapi":"specifications/deribit_asyncapi.json user.access_log","href":"/subscriptions/user/useraccess_log","title":"user.access_log ","version":null},{"asyncapi":"specifications/deribit_asyncapi.json user.lock","href":"/subscriptions/user/userlock","title":"user.lock ","version":null},{"asyncapi":"specifications/deribit_asyncapi.json user.liquidation","href":"/subscriptions/user/userliquidation","title":"user.liquidation ","version":null},{"asyncapi":"specifications/deribit_asyncapi.json user.isolated.liquidation","href":"/subscriptions/user/userisolatedliquidation","title":"user.isolated.liquidation ","version":null},{"asyncapi":"specifications/deribit_asyncapi.json user.lsp","href":"/subscriptions/user/userlsp","title":"user.lsp ","version":null}]},{"group":"Block Rfq","pages":[{"asyncapi":"specifications/deribit_asyncapi.json block_rfq.maker.(currency)","href":"/subscriptions/block-rfq/block_rfqmakercurrency","title":"block_rfq.maker.(currency) ","version":null},{"asyncapi":"specifications/deribit_asyncapi.json block_rfq.taker.(currency)","href":"/subscriptions/block-rfq/block_rfqtakercurrency","title":"block_rfq.taker.(currency) ","version":null},{"asyncapi":"specifications/deribit_asyncapi.json block_rfq.maker.quotes.(currency)","href":"/subscriptions/block-rfq/block_rfqmakerquotescurrency","title":"block_rfq.maker.quotes.(currency) ","version":null},{"asyncapi":"specifications/deribit_asyncapi.json block_rfq.trades.(currency)","href":"/subscriptions/block-rfq/block_rfqtradescurrency","title":"block_rfq.trades.(currency) ","version":null}]}]}]},{"dropdown":"FIX API","icon":"bolt","pages":[{"group":"Overview","pages":[{"title":"Deribit Production FIX API Overview","mode":"wide","href":"/fix-api/production/overview"}]},{"group":"Session Management","pages":[{"title":"Logon(A) (Production FIX API)","mode":"wide","href":"/fix-api/production/logon"},{"title":"Logout(5) (Production FIX API)","mode":"wide","href":"/fix-api/production/logout"},{"title":"Heartbeat(0) (Production FIX API)","mode":"wide","href":"/fix-api/production/heartbeat"},{"title":"Test Request(1) (Production FIX API)","mode":"wide","href":"/fix-api/production/test-request"},{"title":"Resend Request(2) (Production FIX API)","mode":"wide","href":"/fix-api/production/resend-request"},{"title":"Reject(3) (Production FIX API)","mode":"wide","href":"/fix-api/production/reject"},{"title":"Sequence Reset(4) (Production FIX API)","mode":"wide","href":"/fix-api/production/sequence-reset"}]},{"group":"Market Data","pages":[{"title":"Security List Request(x) (Production FIX API)","mode":"wide","href":"/fix-api/production/security-list-request"},{"title":"Security List(y) (Production FIX API)","mode":"wide","href":"/fix-api/production/security-list"},{"title":"Market Data Request(V) (Production FIX API)","mode":"wide","href":"/fix-api/production/market-data-request"},{"title":"Market Data Request Reject(Y) (Production FIX API)","mode":"wide","href":"/fix-api/production/market-data-request-reject"},{"title":"Market Data Snapshot (W) (Production FIX API)","mode":"wide","href":"/fix-api/production/market-data-snapshot"},{"title":"Market Data Incremental Refresh(X) (Production FIX API)","mode":"wide","href":"/fix-api/production/market-data-incremental"},{"title":"Security Status Request(e) (Production FIX API)","mode":"wide","href":"/fix-api/production/security-status-request"},{"title":"Security Status(f) (Production FIX API)","mode":"wide","href":"/fix-api/production/security-status"}]},{"group":"Order Management","pages":[{"title":"New Order Single(D) (Production FIX API)","mode":"wide","href":"/fix-api/production/new-order-single"},{"title":"Order Cancel Request(F) (Production FIX API)","mode":"wide","href":"/fix-api/production/order-cancel-request"},{"title":"Order Cancel Reject(9) (Production FIX API)","mode":"wide","href":"/fix-api/production/order-cancel-reject"},{"title":"Order Cancel/Replace Request(G) (Production FIX API)","mode":"wide","href":"/fix-api/production/order-cancel-replace"},{"title":"Order Mass Cancel Request(q) (Production FIX API)","mode":"wide","href":"/fix-api/production/order-mass-cancel-request"},{"title":"Order Mass Cancel Report(r) (Production FIX API)","mode":"wide","href":"/fix-api/production/order-mass-cancel-report"},{"title":"Order Mass Status Request(AF) (Production FIX API)","mode":"wide","href":"/fix-api/production/order-mass-status-request"},{"title":"Execution Reports(8) (Production FIX API)","mode":"wide","href":"/fix-api/production/execution-reports"}]},{"group":"Position Management","pages":[{"title":"Request For Positions(AN) (Production FIX API)","mode":"wide","href":"/fix-api/production/request-for-positions"},{"title":"Position Report(AP) (Production FIX API)","mode":"wide","href":"/fix-api/production/position-report"}]},{"group":"User Management","pages":[{"title":"User Request(BE) (Production FIX API)","mode":"wide","href":"/fix-api/production/user-request"},{"title":"User Response(BF) (Production FIX API)","mode":"wide","href":"/fix-api/production/user-response"}]},{"group":"Market Maker Protection","pages":[{"title":"MMProtection Limits (MM) (Production FIX API)","mode":"wide","href":"/fix-api/production/mmprotection-limits"},{"title":"MMProtection Limits Result (MR) (Production FIX API)","mode":"wide","href":"/fix-api/production/mmprotection-limits-result"},{"title":"MMProtection Reset(MZ) (Production FIX API)","mode":"wide","href":"/fix-api/production/mmprotection-reset"}]},{"group":"Mass Quoting","pages":[{"title":"Mass Quote(i) (Production FIX API)","mode":"wide","href":"/fix-api/production/mass-quote"},{"title":"Mass Quote Acknowledgement(b) (Production FIX API)","mode":"wide","href":"/fix-api/production/mass-quote-acknowledgement"},{"title":"Quote Cancel(Z) (Production FIX API)","mode":"wide","href":"/fix-api/production/quote-cancel"}]},{"group":"Trade Capture","pages":[{"title":"TradeCaptureReportRequest(AD) (Production FIX API)","mode":"wide","href":"/fix-api/production/trade-capture-report-request"},{"title":"TradeCaptureReportRequestAck(AQ) (Production FIX API)","mode":"wide","href":"/fix-api/production/trade-capture-report-request-ack"},{"title":"TradeCaptureReport(AE) (Production FIX API)","mode":"wide","href":"/fix-api/production/trade-capture-report"}]},{"group":"Security Definition","pages":[{"title":"Security Definition Request(c) (Production FIX API)","mode":"wide","href":"/fix-api/production/security-definition-request"},{"title":"Security Definition(d) (Production FIX API)","mode":"wide","href":"/fix-api/production/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/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/amending-order"},{"title":"Cancelling an Order","mode":"wide","href":"/starbase/cancelling-order"},{"title":"Mass Quotes","mode":"wide","href":"/starbase/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/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"}]}]},{"version":"Upcoming","pages":[{"title":"Upcoming","href":"/"}]}]},"title":"private/get_broker_clients","buildId":"dpl_EnxDqhjaNc9a8MVa833TGULPd9uJ","deploymentId":"dpl_EnxDqhjaNc9a8MVa833TGULPd9uJ","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-26-lDe7V.js","utils-CWQmgYtH.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-4-Aw3rSD.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-C2zjXYA5.js","snippetPresets-DFmpFA7C.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-FJpQavWq.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-D_GvPF7k.js","shallow-Bs2ZB0NO.js","getApiPlaygroundDisplay-DCcqJJk-.js","CodeSnippet-DzDxawVe.js","CodeSnippets-aUr7fU-7.js","Page-CT9uE8Ip.js","getPastedJson-Y1fKsj_I.js","icon-DI4zTsDr.js","MethodPill-C0nDlmSQ.js","DuplicateIcon-NUXbx2nQ.js","createIcon-BdTHrPAi.js","DynamicMarkdown-CtpgKJwj.js","SectionHeading-B3x35tOt.js","axios-vUo_bRtp.js","Markdown-3OmurJMP.js","clsx-DMKzROTp.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-1ms6tsT-.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-Ke9xIMFx.js"]}