Users
Body
userIdsinteger[] · min: 1 · max: 500Required
Responses
200
Successful response
application/json
400
Invalid input data
application/json
500
Internal server error
application/json
post
POST /api/v2/users/by/ids HTTP/1.1
Host: api.ethos.network
Content-Type: application/json
Accept: */*
Content-Length: 15
{
"userIds": [
1
]
}
[
{
"id": 1,
"profileId": 1,
"displayName": "text",
"username": "text",
"avatarUrl": "https://example.com",
"description": "text",
"score": 1,
"status": "ACTIVE",
"userkeys": [
"text"
],
"xpTotal": 1,
"xpStreakDays": 1,
"stats": {
"review": {
"received": {
"negative": 1,
"neutral": 1,
"positive": 1
}
},
"vouch": {
"given": {
"amountWeiTotal": 1,
"count": 1
},
"received": {
"amountWeiTotal": 1,
"count": 1
}
}
}
}
]
Body
addressesstring[] · min: 1 · max: 500Required
Responses
200
Successful response
application/json
400
Invalid input data
application/json
500
Internal server error
application/json
post
POST /api/v2/users/by/address HTTP/1.1
Host: api.ethos.network
Content-Type: application/json
Accept: */*
Content-Length: 22
{
"addresses": [
"text"
]
}
[
{
"id": 1,
"profileId": 1,
"displayName": "text",
"username": "text",
"avatarUrl": "https://example.com",
"description": "text",
"score": 1,
"status": "ACTIVE",
"userkeys": [
"text"
],
"xpTotal": 1,
"xpStreakDays": 1,
"stats": {
"review": {
"received": {
"negative": 1,
"neutral": 1,
"positive": 1
}
},
"vouch": {
"given": {
"amountWeiTotal": 1,
"count": 1
},
"received": {
"amountWeiTotal": 1,
"count": 1
}
}
}
}
]
Body
profileIdsinteger[] · min: 1 · max: 500Required
Responses
200
Successful response
application/json
400
Invalid input data
application/json
500
Internal server error
application/json
post
POST /api/v2/users/by/profile-id HTTP/1.1
Host: api.ethos.network
Content-Type: application/json
Accept: */*
Content-Length: 18
{
"profileIds": [
1
]
}
[
{
"id": 1,
"profileId": 1,
"displayName": "text",
"username": "text",
"avatarUrl": "https://example.com",
"description": "text",
"score": 1,
"status": "ACTIVE",
"userkeys": [
"text"
],
"xpTotal": 1,
"xpStreakDays": 1,
"stats": {
"review": {
"received": {
"negative": 1,
"neutral": 1,
"positive": 1
}
},
"vouch": {
"given": {
"amountWeiTotal": 1,
"count": 1
},
"received": {
"amountWeiTotal": 1,
"count": 1
}
}
}
}
]
Body
accountIdsOrUsernamesstring[] · min: 1 · max: 500Required
Responses
200
Successful response
application/json
400
Invalid input data
application/json
500
Internal server error
application/json
post
POST /api/v2/users/by/x HTTP/1.1
Host: api.ethos.network
Content-Type: application/json
Accept: */*
Content-Length: 34
{
"accountIdsOrUsernames": [
"text"
]
}
[
{
"id": 1,
"profileId": 1,
"displayName": "text",
"username": "text",
"avatarUrl": "https://example.com",
"description": "text",
"score": 1,
"status": "ACTIVE",
"userkeys": [
"text"
],
"xpTotal": 1,
"xpStreakDays": 1,
"stats": {
"review": {
"received": {
"negative": 1,
"neutral": 1,
"positive": 1
}
},
"vouch": {
"given": {
"amountWeiTotal": 1,
"count": 1
},
"received": {
"amountWeiTotal": 1,
"count": 1
}
}
}
}
]
Body
discordIdsstring[] · min: 1 · max: 500Required
Responses
200
Successful response
application/json
400
Invalid input data
application/json
500
Internal server error
application/json
post
POST /api/v2/users/by/discord HTTP/1.1
Host: api.ethos.network
Content-Type: application/json
Accept: */*
Content-Length: 23
{
"discordIds": [
"text"
]
}
[
{
"id": 1,
"profileId": 1,
"displayName": "text",
"username": "text",
"avatarUrl": "https://example.com",
"description": "text",
"score": 1,
"status": "ACTIVE",
"userkeys": [
"text"
],
"xpTotal": 1,
"xpStreakDays": 1,
"stats": {
"review": {
"received": {
"negative": 1,
"neutral": 1,
"positive": 1
}
},
"vouch": {
"given": {
"amountWeiTotal": 1,
"count": 1
},
"received": {
"amountWeiTotal": 1,
"count": 1
}
}
}
}
]
Query parameters
querystring · min: 2 · max: 100Required
userKeyTypestring · enumOptionalPossible values:
limitinteger · max: 50OptionalDefault:
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
GET /api/v2/users/search HTTP/1.1
Host: api.ethos.network
Accept: */*
{
"values": [
{
"id": 1,
"profileId": 1,
"displayName": "text",
"username": "text",
"avatarUrl": "https://example.com",
"description": "text",
"score": 1,
"status": "ACTIVE",
"userkeys": [
"text"
],
"xpTotal": 1,
"xpStreakDays": 1,
"stats": {
"review": {
"received": {
"negative": 1,
"neutral": 1,
"positive": 1
}
},
"vouch": {
"given": {
"amountWeiTotal": 1,
"count": 1
},
"received": {
"amountWeiTotal": 1,
"count": 1
}
}
}
}
],
"total": 1,
"limit": 1,
"offset": 1
}
Path parameters
userIdintegerRequired
Responses
200
Successful response
application/json
400
Invalid input data
application/json
404
Not found
application/json
500
Internal server error
application/json
get
GET /api/v2/user/{userId} HTTP/1.1
Host: api.ethos.network
Accept: */*
{
"id": 1,
"profileId": 1,
"displayName": "text",
"username": "text",
"avatarUrl": "https://example.com",
"description": "text",
"score": 1,
"status": "ACTIVE",
"userkeys": [
"text"
],
"xpTotal": 1,
"xpStreakDays": 1,
"stats": {
"review": {
"received": {
"negative": 1,
"neutral": 1,
"positive": 1
}
},
"vouch": {
"given": {
"amountWeiTotal": 1,
"count": 1
},
"received": {
"amountWeiTotal": 1,
"count": 1
}
}
}
}
Path parameters
addressstringRequired
Responses
200
Successful response
application/json
400
Invalid input data
application/json
404
Not found
application/json
500
Internal server error
application/json
get
GET /api/v2/user/by/address/{address} HTTP/1.1
Host: api.ethos.network
Accept: */*
{
"id": 1,
"profileId": 1,
"displayName": "text",
"username": "text",
"avatarUrl": "https://example.com",
"description": "text",
"score": 1,
"status": "ACTIVE",
"userkeys": [
"text"
],
"xpTotal": 1,
"xpStreakDays": 1,
"stats": {
"review": {
"received": {
"negative": 1,
"neutral": 1,
"positive": 1
}
},
"vouch": {
"given": {
"amountWeiTotal": 1,
"count": 1
},
"received": {
"amountWeiTotal": 1,
"count": 1
}
}
}
}
Path parameters
profileIdintegerRequired
Responses
200
Successful response
application/json
400
Invalid input data
application/json
404
Not found
application/json
500
Internal server error
application/json
get
GET /api/v2/user/by/profile-id/{profileId} HTTP/1.1
Host: api.ethos.network
Accept: */*
{
"id": 1,
"profileId": 1,
"displayName": "text",
"username": "text",
"avatarUrl": "https://example.com",
"description": "text",
"score": 1,
"status": "ACTIVE",
"userkeys": [
"text"
],
"xpTotal": 1,
"xpStreakDays": 1,
"stats": {
"review": {
"received": {
"negative": 1,
"neutral": 1,
"positive": 1
}
},
"vouch": {
"given": {
"amountWeiTotal": 1,
"count": 1
},
"received": {
"amountWeiTotal": 1,
"count": 1
}
}
}
}
Path parameters
usernamestring · min: 1Required
Responses
200
Successful response
application/json
400
Invalid input data
application/json
404
Not found
application/json
500
Internal server error
application/json
get
GET /api/v2/user/by/username/{username} HTTP/1.1
Host: api.ethos.network
Accept: */*
{
"id": 1,
"profileId": 1,
"displayName": "text",
"username": "text",
"avatarUrl": "https://example.com",
"description": "text",
"score": 1,
"status": "ACTIVE",
"userkeys": [
"text"
],
"xpTotal": 1,
"xpStreakDays": 1,
"stats": {
"review": {
"received": {
"negative": 1,
"neutral": 1,
"positive": 1
}
},
"vouch": {
"given": {
"amountWeiTotal": 1,
"count": 1
},
"received": {
"amountWeiTotal": 1,
"count": 1
}
}
}
}
Path parameters
accountIdOrUsernamestring · min: 1Required
Responses
200
Successful response
application/json
400
Invalid input data
application/json
404
Not found
application/json
500
Internal server error
application/json
get
GET /api/v2/user/by/x/{accountIdOrUsername} HTTP/1.1
Host: api.ethos.network
Accept: */*
{
"id": 1,
"profileId": 1,
"displayName": "text",
"username": "text",
"avatarUrl": "https://example.com",
"description": "text",
"score": 1,
"status": "ACTIVE",
"userkeys": [
"text"
],
"xpTotal": 1,
"xpStreakDays": 1,
"stats": {
"review": {
"received": {
"negative": 1,
"neutral": 1,
"positive": 1
}
},
"vouch": {
"given": {
"amountWeiTotal": 1,
"count": 1
},
"received": {
"amountWeiTotal": 1,
"count": 1
}
}
}
}
Path parameters
discordIdstring · min: 1Required
Responses
200
Successful response
application/json
400
Invalid input data
application/json
404
Not found
application/json
500
Internal server error
application/json
get
GET /api/v2/user/by/discord/{discordId} HTTP/1.1
Host: api.ethos.network
Accept: */*
{
"id": 1,
"profileId": 1,
"displayName": "text",
"username": "text",
"avatarUrl": "https://example.com",
"description": "text",
"score": 1,
"status": "ACTIVE",
"userkeys": [
"text"
],
"xpTotal": 1,
"xpStreakDays": 1,
"stats": {
"review": {
"received": {
"negative": 1,
"neutral": 1,
"positive": 1
}
},
"vouch": {
"given": {
"amountWeiTotal": 1,
"count": 1
},
"received": {
"amountWeiTotal": 1,
"count": 1
}
}
}
}
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
GET /api/v2/users/{userkey}/categories HTTP/1.1
Host: api.ethos.network
Accept: */*
{
"overallRank": 1,
"categoryRanks": [
{
"rank": 1,
"category": {
"id": 1,
"slug": "text",
"name": "text",
"description": "text",
"showOnLeaderboard": true,
"showInDailyService": true,
"bannerImageUrl": "https://example.com",
"userCount": 1
}
}
]
}
Authorizations
Responses
200
Successful response
application/json
401
Authorization not provided
application/json
403
Insufficient access
application/json
500
Internal server error
application/json
post
POST /api/v2/users/refresh/twitter HTTP/1.1
Host: api.ethos.network
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"ok": true,
"message": "text"
}
Authorizations
Path parameters
userkeystringRequired
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
POST /api/v2/users/{userkey}/refresh/twitter HTTP/1.1
Host: api.ethos.network
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"ok": true,
"message": "text"
}