Users

Get multiple users by user IDs

post
Body
userIdsinteger[] · min: 1 · max: 500Required
Responses
200
Successful response
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,
    "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
        }
      }
    }
  }
]

Get multiple users by Ethereum addresses

post
Body
addressesstring[] · min: 1 · max: 500Required
Responses
200
Successful response
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,
    "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
        }
      }
    }
  }
]

Get multiple users by profile IDs

post
Body
profileIdsinteger[] · min: 1 · max: 500Required
Responses
200
Successful response
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,
    "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
        }
      }
    }
  }
]

Get multiple users by Twitter/X account IDs or usernames

post
Body
accountIdsOrUsernamesstring[] · min: 1 · max: 500Required
Responses
200
Successful response
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,
    "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
        }
      }
    }
  }
]

Get multiple users by Discord user IDs

post
Body
discordIdsstring[] · min: 1 · max: 500Required
Responses
200
Successful response
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,
    "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
        }
      }
    }
  }
]

Get multiple users by Farcaster user IDs

post
Body
farcasterIdsstring[] · min: 1 · max: 500Required
Responses
200
Successful response
application/json
post
POST /api/v2/users/by/farcaster HTTP/1.1
Host: api.ethos.network
Content-Type: application/json
Accept: */*
Content-Length: 25

{
  "farcasterIds": [
    "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,
    "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
        }
      }
    }
  }
]

Get multiple users by Farcaster usernames

post

Bulk lookup of users by Farcaster usernames. Results are categorized into three arrays:

• "users": Successfully matched usernames with their Ethos user data

• "notFoundUsernames": Valid usernames with no associated Ethos users

• "errorUsernames": Usernames that failed lookup due to network/API errors

Both "users" and "notFoundUsernames" results can be cached safely.

Body
farcasterUsernamesstring[] · min: 1 · max: 500Required
Responses
200
Successful response
application/json
post
POST /api/v2/users/by/farcaster/usernames HTTP/1.1
Host: api.ethos.network
Content-Type: application/json
Accept: */*
Content-Length: 31

{
  "farcasterUsernames": [
    "text"
  ]
}
{
  "users": [
    {
      "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,
        "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
            }
          }
        }
      },
      "username": "text"
    }
  ],
  "notFoundUsernames": [
    "text"
  ],
  "errorUsernames": [
    "text"
  ]
}

Get multiple users by Telegram user IDs

post
Body
telegramIdsstring[] · min: 1 · max: 500Required
Responses
200
Successful response
application/json
post
POST /api/v2/users/by/telegram HTTP/1.1
Host: api.ethos.network
Content-Type: application/json
Accept: */*
Content-Length: 24

{
  "telegramIds": [
    "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,
    "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
        }
      }
    }
  }
]

Search users by query string

get
Query parameters
querystring · min: 2 · max: 100Required
userKeyTypestring · enumOptionalPossible values:
limitinteger · max: 50OptionalDefault: 50
offsetnumberOptionalDefault: 0
Responses
200
Successful response
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,
      "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
          }
        }
      }
    }
  ],
  "total": 1,
  "limit": 1,
  "offset": 1
}

Get a specific user by user ID

get
Path parameters
userIdintegerRequired
Responses
200
Successful response
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,
  "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
      }
    }
  }
}

Get a user by Ethereum address

get
Path parameters
addressstringRequired
Responses
200
Successful response
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,
  "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
      }
    }
  }
}

Get a user by profile ID

get
Path parameters
profileIdintegerRequired
Responses
200
Successful response
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,
  "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
      }
    }
  }
}

Get a user by username

get
Path parameters
usernamestring · min: 1Required
Responses
200
Successful response
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,
  "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
      }
    }
  }
}

Get a user by Twitter/X account ID or username

get
Path parameters
accountIdOrUsernamestring · min: 1Required
Responses
200
Successful response
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,
  "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
      }
    }
  }
}

Get a user by Discord user ID

get
Path parameters
discordUserIdstring · min: 1Required
Responses
200
Successful response
application/json
get
GET /api/v2/user/by/discord/{discordUserId} 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,
  "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
      }
    }
  }
}

Get a user by Farcaster user ID

get
Path parameters
farcasterUserIdstring · min: 1Required
Responses
200
Successful response
application/json
get
GET /api/v2/user/by/farcaster/{farcasterUserId} 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,
  "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
      }
    }
  }
}

Get a user by Farcaster username

get
Path parameters
farcasterUsernamestring · min: 1Required
Responses
200
Successful response
application/json
get
GET /api/v2/user/by/farcaster/username/{farcasterUsername} 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,
  "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
      }
    }
  }
}

Get a user by Telegram user ID

get
Path parameters
telegramUserIdstring · min: 1Required
Responses
200
Successful response
application/json
get
GET /api/v2/user/by/telegram/{telegramUserId} 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,
  "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
      }
    }
  }
}

Get overall position on leaderboard and position in each category for user

get
Path parameters
userkeystringRequired
Responses
200
Successful response
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
      }
    }
  ]
}

Refresh x.com profile details like name, avatar, etc.

post
Authorizations
Responses
200
Successful response
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"
}

Refresh x.com profile details like name, avatar, etc.

post
Authorizations
Path parameters
userkeystringRequired
Responses
200
Successful response
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"
}
PreviousSystemNextVotes