Skip to main content
DELETE
Delete a user preference
The response body shown here is a static example, not live data. After you click Send, your live result appears in a separate panel headed 200 OK. The panel under the status-code tabs is a fixed sample from the spec — its field values (fees, prices, sizes, IDs, timestamps) are placeholders. Use Send, or call the endpoint, for current values.
Removes a single preference key for the address bound to X-API-Key. Idempotent — a key that does not exist still returns 200. The key lives in the query string so the resource has a single canonical URL.

Authorizations

X-API-Key
string
header
required

Hex-encoded Ed25519 public key (64 chars). The public key IS the API key — register it via POST /createApiKey. Required on every authenticated request, both read-only and signed.

X-Timestamp
string
header
required

Unix time in nanoseconds as a decimal string (e.g. "1713825891591000000"). Millisecond or second epochs are rejected with 401 Unauthorized. Must be within ±30,000 ms (MaxTimestampDriftMs, the drift window stays configured in milliseconds) of server wall-clock, or the request is rejected with 401 Unauthorized. Required on all mutating / credential-creating endpoints. This same value must appear as the ct field in the ordersign typed canonical payload (single-order endpoints) or in each element's ct field (batch endpoints).

X-Signature
string
header
required

Lowercase hex-encoded Ed25519 signature (128 chars).

Single-order endpoints (placeOrder, cancelOrder, modifyOrder, and other non-batch mutating routes) sign over the ordersign typed canonical payload — a compact, key-sorted JSON object built from parsed request fields using engine-native integer values:

ct must equal the X-Timestamp header value. Keys in brackets are conditional (omitted when empty). op values: 1=place, 2=cancel, 3=modify. See the ordersign package for field definitions and reference signing code.

Other signed routes (e.g. createApiKey, tokens, userPreferences) still use the legacy scheme: signing_message = X-Timestamp + ACTION + canonicalJSON(body), where ACTION is the camelCase final path segment.

Batch endpoints (batchPlaceOrders, batchCancelOrders) do NOT use this header. They authenticate with per-element typed ordersign signatures embedded in the request body (see the global auth description and the per-field signature descriptions on OrderRequest / CancelOrderRequest).

Read endpoints are authenticated by ?address= (and optionally X-API-Key) only — no signature is required. The one exception is GET /v1/affiliate/inviteCodes, which returns bearer secrets and therefore requires the full header triple; with no body its signing message is X-Timestamp + ACTION. canonicalJSON(body) is the JSON body with object keys sorted lexicographically at every level and no whitespace; the server canonicalizes the received body before verifying, so only the bytes signed over must be canonical. Required on all mutating / credential-creating endpoints.

Query Parameters

key
enum<string>
required

The preference key to delete. Must be a known registry key (else 400). Known preference key. The set is closed; PATCHing or DELETEing a key not in this enum returns 400 with allowed listing the accepted set.

Available options:
favoritedMarkets,
perpsLayout,
spotLayout,
language,
numberRepresentation,
disabledAlerts,
colorTheme,
colorRedGreen,
lastSignedTOS,
isSpotLayoutLocked,
isPerpLayoutLocked,
isSpotLayoutFlex,
isPerpLayoutFlex

Response

Key deleted (or no-op if it did not exist).

address
string
required

20-byte EVM address as hex: optional 0x or 0X prefix and exactly 40 hexadecimal digits. API responses normalize to lowercase af after 0x.

Pattern: ^(0x|0X)?[0-9a-fA-F]{40}$
deleted
enum<string>
required

Known preference key. The set is closed; PATCHing or DELETEing a key not in this enum returns 400 with allowed listing the accepted set.

Available options:
favoritedMarkets,
perpsLayout,
spotLayout,
language,
numberRepresentation,
disabledAlerts,
colorTheme,
colorRedGreen,
lastSignedTOS,
isSpotLayoutLocked,
isPerpLayoutLocked,
isSpotLayoutFlex,
isPerpLayoutFlex