For the complete documentation index, see llms.txt. This page is also available as Markdown.

GET /markets/{market_id}/adl-events

Get ADL settlement history for a market (v0.21)

Get ADL settlement history for a market (v0.21).

operationId: fetchAdlEvents

Not reachable through CCXT. ADL (auto-deleveraging) is a Nexus risk mechanism with no CCXT vocabulary.

Authentication: hmacAuth.

Returns up to limit ADL settlement events for the market, most recent first. Populated when the insurance fund is depleted and auto-deleveraging closes opposite-side positions to absorb bad debt.

Parameters

Name
In
Type
Required
Default
Description

market_id

path

string

Yes

Market identifier (e.g. BTC-USDX-PERP, ETH-USDX-PERP). Uppercase ASCII alphanumeric segments joined by single hyphens, at most 64 characters. A value outside that set is rejected with 400 (INVALID_MARKET_ID) before any store is read — it cannot name a market, so an empty result would assert that nothing traded rather than that the question was malformed. A well-formed identifier that names no listed market is a 404, not a 400.

limit

query

integer

No

100

Responses

Status
Body
Meaning

200

array of AdlEventRecord

ADL settlement history for the market.

400

(no schema declared)

401

(no schema declared)

429

(no schema declared)

Example

curl -X GET 'https://exchange.nexus.xyz/api/exchange/markets/BTC-USDX-PERP/adl-events' \
  -H 'X-API-Key: nx_7f3a1b...' \
  -H 'X-Timestamp: 1776033911836' \
  -H 'X-Signature: <hmac-sha256>'
import requests

headers = {
    "X-API-Key": "nx_7f3a1b...",
    "X-Timestamp": "1776033911836",
    "X-Signature": "<hmac-sha256>"
}

response = requests.get("https://exchange.nexus.xyz/api/exchange/markets/BTC-USDX-PERP/adl-events", headers=headers)
response.raise_for_status()
print(response.json())
const response = await fetch("https://exchange.nexus.xyz/api/exchange/markets/BTC-USDX-PERP/adl-events", {
  method: "GET",
  headers: {
    "X-API-Key": "nx_7f3a1b...",
    "X-Timestamp": "1776033911836",
    "X-Signature": "<hmac-sha256>"
  },
});
if (!response.ok) throw new Error(`${response.status} ${await response.text()}`);
console.log(await response.json());

X-Signature is a placeholder: it is derived from this specific request. See Authentication for the canonical string and the HMAC rule.


Generated from eng/apps/exchange/api/openapi.json (spec 0.9.36). Do not edit by hand — regenerate with python3 product/docs/tools/api-reference/generate.py. Hand-authored context lives in the Guides pages.

Last updated