Users

User Management API

Manage user profile information and settings.

Base URL

https://api.realm.ai/v1/user

Get User Profile

Retrieves the profile information for the authenticated user.

  • Method: GET

  • Endpoint: /profile

  • Authentication: API Key

Response 200 OK

{
  "userId": "usr_a1b2c3d4",
  "username": "example_user",
  "email": "[email protected]",
  "createdAt": "2024-01-15T10:30:00Z",
  "solanaWalletAddress": "SoLAnAaDdReSs...",
  "apiUsage": {
    "quotaLimit": 10000,
    "quotaUsed": 1250,
    "resetDate": "2025-02-01T00:00:00Z"
  }
}

Update User Profile

Updates mutable profile information for the authenticated user.

  • Method: PATCH

  • Endpoint: /profile

  • Authentication: API Key

Request Body

{
  "username": "new_username", // Optional
  "solanaWalletAddress": "NewSoLAnAaDdReSs..." // Optional
}

Response 200 OK

{
  "userId": "usr_a1b2c3d4",
  "username": "new_username",
  "email": "[email protected]", // Email is typically not updatable via API
  "createdAt": "2024-01-15T10:30:00Z",
  "solanaWalletAddress": "NewSoLAnAaDdReSs...",
  "apiUsage": {
    "quotaLimit": 10000,
    "quotaUsed": 1250,
    "resetDate": "2025-02-01T00:00:00Z"
  }
}

Error Responses

  • 400 Bad Request: Invalid input format (e.g., invalid Solana address).

  • 409 Conflict: Username already taken.

(Additional endpoints for managing API keys, notification settings, etc., could be added here)

PreviousMarketPlaceNextIdempotency

Last updated