Karma API

📋 Table of Contents

Overview

The Karma API provides comprehensive karma management services for the OASIS ecosystem. It handles karma earning, spending, tracking, and analytics with support for multiple karma types, real-time updates, and advanced security features.

Karma Management

Get All Karma

GET /api/karma
Authorization: Bearer YOUR_TOKEN

Query Parameters:

  • limit (int, optional): Number of results (default: 50)

  • offset (int, optional): Number to skip (default: 0)

  • type (string, optional): Filter by type (Earned, Spent, Transferred, Bonus)

  • status (string, optional): Filter by status (Active, Pending, Expired, Cancelled)

  • category (string, optional): Filter by category (Gaming, Social, Learning, Contribution)

  • sortBy (string, optional): Sort field (amount, createdAt, expiresAt)

  • sortOrder (string, optional): Sort order (asc/desc, default: desc)

Response:

Get Karma by ID

Parameters:

  • karmaId (string): Karma UUID

Response:

Create Karma

Request Body:

Response:

Update Karma

Parameters:

  • karmaId (string): Karma UUID

Request Body:

Delete Karma

Parameters:

  • karmaId (string): Karma UUID

Karma Operations

Earn Karma

Request Body:

Response:

Spend Karma

Request Body:

Response:

Transfer Karma

Request Body:

Response:

Get Karma Balance

Response:

Get Karma History

Query Parameters:

  • limit (int, optional): Number of results (default: 50)

  • offset (int, optional): Number to skip (default: 0)

  • type (string, optional): Filter by type (Earned, Spent, Transferred, Bonus)

  • category (string, optional): Filter by category

  • startDate (string, optional): Start date (ISO 8601)

  • endDate (string, optional): End date (ISO 8601)

Response:

Karma Analytics

Get Karma Statistics

Query Parameters:

  • timeframe (string, optional): Timeframe (hour, day, week, month)

  • category (string, optional): Filter by category

Response:

Get Karma Performance

Response:

Get Karma Health

Response:

Karma Security

Get Karma Security

Parameters:

  • karmaId (string): Karma UUID

Response:

Update Karma Security

Parameters:

  • karmaId (string): Karma UUID

Request Body:

Error Responses

Karma Not Found

Insufficient Karma

Karma Expired

Invalid Amount

Permission Denied


← Previous: Gifts API | Next: Data API

Last updated