Session Keys

private/set_session_key_debug

Takes the same params as private/set_session_key and rebuilds the session-key Action without executing anything, returning the EIP-712 encoded_data, encoded_data_hashed, action_hash, typed_data_hash, domain_separator, action_typehash, module, owner and expected_signer, plus the decoded session key, expiry, protocol scopes and subaccounts. Byte-compare these against your local computation to find why a signature is rejected. Requires a logged-in session.

POST

private

set_session_key_debug

curl --request POST \
  --url https://api.derive.xyz/v3/private/set_session_key_debug \
  --header 'Content-Type: application/json' \
  --data '
{
  "expiry_sec": 1,
  "nonce": "<string>",
  "offchain_scopes": [
    "<string>"
  ],
  "protocol_scopes": [
    "<string>"
  ],
  "public_session_key": "<string>",
  "signature": "<string>",
  "signature_expiry_sec": 1,
  "signer": "<string>",
  "wallet": "<string>",
  "ip_whitelist": [
    "<string>"
  ],
  "label": "<string>",
  "subaccount_ids": [
    1
  ]
}
'

import requests

url = "https://api.derive.xyz/v3/private/set_session_key_debug"

payload = {
    "expiry_sec": 1,
    "nonce": "<string>",
    "offchain_scopes": ["<string>"],
    "protocol_scopes": ["<string>"],
    "public_session_key": "<string>",
    "signature": "<string>",
    "signature_expiry_sec": 1,
    "signer": "<string>",
    "wallet": "<string>",
    "ip_whitelist": ["<string>"],
    "label": "<string>",
    "subaccount_ids": [1]
}
headers = {"Content-Type": "application/json"}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    expiry_sec: 1,
    nonce: '<string>',
    offchain_scopes: ['<string>'],
    protocol_scopes: ['<string>'],
    public_session_key: '<string>',
    signature: '<string>',
    signature_expiry_sec: 1,
    signer: '<string>',
    wallet: '<string>',
    ip_whitelist: ['<string>'],
    label: '<string>',
    subaccount_ids: [1]
  })
};

