private/get_deposit_history
Returns settled deposits for a single subaccount or an entire wallet (specify exactly one), optionally bounded by a start/end timestamp window. Each entry reports the deposited amount as a decimal, the fee routed to the security module (the net credited amount is amount minus fee), and the resolved settlement batch and status. A deposit that could not reach its target is credited to the wallet’s fallback subaccount instead: it reports is_fallback: true and the rejection that caused it in fallback_error_code, fallback_error_message and fallback_error_data.
curl --request POST \
--url https://api.derive.xyz/v3/private/get_deposit_history \
--header 'Content-Type: application/json' \
--header 'X-DeriveSignature: <api-key>' \
--header 'X-DeriveTimestamp: <api-key>' \
--header 'X-DeriveWallet: <api-key>' \
--data '
{
"end_timestamp": null,
"start_timestamp": null,
"subaccount_id": null,
"wallet": null
}
'import requests
url = "https://api.derive.xyz/v3/private/get_deposit_history"
payload = {
"end_timestamp": None,
"start_timestamp": None,
"subaccount_id": None,
"wallet": None
}
headers = {
"X-DeriveWallet": "<api-key>",
"X-DeriveTimestamp": "<api-key>",
"X-DeriveSignature": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'X-DeriveWallet': '<api-key>',
'X-DeriveTimestamp': '<api-key>',
'X-DeriveSignature': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({end_timestamp: null, start_timestamp: null, subaccount_id: null, wallet: null})
};
fetch('https://api.derive.xyz/v3/private/get_deposit_history', 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://api.derive.xyz/v3/private/get_deposit_history",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'end_timestamp' => null,
'start_timestamp' => null,
'subaccount_id' => null,
'wallet' => null
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-DeriveSignature: <api-key>",
"X-DeriveTimestamp: <api-key>",
"X-DeriveWallet: <api-key>"
],
]);
$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://api.derive.xyz/v3/private/get_deposit_history"
payload := strings.NewReader("{\n \"end_timestamp\": null,\n \"start_timestamp\": null,\n \"subaccount_id\": null,\n \"wallet\": null\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-DeriveWallet", "<api-key>")
req.Header.Add("X-DeriveTimestamp", "<api-key>")
req.Header.Add("X-DeriveSignature", "<api-key>")
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.post("https://api.derive.xyz/v3/private/get_deposit_history")
.header("X-DeriveWallet", "<api-key>")
.header("X-DeriveTimestamp", "<api-key>")
.header("X-DeriveSignature", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"end_timestamp\": null,\n \"start_timestamp\": null,\n \"subaccount_id\": null,\n \"wallet\": null\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.derive.xyz/v3/private/get_deposit_history")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-DeriveWallet"] = '<api-key>'
request["X-DeriveTimestamp"] = '<api-key>'
request["X-DeriveSignature"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"end_timestamp\": null,\n \"start_timestamp\": null,\n \"subaccount_id\": null,\n \"wallet\": null\n}"
response = http.request(request)
puts response.read_body{
"deposits": [
{
"amount": "<string>",
"asset": "<string>",
"batch_status": "Batching",
"batch_uuid": "<string>",
"fee": "<string>",
"is_fallback": true,
"new_subaccount": true,
"operation_id": "<string>",
"subaccount_id": 1,
"timestamp": 1,
"wallet": "<string>",
"action_id": 1,
"bridge_origin": {
"rail": "<string>",
"source_chain_id": 1,
"source_tx_hash": "<string>",
"source_address": "<string>"
},
"fallback_error_code": 123,
"fallback_error_data": "<string>",
"fallback_error_message": "<string>",
"l1_sender": "<string>",
"l1_tx_hash": "<string>",
"tx_hash": "<string>"
}
]
}{
"error": {
"code": 123,
"message": "<string>",
"data": "<string>"
}
}Authorizations
The wallet the request acts for.
The current time in milliseconds, as a decimal string.
EIP-191 signature of the timestamp, by the wallet or one of its session keys.
Body
Parameters for private/get_deposit_history. Takes subaccount_id plus an optional [start_timestamp, end_timestamp] window in unix milliseconds. wallet, when set, takes precedence over subaccount_id and returns the whole wallet's deposits. Results are capped at 1000 rows.
Response
Success
Show child attributes
Show child attributes
curl --request POST \
--url https://api.derive.xyz/v3/private/get_deposit_history \
--header 'Content-Type: application/json' \
--header 'X-DeriveSignature: <api-key>' \
--header 'X-DeriveTimestamp: <api-key>' \
--header 'X-DeriveWallet: <api-key>' \
--data '
{
"end_timestamp": null,
"start_timestamp": null,
"subaccount_id": null,
"wallet": null
}
'import requests
url = "https://api.derive.xyz/v3/private/get_deposit_history"
payload = {
"end_timestamp": None,
"start_timestamp": None,
"subaccount_id": None,
"wallet": None
}
headers = {
"X-DeriveWallet": "<api-key>",
"X-DeriveTimestamp": "<api-key>",
"X-DeriveSignature": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'X-DeriveWallet': '<api-key>',
'X-DeriveTimestamp': '<api-key>',
'X-DeriveSignature': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({end_timestamp: null, start_timestamp: null, subaccount_id: null, wallet: null})
};
fetch('https://api.derive.xyz/v3/private/get_deposit_history', 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://api.derive.xyz/v3/private/get_deposit_history",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'end_timestamp' => null,
'start_timestamp' => null,
'subaccount_id' => null,
'wallet' => null
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-DeriveSignature: <api-key>",
"X-DeriveTimestamp: <api-key>",
"X-DeriveWallet: <api-key>"
],
]);
$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://api.derive.xyz/v3/private/get_deposit_history"
payload := strings.NewReader("{\n \"end_timestamp\": null,\n \"start_timestamp\": null,\n \"subaccount_id\": null,\n \"wallet\": null\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-DeriveWallet", "<api-key>")
req.Header.Add("X-DeriveTimestamp", "<api-key>")
req.Header.Add("X-DeriveSignature", "<api-key>")
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.post("https://api.derive.xyz/v3/private/get_deposit_history")
.header("X-DeriveWallet", "<api-key>")
.header("X-DeriveTimestamp", "<api-key>")
.header("X-DeriveSignature", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"end_timestamp\": null,\n \"start_timestamp\": null,\n \"subaccount_id\": null,\n \"wallet\": null\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.derive.xyz/v3/private/get_deposit_history")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-DeriveWallet"] = '<api-key>'
request["X-DeriveTimestamp"] = '<api-key>'
request["X-DeriveSignature"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"end_timestamp\": null,\n \"start_timestamp\": null,\n \"subaccount_id\": null,\n \"wallet\": null\n}"
response = http.request(request)
puts response.read_body{
"deposits": [
{
"amount": "<string>",
"asset": "<string>",
"batch_status": "Batching",
"batch_uuid": "<string>",
"fee": "<string>",
"is_fallback": true,
"new_subaccount": true,
"operation_id": "<string>",
"subaccount_id": 1,
"timestamp": 1,
"wallet": "<string>",
"action_id": 1,
"bridge_origin": {
"rail": "<string>",
"source_chain_id": 1,
"source_tx_hash": "<string>",
"source_address": "<string>"
},
"fallback_error_code": 123,
"fallback_error_data": "<string>",
"fallback_error_message": "<string>",
"l1_sender": "<string>",
"l1_tx_hash": "<string>",
"tx_hash": "<string>"
}
]
}{
"error": {
"code": 123,
"message": "<string>",
"data": "<string>"
}
}