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

Scope: wallet:read

Try in API console

cURL

cURL

curl --request GET \
  --url https://test.deribit.com/api/v2/private/get_deposits \
  --header 'Content-Type: application/json' \
  --data '
{
  "jsonrpc": "2.0",
  "id": 5611,
  "method": "private/get_deposits",
  "params": {
    "currency": "BTC",
    "count": 10,
    "offset": 0
  }
}
'

import requests

url = "https://test.deribit.com/api/v2/private/get_deposits"

payload = {
    "jsonrpc": "2.0",
    "id": 5611,
    "method": "private/get_deposits",
    "params": {
        "currency": "BTC",
        "count": 10,
        "offset": 0
    }
}
headers = {"Content-Type": "application/json"}

response = requests.get(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    jsonrpc: '2.0',
    id: 5611,
    method: 'private/get_deposits',
    params: {currency: 'BTC', count: 10, offset: 0}
  })
};

fetch('https://test.deribit.com/api/v2/private/get_deposits', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://test.deribit.com/api/v2/private/get_deposits",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_POSTFIELDS => json_encode([
    'jsonrpc' => '2.0',
    'id' => 5611,
    'method' => 'private/get_deposits',
    'params' => [
        'currency' => 'BTC',
        'count' => 10,
        'offset' => 0
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://test.deribit.com/api/v2/private/get_deposits"

	payload := strings.NewReader("{\n  \"jsonrpc\": \"2.0\",\n  \"id\": 5611,\n  \"method\": \"private/get_deposits\",\n  \"params\": {\n    \"currency\": \"BTC\",\n    \"count\": 10,\n    \"offset\": 0\n  }\n}")

	req, _ := http.NewRequest("GET", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://test.deribit.com/api/v2/private/get_deposits")
  .header("Content-Type", "application/json")
  .body("{\n  \"jsonrpc\": \"2.0\",\n  \"id\": 5611,\n  \"method\": \"private/get_deposits\",\n  \"params\": {\n    \"currency\": \"BTC\",\n    \"count\": 10,\n    \"offset\": 0\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://test.deribit.com/api/v2/private/get_deposits")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"jsonrpc\": \"2.0\",\n  \"id\": 5611,\n  \"method\": \"private/get_deposits\",\n  \"params\": {\n    \"currency\": \"BTC\",\n    \"count\": 10,\n    \"offset\": 0\n  }\n}"

response = http.request(request)
puts response.read_body

200

{
  "jsonrpc": "2.0",
  "id": 5611,
  "result": {
    "count": 1,
    "data": [
      {
        "address": "2N35qDKDY22zmJq9eSyiAerMD4enJ1xx6ax",
        "amount": 5,
        "currency": "BTC",
        "received_timestamp": 1549295017670,
        "state": "completed",
        "transaction_id": "230669110fdaf0a0dbcdc079b6b8b43d5af29cc73683835b9bc6b3406c065fda",
        "updated_timestamp": 1549295130159
      }
    ]
  }
}

Query Parameters

currency · enum<string> · required

The currency symbol Currency, i.e "BTC", "ETH", "USDC"

Available options: BTC, ETH, USDC, USDT, EURR

count · integer

Number of requested items, default - 10, maximum - 1000

Required range: 1 <= x <= 1000

offset · integer

The offset for pagination, default - 0

Example:

10

Response

200 - application/json

Success response

jsonrpc · enum<string> · required

The JSON-RPC version (2.0)

Available options: 2.0

result · object · required

Hide child attributes

result. data · object[] · required

Hide child attributes

result.data. currency · enum<string> · required

Currency, i.e "BTC", "ETH", "USDC"

Available options: BTC, ETH, USDC, USDT, EURR

result.data. address · string · required

Address in proper format for currency

Example:

"1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa"

result.data. amount · number · required

Amount of funds in given currency

Example:

1

result.data. state · enum<string> · required

Deposit state. Allowed values:

pending: deposit detected on blockchain/system, compliance not yet finished

completed: compliance check finished successfully

rejected: deposit failed compliance and must be handled manually

replaced: deposit transaction was replaced on the blockchain and should have a new transaction hash

Available options: pending, completed, rejected, replaced

result.data. transaction_id · string | null · required

Transaction id in proper format for currency, null if id is not available

Example:

"1b1fb5568515e2b79503501e3d3680b2d0838d5dfc2d15a04eb8cd9fbbe0b572"

result.data. received_timestamp · integer · required

The timestamp (milliseconds since the Unix epoch)

Example:

1536569522277

result.data. updated_timestamp · integer · required

The timestamp (milliseconds since the Unix epoch)

Example:

1536569522277

result.data. source_address · string

Address in proper format for currency

Example:

"1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa"

result.data. note · string

result.data. clearance_state · enum<string>

Clearance state indicating the current status of the transaction clearance process. Allowed values:

in_progress: clearance process is in progress

pending_admin_decision: transaction is under manual review by Deribit admin

pending_user_input: user should provide additional information regarding the transaction

success: clearance process completed successfully

failed: clearance process failed, transaction is rejected

cancelled: transaction is cancelled (currently used only for withdrawals, meaning the withdrawal is cancelled)

refund_initiated: clearance process failed, transaction refund is initiated, funds are removed from Deribit balance (valid for deposits only)

refunded: clearance process failed, deposit amount is refunded back to the client (valid for deposits only)

Available options: in_progress, pending_admin_decision, pending_user_input, success, failed, cancelled, refund_initiated, refunded

result.data. refund_transaction_id · string | null

Transaction id in proper format for currency, null if id is not available

Example:

"1b1fb5568515e2b79503501e3d3680b2d0838d5dfc2d15a04eb8cd9fbbe0b572"

result. count · integer · required

Total number of results available

Example:

101

id · integer

The id that was sent in the request