Liquidations
public/get_live_auctions
Returns every liquidation auction open right now, each priced for a maximal bid at the moment of the response: the cash a bid would cost, the largest fraction of the account it could take, the account’s mark-to-market value, the expected discount profit, and the balances on offer. Takes no parameters. This is the polling counterpart to the auctions.watch channel and carries the same values; both a solvent auction’s price and the fraction on offer move with wall-clock and with the account’s mark, so a quote is only good for the instant it was taken.
POST
/
public
/
get_live_auctions
public/get_live_auctions
curl --request POST \
--url https://api.derive.xyz/v3/public/get_live_auctions \
--header 'Content-Type: application/json' \
--data '{}'import requests
url = "https://api.derive.xyz/v3/public/get_live_auctions"
payload = {}
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({})
};
fetch('https://api.derive.xyz/v3/public/get_live_auctions', 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/public/get_live_auctions",
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([
]),
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/public/get_live_auctions"
payload := strings.NewReader("{}")
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/public/get_live_auctions")
.header("Content-Type", "application/json")
.body("{}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.derive.xyz/v3/public/get_live_auctions")
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 = "{}"
response = http.request(request)
puts response.read_body{
"auctions": [
{
"estimated_bid_price": "<string>",
"estimated_discount_pnl": "<string>",
"estimated_mtm": "<string>",
"estimated_percent_bid": "<string>",
"margin_type": "<string>",
"min_price_limit": "<string>",
"risk_universe_id": 1,
"subaccount_balances": {},
"subaccount_id": 1,
"timestamp": 123,
"currency": "<string>"
}
]
}{
"error": {
"code": 123,
"message": "<string>",
"data": "<string>"
}
}Body
application/json
This method takes no parameters; send an empty object {}.
Braced rather than a unit struct so schemars emits {"type": "object"}: a unit struct emits null, which contradicts the line above and forced every generated client to cast around the params type.
Response
Success
Show child attributes
Show child attributes
public/get_live_auctions
curl --request POST \
--url https://api.derive.xyz/v3/public/get_live_auctions \
--header 'Content-Type: application/json' \
--data '{}'import requests
url = "https://api.derive.xyz/v3/public/get_live_auctions"
payload = {}
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({})
};
fetch('https://api.derive.xyz/v3/public/get_live_auctions', 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/public/get_live_auctions",
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([
]),
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/public/get_live_auctions"
payload := strings.NewReader("{}")
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/public/get_live_auctions")
.header("Content-Type", "application/json")
.body("{}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.derive.xyz/v3/public/get_live_auctions")
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 = "{}"
response = http.request(request)
puts response.read_body{
"auctions": [
{
"estimated_bid_price": "<string>",
"estimated_discount_pnl": "<string>",
"estimated_mtm": "<string>",
"estimated_percent_bid": "<string>",
"margin_type": "<string>",
"min_price_limit": "<string>",
"risk_universe_id": 1,
"subaccount_balances": {},
"subaccount_id": 1,
"timestamp": 123,
"currency": "<string>"
}
]
}{
"error": {
"code": 123,
"message": "<string>",
"data": "<string>"
}
}