fetch('https://api.derive.xyz/v3/private/set_session_key_debug', 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/set_session_key_debug",
  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([
    'expiry_sec' => 1,
    'nonce' => '<string>',
    'offchain_scopes' => [
        '<string>'
    ],
    'protocol_scopes' => [
        '<string>'
    ],
    'public_session_key' => '<string>',
    'signature' => '<string>',
    'signature_expiry_sec' => 1,
    'signer' => '<string>',
    'wallet' => '<string>',
    'ip_whitelist' => [
        '<string>'
    ],
    'label' => '<string>',
    'subaccount_ids' => [
        1
    ]
  ]),
  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://api.derive.xyz/v3/private/set_session_key_debug"

	payload := strings.NewReader("{\n  \"expiry_sec\": 1,\n  \"nonce\": \"<string>\",\n  \"offchain_scopes\": [\n    \"<string>\"\n  ],\n  \"protocol_scopes\": [\n    \"<string>\"\n  ],\n  \"public_session_key\": \"<string>\",\n  \"signature\": \"<string>\",\n  \"signature_expiry_sec\": 1,\n  \"signer\": \"<string>\",\n  \"wallet\": \"<string>\",\n  \"ip_whitelist\": [\n    \"<string>\"\n  ],\n  \"label\": \"<string>\",\n  \"subaccount_ids\": [\n    1\n  ]\n}")

	req, _ := http.NewRequest("POST", 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.post("https://api.derive.xyz/v3/private/set_session_key_debug")
  .header("Content-Type", "application/json")
  .body("{\n  \"expiry_sec\": 1,\n  \"nonce\": \"<string>\",\n  \"offchain_scopes\": [\n    \"<string>\"\n  ],\n  \"protocol_scopes\": [\n    \"<string>\"\n  ],\n  \"public_session_key\": \"<string>\",\n  \"signature\": \"<string>\",\n  \"signature_expiry_sec\": 1,\n  \"signer\": \"<string>\",\n  \"wallet\": \"<string>\",\n  \"ip_whitelist\": [\n    \"<string>\"\n  ],\n  \"label\": \"<string>\",\n  \"subaccount_ids\": [\n    1\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.derive.xyz/v3/private/set_session_key_debug")

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

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"expiry_sec\": 1,\n  \"nonce\": \"<string>\",\n  \"offchain_scopes\": [\n    \"<string>\"\n  ],\n  \"protocol_scopes\": [\n    \"<string>\"\n  ],\n  \"public_session_key\": \"<string>\",\n  \"signature\": \"<string>\",\n  \"signature_expiry_sec\": 1,\n  \"signer\": \"<string>\",\n  \"wallet\": \"<string>\",\n  \"ip_whitelist\": [\n    \"<string>\"\n  ],\n  \"label\": \"<string>\",\n  \"subaccount_ids\": [\n    1\n  ]\n}"

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

{
  "action_hash": "<string>",
  "action_typehash": "<string>",
  "domain_separator": "<string>",
  "encoded_data": "<string>",
  "encoded_data_hashed": "<string>",
  "expected_signer": "<string>",
  "input_data": {
    "data": {
      "expiry_sec": 1,
      "scopes": [
        "<string>"
      ],
      "session_key": "<string>",
      "subaccounts": [
        1
      ]
    },
    "expiry": 1,
    "module": "<string>",
    "nonce": "<string>",
    "owner": "<string>",
    "signer": "<string>",
    "subaccount_id": 1
  },
  "module": "<string>",
  "owner": "<string>",
  "typed_data_hash": "<string>",
  "recovered_signer": "<string>"
}

Body

application/json

Request parameters for registering a scoped session key. Address fields are 0x-prefixed hex strings.

expiry_sec

integer<uint64>

required

Required range: x >= 0

nonce

string

required

offchain_scopes

string[]

required

Off-chain scopes which are validated in backend only

protocol_scopes

string[]

required

Scopes granted to the session key, validated by the protocol. Each is a string like "trade:orderbook:all".

public_session_key

string

required

Session key address being authorized.

signature

string

required

0x-prefixed hex, 65-byte r||s||v.

signature_expiry_sec

integer<uint64>

required

Required range: x >= 0

signer

string

required

wallet

string

required

Wallet the session key is being registered for.

ip_whitelist

string[] | null

label

string | null

subaccount_ids

integer<uint64>[] | null

Required range: x >= 0

Response

Success

Debug-route payload for one rebuilt action: the EIP-712 hashes plus the action input fields.

action_hash

string

required

EIP-712 struct hash of the Action: keccak256(abi.encode(action_typehash, …, encoded_data_hashed, …)).

action_typehash

string

required

ACTION_TYPEHASH — keccak of the Action struct type string; invariant across deployments.

domain_separator

string

required

EIP-712 domain separator of the Matching contract for this deployment.

encoded_data

string

required

ABI-encoded, module-specific action payload (the data bytes), 0x-hex.

encoded_data_hashed

string

required

keccak256(encoded_data) — the value packed into the struct hash.

expected_signer

string

required

The signer the signature is checked against.

input_data

object

required

The rebuilt Action envelope and its decoded module-specific data.

Show child attributes

module

string

required

Per-action module contract address bound into the signed struct.

owner

string

required

Wallet that owns the subaccount the action applies to.

typed_data_hash

string

required

Final EIP-712 digest the client signs: keccak256(0x1901 || domain_separator || action_hash).

recovered_signer

string | null

null on the debug routes (no signature is checked there); on a signature-mismatch error this is the address actually recovered.

private/set_session_key_debug

curl --request POST \
  --url https://api.derive.xyz/v3/private/set_session_key_debug \
  --header 'Content-Type: application/json' \
  --data '
{
  "expiry_sec": 1,
  "nonce": "<string>",
  "offchain_scopes": [
    "<string>"
  ],
  "protocol_scopes": [
    "<string>"
  ],
  "public_session_key": "<string>",
  "signature": "<string>",
  "signature_expiry_sec": 1,
  "signer": "<string>",
  "wallet": "<string>",
  "ip_whitelist": [
    "<string>"
  ],
  "label": "<string>",
  "subaccount_ids": [
    1
  ]
}
'

import requests

url = "https://api.derive.xyz/v3/private/set_session_key_debug"

payload = {
    "expiry_sec": 1,
    "nonce": "<string>",
    "offchain_scopes": ["<string>"],
    "protocol_scopes": ["<string>"],
    "public_session_key": "<string>",
    "signature": "<string>",
    "signature_expiry_sec": 1,
    "signer": "<string>",
    "wallet": "<string>",
    "ip_whitelist": ["<string>"],
    "label": "<string>",
    "subaccount_ids": [1]
}
headers = {"Content-Type": "application/json"}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    expiry_sec: 1,
    nonce: '<string>',
    offchain_scopes: ['<string>'],
    protocol_scopes: ['<string>'],
    public_session_key: '<string>',
    signature: '<string>',
    signature_expiry_sec: 1,
    signer: '<string>',
    wallet: '<string>',
    ip_whitelist: ['<string>'],
    label: '<string>',
    subaccount_ids: [1]
  })
};

