Developers

API reference

Application endpoints for balances, vault operations, market data, and LUX.

Conventions

The current API is implemented as Next.js route handlers and is intended for the Lucida application and development integrations. Treat every request field as untrusted. Production deployments should add authentication, rate limits, observability, idempotency controls, and a versioned public contract.

Read endpoints

MethodEndpointPurpose
GET/api/apyCurrent APY estimates and source metadata
GET/api/priceCurrent SOL/USD price and source metadata
GET/api/deposit/configNetwork and vault deposit configuration
GET/api/dashboard?wallet=…User principal, positions, shares, and activity
GET/api/withdraw?wallet=…Available vault withdrawal balances
GET/api/lux?wallet=…User LUX summary, epoch data, breakdown, and rank
GET/api/lux/leaderboardLeaderboard-ready LUX records

Write endpoints

MethodEndpointPurpose
POST/api/depositVerify and record a confirmed deposit transaction
POST/api/withdrawCreate a vault withdrawal request

LUX leaderboard shape

{
  "rank": 1,
  "walletAddress": "…",
  "displayWallet": "8Hff...7xA2",
  "totalLux": "1250.000000",
  "vaultsUsed": ["USDC", "SOL"],
  "currentMultiplier": "1.000000",
  "referralLux": "100.000000"
}