How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Deribit

Deribit Wallet API

The Wallet API from Deribit — 21 operation(s) for wallet.

Documentation Provider Profile APIs.io OpenAPI GitHub

Deribit Wallet API is one of 19 APIs that Deribit publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Wallets. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, and rate-limit docs.

This API exposes 21 operations across 21 paths, and defines 58 schemas. It is described by OpenAPI 3.0.0, at version 2.1.1.

Requests are made against a single base URL, https://test.deribit.com/api/v2.

21 operations 21 paths 58 schemas 21 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
2.1.1
Base URL
https://www.deribit.com/api/v2
Resource Areas
1

Paths & Operations 21

Across 21 paths, the API surfaces 21 operations — 21 GET. Each is listed below with its method, path, parameters, and response codes.

Wallet 21
GET
/private/get_deposits
Retrieve the latest user deposits. Returns a list of deposit transactions with their status, amounts, addresses, confirmations, and other relevant details. 📖 Related Article: [Managing Deposits](http…
3 params body → 200
GET
/private/create_deposit_address
Creates a new deposit address for the specified currency. Each currency can have multiple deposit addresses. Use this method to generate a new address for receiving deposits. Note: For Bitcoin, a new…
1 param body → 200
GET
/private/get_current_deposit_address
Retrieve the current deposit address for the specified currency. Returns the most recently created or used deposit address for receiving funds. 📖 Related Article: [Managing Deposits](https://docs.der…
1 param body → 200
GET
/private/withdraw
Creates a new withdrawal request. This method allows you to withdraw funds from your account to an external address. The withdrawal can be configured with priority settings and must use an address fr…
5 params body → 200
GET
/private/cancel_withdrawal
Cancels a pending withdrawal request. This method allows you to cancel a withdrawal that has not yet been processed. Once a withdrawal is processed, it cannot be cancelled. 📖 Related Article: [Managi…
2 params body → 200
GET
/private/get_withdrawals
Retrieve the latest user withdrawals. Returns a list of withdrawal requests with their status, amounts, addresses, and other relevant details. 📖 Related Article: [Managing Withdrawals](https://docs.d…
3 params body → 200
GET
/private/get_address_book
Retrieves the address book entries of the given type. Returns all saved addresses that can be used for withdrawals, along with their labels and beneficiary information if available. 📖 Related Article…
2 params body → 200
GET
/private/add_to_address_book
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. 📖 Related Article: [Managing Withdr…
14 params body → 200
GET
/private/remove_from_address_book
Removes an entry from the address book. This method allows you to delete a saved address that is no longer needed. 📖 Related Article: [Managing Withdrawals](https://docs.deribit.com/articles/managing…
3 params body → 200
GET
/private/update_in_address_book
Updates beneficiary information for an address in the address book. This method allows you to add or modify beneficiary details required for compliance purposes when making withdrawals to certain add…
13 params body → 200
GET
/private/save_address_beneficiary
Saves beneficiary information for an address. This method allows you to store beneficiary details required for compliance purposes, including VASP information, personal details, and wallet type class…
13 params body → 200
GET
/private/get_address_beneficiary
Retrieves beneficiary information for a specific address. Returns the stored beneficiary details including VASP information, personal details, and wallet type classification. 📖 Related Article: [Mana…
3 params body → 200
GET
/private/delete_address_beneficiary
Deletes beneficiary information for a specific address. 📖 Related Article: [Managing Withdrawals](https://docs.deribit.com/articles/managing-withdrawals-api) Scope: wallet:readwrite [Try in API conso…
3 params body → 200
GET
/private/list_address_beneficiaries
Lists address beneficiaries with optional filtering and pagination. Returns all saved beneficiary information for addresses, with support for filtering by currency, address, wallet type, VASP details…
14 params body → 200
GET
/private/submit_transfer_to_subaccount
Transfer funds from the main account to a subaccount. 📖 Related Article: [Managing Transfers](https://docs.deribit.com/articles/managing-transfers-api) Scope: wallets:readwrite [Try in API console](h…
3 params body → 200
GET
/private/submit_transfer_between_subaccounts
Transfer funds between two subaccounts or between a subaccount and the main account. 📖 Related Article: [Managing Transfers](https://docs.deribit.com/articles/managing-transfers-api) Scope: wallets:r…
5 params body → 200
GET
/private/submit_transfer_to_user
Transfer funds to another user. This method allows you to send funds from your main account to another Deribit user's account. The transfer is processed internally and does not require blockchain tra…
3 params body → 200
GET
/private/get_transfers
Retrieve the user's transfers list. Returns a list of internal transfers between accounts, subaccounts, or to other users, including their status, amounts, and other relevant details. 📖 Related Artic…
3 params body → 200
GET
/private/cancel_transfer_by_id
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. 📖 Related Article: [Managing Tr…
2 params body → 200
GET
/private/get_reward_eligibility
Returns reward eligibility status and APR data for all supported currencies. This method takes no parameters. 📖 Related Support Article: [Yield reward-bearing coins](https://support.deribit.com/hc/en…
body → 200
GET
/private/set_clearance_originator
Sets originator of the deposit Scope: wallet:readwrite [Try in API console](https://test.deribit.com/apiconsole?method=%2Fprivate%2Fsetclearanceoriginator)
2 params body → 200

Schemas 58

The contract defines 58 schemas that model the data the API accepts and returns. The most detailed are address_book_item (19 properties), address_beneficiary_item (16 properties), withdrawal (12 properties), deposit (11 properties). Each schema is shown below with its type and property counts.

deposit_state
string
Deposit state. Allowed values: pending : deposit detected on blockchain/system, compliance not yet finished completed : compliance check finished successfully…
PrivateRemoveFromAddressBookResponse
object
3 properties 2 required
PrivateSubmitTransferResponse
object
3 properties 2 required
PrivateDepositAddressResponse
object
3 properties 2 required
wallet_address_type
string
Address type/purpose, allowed values : deposit
PrivateGetDepositsResponse
object
3 properties 2 required
currency_amount
number
Amount of funds in given currency
transfer_state
string
Transfer state, allowed values : prepared, confirmed, cancelled, waitingforadmin, insufficientfunds, withdrawallimit otherwise rejection reason
beneficiary_vasp_name
string
Name of beneficiary VASP
continuation
string
Continuation token for pagination.
PrivateAddressBookResponse
object
3 properties 2 required
beneficiary_company_name
string
Company name of the beneficiary (if beneficiary is a company)
clearance_state
string
Clearance state indicating the current status of the transaction clearance process. Allowed values: inprogress : clearance process is in progress pendingadmind…
PrivateDeleteAddressBeneficiaryResponse
object
3 properties 2 required
timestamp
integer
The timestamp (milliseconds since the Unix epoch)
transfer_other_side
string
For transfer from/to subaccount returns this subaccount name, for transfer to other account returns address, for transfer from other account returns that accou…
beneficiary_vasp_did
string
DID of beneficiary VASP
transfer_type
string
Type of transfer: user - sent to user, subaccount - sent to subaccount
deposit
object
11 properties 7 required
PrivateAddToAddressBookResponse
object
3 properties 2 required
currency_address
string
Address in proper format for currency
currency_transaction_id
string
Transaction id in proper format for currency, null if id is not available
address_label
string
Label of the address book entry
result_count
integer
Total number of results available
currency
string
Currency, i.e "BTC", "ETH", "USDC"
address_beneficiary_item
object
16 properties 11 required
requires_confirmation
boolean
If address requires email confirmation for withdrawals
transfer_direction
string
Transfer direction
PrivateUpdateInAddressBookResponse
object
3 properties 2 required
agree_to_share_with_3rd_party
boolean
Indicates that the user agreed to shared provided information with 3rd parties
waiting_timestamp
boolean
Timestamp when the address will be ready
beneficiary_first_name
string
First name of the beneficiary (if beneficiary is a person)
beneficiary_address
string
Geographical address of the beneficiary
transfer_id
integer
Id of transfer
withdrawal_state
string
Withdrawal state, allowed values : unconfirmed, confirmed, cancelled, completed, interrupted, rejected
user_id
integer
Unique user identifier
beneficiary_last_name
string
Last name of the beneficiary (if beneficiary is a person)
PrivateWithdrawResponse
object
3 properties 2 required
PrivateListAddressBeneficiariesResponse
object
3 properties 2 required
PrivateGetTransfersResponse
object
3 properties 2 required
address_book_item
object
19 properties 3 required
requires_confirmation_change
boolean
If email confirmation change is in progress
wallet_currency
string
Currency, i.e "BTC", "ETH", "USDC"
nonce
string
Nonce
address_book_type
string
Address book type
extra_currencies
array
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…
fee
number
Fee in currency
beneficiary_vasp_website
string
Website of the beneficiary VASP
PrivateGetAddressBeneficiaryResponse
object
3 properties 2 required
PrivateSaveAddressBeneficiaryResponse
object
3 properties 2 required
PrivateGetRewardEligibilityResponse
object
3 properties 2 required
withdrawal
object
12 properties 6 required
transfer_item
object
10 properties 8 required
unhosted_wallet
boolean
Indicates if the address belongs to an unhosted wallet
PrivateGetWithdrawalsResponse
object
3 properties 2 required
address_info_required
boolean
Signalises that addition information regarding the beneficiary of the address is required
personal_wallet
boolean
The user confirms that he provided address belongs to him and he has access to it via an un-hosted wallet software
status
string
Wallet address status, values: [adminlocked, waiting, confirmed, ready]

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

deribit-wallet-api-openapi.yml Raw ↑

Other APIs Deribit publishes across the network.

Deribit WebSocket API
AE Profile APIs.io
Deribit FIX API
AE Profile APIs.io
Deribit Account Management API
AE Profile APIs.io
Deribit Authentication API
AE Profile APIs.io
Deribit Block RFQ API
AE Profile APIs.io
Deribit Block Trade API
AE Profile APIs.io
Deribit Combo Books API
AE Profile APIs.io
Deribit Mark Price API
AE Profile APIs.io
Deribit Market Data API
AE Profile APIs.io
Deribit Matching Engine API
AE Profile APIs.io
Deribit Portfolio Management API
AE Profile APIs.io
Deribit Private API
AE Profile APIs.io
#Wallets
← Back to D APIs
API Details
ID
deribit:deribit-wallet-api
Base URL
https://www.deribit.com/api/v2
Docs
https://docs.deribit.com/
Provider
Deribit
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=deribit-wallet-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/deribit-wallet-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Deribit Wallet API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.