Search users by query string

GET

/users/search

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Get,
    RequestUri = new Uri("https://api.ethos.network/api/v2/users/search?query=example&userKeyType=ADDRESS&limit=50&offset=0"),
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

package main

import (
  "fmt"
  "net/http"
  "io"
)

func main() {

  url := "https://api.ethos.network/api/v2/users/search?query=example&userKeyType=ADDRESS&limit=50&offset=0"

  req, _ := http.NewRequest("GET", url, nil)

  res, _ := http.DefaultClient.Do(req)

  defer res.Body.Close()
  body, _ := io.ReadAll(res.Body)

  fmt.Println(res)
  fmt.Println(string(body))

}

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://api.ethos.network/api/v2/users/search?query=example&userKeyType=ADDRESS&limit=50&offset=0")
  .get()
  .build();

Response response = client.newCall(request).execute();

import axios from 'axios';

const options = {
  method: 'GET',
  url: 'https://api.ethos.network/api/v2/users/search',
  params: {query: 'example', userKeyType: 'ADDRESS', limit: '50', offset: '0'}
};

try {
  const { data } = await axios.request(options);
  console.log(data);
} catch (error) {
  console.error(error);
}

const url = 'https://api.ethos.network/api/v2/users/search?query=example&userKeyType=ADDRESS&limit=50&offset=0';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

use reqwest;

#[tokio::main]
pub async fn main() {
    let url = "https://api.ethos.network/api/v2/users/search";

    let querystring = [
        ("query", "example"),
        ("userKeyType", "ADDRESS"),
        ("limit", "50"),
        ("offset", "0"),
    ];

    let client = reqwest::Client::new();
    let response = client.get(url)
        .query(&querystring)
        .send()
        .await;

    let results = response.unwrap()
        .json::<serde_json::Value>()
        .await
        .unwrap();

    dbg!(results);
}

curl --request GET \
  --url 'https://api.ethos.network/api/v2/users/search?query=example&userKeyType=ADDRESS&limit=50&offset=0'

Searches by display name, Ethos username, ENS name or exact address. Use an exact lookup endpoint when you already know an address or account id. Returns 429 when search is busy or the query is too slow; retry with a more specific query.

Parameters

Query Parameters

query

required

string

>= 2 characters <= 100 characters

userKeyType

string

Allowed values: ADDRESS DISCORD FARCASTER GITHUB PUMPFUN SOLANA TELEGRAM TWITTER PROFILE

limit

integer

default: 50 <= 50

offset

integer

0 <= 2147483647

Responses

200

Successful response

application/json

object

values

required

Array<object>

object

required

number

profileId

required

number | null

displayName

required

string

username

required

string | null

avatarUrl

required

string format: uri

description

required

string | null

score

required

number

status

required

string

Allowed values: ACTIVE INACTIVE MERGED

userkeys

required

Array<string>

xpTotal

required

number

xpStreakDays

required

number

xpRemovedDueToAbuse

required

boolean

influenceFactor

required

number

influenceFactorPercentile

required

number

humanVerificationStatus

Any of:

string
null

string

Allowed values: REQUESTED VERIFIED REVOKED PENDING

validatorNftCount

required

number

meowMeowsNftCount

required

number

links

required

object

profile

required

string format: uri

scoreBreakdown

required

string format: uri

stats

required

object

holdingsWei

required

Any of:

integer
null

integer format: int64

review

required

object

received

required

object

negative

required

number

neutral

required

number

positive

required

number

vouch

required

@deprecated Native-currency lifetime totals only. Use stats.vouchTotals (per-token). Removed after 2026-10-20.

object

given

required

object

amountWeiTotal

required

integer format: int64

count

required

number

received

required

object

amountWeiTotal

required

integer format: int64

count

required

number

vouchTotals

required

Array<object>

>= 1 items

object

balance

required

object

given

required

integer format: int64

received

required

integer format: int64

count

required

object

given

required

integer

<= 9007199254740991

received

required

integer

<= 9007199254740991

token

required

object

address

required

Any of:

string
null

Ethereum address (0x-prefixed, 20 bytes)

string

decimals

required

integer

<= 9007199254740991

required

Lowercase token identifier

string

Allowed values: eth whuf

whufGuarantee

required

Any of:

object
null

object

asOf

required

string

expiresAt

required

string | null

guaranteedWei

required

integer format: int64

status

required

string

Allowed values: active expired

total

required

number

limit

required

number

offset

required

number

Example

{
  "values": [
    {
      "status": "ACTIVE",
      "humanVerificationStatus": "REQUESTED",
      "stats": {
        "vouchTotals": [
          {
            "token": {
              "id": "eth"
            }
          }
        ],
        "whufGuarantee": {
          "status": "active"
        }
      }
    }
  ]
}

400

Invalid input data

application/json

Invalid input data error (400)

The error information

object

message

required

The error message

string

code

required

The error code

string

issues

An array of issues that were responsible for the error

Array<object>

object

message

required

string

Example

{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}

404

Not found

application/json

Not found error (404)

The error information

object

message

required

The error message

string

code

required

The error code

string

issues

An array of issues that were responsible for the error

Array<object>

object

message

required

string

Example

{
  "code": "NOT_FOUND",
  "message": "Not found",
  "issues": []
}

500

Internal server error

application/json

Internal server error error (500)

The error information

object

message

required

The error message

string

code

required

The error code

string

issues

An array of issues that were responsible for the error

Array<object>

object

message

required

string

Example

{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}