Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.ordsbot.com/llms.txt

Use this file to discover all available pages before exploring further.

​
POST /api/auth/challenge

Request a sign-in challenge for a Bitcoin address. During beta, the address must be whitelisted. Admin addresses bypass the whitelist.

​
Request body

{
  "address": "bc1q..."
}

​
Response

{
  "challengeId": "550e8400-e29b-41d4-a716-446655440000",
  "message": "Sign in to OrdsBot: a1b2c3d4e5f6",
  "expiresAt": 1700000300
}

​
Errors

CodeError
400Invalid Bitcoin address format
403Address not whitelisted for beta access

​
POST /api/auth/verify

Submit the wallet signature to authenticate and receive a session token.

​
Request body

{
  "challengeId": "550e8400-e29b-41d4-a716-446655440000",
  "address": "bc1q...",
  "signature": "base64-encoded-signature",
  "publicKey": "02abc..."
}
publicKey is optional but recommended — it speeds up verification for some wallet types.

​
Response

{
  "token": "your-session-token",
  "user": {
    "id": 1,
    "address": "bc1q...",
    "ordinalsAddress": "bc1p...",
    "plan": "beta",
    "isAdmin": false
  }
}

​
Errors

CodeError
400Missing required fields
401Invalid signature or expired challenge

​
POST /api/auth/logout

Invalidate the current session. Requires authentication.

​
Response

{ "success": true }

​
GET /api/auth/me

Returns the authenticated user’s profile, plan limits, and usage stats.

​
Response

{
  "id": 1,
  "address": "bc1q...",
  "ordinalsAddress": "bc1p...",
  "displayName": null,
  "plan": "beta",
  "planDetails": {
    "name": "Beta Tester",
    "maxTasks": 100,
    "maxBidsPerTask": 10,
    "priceSats": 0,
    "durationDays": 90
  },
  "isAdmin": false,
  "subscription": {
    "plan": "beta",
    "expiresAt": "2026-06-14T00:00:00.000Z",
    "status": "active"
  },
  "stats": {
    "taskCount": 3,
    "maxTasks": 100,
    "exposure": 1200000,
    "maxExposure": 5000000
  },
  "createdAt": "2026-03-26T00:00:00.000Z"
}