fetch('https://api.derive.xyz/v3/private/set_session_key_debug', 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/set_session_key_debug",
  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([
    'expiry_sec' => 1,
    'nonce' => '<string>',
    'offchain_scopes' => [
        '<string>'
    ],
    'protocol_scopes' => [
        '<string>'
    ],
    'public_session_key' => '<string>',
    'signature' => '<string>',
    'signature_expiry_sec' => 1,
    'signer' => '<string>',
    'wallet' => '<string>',
    'ip_whitelist' => [
        '<string>'
    ],
    'label' => '<string>',
    'subaccount_ids' => [
        1
    ]
  ]),
  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://api.derive.xyz/v3/private/set_session_key_debug"

	payload := strings.NewReader("{\n  \"expiry_sec\": 1,\n  \"nonce\": \"<string>\",\n  \"offchain_scopes\": [\n    \"<string>\"\n  ],\n  \"protocol_scopes\": [\n    \"<string>\"\n  ],\n  \"public_session_key\": \"<string>\",\n  \"signature\": \"<string>\",\n  \"signature_expiry_sec\": 1,\n  \"signer\": \"<string>\",\n  \"wallet\": \"<string>\",\n  \"ip_whitelist\": [\n    \"<string>\"\n  ],\n  \"label\": \"<string>\",\n  \"subaccount_ids\": [\n    1\n  ]\n}")

	req, _ := http.NewRequest("POST", 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.post("https://api.derive.xyz/v3/private/set_session_key_debug")
  .header("Content-Type", "application/json")
  .body("{\n  \"expiry_sec\": 1,\n  \"nonce\": \"<string>\",\n  \"offchain_scopes\": [\n    \"<string>\"\n  ],\n  \"protocol_scopes\": [\n    \"<string>\"\n  ],\n  \"public_session_key\": \"<string>\",\n  \"signature\": \"<string>\",\n  \"signature_expiry_sec\": 1,\n  \"signer\": \"<string>\",\n  \"wallet\": \"<string>\",\n  \"ip_whitelist\": [\n    \"<string>\"\n  ],\n  \"label\": \"<string>\",\n  \"subaccount_ids\": [\n    1\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.derive.xyz/v3/private/set_session_key_debug")

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

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"expiry_sec\": 1,\n  \"nonce\": \"<string>\",\n  \"offchain_scopes\": [\n    \"<string>\"\n  ],\n  \"protocol_scopes\": [\n    \"<string>\"\n  ],\n  \"public_session_key\": \"<string>\",\n  \"signature\": \"<string>\",\n  \"signature_expiry_sec\": 1,\n  \"signer\": \"<string>\",\n  \"wallet\": \"<string>\",\n  \"ip_whitelist\": [\n    \"<string>\"\n  ],\n  \"label\": \"<string>\",\n  \"subaccount_ids\": [\n    1\n  ]\n}"

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

{
  "action_hash": "<string>",
  "action_typehash": "<string>",
  "domain_separator": "<string>",
  "encoded_data": "<string>",
  "encoded_data_hashed": "<string>",
  "expected_signer": "<string>",
  "input_data": {
    "data": {
      "expiry_sec": 1,
      "scopes": [
        "<string>"
      ],
      "session_key": "<string>",
      "subaccounts": [
        1
      ]
    },
    "expiry": 1,
    "module": "<string>",
    "nonce": "<string>",
    "owner": "<string>",
    "signer": "<string>",
    "subaccount_id": 1
  },
  "module": "<string>",
  "owner": "<string>",
  "typed_data_hash": "<string>",
  "recovered_signer": "<string>"
}

HTTP & WS Methods

WS-only Methods

WS Subscriptions

private/set_session_key_debug

Body

Response