The protocol speaks JSON.
Read hunter stats, subscribe to lifecycle webhooks, and run the protocol as a service. Public read endpoints are open; write endpoints require a partner key.
Quickstart
Full reference →No SDK install needed. Hit any read endpoint with `curl`. Every response is JSON with rate-limit headers attached.
curl https://nslevelup.vercel.app/api/v1/today
# → 200 OK
# {
# "wallet": "...",
# "quest": { "title": "Cold plunge", "stake": 2, "xp": 60 },
# "rank": "C",
# "streak": 17,
# "gates_cleared": 4
# }Quick links
REST API reference
Every v1 endpoint, request shape, and example response. Includes rate limit headers + error envelope.
Browse endpointsOpenAPI 3.1 spec
Machine-readable JSON + YAML. Drop into Postman, Stoplight, or Insomnia to generate clients.
Download YAMLTypeScript SDK
Zero-dep client. One import, typed responses, ESM-first. Inline the source — no npm install required.
Read SDK sourceOutbound webhooks
Subscribe to quest.verified, gate.cleared, cohort.resolved, cohort.member_joined. HMAC-SHA256 signed.
Wire a webhookAuthentication & scopes
Bearer tokens for partner keys. Rate limits 60/min/IP, 5× partner, 20× enterprise. Wallet sigs for service-to-service.
Read auth modelWhite paper v1
Protocol thesis, XPER token model, survivor pool math, KYC tiers, GM Trust Score.
Read on GitHub
Authentication
- Public readNo header required. Rate limited 60 req/min per IP. Endpoints: today, hunter, cohort, leaderboard, activity, stats, snapshots.
- Partner keyBearer token in Authorization: Bearer nslu_XXX_YYY. 5× rate budget. Request via /admin/api-keys (admin gated).
- EnterpriseSame Bearer shape, 20× rate budget, includes write endpoints (/v1/cohorts, /v1/webhooks management).
- Webhook deliveryX-NSLevelUp-Signature: t=<unix>,v1=<hex(hmac_sha256(secret, t + '.' + body))>. Reject if timestamp is older than 5 min.
Integrations
- Telegram botVerified quests, gate clears, and morning System DMs. Webhook → bot relay.
- Solana mainnetAnchor program LevelUp Escrow handles stake_quest, slash_quest, resolve_quest, cohort escrow.
- Apple Health / WatchiOS Shortcut bridge for steps + workout verify. HealthKit cohort qualification mode in v2.
- Postman / StoplightImport /api/v1/openapi.yaml — every endpoint, every schema, every example response.
- EmbedsDrop-in HUD + leaderboard + today widgets at /embed/{hud,leaderboard,today}. iFrame friendly.
- Discord / FarcasterWebhook fan-out via /api/v1/webhooks. Bring your own relay; the protocol fires events, you route them.
Email partners@nslevelup.app with what you want to build. Default tier is 5× rate budget and webhook subscription rights. Enterprise unlock includes write endpoints + dedicated relay.