Xp

Get detailed weekly XP statistics for specified users (Admin only)

get

Authorizations

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

userIdsinteger[] · min: 1 · max: 100Required

weekStartstringRequired

weekEndstringRequired

Responses

200

Successful response

application/json

400

Invalid input data

application/json

401

Authorization not provided

application/json

403

Insufficient access

application/json

404

Not found

application/json

500

Internal server error

application/json

get

/admin/xp/weekly/stats

HTTPcURLJavaScriptPython

GET /api/v2/admin/xp/weekly/stats?userIds=1&weekStart=text&weekEnd=text HTTP/1.1
Host: api.ethos.network
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "ANY_ADDITIONAL_PROPERTY": "text"
  }
]

Get user IDs that were active in the specified date range (Admin only)

get

Authorizations

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

weekStartstringRequired

weekEndstringRequired

Responses

200

Successful response

application/json

Responseinteger[]

400

Invalid input data

application/json

401

Authorization not provided

application/json

403

Insufficient access

application/json

404

Not found

application/json

500

Internal server error

application/json

get

/admin/xp/weekly/active-users

HTTPcURLJavaScriptPython

GET /api/v2/admin/xp/weekly/active-users?weekStart=text&weekEnd=text HTTP/1.1
Host: api.ethos.network
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  1
]

Get total XP for a user across all seasons

get

Path parameters

userkeystringRequired

Responses

200

Successful response

application/json

Responsenumber

400

Invalid input data

application/json

404

Not found

application/json

500

Internal server error

application/json

get

/xp/user/{userkey}

HTTPcURLJavaScriptPython

GET /api/v2/xp/user/{userkey} HTTP/1.1
Host: api.ethos.network
Accept: */*

1

Get XP for a user in a specific season

get

Path parameters

userkeystringRequired

seasonIdnumberRequired

Responses

200

Successful response

application/json

Responsenumber

400

Invalid input data

application/json

404

Not found

application/json

500

Internal server error

application/json

get

/xp/user/{userkey}/season/{seasonId}

HTTPcURLJavaScriptPython

GET /api/v2/xp/user/{userkey}/season/{seasonId} HTTP/1.1
Host: api.ethos.network
Accept: */*

1

Get weekly XP data for a user in a specific season

get

Path parameters

userkeystringRequired

seasonIdnumberRequired

Responses

200

Successful response

application/json

400

Invalid input data

application/json

404

Not found

application/json

500

Internal server error

application/json

get

/xp/user/{userkey}/season/{seasonId}/weekly

HTTPcURLJavaScriptPython

GET /api/v2/xp/user/{userkey}/season/{seasonId}/weekly HTTP/1.1
Host: api.ethos.network
Accept: */*

[
  {
    "week": 1,
    "weeklyXp": 1,
    "cumulativeXp": 1
  }
]

Get all XP seasons plus current season information

get

Responses

200

Successful response

application/json

500

Internal server error

application/json

get

/xp/seasons

HTTPcURLJavaScriptPython

GET /api/v2/xp/seasons HTTP/1.1
Host: api.ethos.network
Accept: */*

{
  "seasons": [
    {
      "id": 1,
      "name": "text",
      "startDate": "text"
    }
  ],
  "currentSeason": {
    "id": 1,
    "name": "text",
    "startDate": "text",
    "week": 1
  }
}

Get all weeks in a season with their date ranges

get

Path parameters

seasonIdnumberRequired

Responses

200

Successful response

application/json

400

Invalid input data

application/json

404

Not found

application/json

500

Internal server error

application/json

get

/xp/season/{seasonId}/weeks

HTTPcURLJavaScriptPython

