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

Deribit Wallet API

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

Deribit Wallet API is one of 14 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.2.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.2.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
Get private get deposits
getPrivateGetDeposits 3 params body → 200
GET
/private/create_deposit_address
Get private create deposit address
getPrivateCreateDepositAddress 1 param body → 200
GET
/private/get_current_deposit_address
Get private get current deposit address
getPrivateGetCurrentDepositAddress 1 param body → 200
GET
/private/withdraw
Get private withdraw
getPrivateWithdraw 5 params body → 200
GET
/private/cancel_withdrawal
Get private cancel withdrawal
getPrivateCancelWithdrawal 2 params body → 200
GET
/private/get_withdrawals
Get private get withdrawals
getPrivateGetWithdrawals 3 params body → 200
GET
/private/get_address_book
Get private get address book
getPrivateGetAddressBook 2 params body → 200
GET
/private/add_to_address_book
Get private add to address book
getPrivateAddToAddressBook 14 params body → 200
GET
/private/remove_from_address_book
Get private remove from address book
getPrivateRemoveFromAddressBook 3 params body → 200
GET
/private/update_in_address_book
Get private update in address book
getPrivateUpdateInAddressBook 13 params body → 200
GET
/private/save_address_beneficiary
Get private save address beneficiary
getPrivateSaveAddressBeneficiary 13 params body → 200
GET
/private/get_address_beneficiary
Get private get address beneficiary
getPrivateGetAddressBeneficiary 3 params body → 200
GET
/private/delete_address_beneficiary
Get private delete address beneficiary
getPrivateDeleteAddressBeneficiary 3 params body → 200
GET
/private/list_address_beneficiaries
Get private list address beneficiaries
getPrivateListAddressBeneficiaries 14 params body → 200
GET
/private/submit_transfer_to_subaccount
Get private submit transfer to subaccount
getPrivateSubmitTransferToSubaccount 3 params body → 200
GET
/private/submit_transfer_between_subaccounts
Get private submit transfer between subaccounts
getPrivateSubmitTransferBetweenSubaccounts 5 params body → 200
GET
/private/submit_transfer_to_user
Get private submit transfer to user
getPrivateSubmitTransferToUser 3 params body → 200
GET
/private/get_transfers
Get private get transfers
getPrivateGetTransfers 3 params body → 200
GET
/private/cancel_transfer_by_id
Get private cancel transfer by id
getPrivateCancelTransferById 2 params body → 200
GET
/private/get_reward_eligibility
Get private get reward eligibility
getPrivateGetRewardEligibility body → 200
GET
/private/set_clearance_originator
Get private set clearance originator
getPrivateSetClearanceOriginator 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.

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

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
Deribit FIX API
Deribit Account Management API
Deribit Authentication API
Deribit Block RFQ API
Deribit Block Trade API
Deribit Combo Books API
Deribit Market Data API
Deribit Portfolio Management API
Deribit Session Management API
Deribit Subscription Management API
Deribit Supporting API
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.