Adds a new address to the address book. The address book allows you to store addresses for withdrawals, along with beneficiary information for compliance purposes.
Coinbase wallet type
For Coinbase wallet type accounts the method supports network selection and CTN (Coinbase Transfer Network) counterparties, and behaves differently:
Required parameters are type and label, plus one of:
address together with currency and network (optional tag) — an on-chain address on the selected network, or
counterparty_id — a CTN counterparty; currency is then omitted and the entry applies to all currencies.
type accepts only withdrawal and transfer.
Travel rule data is provided with the fields name, country, address, financial_institution, account, account_location, entity_type (organization or individual), wallet_type (exchange or self_hosted) and is_self instead of the legacy beneficiary_*, agreed and personal fields.
extra_currencies is not supported.
The response contains a Coinbase address book entry object, including the entry id which can be used instead of address in the other address book methods.
The currency symbol. Required for legacy wallet type (wallet currencies only). Coinbase wallet type: required when address is used (any portfolio currency); omitted when adding a CTN counterparty via counterparty_id — such entries apply to all currencies ("all").
Currency, i.e "BTC", "ETH", "USDC"
Available options:
BTC,
ETH,
USDC,
USDT,
EURR
Example:
"BTC"
type
enum<string>
required
Address book type
Available options:
transfer,
withdrawal,
deposit_source
Example:
"withdrawal"
address
string
Address in currency format. Required for legacy wallet type.Coinbase wallet type: required when counterparty_id is not provided, and must then be used together with currency and network (and tag for networks that require one). For Coinbase wallet type the same value is also stored as the beneficiary address travel rule field.
Address in proper format for currency
Example:
"bc1qar0srrr7xfkvy5l643lydnw9re59gtzzwf0uyj"
network
string
Blockchain network resource name (e.g. networks/ethereum-mainnet), for Coinbase wallet types. Available networks are returned by public/get_currencies in coinbase_networks. Requiredness depends on the operation. When resolving an existing address-book entry, it is optional if the entry resolves uniquely; it disambiguates an address present on multiple networks.
Example:
"networks/ethereum-mainnet"
tag
string
Destination tag / memo for networks that support one. Coinbase wallet type only. Used together with address and network; also serves to disambiguate address book entries that share the same address.
counterparty_id
string
Identifier of a Coinbase Transfer Network (CTN) counterparty. Coinbase wallet type only. Used instead of address and network; entries created with counterparty_id apply to all currencies, so currency is omitted.
Example:
"cp-8f3e2a1b9c4d"
label
string
required
Label of the address book entry
Example:
"Main address"
beneficiary_vasp_name
string
Name of beneficiary VASP
Example:
"Moneys Gone"`
beneficiary_vasp_did
string
DID of beneficiary VASP
Example:
"did:example:123456789abcdefghi"
beneficiary_vasp_website
string
Website of the beneficiary VASP
beneficiary_first_name
string
First name of beneficiary (if beneficiary is a person)
First name of the beneficiary (if beneficiary is a person)
Example:
"John"
beneficiary_last_name
string
First name of beneficiary (if beneficiary is a person)
Last name of the beneficiary (if beneficiary is a person)
Example:
"Doe"
beneficiary_company_name
string
Beneficiary company name (if beneficiary is a company)
Company name of the beneficiary (if beneficiary is a company)
Example:
"Company Name"
beneficiary_address
string
Geographical address of the beneficiary
Example:
"NL, Amsterdam, Street, 1"
agreed
boolean
Indicates that the user agreed to shared provided information with 3rd parties
Example:
true
personal
boolean
The user confirms that he provided address belongs to him and he has access to it via an un-hosted wallet software
Example:
false
extra_currencies
string[]
The user can pass a list of currencies to add the address for. It is currently available ONLY for ERC20 currencies. Without passing this paramater for an ERC20 currency, the address will be added to ALL of the ERC20 currencies.
Name of the currency
Example:
["USDC"]
name
string
Full name of the beneficiary (person or organization). Coinbase wallet type only — travel rule data.
Example:
"Alice Smith"
country
string
Country code of the beneficiary (ISO 3166-1 alpha-2). Coinbase wallet type only — travel rule data.
Example:
"NL"
financial_institution
string
Name of the financial institution holding the beneficiary account. Coinbase wallet type only — travel rule data.
account
string
Account identifier of the beneficiary at the financial institution. Coinbase wallet type only — travel rule data.
account_location
string
Location of the beneficiary account. Coinbase wallet type only — travel rule data.
entity_type
enum<string>
Type of the beneficiary entity. Coinbase wallet type only — travel rule data.
Available options:
organization,
individual
wallet_type
enum<string>
Type of the beneficiary wallet. Coinbase wallet type only — travel rule data.
Available options:
exchange,
self_hosted
is_self
boolean
Indicates that the beneficiary is the account owner. Coinbase wallet type only — travel rule data.
Response
200 - application/json
Success response
jsonrpc
enum<string>
required
The JSON-RPC version (2.0)
Available options:
2.0
result
object
required
Option 1
Option 2
Hide child attributes
result.currency
enum<string>
required
Currency, i.e "BTC", "ETH", "USDC"
Available options:
BTC,
ETH,
STETH,
ETHW,
USDC,
USDT,
EURR,
SOL,
XRP,
USYC,
PAXG,
BNB,
USDE
result.address
string
required
Address in proper format for currency
Example:
"1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa"
result.creation_timestamp
integer
required
The timestamp (milliseconds since the Unix epoch)
Example:
1536569522277
result.type
enum<string>
Address book type
Available options:
transfer,
withdrawal,
deposit_source
result.label
string
Label of the address book entry
Example:
"Main address"
result.beneficiary_vasp_name
string
Name of beneficiary VASP
Example:
"Money's Gone"
result.beneficiary_vasp_did
string
DID of beneficiary VASP
Example:
"did:example:123456789abcdefghi"
result.beneficiary_vasp_website
string
Website of the beneficiary VASP
result.beneficiary_first_name
string
First name of the beneficiary (if beneficiary is a person)
Example:
"John"
result.beneficiary_last_name
string
Last name of the beneficiary (if beneficiary is a person)
Example:
"Doe"
result.beneficiary_company_name
string
Company name of the beneficiary (if beneficiary is a company)
Example:
"Company Name"
result.beneficiary_address
string
Geographical address of the beneficiary
Example:
"NL, Amsterdam, Street, 1"
result.agreed
boolean
Indicates that the user agreed to shared provided information with 3rd parties
Example:
true
result.personal
boolean
The user confirms that he provided address belongs to him and he has access to it via an un-hosted wallet software
Example:
true
result.info_required
boolean
Signalises that addition information regarding the beneficiary of the address is required
Timestamp (milliseconds since the Unix epoch) at which the address becomes usable; present while status is waiting; null for Coinbase deposit addresses.
Example:
1720252232860
result.requires_confirmation
boolean
If address requires email confirmation for withdrawals
Example:
true
result.requires_confirmation_change
boolean
If email confirmation change is in progress
Example:
true
result.requires_security_key
boolean
If withdrawals to this address require a security key
Example:
false
id
integer
The id that was sent in the request
Was this page helpful?
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Deribit API Documentation","colors":{"primary":"#0052FF","light":"#FFFFFF","dark":"#0A0B0D"},"logo":{"light":"https://mintcdn.com/deribit/jU8dKQ0mWmFd1NVE/images/deribit_cb_logo_main_black_rgb.svg?fit=max\u0026auto=format\u0026n=jU8dKQ0mWmFd1NVE\u0026q=85\u0026s=f6995f51656093856017582bb557e0ff","dark":"https://mintcdn.com/deribit/jU8dKQ0mWmFd1NVE/images/deribit_cb_logo_main_white_rgb.svg?fit=max\u0026auto=format\u0026n=jU8dKQ0mWmFd1NVE\u0026q=85\u0026s=54d8347f0cac32c775a460a4d7e569f4"},"favicon":{"light":"https://mintcdn.com/deribit/WDohEFxcHZWhzVUu/images/deribit_cb_emblem_blue_rgb@2x.png?fit=max\u0026auto=format\u0026n=WDohEFxcHZWhzVUu\u0026q=85\u0026s=0a53f4ec20c46d3d11d95a63fb1758aa","dark":"https://mintcdn.com/deribit/WDohEFxcHZWhzVUu/images/deribit_cb_emblem_blue_rgb@2x.png?fit=max\u0026auto=format\u0026n=WDohEFxcHZWhzVUu\u0026q=85\u0026s=0a53f4ec20c46d3d11d95a63fb1758aa"},"api":{"params":{"expanded":"all"},"playground":{"display":"none"},"examples":{"autogenerate":false}},"footer":{"socials":{"x":"https://x.com/DeribitOfficial","linkedin":"https://www.linkedin.com/company/deribit"}},"seo":{"metatags":{"canonical":"https://docs.deribit.com/","description":"Complete API documentation for Deribit cryptocurrency derivatives exchange. Learn how to integrate with our JSON-RPC, WebSocket, and FIX APIs for trading futures, perpetuals, and options.","keywords":"Deribit API, cryptocurrency API, derivatives API, trading API, WebSocket API, FIX API, Bitcoin futures, options trading, API documentation","author":"Deribit","robots":"index, follow","og:type":"website","og:site_name":"Deribit API Documentation","og:locale":"en_US","twitter:card":"summary_large_image","twitter:site":"@DeribitOfficial","application-name":"Deribit API Documentation","theme-color":"#0052FF","color-scheme":"light dark"}},"integrations":{"ga4":{"measurementId":"G-3TPTYKFQQ7"}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"deribit","hasAudioNarration":false,"actualSubdomain":"deribit","customDomains":["docs.deribit.com"],"gitSource":{"type":"github","owner":"deribit","repo":"api-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"feedback":{"thumbs":true,"edits":true,"issues":true,"contextualFeedback":{"allowEmail":true},"agentFeedback":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"REMOVE_BRANDING":{"status":"ENABLED"},"CONTEXTUAL_FEEDBACK":{"status":"ENABLED"},"CODE_SNIPPET_FEEDBACK":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6b0072fede75caffbb0284e0","clientVersion":"0.0.4270","searchFilterCounts":[{"language":"default","tag":"API Reference","count":606},{"language":"default","tag":"JSON-RPC API","count":376},{"language":"default","tag":"Methods","count":373},{"language":"default","tag":"Market Data","count":103},{"language":"default","tag":"Subscription Channels","count":87},{"language":"default","tag":"Websockets","count":86},{"language":"default","tag":"Account Management","count":82},{"language":"default","tag":"FIX API","count":78},{"language":"default","tag":"Trading","count":74},{"language":"default","tag":"Wallet","count":50}],"searchSettings":{"maxResults":10}},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableAskAiSearchBar":true,"deflection":{"enabled":true,"email":"dev@deribit.com","showHelpButton":true}},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"site-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"treatment","enabled":true,"payload":{"type":"string","value":"treatment"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"public/style.css","content":".method-pill,.method-nav-pill{display:none!important}.tryit-button{display:none!important}.api-section-heading-subtitle{display:none!important}.api-section[data-section=\"body\"]{display:none!important}li[data-title] button.group>div{font-weight:700!important}body:has(a[aria-current=\"page\"][href*=\"/fix-api/\"]) table th:nth-child(1),body:has(a[aria-current=\"page\"][href*=\"/fix-api/\"]) table td:nth-child(1){width:6%!important;min-width:50px}body:has(a[aria-current=\"page\"][href*=\"/fix-api/\"]) table th:nth-child(2),body:has(a[aria-current=\"page\"][href*=\"/fix-api/\"]) table td:nth-child(2){width:12%!important;min-width:90px}body:has(a[aria-current=\"page\"][href*=\"/fix-api/\"]) table th:nth-child(3),body:has(a[aria-current=\"page\"][href*=\"/fix-api/\"]) table td:nth-child(3){width:8%!important;min-width:70px}body:has(a[aria-current=\"page\"][href*=\"/fix-api/\"]) table th:nth-child(4),body:has(a[aria-current=\"page\"][href*=\"/fix-api/\"]) table td:nth-child(4){width:8%!important;min-width:70px}body:has(a[aria-current=\"page\"][href*=\"/fix-api/\"]) table th:nth-child(5),body:has(a[aria-current=\"page\"][href*=\"/fix-api/\"]) table td:nth-child(5){width:66%!important;min-width:350px}.rate-limit-methods{margin-top:0.75rem}.rate-limit-method-labels,.rate-limit-method-values{display:grid;grid-template-columns:minmax(4.5rem, 0.7fr) minmax(5rem, 0.9fr) minmax(8rem, 1.4fr) minmax(6rem, 1fr);column-gap:1rem;align-items:baseline}.rate-limit-method-labels{padding-bottom:0.35rem;border-bottom:1px solid color-mix(in srgb, currentColor 16%, transparent);font-size:0.8125rem;font-weight:600}.rate-limit-method{padding:0.7rem 0;border-bottom:1px solid color-mix(in srgb, currentColor 12%, transparent)}.rate-limit-method:last-child{border-bottom:none;padding-bottom:0.15rem}.rate-limit-method-name{margin-bottom:0.3rem}.rate-limit-method-name code{white-space:nowrap!important;word-break:normal!important;overflow-wrap:normal!important}.rate-limit-metric-label{display:none}.rate-limit-tiers table{table-layout:fixed;width:100%}.rate-limit-tiers th,.rate-limit-tiers td{min-width:0!important;width:auto!important}.rate-limit-tiers th:nth-child(1),.rate-limit-tiers td:nth-child(1){width:11%!important}.rate-limit-tiers th:nth-child(2),.rate-limit-tiers td:nth-child(2){width:18%!important}.rate-limit-tiers th:nth-child(3),.rate-limit-tiers td:nth-child(3){width:18%!important}.rate-limit-tiers th:nth-child(4),.rate-limit-tiers td:nth-child(4){width:16%!important}.rate-limit-tiers th:nth-child(5),.rate-limit-tiers td:nth-child(5){width:37%!important}@media (max-width: 640px){.rate-limit-method-labels{display:none}.rate-limit-method-values{grid-template-columns:1fr 1fr;row-gap:0.45rem}.rate-limit-metric-label{display:block;font-size:0.75rem;font-weight:600;opacity:0.7}}"}]}
{"page":{"pagePath":"api-reference/upcoming/wallet/private-add_to_address_book","slug":"/api-reference/upcoming/wallet/private-add_to_address_book","pageMetadata":{"title":"private/add_to_address_book","description":"Adds a new address to the address book. The address book allows you to store addresses for withdrawals, along with beneficiary information for compliance purposes.\n\n**Coinbase wallet type**\n\nFor Coinbase wallet type accounts the method supports network selection and CTN (Coinbase Transfer Network) counterparties, and behaves differently:\n\n- Required parameters are `type` and `label`, plus one of:\n - `address` together with `currency` and `network` (optional `tag`) — an on-chain address on the selected network, or\n - `counterparty_id` — a CTN counterparty; `currency` is then omitted and the entry applies to all currencies.\n- `type` accepts only `withdrawal` and `transfer`.\n- Travel rule data is provided with the fields `name`, `country`, `address`, `financial_institution`, `account`, `account_location`, `entity_type` (`organization` or `individual`), `wallet_type` (`exchange` or `self_hosted`) and `is_self` instead of the legacy `beneficiary_*`, `agreed` and `personal` fields.\n- `extra_currencies` is not supported.\n- The response contains a Coinbase address book entry object, including the entry `id` which can be used instead of `address` in the other address book methods.\n\n**📖 Related Article:** [Managing Withdrawals](https://docs.deribit.com/articles/managing-withdrawals-api)\n\n**Scope:** `wallet:read_write`\n\n[Try in API console](https://test.deribit.com/api_console?method=%2Fprivate%2Fadd_to_address_book)\n\n","deprecated":null,"version":null,"og:title":"private/add_to_address_book","keywords":["private/add_to_address_book","currency","type","address","network","tag","counterparty_id","label","beneficiary_vasp_name","beneficiary_vasp_did","beneficiary_vasp_website","beneficiary_first_name","beneficiary_last_name","beneficiary_company_name","beneficiary_address","agreed","personal","extra_currencies","name","country","financial_institution","account","account_location","entity_type","wallet_type","is_self","creation_timestamp","info_required","status","waiting_timestamp","requires_confirmation","requires_confirmation_change","requires_security_key","kind","updated_timestamp","network_display_name","beneficiary_created","beneficiary_updated"],"openapi":"/specifications/deribit_upcoming_openapi.json get /private/add_to_address_book","href":"/api-reference/upcoming/wallet/private-add_to_address_book","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n a: \"a\",\n code: \"code\",\n li: \"li\",\n p: \"p\",\n strong: \"strong\",\n ul: \"ul\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"Adds a new address to the address book. The address book allows you to store addresses for withdrawals, along with beneficiary information for compliance purposes.\"\n }), \"\\n\", _jsx(_components.p, {\n children: _jsx(_components.strong, {\n children: \"Coinbase wallet type\"\n })\n }), \"\\n\", _jsx(_components.p, {\n children: \"For Coinbase wallet type accounts the method supports network selection and CTN (Coinbase Transfer Network) counterparties, and behaves differently:\"\n }), \"\\n\", _jsxs(_components.ul, {\n children: [\"\\n\", _jsxs(_components.li, {\n children: [\"Required parameters are \", _jsx(_components.code, {\n children: \"type\"\n }), \" and \", _jsx(_components.code, {\n children: \"label\"\n }), \", plus one of:\", \"\\n\", _jsxs(_components.ul, {\n children: [\"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.code, {\n children: \"address\"\n }), \" together with \", _jsx(_components.code, {\n children: \"currency\"\n }), \" and \", _jsx(_components.code, {\n children: \"network\"\n }), \" (optional \", _jsx(_components.code, {\n children: \"tag\"\n }), \") — an on-chain address on the selected network, or\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.code, {\n children: \"counterparty_id\"\n }), \" — a CTN counterparty; \", _jsx(_components.code, {\n children: \"currency\"\n }), \" is then omitted and the entry applies to all currencies.\"]\n }), \"\\n\"]\n }), \"\\n\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.code, {\n children: \"type\"\n }), \" accepts only \", _jsx(_components.code, {\n children: \"withdrawal\"\n }), \" and \", _jsx(_components.code, {\n children: \"transfer\"\n }), \".\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [\"Travel rule data is provided with the fields \", _jsx(_components.code, {\n children: \"name\"\n }), \", \", _jsx(_components.code, {\n children: \"country\"\n }), \", \", _jsx(_components.code, {\n children: \"address\"\n }), \", \", _jsx(_components.code, {\n children: \"financial_institution\"\n }), \", \", _jsx(_components.code, {\n children: \"account\"\n }), \", \", _jsx(_components.code, {\n children: \"account_location\"\n }), \", \", _jsx(_components.code, {\n children: \"entity_type\"\n }), \" (\", _jsx(_components.code, {\n children: \"organization\"\n }), \" or \", _jsx(_components.code, {\n children: \"individual\"\n }), \"), \", _jsx(_components.code, {\n children: \"wallet_type\"\n }), \" (\", _jsx(_components.code, {\n children: \"exchange\"\n }), \" or \", _jsx(_components.code, {\n children: \"self_hosted\"\n }), \") and \", _jsx(_components.code, {\n children: \"is_self\"\n }), \" instead of the legacy \", _jsx(_components.code, {\n children: \"beneficiary_*\"\n }), \", \", _jsx(_components.code, {\n children: \"agreed\"\n }), \" and \", _jsx(_components.code, {\n children: \"personal\"\n }), \" fields.\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.code, {\n children: \"extra_currencies\"\n }), \" is not supported.\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [\"The response contains a Coinbase address book entry object, including the entry \", _jsx(_components.code, {\n children: \"id\"\n }), \" which can be used instead of \", _jsx(_components.code, {\n children: \"address\"\n }), \" in the other address book methods.\"]\n }), \"\\n\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.strong, {\n children: \"📖 Related Article:\"\n }), \" \", _jsx(_components.a, {\n href: \"https://docs.deribit.com/articles/managing-withdrawals-api\",\n children: \"Managing Withdrawals\"\n })]\n }), \"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.strong, {\n children: \"Scope:\"\n }), \" \", _jsx(_components.code, {\n children: \"wallet:read_write\"\n })]\n }), \"\\n\", _jsx(_components.p, {\n children: _jsx(_components.a, {\n href: \"https://test.deribit.com/api_console?method=%2Fprivate%2Fadd_to_address_book\",\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/add_to_address_book","description":"Adds a new address to the address book. The address book allows you to store addresses for withdrawals, along with beneficiary information for compliance purposes.\n\n**Coinbase wallet type**\n\nFor Coinbase wallet type accounts the method supports network selection and CTN (Coinbase Transfer Network) counterparties, and behaves differently:\n\n- Required parameters are `type` and `label`, plus one of:\n - `address` together with `currency` and `network` (optional `tag`) — an on-chain address on the selected network, or\n - `counterparty_id` — a CTN counterparty; `currency` is then omitted and the entry applies to all currencies.\n- `type` accepts only `withdrawal` and `transfer`.\n- Travel rule data is provided with the fields `name`, `country`, `address`, `financial_institution`, `account`, `account_location`, `entity_type` (`organization` or `individual`), `wallet_type` (`exchange` or `self_hosted`) and `is_self` instead of the legacy `beneficiary_*`, `agreed` and `personal` fields.\n- `extra_currencies` is not supported.\n- The response contains a Coinbase address book entry object, including the entry `id` which can be used instead of `address` in the other address book methods.\n\n**📖 Related Article:** [Managing Withdrawals](https://docs.deribit.com/articles/managing-withdrawals-api)\n\n**Scope:** `wallet:read_write`\n\n[Try in API console](https://test.deribit.com/api_console?method=%2Fprivate%2Fadd_to_address_book)\n\n","deprecated":null,"version":null,"og:title":"private/add_to_address_book","keywords":["private/add_to_address_book","currency","type","address","network","tag","counterparty_id","label","beneficiary_vasp_name","beneficiary_vasp_did","beneficiary_vasp_website","beneficiary_first_name","beneficiary_last_name","beneficiary_company_name","beneficiary_address","agreed","personal","extra_currencies","name","country","financial_institution","account","account_location","entity_type","wallet_type","is_self","creation_timestamp","info_required","status","waiting_timestamp","requires_confirmation","requires_confirmation_change","requires_security_key","kind","updated_timestamp","network_display_name","beneficiary_created","beneficiary_updated"],"openapi":"/specifications/deribit_upcoming_openapi.json get /private/add_to_address_book","href":"/api-reference/upcoming/wallet/private-add_to_address_book","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/deribit/a355478acb7a8697/public/replace-query-params.js"],"openApiReferenceData":{"operation":{"parameters":["b1ce97c6-d363-4eab-8264-3f784e4ab632","4ed96a64-3610-49c5-a955-1d17cee2b8bb","ef92f911-dcba-4b6c-938b-5c4a3a0f6901","3687f329-84cb-4c47-b84c-867f08a24b92","380c6cdf-6b36-4879-b23f-281e72477a9e","ba39a172-d7a2-400f-8716-ac24ec8c2e14","d113b78c-2f66-4564-bcb5-fcb6ff90c45a","c2f36deb-dd81-473b-9db3-7e4b08284e0c","d1190fcf-d0f5-4eb8-854d-f14067ad9cb6","582eb784-472e-4d4c-9f27-d868787b4a3b","b4107fc1-18b4-44ec-8575-e4c0a9105290","4ff55244-1fa4-4e99-84e9-c3dbfd0f9c12","4cea5842-f2f3-4425-bfc8-ff6e3f71d44b","7619f485-0577-4c56-9215-567b980b9592","3527f2f5-53ef-4af5-8b93-4e7d383f7fac","2a30016f-773b-4730-98f8-a1184ec4c56a","66159062-34f9-483d-89fc-0ee448589524","ee52a9c9-1d69-4301-ab49-331623647661","a5e23c0d-96ac-4402-914e-1c50e009a2e7","7338801e-4679-4f38-bda7-e2106bfd30fb","efe75222-e146-4e85-9b2b-fa52eb125ef0","94b63246-aeed-4e15-a6c1-ac26e77130ee","40f47682-f863-4979-8c9e-92df02c90023","9ed107da-99c1-4489-b291-c63c2099f929","88ca8359-03c0-47c0-83b1-3c84d0ed73b2"],"responses":{"200":"148e1bbf-d54b-45e9-ab61-d3f0d9692a10"},"tags":["Wallet","Private"],"requestBody":"f85205d8-ea66-4677-ba43-f99b48ec2e91","description":"Adds a new address to the address book. The address book allows you to store addresses for withdrawals, along with beneficiary information for compliance purposes.\n\n**Coinbase wallet type**\n\nFor Coinbase wallet type accounts the method supports network selection and CTN (Coinbase Transfer Network) counterparties, and behaves differently:\n\n- Required parameters are `type` and `label`, plus one of:\n - `address` together with `currency` and `network` (optional `tag`) — an on-chain address on the selected network, or\n - `counterparty_id` — a CTN counterparty; `currency` is then omitted and the entry applies to all currencies.\n- `type` accepts only `withdrawal` and `transfer`.\n- Travel rule data is provided with the fields `name`, `country`, `address`, `financial_institution`, `account`, `account_location`, `entity_type` (`organization` or `individual`), `wallet_type` (`exchange` or `self_hosted`) and `is_self` instead of the legacy `beneficiary_*`, `agreed` and `personal` fields.\n- `extra_currencies` is not supported.\n- The response contains a Coinbase address book entry object, including the entry `id` which can be used instead of `address` in the other address book methods.\n\n**📖 Related Article:** [Managing Withdrawals](https://docs.deribit.com/articles/managing-withdrawals-api)\n\n**Scope:** `wallet:read_write`\n\n[Try in API console](https://test.deribit.com/api_console?method=%2Fprivate%2Fadd_to_address_book)\n\n","x-mint":{"metadata":{"title":"private/add_to_address_book","og:title":"private/add_to_address_book","keywords":["private/add_to_address_book","currency","type","address","network","tag","counterparty_id","label","beneficiary_vasp_name","beneficiary_vasp_did","beneficiary_vasp_website","beneficiary_first_name","beneficiary_last_name","beneficiary_company_name","beneficiary_address","agreed","personal","extra_currencies","name","country","financial_institution","account","account_location","entity_type","wallet_type","is_self","creation_timestamp","info_required","status","waiting_timestamp","requires_confirmation","requires_confirmation_change","requires_security_key","kind","updated_timestamp","network_display_name","beneficiary_created","beneficiary_updated"]},"href":"/api-reference/upcoming/wallet/private-add_to_address_book"},"x-codeSamples":[{"lang":"bash","label":"cURL","source":"curl --request POST \\\n --url https://test.deribit.com/api/v2/private/add_to_address_book \\\n --header 'Authorization: Bearer \u003cACCESS_TOKEN>' \\\n --header 'Content-Type: application/json' \\\n --data '{\n \"jsonrpc\": \"2.0\",\n \"id\": 42,\n \"method\": \"private/add_to_address_book\",\n \"params\": {\n \"currency\": \"BTC\",\n \"type\": \"withdrawal\",\n \"address\": \"bc1qar0srrr7xfkvy5l643lydnw9re59gtzzwf0uyj\",\n \"label\": \"Main address\",\n \"beneficiary_vasp_name\": \"Money`s Gone\",\n \"beneficiary_vasp_did\": \"did:example:123456789abcdefghi\",\n \"beneficiary_first_name\": \"John\",\n \"beneficiary_last_name\": \"Doe\",\n \"beneficiary_address\": \"NL, Amsterdam, Street, 1\",\n \"agreed\": true,\n \"personal\": false\n }\n}'"}],"method":"get","type":"path","servers":["664f4fbb-b57f-4e03-8c19-f187cd931be6"],"security":[],"path":"/private/add_to_address_book","baseUrlOptions":["https://test.deribit.com/api/v2"],"title":"","codeSamples":[{"label":"cURL","lang":"bash","source":"curl --request POST \\\n --url https://test.deribit.com/api/v2/private/add_to_address_book \\\n --header 'Authorization: Bearer \u003cACCESS_TOKEN>' \\\n --header 'Content-Type: application/json' \\\n --data '{\n \"jsonrpc\": \"2.0\",\n \"id\": 42,\n \"method\": \"private/add_to_address_book\",\n \"params\": {\n \"currency\": \"BTC\",\n \"type\": \"withdrawal\",\n \"address\": \"bc1qar0srrr7xfkvy5l643lydnw9re59gtzzwf0uyj\",\n \"label\": \"Main address\",\n \"beneficiary_vasp_name\": \"Money`s Gone\",\n \"beneficiary_vasp_did\": \"did:example:123456789abcdefghi\",\n \"beneficiary_first_name\": \"John\",\n \"beneficiary_last_name\": \"Doe\",\n \"beneficiary_address\": \"NL, Amsterdam, Street, 1\",\n \"agreed\": true,\n \"personal\": false\n }\n}'"}],"requiredOnlyExamples":false,"disableCodeSampleGeneration":true,"requestExampleType":"codeSamples","responseExampleType":"generated"},"dependencies":{"parameters":{"b1ce97c6-d363-4eab-8264-3f784e4ab632":{"name":"currency","in":"query","required":false,"schema":{"enum":["BTC","ETH","USDC","USDT","EURR"],"type":"string","description":"The currency symbol. **Required for legacy wallet type** (wallet currencies only). **Coinbase wallet type:** required when `address` is used (any portfolio currency); omitted when adding a CTN counterparty via `counterparty_id` — such entries apply to all currencies (`\"all\"`).\nCurrency, i.e `\"BTC\"`, `\"ETH\"`, `\"USDC\"`","example":"BTC","isRequired":false,"uniqueKey":"","typeLabel":"enum\u003cstring>"},"description":"The currency symbol. **Required for legacy wallet type** (wallet currencies only). **Coinbase wallet type:** required when `address` is used (any portfolio currency); omitted when adding a CTN counterparty via `counterparty_id` — such entries apply to all currencies (`\"all\"`)."},"4ed96a64-3610-49c5-a955-1d17cee2b8bb":{"name":"type","in":"query","required":true,"schema":{"enum":["transfer","withdrawal","deposit_source"],"type":"string","description":"Address book type","example":"withdrawal","isRequired":true,"uniqueKey":"","typeLabel":"enum\u003cstring>"},"description":"Address book type. Legacy wallet type: `withdrawal`, `transfer` or `deposit_source`. Coinbase wallet type: `withdrawal` or `transfer` only."},"ef92f911-dcba-4b6c-938b-5c4a3a0f6901":{"name":"address","in":"query","required":false,"schema":{"example":"bc1qar0srrr7xfkvy5l643lydnw9re59gtzzwf0uyj","type":"string","description":"Address in currency format. **Required for legacy wallet type.** **Coinbase wallet type:** required when `counterparty_id` is not provided, and must then be used together with `currency` and `network` (and `tag` for networks that require one). For Coinbase wallet type the same value is also stored as the beneficiary address travel rule field.\nAddress in proper format for currency","isRequired":false,"uniqueKey":"","typeLabel":"string"},"description":"Address in currency format. **Required for legacy wallet type.** **Coinbase wallet type:** required when `counterparty_id` is not provided, and must then be used together with `currency` and `network` (and `tag` for networks that require one). For Coinbase wallet type the same value is also stored as the beneficiary address travel rule field."},"3687f329-84cb-4c47-b84c-867f08a24b92":{"name":"network","in":"query","schema":{"type":"string","example":"networks/ethereum-mainnet","isRequired":false,"description":"Blockchain network resource name (e.g. networks/ethereum-mainnet), for Coinbase wallet types. Available networks are returned by public/get_currencies in coinbase_networks. Requiredness depends on the operation. When resolving an existing address-book entry, it is optional if the entry resolves uniquely; it disambiguates an address present on multiple networks.","uniqueKey":"","typeLabel":"string"},"required":false,"description":"Blockchain network resource name (e.g. networks/ethereum-mainnet), for Coinbase wallet types. Available networks are returned by public/get_currencies in coinbase_networks. Requiredness depends on the operation. When resolving an existing address-book entry, it is optional if the entry resolves uniquely; it disambiguates an address present on multiple networks."},"380c6cdf-6b36-4879-b23f-281e72477a9e":{"name":"tag","in":"query","schema":{"type":"string","isRequired":false,"description":"Destination tag / memo for networks that support one. **Coinbase wallet type only.** Used together with `address` and `network`; also serves to disambiguate address book entries that share the same address.","uniqueKey":"","typeLabel":"string"},"required":false,"description":"Destination tag / memo for networks that support one. **Coinbase wallet type only.** Used together with `address` and `network`; also serves to disambiguate address book entries that share the same address."},"ba39a172-d7a2-400f-8716-ac24ec8c2e14":{"name":"counterparty_id","in":"query","schema":{"type":"string","example":"cp-8f3e2a1b9c4d","isRequired":false,"description":"Identifier of a Coinbase Transfer Network (CTN) counterparty. **Coinbase wallet type only.** Used instead of `address` and `network`; entries created with `counterparty_id` apply to all currencies, so `currency` is omitted.","uniqueKey":"","typeLabel":"string"},"required":false,"description":"Identifier of a Coinbase Transfer Network (CTN) counterparty. **Coinbase wallet type only.** Used instead of `address` and `network`; entries created with `counterparty_id` apply to all currencies, so `currency` is omitted."},"d113b78c-2f66-4564-bcb5-fcb6ff90c45a":{"name":"label","in":"query","schema":{"example":"Main address","type":"string","description":"Label of the address book entry","isRequired":true,"uniqueKey":"","typeLabel":"string"},"required":true,"description":"Label of the address book entry"},"c2f36deb-dd81-473b-9db3-7e4b08284e0c":{"name":"beneficiary_vasp_name","in":"query","required":false,"schema":{"example":"Money`s Gone","type":"string","description":"Name of beneficiary VASP","isRequired":false,"uniqueKey":"","typeLabel":"string"},"description":"Name of beneficiary VASP. **Legacy wallet type only.**"},"d1190fcf-d0f5-4eb8-854d-f14067ad9cb6":{"name":"beneficiary_vasp_did","in":"query","required":false,"schema":{"example":"did:example:123456789abcdefghi","type":"string","description":"DID of beneficiary VASP","isRequired":false,"uniqueKey":"","typeLabel":"string"},"description":"DID of beneficiary VASP. **Legacy wallet type only.**"},"582eb784-472e-4d4c-9f27-d868787b4a3b":{"name":"beneficiary_vasp_website","in":"query","schema":{"type":"string","description":"Website of the beneficiary VASP","isRequired":false,"uniqueKey":"","typeLabel":"string"},"required":false,"description":"Website of the beneficiary VASP. Required if the address book entry is associated with a VASP that is not included in the list of known VASPs"},"b4107fc1-18b4-44ec-8575-e4c0a9105290":{"name":"beneficiary_first_name","in":"query","schema":{"example":"John","type":"string","description":"First name of beneficiary (if beneficiary is a person)\nFirst name of the beneficiary (if beneficiary is a person)","isRequired":false,"uniqueKey":"","typeLabel":"string"},"description":"First name of beneficiary (if beneficiary is a person)","required":false},"4ff55244-1fa4-4e99-84e9-c3dbfd0f9c12":{"name":"beneficiary_last_name","in":"query","schema":{"example":"Doe","type":"string","description":"First name of beneficiary (if beneficiary is a person)\nLast name of the beneficiary (if beneficiary is a person)","isRequired":false,"uniqueKey":"","typeLabel":"string"},"description":"First name of beneficiary (if beneficiary is a person)","required":false},"4cea5842-f2f3-4425-bfc8-ff6e3f71d44b":{"name":"beneficiary_company_name","in":"query","schema":{"example":"Company Name","type":"string","description":"Beneficiary company name (if beneficiary is a company)\nCompany name of the beneficiary (if beneficiary is a company)","isRequired":false,"uniqueKey":"","typeLabel":"string"},"description":"Beneficiary company name (if beneficiary is a company)","required":false},"7619f485-0577-4c56-9215-567b980b9592":{"name":"beneficiary_address","in":"query","required":false,"schema":{"example":"NL, Amsterdam, Street, 1","type":"string","description":"Geographical address of the beneficiary","isRequired":false,"uniqueKey":"","typeLabel":"string"},"description":"Geographical address of the beneficiary. **Legacy wallet type only.**"},"3527f2f5-53ef-4af5-8b93-4e7d383f7fac":{"name":"agreed","in":"query","required":false,"schema":{"example":true,"type":"boolean","description":"Indicates that the user agreed to shared provided information with 3rd parties","isRequired":false,"uniqueKey":"","typeLabel":"boolean"},"description":"Indicates that the user agreed to shared provided information with 3rd parties. **Legacy wallet type only.**"},"2a30016f-773b-4730-98f8-a1184ec4c56a":{"name":"personal","in":"query","required":false,"schema":{"example":false,"type":"boolean","description":"The user confirms that he provided address belongs to him and he has access to it via an un-hosted wallet software","isRequired":false,"uniqueKey":"","typeLabel":"boolean"},"description":"The user confirms that he provided address belongs to him and he has access to it via an un-hosted wallet software. **Legacy wallet type only.**"},"66159062-34f9-483d-89fc-0ee448589524":{"name":"extra_currencies","in":"query","schema":{"items":{"type":"string","description":"Name of the currency","uniqueKey":"items.[INDEX]","typeLabel":"string"},"example":["USDC"],"type":"array","description":"The user can pass a list of currencies to add the address for. It is currently available ONLY for ERC20 currencies. Without passing this paramater for an ERC20 currency, the address will be added to ALL of the ERC20 currencies.","isRequired":false,"uniqueKey":"","typeLabel":"string[]"},"description":"The user can pass a list of currencies to add the address for. It is currently available ONLY for ERC20 currencies. Without passing this paramater for an ERC20 currency, the address will be added to ALL of the ERC20 currencies.","required":false},"ee52a9c9-1d69-4301-ab49-331623647661":{"name":"name","in":"query","schema":{"type":"string","example":"Alice Smith","isRequired":false,"description":"Full name of the beneficiary (person or organization). **Coinbase wallet type only** — travel rule data.","uniqueKey":"","typeLabel":"string"},"required":false,"description":"Full name of the beneficiary (person or organization). **Coinbase wallet type only** — travel rule data."},"a5e23c0d-96ac-4402-914e-1c50e009a2e7":{"name":"country","in":"query","schema":{"type":"string","example":"NL","isRequired":false,"description":"Country code of the beneficiary (ISO 3166-1 alpha-2). **Coinbase wallet type only** — travel rule data.","uniqueKey":"","typeLabel":"string"},"required":false,"description":"Country code of the beneficiary (ISO 3166-1 alpha-2). **Coinbase wallet type only** — travel rule data."},"7338801e-4679-4f38-bda7-e2106bfd30fb":{"name":"financial_institution","in":"query","schema":{"type":"string","isRequired":false,"description":"Name of the financial institution holding the beneficiary account. **Coinbase wallet type only** — travel rule data.","uniqueKey":"","typeLabel":"string"},"required":false,"description":"Name of the financial institution holding the beneficiary account. **Coinbase wallet type only** — travel rule data."},"efe75222-e146-4e85-9b2b-fa52eb125ef0":{"name":"account","in":"query","schema":{"type":"string","isRequired":false,"description":"Account identifier of the beneficiary at the financial institution. **Coinbase wallet type only** — travel rule data.","uniqueKey":"","typeLabel":"string"},"required":false,"description":"Account identifier of the beneficiary at the financial institution. **Coinbase wallet type only** — travel rule data."},"94b63246-aeed-4e15-a6c1-ac26e77130ee":{"name":"account_location","in":"query","schema":{"type":"string","isRequired":false,"description":"Location of the beneficiary account. **Coinbase wallet type only** — travel rule data.","uniqueKey":"","typeLabel":"string"},"required":false,"description":"Location of the beneficiary account. **Coinbase wallet type only** — travel rule data."},"40f47682-f863-4979-8c9e-92df02c90023":{"name":"entity_type","in":"query","schema":{"type":"string","enum":["organization","individual"],"isRequired":false,"description":"Type of the beneficiary entity. **Coinbase wallet type only** — travel rule data.","uniqueKey":"","typeLabel":"enum\u003cstring>"},"required":false,"description":"Type of the beneficiary entity. **Coinbase wallet type only** — travel rule data."},"9ed107da-99c1-4489-b291-c63c2099f929":{"name":"wallet_type","in":"query","schema":{"type":"string","enum":["exchange","self_hosted"],"isRequired":false,"description":"Type of the beneficiary wallet. **Coinbase wallet type only** — travel rule data.","uniqueKey":"","typeLabel":"enum\u003cstring>"},"required":false,"description":"Type of the beneficiary wallet. **Coinbase wallet type only** — travel rule data."},"88ca8359-03c0-47c0-83b1-3c84d0ed73b2":{"name":"is_self","in":"query","schema":{"type":"boolean","isRequired":false,"description":"Indicates that the beneficiary is the account owner. **Coinbase wallet type only** — travel rule data.","uniqueKey":"","typeLabel":"boolean"},"required":false,"description":"Indicates that the beneficiary is the account owner. **Coinbase wallet type only** — travel rule data."}},"requestBody":{"content":{"application/json":{"examples":{"request":{"title":"request","summary":"JSON-RPC Request Example","value":{"jsonrpc":"2.0","id":42,"method":"private/add_to_address_book","params":{"currency":"BTC","type":"withdrawal","address":"bc1qar0srrr7xfkvy5l643lydnw9re59gtzzwf0uyj","label":"Main address","beneficiary_vasp_name":"Money`s Gone","beneficiary_vasp_did":"did:example:123456789abcdefghi","beneficiary_first_name":"John","beneficiary_last_name":"Doe","beneficiary_address":"NL, Amsterdam, Street, 1","agreed":true,"personal":false}}}},"exampleType":"examples"}},"description":"JSON-RPC request body","exampleType":"examples"},"responses":{"148e1bbf-d54b-45e9-ab61-d3f0d9692a10":{"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":{"oneOf":[{"type":"object","required":["currency","address","creation_timestamp"],"properties":{"currency":{"enum":["BTC","ETH","STETH","ETHW","USDC","USDT","EURR","SOL","XRP","USYC","PAXG","BNB","USDE"],"type":"string","description":"Currency, i.e `\"BTC\"`, `\"ETH\"`, `\"USDC\"`","isRequired":true,"uniqueKey":"result.oneOf.0.currency","typeLabel":"enum\u003cstring>"},"address":{"example":"1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa","type":"string","description":"Address in proper format for currency","isRequired":true,"uniqueKey":"result.oneOf.0.address","typeLabel":"string"},"creation_timestamp":{"example":1536569522277,"type":"integer","description":"The timestamp (milliseconds since the Unix epoch)","isRequired":true,"uniqueKey":"result.oneOf.0.creation_timestamp","typeLabel":"integer"},"type":{"enum":["transfer","withdrawal","deposit_source"],"type":"string","description":"Address book type","uniqueKey":"result.oneOf.0.type","typeLabel":"enum\u003cstring>"},"label":{"example":"Main address","type":"string","description":"Label of the address book entry","uniqueKey":"result.oneOf.0.label","typeLabel":"string"},"beneficiary_vasp_name":{"example":"Money's Gone","type":"string","description":"Name of beneficiary VASP","uniqueKey":"result.oneOf.0.beneficiary_vasp_name","typeLabel":"string"},"beneficiary_vasp_did":{"example":"did:example:123456789abcdefghi","type":"string","description":"DID of beneficiary VASP","uniqueKey":"result.oneOf.0.beneficiary_vasp_did","typeLabel":"string"},"beneficiary_vasp_website":{"type":"string","description":"Website of the beneficiary VASP","uniqueKey":"result.oneOf.0.beneficiary_vasp_website","typeLabel":"string"},"beneficiary_first_name":{"example":"John","type":"string","description":"First name of the beneficiary (if beneficiary is a person)","uniqueKey":"result.oneOf.0.beneficiary_first_name","typeLabel":"string"},"beneficiary_last_name":{"example":"Doe","type":"string","description":"Last name of the beneficiary (if beneficiary is a person)","uniqueKey":"result.oneOf.0.beneficiary_last_name","typeLabel":"string"},"beneficiary_company_name":{"example":"Company Name","type":"string","description":"Company name of the beneficiary (if beneficiary is a company)","uniqueKey":"result.oneOf.0.beneficiary_company_name","typeLabel":"string"},"beneficiary_address":{"example":"NL, Amsterdam, Street, 1","type":"string","description":"Geographical address of the beneficiary","uniqueKey":"result.oneOf.0.beneficiary_address","typeLabel":"string"},"agreed":{"example":true,"type":"boolean","description":"Indicates that the user agreed to shared provided information with 3rd parties","uniqueKey":"result.oneOf.0.agreed","typeLabel":"boolean"},"personal":{"example":true,"type":"boolean","description":"The user confirms that he provided address belongs to him and he has access to it via an un-hosted wallet software","uniqueKey":"result.oneOf.0.personal","typeLabel":"boolean"},"info_required":{"example":true,"type":"boolean","description":"Signalises that addition information regarding the beneficiary of the address is required","uniqueKey":"result.oneOf.0.info_required","typeLabel":"boolean"},"status":{"enum":["admin_locked","waiting","confirmed","ready"],"type":"string","description":"Wallet address status, values: [`admin_locked`, `waiting`, `confirmed`, `ready`]","uniqueKey":"result.oneOf.0.status","typeLabel":"enum\u003cstring>"},"waiting_timestamp":{"oneOf":[{"example":1720252232860,"type":"integer","description":"Timestamp (milliseconds since the Unix epoch) at which the address becomes usable; present while status is waiting; null for Coinbase deposit addresses.","uniqueKey":"result.oneOf.0.waiting_timestamp.oneOf.0","typeLabel":"integer"},{"example":1720252232860,"type":"null","description":"Timestamp (milliseconds since the Unix epoch) at which the address becomes usable; present while status is waiting; null for Coinbase deposit addresses.","uniqueKey":"result.oneOf.0.waiting_timestamp.oneOf.1","typeLabel":"null"}],"uniqueKey":"result.oneOf.0.waiting_timestamp","typeLabel":"integer | null"},"requires_confirmation":{"example":true,"type":"boolean","description":"If address requires email confirmation for withdrawals","uniqueKey":"result.oneOf.0.requires_confirmation","typeLabel":"boolean"},"requires_confirmation_change":{"example":true,"type":"boolean","description":"If email confirmation change is in progress","uniqueKey":"result.oneOf.0.requires_confirmation_change","typeLabel":"boolean"},"requires_security_key":{"type":"boolean","example":false,"description":"If withdrawals to this address require a security key","uniqueKey":"result.oneOf.0.requires_security_key","typeLabel":"boolean"}},"isRequired":true,"uniqueKey":"result.oneOf.0","typeLabel":"object"},{"type":"object","description":"Address book entry of a Coinbase wallet type account. Returned instead of `address_book_item` for Coinbase wallet type users.","required":["id","currency","address","type","kind","creation_timestamp"],"properties":{"id":{"type":"string","example":"0190a1b2-7c3d-7e5f-8a9b-0c1d2e3f4a5b","description":"Unique identifier (UUID7) of the address book entry","isRequired":true,"uniqueKey":"result.oneOf.1.id","typeLabel":"string"},"currency":{"type":"string","example":"ETH","description":"The currency symbol, or `\"all\"` for CTN counterparty entries that apply to all currencies","isRequired":true,"uniqueKey":"result.oneOf.1.currency","typeLabel":"string"},"address":{"type":"string","example":"0x742d35Cc6634C0532925a3b844Bc454e4438f44e","description":"The on-chain address, or the CTN counterparty identifier when `kind` is `\"ctn\"`","isRequired":true,"uniqueKey":"result.oneOf.1.address","typeLabel":"string"},"type":{"enum":["deposit","withdrawal","transfer"],"type":"string","description":"Address book entry type","isRequired":true,"uniqueKey":"result.oneOf.1.type","typeLabel":"enum\u003cstring>"},"kind":{"type":"string","enum":["onchain","ctn"],"description":"Kind of the destination: `\"onchain\"` — blockchain address, `\"ctn\"` — Coinbase Transfer Network counterparty","isRequired":true,"uniqueKey":"result.oneOf.1.kind","typeLabel":"enum\u003cstring>"},"creation_timestamp":{"example":1536569522277,"type":"integer","description":"The timestamp (milliseconds since the Unix epoch)","isRequired":true,"uniqueKey":"result.oneOf.1.creation_timestamp","typeLabel":"integer"},"label":{"example":"Main address","type":"string","description":"Label of the address book entry","uniqueKey":"result.oneOf.1.label","typeLabel":"string"},"updated_timestamp":{"example":1536569522277,"type":"integer","description":"The timestamp (milliseconds since the Unix epoch)","uniqueKey":"result.oneOf.1.updated_timestamp","typeLabel":"integer"},"status":{"type":"string","enum":["active","waiting","ready"],"description":"Status of the entry: `\"active\"` for deposit addresses, `\"waiting\"` while the security delay is pending, `\"ready\"` otherwise","uniqueKey":"result.oneOf.1.status","typeLabel":"enum\u003cstring>"},"waiting_timestamp":{"oneOf":[{"example":1720252232860,"type":"integer","description":"Timestamp (milliseconds since the Unix epoch) at which the address becomes usable; present while status is waiting; null for Coinbase deposit addresses.","uniqueKey":"result.oneOf.1.waiting_timestamp.oneOf.0","typeLabel":"integer"},{"example":1720252232860,"type":"null","description":"Timestamp (milliseconds since the Unix epoch) at which the address becomes usable; present while status is waiting; null for Coinbase deposit addresses.","uniqueKey":"result.oneOf.1.waiting_timestamp.oneOf.1","typeLabel":"null"}],"uniqueKey":"result.oneOf.1.waiting_timestamp","typeLabel":"integer | null"},"requires_confirmation":{"example":true,"type":"boolean","description":"If address requires email confirmation for withdrawals","uniqueKey":"result.oneOf.1.requires_confirmation","typeLabel":"boolean"},"requires_confirmation_change":{"example":true,"type":"boolean","description":"If email confirmation change is in progress","uniqueKey":"result.oneOf.1.requires_confirmation_change","typeLabel":"boolean"},"requires_security_key":{"type":"boolean","example":false,"description":"If withdrawals to this address require a security key","uniqueKey":"result.oneOf.1.requires_security_key","typeLabel":"boolean"},"info_required":{"example":true,"type":"boolean","description":"Signalises that addition information regarding the beneficiary of the address is required","uniqueKey":"result.oneOf.1.info_required","typeLabel":"boolean"},"network":{"type":"string","example":"networks/ethereum-mainnet","description":"Network resource name of the destination (e.g. `\"networks/ethereum-mainnet\"`); absent for CTN entries","uniqueKey":"result.oneOf.1.network","typeLabel":"string"},"network_display_name":{"type":"string","example":"Ethereum","description":"Human-readable name of the network (e.g. `\"Ethereum\"`); absent for CTN entries","uniqueKey":"result.oneOf.1.network_display_name","typeLabel":"string"},"tag":{"type":"string","description":"Destination tag / memo of the entry; absent when not set","uniqueKey":"result.oneOf.1.tag","typeLabel":"string"},"name":{"type":"string","description":"Beneficiary name — travel rule data (present when provided)","uniqueKey":"result.oneOf.1.name","typeLabel":"string"},"country":{"type":"string","description":"Beneficiary country code (ISO 3166-1 alpha-2) — travel rule data (present when provided)","uniqueKey":"result.oneOf.1.country","typeLabel":"string"},"financial_institution":{"type":"string","description":"Financial institution of the beneficiary — travel rule data (present when provided)","uniqueKey":"result.oneOf.1.financial_institution","typeLabel":"string"},"account":{"type":"string","description":"Account identifier of the beneficiary — travel rule data (present when provided)","uniqueKey":"result.oneOf.1.account","typeLabel":"string"},"account_location":{"type":"string","description":"Location of the beneficiary account — travel rule data (present when provided)","uniqueKey":"result.oneOf.1.account_location","typeLabel":"string"},"entity_type":{"type":"string","enum":["organization","individual"],"description":"Type of the beneficiary entity — travel rule data (present when provided)","uniqueKey":"result.oneOf.1.entity_type","typeLabel":"enum\u003cstring>"},"wallet_type":{"type":"string","enum":["exchange","self_hosted"],"description":"Type of the beneficiary wallet — travel rule data (present when provided)","uniqueKey":"result.oneOf.1.wallet_type","typeLabel":"enum\u003cstring>"},"is_self":{"type":"boolean","description":"Indicates that the beneficiary is the account owner — travel rule data (present when provided)","uniqueKey":"result.oneOf.1.is_self","typeLabel":"boolean"},"beneficiary_created":{"example":1536569522277,"type":"integer","description":"The timestamp (milliseconds since the Unix epoch)","uniqueKey":"result.oneOf.1.beneficiary_created","typeLabel":"integer"},"beneficiary_updated":{"example":1536569522277,"type":"integer","description":"The timestamp (milliseconds since the Unix epoch)","uniqueKey":"result.oneOf.1.beneficiary_updated","typeLabel":"integer"}},"isRequired":true,"uniqueKey":"result.oneOf.1","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","summary":"Response example","value":{"jsonrpc":"2.0","id":42,"result":{"address":"bc1qar0srrr7xfkvy5l643lydnw9re59gtzzwf0uyj","creation_timestamp":1536569522277,"currency":"BTC","type":"withdrawal","label":"Main address","beneficiary_vasp_name":"Money`s Gone","beneficiary_vasp_did":"did:example:123456789abcdefghi","beneficiary_first_name":"John","beneficiary_last_name":"Doe","beneficiary_address":"NL, Amsterdam, Street, 1","agreed":true,"personal":false,"info_required":false}}},"coinbaseResponse":{"title":"coinbaseResponse","summary":"Coinbase response example","value":{"jsonrpc":"2.0","id":42,"result":{"id":"0190a1b2-7c3d-7e5f-8a9b-0c1d2e3f4a5b","currency":"ETH","address":"0x742d35Cc6634C0532925a3b844Bc454e4438f44e","type":"withdrawal","kind":"onchain","label":"Main address","creation_timestamp":1719993033041,"updated_timestamp":1719993033041,"status":"waiting","waiting_timestamp":1720252232860,"requires_confirmation":false,"requires_confirmation_change":false,"requires_security_key":true,"info_required":false,"network":"networks/ethereum-mainnet","network_display_name":"Ethereum","name":"Alice Smith","country":"NL","beneficiary_created":1719993033041,"beneficiary_updated":1719993033041}}}},"exampleType":"examples"}},"description":"Success response","exampleType":"examples"}},"security":{},"servers":{"664f4fbb-b57f-4e03-8c19-f187cd931be6":{"url":"https://test.deribit.com/api/v2"}}},"originalFileLocation":"specifications/deribit_upcoming_openapi.json"},"subdomain":"deribit","siteName":"Deribit API Documentation","title":"private/add_to_address_book","relatedPagesConfig":{"enabled":true,"limit":5,"mode":"automatic"},"navMaps":{"firstHrefInVersion":{"Production":{"href":"/","matchLevel":4},"Upcoming":{"href":"/api-reference/upcoming/wallet/private-add_to_address_book","matchLevel":0}},"firstHrefInLanguage":{}},"lastModified":"2026-11-19T14:42:31.290Z","originalFileLocation":"api-reference/upcoming/wallet/private-add_to_address_book.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=\"Adds a new address to the address book. The address book allows you to store addresses for withdrawals, along with beneficiary information for compliance purposes. Coinbase wallet type For Coinbase wallet type accounts the method supports network selection and CTN (Coinbase Transfer Network) counterparties, and behaves differently: - Required parameters are type and label, plus one of: - address together with currency and network (optional tag) — an on-chain address on the selected network, or - counterparty_id — a CTN counterparty; currency is then omitted and the entry applies to all currencies. - type accepts only withdrawal and transfer. - Travel rule data is provided with the fields name, country, address, financial_institution, account, account_location, entity_type (organization or individual), wallet_type (exchange or self_hosted) and is_self instead of the legacy beneficiary_*, agreed and personal fields. - extra_currencies is not supported. - The response contains a Coinbase address book entry object, including the entry id which can be used instead of address in the other address book methods. 📖 Related Article: Managing Withdrawals Scope: wallet:read_write 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/add_to_address_book\">\u003cmeta data-mint-head property=\"og:description\" content=\"Adds a new address to the address book. The address book allows you to store addresses for withdrawals, along with beneficiary information for compliance purposes. Coinbase wallet type For Coinbase wallet type accounts the method supports network selection and CTN (Coinbase Transfer Network) counterparties, and behaves differently: - Required parameters are type and label, plus one of: - address together with currency and network (optional tag) — an on-chain address on the selected network, or - counterparty_id — a CTN counterparty; currency is then omitted and the entry applies to all currencies. - type accepts only withdrawal and transfer. - Travel rule data is provided with the fields name, country, address, financial_institution, account, account_location, entity_type (organization or individual), wallet_type (exchange or self_hosted) and is_self instead of the legacy beneficiary_*, agreed and personal fields. - extra_currencies is not supported. - The response contains a Coinbase address book entry object, including the entry id which can be used instead of address in the other address book methods. 📖 Related Article: Managing Withdrawals Scope: wallet:read_write Try in API console\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Deribit API Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.deribit.com//api-reference/upcoming/wallet/private-add_to_address_book\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://deribit.mintlify.site/_mintlify/api/og/v2?division=Wallet\u0026amp;title=private%2Fadd_to_address_book\u0026amp;description=Adds+a+new+address+to+the+address+book.+The+address+book+allows+you+to+store+addresses+for+withdrawals%2C+along+with+beneficiary+information+for+compliance+purpos\u0026amp;theme=ac8885f98fec5a1d80cab062\u0026amp;signature=cd2276c34c4f14a8b63ff8f33c6829cba27d1bda32965c2b887885af655516f3\">\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/add_to_address_book\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Adds a new address to the address book. The address book allows you to store addresses for withdrawals, along with beneficiary information for compliance purposes. Coinbase wallet type For Coinbase wallet type accounts the method supports network selection and CTN (Coinbase Transfer Network) counterparties, and behaves differently: - Required parameters are type and label, plus one of: - address together with currency and network (optional tag) — an on-chain address on the selected network, or - counterparty_id — a CTN counterparty; currency is then omitted and the entry applies to all currencies. - type accepts only withdrawal and transfer. - Travel rule data is provided with the fields name, country, address, financial_institution, account, account_location, entity_type (organization or individual), wallet_type (exchange or self_hosted) and is_self instead of the legacy beneficiary_*, agreed and personal fields. - extra_currencies is not supported. - The response contains a Coinbase address book entry object, including the entry id which can be used instead of address in the other address book methods. 📖 Related Article: Managing Withdrawals Scope: wallet:read_write Try in API console\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://deribit.mintlify.site/_mintlify/api/og/v2?division=Wallet\u0026amp;title=private%2Fadd_to_address_book\u0026amp;description=Adds+a+new+address+to+the+address+book.+The+address+book+allows+you+to+store+addresses+for+withdrawals%2C+along+with+beneficiary+information+for+compliance+purpos\u0026amp;theme=ac8885f98fec5a1d80cab062\u0026amp;signature=cd2276c34c4f14a8b63ff8f33c6829cba27d1bda32965c2b887885af655516f3\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/deribit/pu9BhCQUYFueUXtn/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Deribit API Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0052FF\">\u003cmeta data-mint-head name=\"og:locale\" content=\"en_US\">\u003cmeta data-mint-head name=\"author\" content=\"Deribit\">\u003cmeta data-mint-head name=\"application-name\" content=\"Deribit API Documentation\">\u003cmeta data-mint-head name=\"theme-color\" content=\"#0052FF\">\u003cmeta data-mint-head name=\"color-scheme\" content=\"light dark\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.deribit.com//api-reference/upcoming/wallet/private-add_to_address_book\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/upcoming/wallet/private-add_to_address_book.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.deribit.com/#organization\",\"name\":\"Deribit API Documentation\",\"url\":\"https://docs.deribit.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/deribit/jU8dKQ0mWmFd1NVE/images/deribit_cb_logo_main_black_rgb.svg?fit=max\u0026auto=format\u0026n=jU8dKQ0mWmFd1NVE\u0026q=85\u0026s=f6995f51656093856017582bb557e0ff\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.deribit.com#website\",\"name\":\"Deribit API Documentation\",\"url\":\"https://docs.deribit.com\",\"publisher\":{\"@id\":\"https://docs.deribit.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.deribit.com//api-reference/upcoming/wallet/private-add_to_address_book#webpage\",\"url\":\"https://docs.deribit.com//api-reference/upcoming/wallet/private-add_to_address_book\",\"name\":\"private/add_to_address_book\",\"description\":\"Adds a new address to the address book. The address book allows you to store addresses for withdrawals, along with beneficiary information for compliance purposes. Coinbase wallet type For Coinbase wallet type accounts the method supports network selection and CTN (Coinbase Transfer Network) counterparties, and behaves differently: - Required parameters are type and label, plus one of: - address together with currency and network (optional tag) — an on-chain address on the selected network, or - counterparty_id — a CTN counterparty; currency is then omitted and the entry applies to all currencies. - type accepts only withdrawal and transfer. - Travel rule data is provided with the fields name, country, address, financial_institution, account, account_location, entity_type (organization or individual), wallet_type (exchange or self_hosted) and is_self instead of the legacy beneficiary_*, agreed and personal fields. - extra_currencies is not supported. - The response contains a Coinbase address book entry object, including the entry id which can be used instead of address in the other address book methods. 📖 Related Article: Managing Withdrawals Scope: wallet:read_write Try in API console\",\"dateModified\":\"2026-11-19T14:42:31.290Z\",\"isPartOf\":{\"@id\":\"https://docs.deribit.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.deribit.com//api-reference/upcoming/wallet/private-add_to_address_book#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.deribit.com//api-reference/upcoming/wallet/private-add_to_address_book#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Methods\",\"item\":\"https://docs.deribit.com/api-reference/upcoming/authentication/public-auth\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Wallet\",\"item\":\"https://docs.deribit.com/api-reference/upcoming/wallet/private-add_to_address_book\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"private/add_to_address_book\",\"item\":\"https://docs.deribit.com//api-reference/upcoming/wallet/private-add_to_address_book\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.deribit.com//api-reference/upcoming/wallet/private-add_to_address_book#apireference\",\"headline\":\"private/add_to_address_book\",\"name\":\"private/add_to_address_book\",\"description\":\"Adds a new address to the address book. The address book allows you to store addresses for withdrawals, along with beneficiary information for compliance purposes. Coinbase wallet type For Coinbase wallet type accounts the method supports network selection and CTN (Coinbase Transfer Network) counterparties, and behaves differently: - Required parameters are type and label, plus one of: - address together with currency and network (optional tag) — an on-chain address on the selected network, or - counterparty_id — a CTN counterparty; currency is then omitted and the entry applies to all currencies. - type accepts only withdrawal and transfer. - Travel rule data is provided with the fields name, country, address, financial_institution, account, account_location, entity_type (organization or individual), wallet_type (exchange or self_hosted) and is_self instead of the legacy beneficiary_*, agreed and personal fields. - extra_currencies is not supported. - The response contains a Coinbase address book entry object, including the entry id which can be used instead of address in the other address book methods. 📖 Related Article: Managing Withdrawals Scope: wallet:read_write Try in API console\",\"url\":\"https://docs.deribit.com//api-reference/upcoming/wallet/private-add_to_address_book\",\"mainEntityOfPage\":{\"@id\":\"https://docs.deribit.com//api-reference/upcoming/wallet/private-add_to_address_book#webpage\"},\"dateModified\":\"2026-11-19T14:42:31.290Z\",\"keywords\":\"private/add_to_address_book, currency, type, address, network, tag, counterparty_id, label, beneficiary_vasp_name, beneficiary_vasp_did, beneficiary_vasp_website, beneficiary_first_name, beneficiary_last_name, beneficiary_company_name, beneficiary_address, agreed, personal, extra_currencies, name, country, financial_institution, account, account_location, entity_type, wallet_type, is_self, creation_timestamp, info_required, status, waiting_timestamp, requires_confirmation, requires_confirmation_change, requires_security_key, kind, updated_timestamp, network_display_name, beneficiary_created, beneficiary_updated\",\"publisher\":{\"@id\":\"https://docs.deribit.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.deribit.com#website\"}}]}\u003c/script>","agentPointerHref":"/api-reference/upcoming/wallet/private-add_to_address_book.md","siteName":"Deribit API Documentation","nav":{"global":null,"versions":[{"version":"Production","pages":[{"title":"Production","href":"/"}]},{"version":"Upcoming","tabs":[{"tab":"Overview","pages":[{"title":"Overview","href":""}]},{"tab":"API Reference","dropdowns":[{"dropdown":"JSON-RPC API","icon":"code","pages":[{"group":"Methods overview","pages":[{"title":"JSON-RPC 2.0 Protocol","href":"/articles/json-rpc-overview"},{"title":"Error Codes","href":"/articles/errors"},{"title":"Using the currency Parameter","href":"/articles/currency-parameter"}]},{"group":"Methods","pages":[{"group":"Authentication","pages":[{"title":"public/auth","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /public/auth","href":"/api-reference/upcoming/authentication/public-auth"},{"title":"public/exchange_token","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /public/exchange_token","href":"/api-reference/upcoming/authentication/public-exchange_token"},{"title":"public/fork_token","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /public/fork_token","href":"/api-reference/upcoming/authentication/public-fork_token"},{"title":"private/logout","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/logout","href":"/api-reference/upcoming/authentication/private-logout"}]},{"group":"Account Management","pages":[{"title":"private/change_api_key_name","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/change_api_key_name","href":"/api-reference/upcoming/account-management/private-change_api_key_name"},{"title":"private/change_margin_model","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/change_margin_model","href":"/api-reference/upcoming/account-management/private-change_margin_model"},{"title":"private/change_scope_in_api_key","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/change_scope_in_api_key","href":"/api-reference/upcoming/account-management/private-change_scope_in_api_key"},{"title":"private/change_subaccount_name","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/change_subaccount_name","href":"/api-reference/upcoming/account-management/private-change_subaccount_name"},{"title":"private/create_api_key","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/create_api_key","href":"/api-reference/upcoming/account-management/private-create_api_key"},{"title":"private/create_subaccount","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/create_subaccount","href":"/api-reference/upcoming/account-management/private-create_subaccount"},{"title":"private/delete_member","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/delete_member","href":"/api-reference/upcoming/account-management/private-delete_member"},{"title":"private/disable_api_key","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/disable_api_key","href":"/api-reference/upcoming/account-management/private-disable_api_key"},{"title":"private/edit_api_key","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/edit_api_key","href":"/api-reference/upcoming/account-management/private-edit_api_key"},{"title":"private/enable_affiliate_program","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/enable_affiliate_program","href":"/api-reference/upcoming/account-management/private-enable_affiliate_program"},{"title":"private/enable_api_key","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/enable_api_key","href":"/api-reference/upcoming/account-management/private-enable_api_key"},{"title":"private/get_access_log","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/get_access_log","href":"/api-reference/upcoming/account-management/private-get_access_log"},{"title":"private/get_account_summaries","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/get_account_summaries","href":"/api-reference/upcoming/account-management/private-get_account_summaries"},{"title":"private/get_account_summary","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/get_account_summary","href":"/api-reference/upcoming/account-management/private-get_account_summary"},{"title":"private/get_affiliate_program_info","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/get_affiliate_program_info","href":"/api-reference/upcoming/account-management/private-get_affiliate_program_info"},{"title":"private/get_currencies","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/get_currencies","href":"/api-reference/upcoming/account-management/private-get_currencies"},{"title":"private/get_email_language","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/get_email_language","href":"/api-reference/upcoming/account-management/private-get_email_language"},{"title":"private/get_members","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/get_members","href":"/api-reference/upcoming/account-management/private-get_members"},{"title":"private/get_new_announcements","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/get_new_announcements","href":"/api-reference/upcoming/account-management/private-get_new_announcements"},{"title":"private/get_position","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/get_position","href":"/api-reference/upcoming/account-management/private-get_position"},{"title":"private/get_positions","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/get_positions","href":"/api-reference/upcoming/account-management/private-get_positions"},{"title":"private/get_subaccounts","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/get_subaccounts","href":"/api-reference/upcoming/account-management/private-get_subaccounts"},{"title":"private/get_subaccounts_details","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/get_subaccounts_details","href":"/api-reference/upcoming/account-management/private-get_subaccounts_details"},{"title":"private/get_transaction_log","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/get_transaction_log","href":"/api-reference/upcoming/account-management/private-get_transaction_log"},{"title":"private/get_user_locks","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/get_user_locks","href":"/api-reference/upcoming/account-management/private-get_user_locks"},{"title":"private/list_api_keys","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/list_api_keys","href":"/api-reference/upcoming/account-management/private-list_api_keys"},{"title":"private/list_custody_accounts","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/list_custody_accounts","href":"/api-reference/upcoming/account-management/private-list_custody_accounts"},{"title":"private/pme/simulate","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/pme/simulate","href":"/api-reference/upcoming/account-management/private-simulate"},{"title":"private/remove_api_key","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/remove_api_key","href":"/api-reference/upcoming/account-management/private-remove_api_key"},{"title":"private/remove_subaccount","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/remove_subaccount","href":"/api-reference/upcoming/account-management/private-remove_subaccount"},{"title":"private/reset_api_key","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/reset_api_key","href":"/api-reference/upcoming/account-management/private-reset_api_key"},{"title":"private/set_announcement_as_read","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/set_announcement_as_read","href":"/api-reference/upcoming/account-management/private-set_announcement_as_read"},{"title":"private/set_disabled_trading_products","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/set_disabled_trading_products","href":"/api-reference/upcoming/account-management/private-set_disabled_trading_products"},{"title":"private/set_email_for_subaccount","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/set_email_for_subaccount","href":"/api-reference/upcoming/account-management/private-set_email_for_subaccount"},{"title":"private/set_email_language","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/set_email_language","href":"/api-reference/upcoming/account-management/private-set_email_language"},{"title":"private/set_member","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/set_member","href":"/api-reference/upcoming/account-management/private-set_member"},{"title":"private/set_self_trading_config","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/set_self_trading_config","href":"/api-reference/upcoming/account-management/private-set_self_trading_config"},{"title":"private/simulate_portfolio","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/simulate_portfolio","href":"/api-reference/upcoming/account-management/private-simulate_portfolio"},{"title":"private/toggle_notifications_from_subaccount","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/toggle_notifications_from_subaccount","href":"/api-reference/upcoming/account-management/private-toggle_notifications_from_subaccount"},{"title":"private/toggle_subaccount_login","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/toggle_subaccount_login","href":"/api-reference/upcoming/account-management/private-toggle_subaccount_login"},{"title":"public/get_announcements","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /public/get_announcements","href":"/api-reference/upcoming/account-management/public-get_announcements"}]},{"group":"Block RFQ","pages":[{"title":"private/accept_block_rfq","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/accept_block_rfq","href":"/api-reference/upcoming/block-rfq/private-accept_block_rfq"},{"title":"private/add_block_rfq_quote","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/add_block_rfq_quote","href":"/api-reference/upcoming/block-rfq/private-add_block_rfq_quote"},{"title":"private/cancel_all_block_rfq_quotes","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/cancel_all_block_rfq_quotes","href":"/api-reference/upcoming/block-rfq/private-cancel_all_block_rfq_quotes"},{"title":"private/cancel_block_rfq","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/cancel_block_rfq","href":"/api-reference/upcoming/block-rfq/private-cancel_block_rfq"},{"title":"private/cancel_block_rfq_quote","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/cancel_block_rfq_quote","href":"/api-reference/upcoming/block-rfq/private-cancel_block_rfq_quote"},{"title":"private/cancel_block_rfq_trigger","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/cancel_block_rfq_trigger","href":"/api-reference/upcoming/block-rfq/private-cancel_block_rfq_trigger"},{"title":"private/create_block_rfq","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/create_block_rfq","href":"/api-reference/upcoming/block-rfq/private-create_block_rfq"},{"title":"private/edit_block_rfq_quote","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/edit_block_rfq_quote","href":"/api-reference/upcoming/block-rfq/private-edit_block_rfq_quote"},{"title":"private/get_block_rfq_makers","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/get_block_rfq_makers","href":"/api-reference/upcoming/block-rfq/private-get_block_rfq_makers"},{"title":"private/get_block_rfq_quotes","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/get_block_rfq_quotes","href":"/api-reference/upcoming/block-rfq/private-get_block_rfq_quotes"},{"title":"private/get_block_rfq_user_info","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/get_block_rfq_user_info","href":"/api-reference/upcoming/block-rfq/private-get_block_rfq_user_info"},{"title":"private/get_block_rfqs","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/get_block_rfqs","href":"/api-reference/upcoming/block-rfq/private-get_block_rfqs"},{"title":"public/get_block_rfq_trades","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /public/get_block_rfq_trades","href":"/api-reference/upcoming/block-rfq/public-get_block_rfq_trades"}]},{"group":"Block Trade","pages":[{"title":"private/approve_block_trade","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/approve_block_trade","href":"/api-reference/upcoming/block-trade/private-approve_block_trade"},{"title":"private/execute_block_trade","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/execute_block_trade","href":"/api-reference/upcoming/block-trade/private-execute_block_trade"},{"title":"private/get_block_trade","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/get_block_trade","href":"/api-reference/upcoming/block-trade/private-get_block_trade"},{"title":"private/get_block_trade_requests","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/get_block_trade_requests","href":"/api-reference/upcoming/block-trade/private-get_block_trade_requests"},{"title":"private/get_block_trades","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/get_block_trades","href":"/api-reference/upcoming/block-trade/private-get_block_trades"},{"title":"private/get_broker_clients","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/get_broker_clients","href":"/api-reference/upcoming/block-trade/private-get_broker_clients"},{"title":"private/get_broker_trade_requests","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/get_broker_trade_requests","href":"/api-reference/upcoming/block-trade/private-get_broker_trade_requests"},{"title":"private/get_broker_trades","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/get_broker_trades","href":"/api-reference/upcoming/block-trade/private-get_broker_trades"},{"title":"private/invalidate_block_trade_signature","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/invalidate_block_trade_signature","href":"/api-reference/upcoming/block-trade/private-invalidate_block_trade_signature"},{"title":"private/reject_block_trade","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/reject_block_trade","href":"/api-reference/upcoming/block-trade/private-reject_block_trade"},{"title":"private/simulate_block_trade","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/simulate_block_trade","href":"/api-reference/upcoming/block-trade/private-simulate_block_trade"},{"title":"private/verify_block_trade","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/verify_block_trade","href":"/api-reference/upcoming/block-trade/private-verify_block_trade"}]},{"group":"Combo Books","pages":[{"title":"private/create_combo","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/create_combo","href":"/api-reference/upcoming/combo-books/private-create_combo"},{"title":"private/get_leg_prices","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/get_leg_prices","href":"/api-reference/upcoming/combo-books/private-get_leg_prices"},{"title":"public/get_combo_details","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /public/get_combo_details","href":"/api-reference/upcoming/combo-books/public-get_combo_details"},{"title":"public/get_combo_ids","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /public/get_combo_ids","href":"/api-reference/upcoming/combo-books/public-get_combo_ids"},{"title":"public/get_combos","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /public/get_combos","href":"/api-reference/upcoming/combo-books/public-get_combos"}]},{"group":"LSP","pages":[{"title":"private/get_lsp_participant_config","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/get_lsp_participant_config","href":"/api-reference/upcoming/lsp/private-get_lsp_participant_config"},{"title":"private/get_lsp_participants","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/get_lsp_participants","href":"/api-reference/upcoming/lsp/private-get_lsp_participants"},{"title":"private/get_lsp_participants_usage","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/get_lsp_participants_usage","href":"/api-reference/upcoming/lsp/private-get_lsp_participants_usage"},{"title":"private/get_lsp_usage","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/get_lsp_usage","href":"/api-reference/upcoming/lsp/private-get_lsp_usage"}]},{"group":"Market Data","pages":[{"title":"public/get_apr_history","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /public/get_apr_history","href":"/api-reference/upcoming/market-data/public-get_apr_history"},{"title":"public/get_basket_index_composition","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /public/get_basket_index_composition","href":"/api-reference/upcoming/market-data/public-get_basket_index_composition"},{"title":"public/get_book_summary_by_currency","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /public/get_book_summary_by_currency","href":"/api-reference/upcoming/market-data/public-get_book_summary_by_currency"},{"title":"public/get_book_summary_by_instrument","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /public/get_book_summary_by_instrument","href":"/api-reference/upcoming/market-data/public-get_book_summary_by_instrument"},{"title":"public/get_contract_size","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /public/get_contract_size","href":"/api-reference/upcoming/market-data/public-get_contract_size"},{"title":"public/get_currencies","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /public/get_currencies","href":"/api-reference/upcoming/market-data/public-get_currencies"},{"title":"public/get_delivery_prices","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /public/get_delivery_prices","href":"/api-reference/upcoming/market-data/public-get_delivery_prices"},{"title":"public/get_expirations","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /public/get_expirations","href":"/api-reference/upcoming/market-data/public-get_expirations"},{"title":"public/get_funding_chart_data","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /public/get_funding_chart_data","href":"/api-reference/upcoming/market-data/public-get_funding_chart_data"},{"title":"public/get_funding_rate_history","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /public/get_funding_rate_history","href":"/api-reference/upcoming/market-data/public-get_funding_rate_history"},{"title":"public/get_funding_rate_value","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /public/get_funding_rate_value","href":"/api-reference/upcoming/market-data/public-get_funding_rate_value"},{"title":"public/get_historical_volatility","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /public/get_historical_volatility","href":"/api-reference/upcoming/market-data/public-get_historical_volatility"},{"title":"public/get_index_price","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /public/get_index_price","href":"/api-reference/upcoming/market-data/public-get_index_price"},{"title":"public/get_index_price_names","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /public/get_index_price_names","href":"/api-reference/upcoming/market-data/public-get_index_price_names"},{"title":"public/get_instrument","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /public/get_instrument","href":"/api-reference/upcoming/market-data/public-get_instrument"},{"title":"public/get_instruments","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /public/get_instruments","href":"/api-reference/upcoming/market-data/public-get_instruments"},{"title":"public/get_last_settlements_by_currency","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /public/get_last_settlements_by_currency","href":"/api-reference/upcoming/market-data/public-get_last_settlements_by_currency"},{"title":"public/get_last_settlements_by_instrument","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /public/get_last_settlements_by_instrument","href":"/api-reference/upcoming/market-data/public-get_last_settlements_by_instrument"},{"title":"public/get_last_trades_by_currency","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /public/get_last_trades_by_currency","href":"/api-reference/upcoming/market-data/public-get_last_trades_by_currency"},{"title":"public/get_last_trades_by_currency_and_time","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /public/get_last_trades_by_currency_and_time","href":"/api-reference/upcoming/market-data/public-get_last_trades_by_currency_and_time"},{"title":"public/get_last_trades_by_instrument","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /public/get_last_trades_by_instrument","href":"/api-reference/upcoming/market-data/public-get_last_trades_by_instrument"},{"title":"public/get_last_trades_by_instrument_and_time","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /public/get_last_trades_by_instrument_and_time","href":"/api-reference/upcoming/market-data/public-get_last_trades_by_instrument_and_time"},{"title":"public/get_mark_price_history","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /public/get_mark_price_history","href":"/api-reference/upcoming/market-data/public-get_mark_price_history"},{"title":"public/get_order_book","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /public/get_order_book","href":"/api-reference/upcoming/market-data/public-get_order_book"},{"title":"public/get_order_book_by_instrument_id","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /public/get_order_book_by_instrument_id","href":"/api-reference/upcoming/market-data/public-get_order_book_by_instrument_id"},{"title":"public/get_supported_index_names","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /public/get_supported_index_names","href":"/api-reference/upcoming/market-data/public-get_supported_index_names"},{"title":"public/get_trade_volumes","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /public/get_trade_volumes","href":"/api-reference/upcoming/market-data/public-get_trade_volumes"},{"title":"public/get_tradingview_chart_data","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /public/get_tradingview_chart_data","href":"/api-reference/upcoming/market-data/public-get_tradingview_chart_data"},{"title":"public/get_volatility_index_data","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /public/get_volatility_index_data","href":"/api-reference/upcoming/market-data/public-get_volatility_index_data"},{"title":"public/ticker","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /public/ticker","href":"/api-reference/upcoming/market-data/public-ticker"},{"title":"public/get_index_chart_data","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /public/get_index_chart_data","href":"/api-reference/upcoming/market-data/public-get_index_chart_data"}]},{"group":"Session Management","pages":[{"title":"private/disable_cancel_on_disconnect","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/disable_cancel_on_disconnect","href":"/api-reference/upcoming/session-management/private-disable_cancel_on_disconnect"},{"title":"private/enable_cancel_on_disconnect","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/enable_cancel_on_disconnect","href":"/api-reference/upcoming/session-management/private-enable_cancel_on_disconnect"},{"title":"private/get_cancel_on_disconnect","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/get_cancel_on_disconnect","href":"/api-reference/upcoming/session-management/private-get_cancel_on_disconnect"},{"title":"public/disable_heartbeat","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /public/disable_heartbeat","href":"/api-reference/upcoming/session-management/public-disable_heartbeat"},{"title":"public/set_heartbeat","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /public/set_heartbeat","href":"/api-reference/upcoming/session-management/public-set_heartbeat"}]},{"group":"Subscription Management","pages":[{"title":"private/subscribe","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/subscribe","href":"/api-reference/upcoming/subscription-management/private-subscribe"},{"title":"private/unsubscribe","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/unsubscribe","href":"/api-reference/upcoming/subscription-management/private-unsubscribe"},{"title":"private/unsubscribe_all","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/unsubscribe_all","href":"/api-reference/upcoming/subscription-management/private-unsubscribe_all"},{"title":"public/subscribe","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /public/subscribe","href":"/api-reference/upcoming/subscription-management/public-subscribe"},{"title":"public/unsubscribe","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /public/unsubscribe","href":"/api-reference/upcoming/subscription-management/public-unsubscribe"},{"title":"public/unsubscribe_all","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /public/unsubscribe_all","href":"/api-reference/upcoming/subscription-management/public-unsubscribe_all"}]},{"group":"Supporting","pages":[{"title":"public/get_time","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /public/get_time","href":"/api-reference/upcoming/supporting/public-get_time"},{"title":"public/hello","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /public/hello","href":"/api-reference/upcoming/supporting/public-hello"},{"title":"public/status","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /public/status","href":"/api-reference/upcoming/supporting/public-status"},{"title":"public/test","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /public/test","href":"/api-reference/upcoming/supporting/public-test"}]},{"group":"Trading","pages":[{"title":"private/buy","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/buy","href":"/api-reference/upcoming/trading/private-buy"},{"title":"private/cancel","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/cancel","href":"/api-reference/upcoming/trading/private-cancel"},{"title":"private/cancel_all","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/cancel_all","href":"/api-reference/upcoming/trading/private-cancel_all"},{"title":"private/cancel_all_by_currency","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/cancel_all_by_currency","href":"/api-reference/upcoming/trading/private-cancel_all_by_currency"},{"title":"private/cancel_all_by_currency_pair","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/cancel_all_by_currency_pair","href":"/api-reference/upcoming/trading/private-cancel_all_by_currency_pair"},{"title":"private/cancel_all_by_instrument","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/cancel_all_by_instrument","href":"/api-reference/upcoming/trading/private-cancel_all_by_instrument"},{"title":"private/cancel_all_by_kind_or_type","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/cancel_all_by_kind_or_type","href":"/api-reference/upcoming/trading/private-cancel_all_by_kind_or_type"},{"title":"private/cancel_by_label","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/cancel_by_label","href":"/api-reference/upcoming/trading/private-cancel_by_label"},{"title":"private/cancel_quotes","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/cancel_quotes","href":"/api-reference/upcoming/trading/private-cancel_quotes"},{"title":"private/close_position","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/close_position","href":"/api-reference/upcoming/trading/private-close_position"},{"title":"private/edit","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/edit","href":"/api-reference/upcoming/trading/private-edit"},{"title":"private/edit_by_label","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/edit_by_label","href":"/api-reference/upcoming/trading/private-edit_by_label"},{"title":"private/get_margins","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/get_margins","href":"/api-reference/upcoming/trading/private-get_margins"},{"title":"private/get_mmp_config","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/get_mmp_config","href":"/api-reference/upcoming/trading/private-get_mmp_config"},{"title":"private/get_mmp_status","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/get_mmp_status","href":"/api-reference/upcoming/trading/private-get_mmp_status"},{"title":"private/get_open_orders","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/get_open_orders","href":"/api-reference/upcoming/trading/private-get_open_orders"},{"title":"private/get_open_orders_by_currency","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/get_open_orders_by_currency","href":"/api-reference/upcoming/trading/private-get_open_orders_by_currency"},{"title":"private/get_open_orders_by_instrument","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/get_open_orders_by_instrument","href":"/api-reference/upcoming/trading/private-get_open_orders_by_instrument"},{"title":"private/get_open_orders_by_label","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/get_open_orders_by_label","href":"/api-reference/upcoming/trading/private-get_open_orders_by_label"},{"title":"private/get_order_history_by_currency","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/get_order_history_by_currency","href":"/api-reference/upcoming/trading/private-get_order_history_by_currency"},{"title":"private/get_order_history_by_instrument","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/get_order_history_by_instrument","href":"/api-reference/upcoming/trading/private-get_order_history_by_instrument"},{"title":"private/get_order_margin_by_ids","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/get_order_margin_by_ids","href":"/api-reference/upcoming/trading/private-get_order_margin_by_ids"},{"title":"private/get_order_state","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/get_order_state","href":"/api-reference/upcoming/trading/private-get_order_state"},{"title":"private/get_order_state_by_label","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/get_order_state_by_label","href":"/api-reference/upcoming/trading/private-get_order_state_by_label"},{"title":"private/get_settlement_history_by_currency","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/get_settlement_history_by_currency","href":"/api-reference/upcoming/trading/private-get_settlement_history_by_currency"},{"title":"private/get_settlement_history_by_instrument","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/get_settlement_history_by_instrument","href":"/api-reference/upcoming/trading/private-get_settlement_history_by_instrument"},{"title":"private/get_trigger_order_history","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/get_trigger_order_history","href":"/api-reference/upcoming/trading/private-get_trigger_order_history"},{"title":"private/get_user_trades_by_currency","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/get_user_trades_by_currency","href":"/api-reference/upcoming/trading/private-get_user_trades_by_currency"},{"title":"private/get_user_trades_by_currency_and_time","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/get_user_trades_by_currency_and_time","href":"/api-reference/upcoming/trading/private-get_user_trades_by_currency_and_time"},{"title":"private/get_user_trades_by_instrument","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/get_user_trades_by_instrument","href":"/api-reference/upcoming/trading/private-get_user_trades_by_instrument"},{"title":"private/get_user_trades_by_instrument_and_time","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/get_user_trades_by_instrument_and_time","href":"/api-reference/upcoming/trading/private-get_user_trades_by_instrument_and_time"},{"title":"private/get_user_trades_by_order","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/get_user_trades_by_order","href":"/api-reference/upcoming/trading/private-get_user_trades_by_order"},{"title":"private/mass_quote","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/mass_quote","href":"/api-reference/upcoming/trading/private-mass_quote"},{"title":"private/move_positions","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/move_positions","href":"/api-reference/upcoming/trading/private-move_positions"},{"title":"private/reset_mmp","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/reset_mmp","href":"/api-reference/upcoming/trading/private-reset_mmp"},{"title":"private/sell","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/sell","href":"/api-reference/upcoming/trading/private-sell"},{"title":"private/set_mmp_config","description":"Configures Market Maker Protection (MMP) for a specific index. This method sets the monitoring window, freeze duration, and exposure limits (quantity, delta, vega, and Maximum Quote Quantity).\n\nAt least one limit parameter must be set. Maximum Quote Quantity (MQQ) is a required parameter that limits the total combined size of open MMP orders. MQQ is configured per index but enforced per side, per order book (instrument).\n\nThe `interval` parameter defines the monitoring window duration in seconds. The `frozen_time` parameter sets how long MMP remains active after being triggered. Set `frozen_time` to `0` to disable automatic reset (manual reset required).\n\nFor Mass Quotes, use the `mmp_group` parameter to configure MMP for a specific group. Set `block_rfq` to `true` to configure MMP for Block RFQ (requires `block_rfq:read_write` scope). Set `interval` to `0` to remove MMP configuration.\n\n**MMP margin reservation (MQQ-based Initial Margin)**\n\nSetting a non-zero `max_quote_quantity` immediately reserves Initial Margin equal to `MQQ × 3%`. This reservation is **unconditional and continuous** — it is held from the moment the config is active regardless of whether you have any open positions or open orders. Multiple MMP groups on the same currency pair each contribute independently. The reserved margin is visible in the **Portfolio Margin** section of the platform.\n\n**To release the reserved margin**, remove the MMP configuration entirely by calling this method with `interval = 0`. Setting `interval` to `0` deletes the configuration entry for the specified `index_name` (and `mmp_group` if provided), which immediately frees all margin reserved by that config entry.\n\n**📖 Related Article:** [Market Maker Protection API Configuration](https://docs.deribit.com/articles/market-maker-protection)\n\n**Scope:** `trade:read_write` or `block_rfq:read_write` (when `block_rfq` = `true`)\n\n[Try in API console](https://test.deribit.com/api_console?method=%2Fprivate%2Fset_mmp_config)\n\n","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/set_mmp_config","href":"/api-reference/upcoming/trading/private-set_mmp_config"}]},{"group":"Wallet","pages":[{"title":"private/add_to_address_book","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/add_to_address_book","href":"/api-reference/upcoming/wallet/private-add_to_address_book"},{"title":"private/cancel_transfer_by_id","description":"Cancel a pending transfer by its ID. This method allows you to cancel a transfer that has not yet been processed. Once a transfer is processed, it cannot be cancelled.\n\n**📖 Related Article:** [Managing Transfers](https://docs.deribit.com/articles/managing-transfers-api)\n\n**Scope:** `wallet:read_write`\n\n[Try in API console](https://test.deribit.com/api_console?method=%2Fprivate%2Fcancel_transfer_by_id)\n\n","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/cancel_transfer_by_id","href":"/api-reference/upcoming/wallet/private-cancel_transfer_by_id"},{"title":"private/cancel_withdrawal","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/cancel_withdrawal","href":"/api-reference/upcoming/wallet/private-cancel_withdrawal"},{"title":"private/coinbase/estimate_withdrawal_fee","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/coinbase/estimate_withdrawal_fee","href":"/api-reference/upcoming/wallet/private-estimate_withdrawal_fee"},{"title":"private/create_deposit_address","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/create_deposit_address","href":"/api-reference/upcoming/wallet/private-create_deposit_address"},{"title":"private/delete_address_beneficiary","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/delete_address_beneficiary","href":"/api-reference/upcoming/wallet/private-delete_address_beneficiary"},{"title":"private/get_address_beneficiary","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/get_address_beneficiary","href":"/api-reference/upcoming/wallet/private-get_address_beneficiary"},{"title":"private/get_address_book","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/get_address_book","href":"/api-reference/upcoming/wallet/private-get_address_book"},{"title":"private/get_ctn_id","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/get_ctn_id","href":"/api-reference/upcoming/wallet/private-get_ctn_id"},{"title":"private/get_current_deposit_address","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/get_current_deposit_address","href":"/api-reference/upcoming/wallet/private-get_current_deposit_address"},{"title":"private/get_deposits","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/get_deposits","href":"/api-reference/upcoming/wallet/private-get_deposits"},{"title":"private/get_reward_eligibility","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/get_reward_eligibility","href":"/api-reference/upcoming/wallet/private-get_reward_eligibility"},{"title":"private/get_transfers","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/get_transfers","href":"/api-reference/upcoming/wallet/private-get_transfers"},{"title":"private/get_withdrawals","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/get_withdrawals","href":"/api-reference/upcoming/wallet/private-get_withdrawals"},{"title":"private/list_address_beneficiaries","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/list_address_beneficiaries","href":"/api-reference/upcoming/wallet/private-list_address_beneficiaries"},{"title":"private/remove_from_address_book","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/remove_from_address_book","href":"/api-reference/upcoming/wallet/private-remove_from_address_book"},{"title":"private/save_address_beneficiary","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/save_address_beneficiary","href":"/api-reference/upcoming/wallet/private-save_address_beneficiary"},{"title":"private/set_address_requires_security_key","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/set_address_requires_security_key","href":"/api-reference/upcoming/wallet/private-set_address_requires_security_key"},{"title":"private/set_clearance_originator","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/set_clearance_originator","href":"/api-reference/upcoming/wallet/private-set_clearance_originator"},{"title":"private/set_coinbase_subaccount_withdrawals_allowed","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/set_coinbase_subaccount_withdrawals_allowed","href":"/api-reference/upcoming/wallet/private-set_coinbase_subaccount_withdrawals_allowed"},{"title":"private/submit_transfer_between_subaccounts","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/submit_transfer_between_subaccounts","href":"/api-reference/upcoming/wallet/private-submit_transfer_between_subaccounts"},{"title":"private/submit_transfer_to_subaccount","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/submit_transfer_to_subaccount","href":"/api-reference/upcoming/wallet/private-submit_transfer_to_subaccount"},{"title":"private/submit_transfer_to_user","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/submit_transfer_to_user","href":"/api-reference/upcoming/wallet/private-submit_transfer_to_user"},{"title":"private/update_in_address_book","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/update_in_address_book","href":"/api-reference/upcoming/wallet/private-update_in_address_book"},{"title":"private/withdraw","deprecated":null,"version":null,"openapi":"/specifications/deribit_upcoming_openapi.json get /private/withdraw","href":"/api-reference/upcoming/wallet/private-withdraw"}]}]}]},{"dropdown":"Subscription Channels","icon":"rss","groups":[{"group":"Introduction","pages":[{"title":"Notifications","href":"/articles/notifications"}]},{"group":"Websockets","pages":[{"group":"Platform","pages":[{"asyncapi":"specifications/deribit_upcoming_asyncapi.json platform_state","href":"/subscriptions/upcoming/platform/platform_state","title":"platform_state ","version":null},{"asyncapi":"specifications/deribit_upcoming_asyncapi.json platform_state.public_methods_state","href":"/subscriptions/upcoming/platform/platform_statepublic_methods_state","title":"platform_state.public_methods_state ","version":null}]},{"group":"Announcements","pages":[{"asyncapi":"specifications/deribit_upcoming_asyncapi.json announcements","href":"/subscriptions/upcoming/announcements/announcements","title":"announcements ","version":null}]},{"group":"Orderbook","pages":[{"asyncapi":"specifications/deribit_upcoming_asyncapi.json book.(instrument_name).(interval)","href":"/subscriptions/upcoming/orderbook/bookinstrument_nameinterval","title":"book.(instrument_name).(interval) ","version":null},{"asyncapi":"specifications/deribit_upcoming_asyncapi.json book.(instrument_name).(group).(depth).(interval)","href":"/subscriptions/upcoming/orderbook/bookinstrument_namegroupdepthinterval","title":"book.(instrument_name).(group).(depth).(interval) ","version":null}]},{"group":"Market Data","pages":[{"asyncapi":"specifications/deribit_upcoming_asyncapi.json ticker.(instrument_name).(interval)","href":"/subscriptions/upcoming/market-data/tickerinstrument_nameinterval","title":"ticker.(instrument_name).(interval) ","version":null},{"asyncapi":"specifications/deribit_upcoming_asyncapi.json incremental_ticker.(instrument_name)","href":"/subscriptions/upcoming/market-data/incremental_tickerinstrument_name","title":"incremental_ticker.(instrument_name) ","version":null},{"asyncapi":"specifications/deribit_upcoming_asyncapi.json perpetual.(instrument_name).(interval)","href":"/subscriptions/upcoming/market-data/perpetualinstrument_nameinterval","title":"perpetual.(instrument_name).(interval) ","version":null},{"asyncapi":"specifications/deribit_upcoming_asyncapi.json quote.(instrument_name)","href":"/subscriptions/upcoming/market-data/quoteinstrument_name","title":"quote.(instrument_name) ","version":null},{"asyncapi":"specifications/deribit_upcoming_asyncapi.json deribit_price_index.(index_name)","href":"/subscriptions/upcoming/market-data/deribit_price_indexindex_name","title":"deribit_price_index.(index_name) ","version":null},{"asyncapi":"specifications/deribit_upcoming_asyncapi.json deribit_price_ranking.(index_name)","href":"/subscriptions/upcoming/market-data/deribit_price_rankingindex_name","title":"deribit_price_ranking.(index_name) ","version":null},{"asyncapi":"specifications/deribit_upcoming_asyncapi.json deribit_price_statistics.(index_name)","href":"/subscriptions/upcoming/market-data/deribit_price_statisticsindex_name","title":"deribit_price_statistics.(index_name) ","version":null},{"asyncapi":"specifications/deribit_upcoming_asyncapi.json deribit_volatility_index.(index_name)","href":"/subscriptions/upcoming/market-data/deribit_volatility_indexindex_name","title":"deribit_volatility_index.(index_name) ","version":null},{"asyncapi":"specifications/deribit_upcoming_asyncapi.json markprice.options.(index_name)","href":"/subscriptions/upcoming/market-data/markpriceoptionsindex_name","title":"markprice.options.(index_name) ","version":null},{"asyncapi":"specifications/deribit_upcoming_asyncapi.json estimated_expiration_price.(index_name)","href":"/subscriptions/upcoming/market-data/estimated_expiration_priceindex_name","title":"estimated_expiration_price.(index_name) ","version":null},{"asyncapi":"specifications/deribit_upcoming_asyncapi.json chart.trades.(instrument_name).(resolution)","href":"/subscriptions/upcoming/market-data/charttradesinstrument_nameresolution","title":"chart.trades.(instrument_name).(resolution) ","version":null},{"asyncapi":"specifications/deribit_upcoming_asyncapi.json instrument.creation.(kind).(currency)","href":"/subscriptions/upcoming/market-data/instrumentcreationkindcurrency","title":"instrument.creation.(kind).(currency) ","version":null},{"asyncapi":"specifications/deribit_upcoming_asyncapi.json instrument.state.(kind).(currency)","href":"/subscriptions/upcoming/market-data/instrumentstatekindcurrency","title":"instrument.state.(kind).(currency) ","version":null}]},{"group":"Trades","pages":[{"asyncapi":"specifications/deribit_upcoming_asyncapi.json trades.(instrument_name).(interval)","href":"/subscriptions/upcoming/trades/tradesinstrument_nameinterval","title":"trades.(instrument_name).(interval) ","version":null},{"asyncapi":"specifications/deribit_upcoming_asyncapi.json trades.(kind).(currency).(interval)","href":"/subscriptions/upcoming/trades/tradeskindcurrencyinterval","title":"trades.(kind).(currency).(interval) ","version":null}]},{"group":"Block Trade","pages":[{"asyncapi":"specifications/deribit_upcoming_asyncapi.json block_trade_confirmations","href":"/subscriptions/upcoming/block-trade/block_trade_confirmations","title":"block_trade_confirmations ","version":null},{"asyncapi":"specifications/deribit_upcoming_asyncapi.json block_trade_confirmations.(currency)","href":"/subscriptions/upcoming/block-trade/block_trade_confirmationscurrency","title":"block_trade_confirmations.(currency) ","version":null}]},{"group":"User","pages":[{"asyncapi":"specifications/deribit_upcoming_asyncapi.json user.mmp_trigger.(index_name)","href":"/subscriptions/upcoming/user/usermmp_triggerindex_name","title":"user.mmp_trigger.(index_name) ","version":null},{"asyncapi":"specifications/deribit_upcoming_asyncapi.json user.portfolio.(currency)","href":"/subscriptions/upcoming/user/userportfoliocurrency","title":"user.portfolio.(currency) ","version":null},{"asyncapi":"specifications/deribit_upcoming_asyncapi.json user.trades.(instrument_name).(interval)","href":"/subscriptions/upcoming/user/usertradesinstrument_nameinterval","title":"user.trades.(instrument_name).(interval) ","version":null},{"asyncapi":"specifications/deribit_upcoming_asyncapi.json user.trades.(kind).(currency).(interval)","href":"/subscriptions/upcoming/user/usertradeskindcurrencyinterval","title":"user.trades.(kind).(currency).(interval) ","version":null},{"asyncapi":"specifications/deribit_upcoming_asyncapi.json user.combo_trades.(instrument_name).(interval)","href":"/subscriptions/upcoming/user/usercombo_tradesinstrument_nameinterval","title":"user.combo_trades.(instrument_name).(interval) ","version":null},{"asyncapi":"specifications/deribit_upcoming_asyncapi.json user.combo_trades.(kind).(currency).(interval)","href":"/subscriptions/upcoming/user/usercombo_tradeskindcurrencyinterval","title":"user.combo_trades.(kind).(currency).(interval) ","version":null},{"asyncapi":"specifications/deribit_upcoming_asyncapi.json user.orders.(instrument_name).raw","href":"/subscriptions/upcoming/user/userordersinstrument_nameraw","title":"user.orders.(instrument_name).raw ","version":null},{"asyncapi":"specifications/deribit_upcoming_asyncapi.json user.orders.(instrument_name).(interval)","href":"/subscriptions/upcoming/user/userordersinstrument_nameinterval","title":"user.orders.(instrument_name).(interval) ","version":null},{"asyncapi":"specifications/deribit_upcoming_asyncapi.json user.orders.(kind).(currency).raw","href":"/subscriptions/upcoming/user/userorderskindcurrencyraw","title":"user.orders.(kind).(currency).raw ","version":null},{"asyncapi":"specifications/deribit_upcoming_asyncapi.json user.orders.(kind).(currency).(interval)","href":"/subscriptions/upcoming/user/userorderskindcurrencyinterval","title":"user.orders.(kind).(currency).(interval) ","version":null},{"asyncapi":"specifications/deribit_upcoming_asyncapi.json user.changes.(instrument_name).(interval)","href":"/subscriptions/upcoming/user/userchangesinstrument_nameinterval","title":"user.changes.(instrument_name).(interval) ","version":null},{"asyncapi":"specifications/deribit_upcoming_asyncapi.json user.changes.(kind).(currency).(interval)","href":"/subscriptions/upcoming/user/userchangeskindcurrencyinterval","title":"user.changes.(kind).(currency).(interval) ","version":null},{"asyncapi":"specifications/deribit_upcoming_asyncapi.json user.access_log","href":"/subscriptions/upcoming/user/useraccess_log","title":"user.access_log ","version":null},{"asyncapi":"specifications/deribit_upcoming_asyncapi.json user.lock","href":"/subscriptions/upcoming/user/userlock","title":"user.lock ","version":null},{"asyncapi":"specifications/deribit_upcoming_asyncapi.json user.liquidation","href":"/subscriptions/upcoming/user/userliquidation","title":"user.liquidation ","version":null},{"asyncapi":"specifications/deribit_upcoming_asyncapi.json user.isolated.liquidation","href":"/subscriptions/upcoming/user/userisolatedliquidation","title":"user.isolated.liquidation ","version":null},{"asyncapi":"specifications/deribit_upcoming_asyncapi.json user.lsp","href":"/subscriptions/upcoming/user/userlsp","title":"user.lsp ","version":null}]},{"group":"Block RFQ","pages":[{"asyncapi":"specifications/deribit_upcoming_asyncapi.json block_rfq.maker.(currency)","href":"/subscriptions/upcoming/block-rfq/block_rfqmakercurrency","title":"block_rfq.maker.(currency) ","version":null},{"asyncapi":"specifications/deribit_upcoming_asyncapi.json block_rfq.taker.(currency)","href":"/subscriptions/upcoming/block-rfq/block_rfqtakercurrency","title":"block_rfq.taker.(currency) ","version":null},{"asyncapi":"specifications/deribit_upcoming_asyncapi.json block_rfq.maker.quotes.(currency)","href":"/subscriptions/upcoming/block-rfq/block_rfqmakerquotescurrency","title":"block_rfq.maker.quotes.(currency) ","version":null},{"asyncapi":"specifications/deribit_upcoming_asyncapi.json block_rfq.trades.(currency)","href":"/subscriptions/upcoming/block-rfq/block_rfqtradescurrency","title":"block_rfq.trades.(currency) ","version":null}]}]}]},{"dropdown":"FIX API","icon":"bolt","pages":[{"group":"Overview","pages":[{"title":"Deribit Upcoming FIX API Overview","mode":"wide","href":"/fix-api/upcoming/overview"}]},{"group":"Session Management","pages":[{"title":"Logon(A) (Upcoming FIX API)","mode":"wide","href":"/fix-api/upcoming/logon"},{"title":"Logout(5) (Upcoming FIX API)","mode":"wide","href":"/fix-api/upcoming/logout"},{"title":"Heartbeat(0) (Upcoming FIX API)","mode":"wide","href":"/fix-api/upcoming/heartbeat"},{"title":"Test Request(1) (Upcoming FIX API)","mode":"wide","href":"/fix-api/upcoming/test-request"},{"title":"Resend Request(2) (Upcoming FIX API)","mode":"wide","href":"/fix-api/upcoming/resend-request"},{"title":"Reject(3) (Upcoming FIX API)","mode":"wide","href":"/fix-api/upcoming/reject"},{"title":"Sequence Reset(4) (Upcoming FIX API)","mode":"wide","href":"/fix-api/upcoming/sequence-reset"}]},{"group":"Market Data","pages":[{"title":"Security List Request(x) (Upcoming FIX API)","mode":"wide","href":"/fix-api/upcoming/security-list-request"},{"title":"Security List(y) (Upcoming FIX API)","mode":"wide","href":"/fix-api/upcoming/security-list"},{"title":"Market Data Request(V) (Upcoming FIX API)","mode":"wide","href":"/fix-api/upcoming/market-data-request"},{"title":"Market Data Request Reject(Y) (Upcoming FIX API)","mode":"wide","href":"/fix-api/upcoming/market-data-request-reject"},{"title":"Market Data Snapshot/Full Refresh(W) (Upcoming FIX API)","mode":"wide","href":"/fix-api/upcoming/market-data-snapshot"},{"title":"Market Data Incremental Refresh(X) (Upcoming FIX API)","mode":"wide","href":"/fix-api/upcoming/market-data-incremental"},{"title":"Security Status Request(e) (Upcoming FIX API)","mode":"wide","href":"/fix-api/upcoming/security-status-request"},{"title":"Security Status(f) (Upcoming FIX API)","mode":"wide","href":"/fix-api/upcoming/security-status"}]},{"group":"Order Management","pages":[{"title":"New Order Single(D) (Upcoming FIX API)","mode":"wide","href":"/fix-api/upcoming/new-order-single"},{"title":"Order Cancel Request(F) (Upcoming FIX API)","mode":"wide","href":"/fix-api/upcoming/order-cancel-request"},{"title":"Order Cancel Reject(9) (Upcoming FIX API)","mode":"wide","href":"/fix-api/upcoming/order-cancel-reject"},{"title":"Order Cancel/Replace Request(G) (Upcoming FIX API)","mode":"wide","href":"/fix-api/upcoming/order-cancel-replace"},{"title":"Order Mass Cancel Request(q) (Upcoming FIX API)","mode":"wide","href":"/fix-api/upcoming/order-mass-cancel-request"},{"title":"Order Mass Cancel Report(r) (Upcoming FIX API)","mode":"wide","href":"/fix-api/upcoming/order-mass-cancel-report"},{"title":"Order Mass Status Request(AF) (Upcoming FIX API)","mode":"wide","href":"/fix-api/upcoming/order-mass-status-request"},{"title":"Execution Reports(8) (Upcoming FIX API)","mode":"wide","href":"/fix-api/upcoming/execution-reports"}]},{"group":"Position Management","pages":[{"title":"Request For Positions(AN) (Upcoming FIX API)","mode":"wide","href":"/fix-api/upcoming/request-for-positions"},{"title":"Position Report(AP) (Upcoming FIX API)","mode":"wide","href":"/fix-api/upcoming/position-report"}]},{"group":"User Management","pages":[{"title":"User Request(BE) (Upcoming FIX API)","mode":"wide","href":"/fix-api/upcoming/user-request"},{"title":"User Response(BF) (Upcoming FIX API)","mode":"wide","href":"/fix-api/upcoming/user-response"}]},{"group":"Market Maker Protection","pages":[{"title":"MMProtection Limits (MM) (Upcoming FIX API)","mode":"wide","href":"/fix-api/upcoming/mmprotection-limits"},{"title":"MMProtection Limits Result/Reject(MR) (Upcoming FIX API)","mode":"wide","href":"/fix-api/upcoming/mmprotection-limits-result"},{"title":"MMProtection Reset(MZ) (Upcoming FIX API)","mode":"wide","href":"/fix-api/upcoming/mmprotection-reset"}]},{"group":"Mass Quoting","pages":[{"title":"Mass Quote(i) (Upcoming FIX API)","mode":"wide","href":"/fix-api/upcoming/mass-quote"},{"title":"Mass Quote Acknowledgement(b) (Upcoming FIX API)","mode":"wide","href":"/fix-api/upcoming/mass-quote-acknowledgement"},{"title":"Quote Cancel(Z) (Upcoming FIX API)","mode":"wide","href":"/fix-api/upcoming/quote-cancel"}]},{"group":"Trade Capture","pages":[{"title":"TradeCaptureReportRequest(AD) (Upcoming FIX API)","mode":"wide","href":"/fix-api/upcoming/trade-capture-report-request"},{"title":"TradeCaptureReportRequestAck(AQ) (Upcoming FIX API)","mode":"wide","href":"/fix-api/upcoming/trade-capture-report-request-ack"},{"title":"TradeCaptureReport(AE) (Upcoming FIX API)","mode":"wide","href":"/fix-api/upcoming/trade-capture-report"}]},{"group":"Security Definition","pages":[{"title":"Security Definition Request(c) (Upcoming FIX API)","mode":"wide","href":"/fix-api/upcoming/security-definition-request"},{"title":"Security Definition(d) (Upcoming FIX API)","mode":"wide","href":"/fix-api/upcoming/security-definition"}]}]},{"dropdown":"Starbase API","icon":"rocket","pages":[{"group":"Introduction","pages":[{"title":"Starbase API Overview","mode":"wide","href":"/starbase/overview"},{"title":"Starbase Connectivity Quickstart","mode":"wide","href":"/starbase/quickstart"},{"title":"Creating and Assigning a Member","mode":"wide","href":"/starbase/creating-member"},{"title":"Creating a Starbase API Key","mode":"wide","href":"/starbase/creating-api-key"},{"title":"Production Readiness Checklist","mode":"wide","href":"/starbase/production-readiness-checklist"},{"title":"Infrastructure, Connectivity \u0026 Best Practices","mode":"wide","href":"/starbase/connectivity-best-practices"}]},{"group":"API Reference","pages":[{"title":"Binary API Reference","mode":"wide","href":"/starbase/upcoming/binary-api-reference"},{"group":"Session Messages","expanded":false,"pages":[{"title":"Starbase Session Messages","mode":"wide","href":"/starbase/session-messages"}]},{"group":"Order Entry Messages","expanded":false,"pages":[{"title":"Placing a New Order","mode":"wide","href":"/starbase/placing-new-order"},{"title":"Amending an Order","mode":"wide","href":"/starbase/upcoming/amending-order"},{"title":"Cancelling an Order","mode":"wide","href":"/starbase/cancelling-order"},{"title":"Mass Quotes","mode":"wide","href":"/starbase/upcoming/mass-quotes"},{"title":"Starbase Mass Cancel Messages","mode":"wide","href":"/starbase/mass-cancel"}]},{"group":"Market Data Messages","expanded":false,"pages":[{"title":"Maintaining the order book","mode":"wide","href":"/starbase/order-book-maintenance"},{"title":"Trades","mode":"wide","href":"/starbase/trades"},{"title":"Starbase Reference Data and Instrument Definitions","mode":"wide","href":"/starbase/reference-data"}]},{"group":"Unsolicited Events","expanded":false,"pages":[{"title":"Starbase Unsolicited Events","mode":"wide","href":"/starbase/unsolicited-events"}]},{"group":"REST API","expanded":true,"pages":[{"title":"REST Order Gateway Authentication","mode":"wide","href":"/starbase/rest-authentication"},{"title":"Get Open Orders","deprecated":null,"version":null,"openapi":"/specifications/starbase_rest_openapi.json get /api/v2/private/get_open_orders","href":"/api-reference/trading/get-open-orders"},{"title":"Get Starbase Risk Limits","deprecated":null,"version":null,"openapi":"/specifications/starbase_rest_openapi.json get /api/v2/private/get_starbase_risk_limits","href":"/api-reference/portfolio-management/get-starbase-risk-limits"},{"title":"Mass Cancel","deprecated":null,"version":null,"openapi":"/specifications/starbase_rest_openapi.json get /api/v2/private/cancel_all","href":"/api-reference/portfolio-management/mass-cancel"},{"title":"Lock Portfolio","deprecated":null,"version":null,"openapi":"/specifications/starbase_rest_openapi.json get /api/v2/private/lock_portfolio","href":"/api-reference/portfolio-management/lock-portfolio"},{"title":"Unlock Portfolio","deprecated":null,"version":null,"openapi":"/specifications/starbase_rest_openapi.json get /api/v2/private/unlock_portfolio","href":"/api-reference/portfolio-management/unlock-portfolio"},{"title":"List Instruments","deprecated":null,"version":null,"openapi":"/specifications/starbase_rest_openapi.json get /api/v2/public/get_instruments","href":"/api-reference/market-data/list-instruments"}]},{"group":"FIX Drop Copy","expanded":false,"pages":[{"title":"Starbase FIX Drop Copy API","mode":"wide","href":"/starbase/fix-drop-copy-api"}]}]},{"group":"Core Concepts","pages":[{"title":"Market Model","mode":"wide","href":"/starbase/market-model"},{"title":"Account Model","mode":"wide","href":"/starbase/account-model"},{"title":"Underlying Tiers","mode":"wide","href":"/starbase/underlying-tiers"},{"title":"Speed Bumps","mode":"wide","href":"/starbase/upcoming/speed-bumps"},{"title":"Starbase Market Maker Protection (MMP)","mode":"wide","href":"/starbase/mmp"},{"title":"Self Match Prevention (SMP)","mode":"wide","href":"/starbase/smp"},{"title":"Portfolio Management","mode":"wide","href":"/starbase/portfolio-management"}]},{"group":"Technical Information","pages":[{"title":"Starbase API Rate Limits","href":"/starbase/api-rate-limits"},{"title":"Risk Bypass","mode":"wide","href":"/starbase/risk-bypass"},{"title":"Cancel on Disconnect","mode":"wide","href":"/starbase/cancel-on-disconnect"},{"title":"Gateway Connectivity","mode":"wide","href":"/starbase/gateway-connectivity"},{"title":"Multicast Channels","mode":"wide","href":"/starbase/multicast-channels"},{"title":"Multicast Subscription Guide","href":"/starbase/multicast-subscription-guide"},{"title":"Multicast Retransmit Gateway","href":"/starbase/retransmit-gateway"}]}]}]},{"tab":"Changelogs","pages":[{"title":"Changelogs","href":"/changelogs/jsonrpc"}]}]}]},"basePath":"","title":"private/add_to_address_book","deploymentId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","buildId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CiUHMMOm.js","snippetPresets-BgfXU7Bw.js","utils-DWvOwgy_.js","style-to-object-BY3JEAdk.js","utils-BN7RXSMJ.js","v4-DIgz8zy6.js","addUniqueKeysToSchema-CFw8bq89.js","conditional-requirements-CFM0id0Q.js","cloneDeep-CAwdfOU2.js","_Uint8Array-BJr8e-ZL.js","isObject-FP1Yky1u.js","ApiExamples-XX0UgMZK.js","usePlaygroundInputsStore-DXDFSa1V.js","shallow-CdX5aREi.js","isEqual-CoOaxexF.js","CodeSnippets-Cg2wpzWm.js","CodeSnippet-D_HwgQO_.js","getApiPlaygroundDisplay-CmCoerhe.js","Page-CVJ-f_k1.js","DynamicMarkdown-CQM9Bhbv.js","SectionHeading-DpbrP8nQ.js","icon-BPCgijHy.js","MethodPill-GQ8DuY0c.js","getPastedJson-Cb5mT31m.js","Check2Icon-a7bUI6e8.js","axios-CsQoIw0U.js","Markdown-CX2QY19L.js","AssistantPageLink-CY3bFglh.js","dist-Dl6_zDnT.js","lib-DMeTj1gb.js","lib-B8HbPgcC.js","katex-Dbtb6Wk7.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js"]}