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

POST /faucet

Claim testnet faucet

Claim testnet faucet.

operationId: claimFaucet

Not reachable through CCXT. Testnet-only token dispenser. Not a venue capability CCXT models at all.

Authentication: hmacAuth.

Credit a fixed testnet faucet amount of synthetic USDX to the authenticated account, subject to a per-wallet cooldown and cumulative cap.

Testnet only. There is no faucet on mainnet — real-funds collateral arrives through the USDX bridge instead. Do not build a funding flow that assumes this operation exists on every network.

Responses

Status
Body
Meaning

200

FaucetResponse

Faucet credited.

401

(no schema declared)

403

(no schema declared)

429

(no schema declared)

Cooldown not elapsed or cumulative cap reached

Example

curl -X POST 'https://exchange.nexus.xyz/api/exchange/faucet' \
  -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.post("https://exchange.nexus.xyz/api/exchange/faucet", headers=headers)
response.raise_for_status()
print(response.json())
const response = await fetch("https://exchange.nexus.xyz/api/exchange/faucet", {
  method: "POST",
  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