GET /api/v2/xp/season/{seasonId}/weeks HTTP/1.1
Host: api.ethos.network
Accept: */*

[
  {
    "week": 1,
    "startDate": "text",
    "endDate": "text"
  }
]

Get leaderboard rank for a user

get

Path parameters

userkeystringRequired

Responses

200

Successful response

application/json

Responsenumber

400

Invalid input data

application/json

404

Not found

application/json

500

Internal server error

application/json

get

/xp/user/{userkey}/leaderboard-rank

HTTPcURLJavaScriptPython

GET /api/v2/xp/user/{userkey}/leaderboard-rank HTTP/1.1
Host: api.ethos.network
Accept: */*

1

Send an XP tip to another user

post

Authorizations

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

receiverProfileIdinteger · max: 2147483647Required

amountintegerRequired

Responses

200

Successful response

application/json

400

Invalid input data

application/json

401

Authorization not provided

application/json

403

Insufficient access

application/json

500

Internal server error

application/json

post

/xp/tip

HTTPcURLJavaScriptPython

POST /api/v2/xp/tip HTTP/1.1
Host: api.ethos.network
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 34

{
  "receiverProfileId": 1,
  "amount": 1
}

{
  "tipId": 1,
  "senderNewBalance": 1,
  "receiverNewBalance": 1
}

Get XP tips sent by the authenticated user

get

Authorizations

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

limitinteger · max: 100OptionalDefault: 50

offsetnumberOptionalDefault: 0

Responses

200

Successful response

application/json

400

Invalid input data

application/json

401

Authorization not provided

application/json

403

Insufficient access

application/json

404

Not found

application/json

500

Internal server error

application/json

get

/xp/tips/sent

HTTPcURLJavaScriptPython

GET /api/v2/xp/tips/sent HTTP/1.1
Host: api.ethos.network
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "values": [
    {
      "id": 1,
      "senderProfileId": 1,
      "receiverProfileId": 1,
      "amount": 1,
      "createdAt": "text"
    }
  ],
  "total": 1
}

Get XP tips received by the authenticated user

get

Authorizations

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

limitinteger · max: 100OptionalDefault: 50

offsetnumberOptionalDefault: 0

Responses

200

Successful response

application/json

400

Invalid input data

application/json

401

Authorization not provided

application/json

403

Insufficient access

application/json

404

Not found

application/json

500

Internal server error

application/json

get

/xp/tips/received

HTTPcURLJavaScriptPython

GET /api/v2/xp/tips/received HTTP/1.1
Host: api.ethos.network
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "values": [
    {
      "id": 1,
      "senderProfileId": 1,
      "receiverProfileId": 1,
      "amount": 1,
      "createdAt": "text"
    }
  ],
  "total": 1
}

Get XP tip statistics for the authenticated user

get

Authorizations

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Successful response

application/json

401

Authorization not provided

application/json

403

Insufficient access

application/json

500

Internal server error

application/json

get

/xp/tips/stats

HTTPcURLJavaScriptPython

GET /api/v2/xp/tips/stats HTTP/1.1
Host: api.ethos.network
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "totalSent": 1,
  "totalReceived": 1
}

Get XP history for a user

get

Query parameters

userkeystringRequired

seasonIdnumberOptional

limitinteger · max: 100OptionalDefault: 50

offsetnumberOptionalDefault: 0

Responses

200

Successful response

application/json

400

Invalid input data

application/json

404

Not found

application/json

500

Internal server error

application/json

get

/xp/history

HTTPcURLJavaScriptPython

GET /api/v2/xp/history?userkey=text HTTP/1.1
Host: api.ethos.network
Accept: */*

{
  "values": [
    {
      "id": 1,
      "type": "text",
      "points": 1,
      "metadata": null,
      "createdAt": "text",
      "week": 1,
      "xpSeasonId": 1
    }
  ],
  "total": 1
}

Get current profile's XP Season 2 decision

get

Authorizations

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Successful response

application/json

401

Authorization not provided

application/json

403

Insufficient access

application/json

500

Internal server error

application/json

get

/xp/decision

HTTPcURLJavaScriptPython

GET /api/v2/xp/decision HTTP/1.1
Host: api.ethos.network
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "profileId": 1,
  "seasonId": 1,
  "decisionType": "SPEND",
  "delegations": [
    {
      "validatorTokenId": "text",
      "xpAmount": 1
    }
  ],
  "createdAt": "text",
  "updatedAt": "text"
}

Submit or update XP Season 2 decision

post

Authorizations

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

decisionTypestring · enumRequiredPossible values:

Responses

200

Successful response

application/json

400

Invalid input data

application/json

401

Authorization not provided

application/json

403

Insufficient access

application/json

500

Internal server error

application/json

post

/xp/decision

HTTPcURLJavaScriptPython

POST /api/v2/xp/decision HTTP/1.1
Host: api.ethos.network
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 81

{
  "decisionType": "SPEND",
  "delegations": [
    {
      "validatorTokenId": "text",
      "xpAmount": 1
    }
  ]
}

{
  "profileId": 1,
  "seasonId": 1,
  "decisionType": "SPEND",
  "delegations": [
    {
      "validatorTokenId": "text",
      "xpAmount": 1
    }
  ],
  "createdAt": "text",
  "updatedAt": "text"
}

Get XP Season 2 decision metadata (deadlines, dates)

get

Responses

200

Successful response

application/json

500

Internal server error

application/json

get

/xp/decision/metadata

HTTPcURLJavaScriptPython

GET /api/v2/xp/decision/metadata HTTP/1.1
Host: api.ethos.network
Accept: */*

{
  "deadline": "text",
  "delegatePercentage": 1,
  "isBeforeDeadline": true,
  "maxValidators": 1,
  "minValidators": 1,
  "nothingPenalty": 1,
  "spendPercentage": 1,
  "validatorXpCap": 1
}

Get list of validator profiles for delegation

get

Responses

200

Successful response

application/json

500

Internal server error

application/json

get

/xp/validators

HTTPcURLJavaScriptPython

GET /api/v2/xp/validators HTTP/1.1
Host: api.ethos.network
Accept: */*

[
  {
    "tokenId": "text",
    "name": "text",
    "imageUrl": "text",
    "ownerAddress": "text",
    "ownerProfileId": 1,
    "ownerDisplayName": "text",
    "ownerUsername": "text",
    "ownerAvatarUrl": "text",
    "currentXp": 1,
    "remainingCapacity": 1,
    "xpCap": 1,
    "isFull": true
  }
]

Get validators owned by a profile with their delegators and XP info

get

Path parameters

userkeystringRequired

Responses

200

Successful response

application/json

400

Invalid input data

application/json

404

Not found

application/json

500

Internal server error

application/json

get

/xp/validators/profile/{userkey}

HTTPcURLJavaScriptPython

GET /api/v2/xp/validators/profile/{userkey} HTTP/1.1
Host: api.ethos.network
Accept: */*

[
  {
    "tokenId": "text",
    "name": "text",
    "imageUrl": "text",
    "currentXp": 1,
    "xpCap": 1,
    "delegators": [
      {
        "user": {
          "id": 1,
          "profileId": 1,
          "displayName": "text",
          "username": "text",
          "avatarUrl": "https://example.com",
          "description": "text",
          "score": 1,
          "status": "ACTIVE",
          "userkeys": [
            "text"
          ],
          "xpTotal": 1,
          "xpStreakDays": 1,
          "xpRemovedDueToAbuse": true,
          "influenceFactor": 1,
          "influenceFactorPercentile": 1,
          "mommyPawnshopBingo": "REQUESTED",
          "links": {
            "profile": "https://example.com",
            "scoreBreakdown": "https://example.com"
          },
          "stats": {
            "review": {
              "received": {
                "negative": 1,
                "neutral": 1,
                "positive": 1
              }
            },
            "vouch": {
              "given": {
                "amountWeiTotal": 1,
                "count": 1
              },
              "received": {
                "amountWeiTotal": 1,
                "count": 1
              }
            }
          }
        },
        "xpAmount": 1
      }
    ]
  }
]