Search users by nickname

Search users by nicknameClient-side

get/users/search/by_nickname

Searches users by the nickname parameter and gets a list of them. Search can be performed instantly when the user starts entering the search parameter.

The workflow of using this call:

The user enters a nickname or tag, or nickname and tag.
The Xsolla Login server searches for users in the Login project data of the user who initiated a search.

The current user can execute this call only one time per second.

SecurityBearer

Request

query Parameters

nickname required	string [ 3 .. 255 ] characters The search string that may contain: nickname only. Search is performed by substring at the beginning of the nickname. tag only, is used with "#" at the beginning. Search is performed by substring at the beginning of the tag. nickname and tag together, is used with "#" and without space. Search is performed by full nickname and substring at the beginning of the tag.
offset	integer [ 0 .. 100 ] Default: 0 Number of the elements from which the list is generated.
limit	integer [ 1 .. 100 ] Default: 100 Maximum number of users that are returned at a time.

Responses

200

401

Unauthorized

422

Unprocessable Entity

429

Too Many Requests

Request samples

curl --request GET \
  --url 'https://login.xsolla.com/api/users/search/by_nickname?nickname=SOME_STRING_VALUE&offset=0&limit=100' \
  --header 'Authorization: Bearer BEARER_TOKEN'

Response samples

application/json

{"offset": 3,
"total_count": 100,
"users": [{"avatar": "https://pbs.twimg.com/profile_images/874276177757336672/kUuht00m_400x400.jpg",
"is_me": true,
"last_login": "2018-10-01T13:15:08+05:00",
"nickname": "Quana",
"registered": "2018-10-01T13:15:08+05:00",
"tag": "24234",
"user_id": "2a6e0079-d7a7-11e8-963b-82010aa80778"
},
{"avatar": "https://pbs.twimg.com/profile_images/874276177757336222/kUuht00m_400x400.jpg",
"is_me": false,
"last_login": "2018-10-01T13:15:08+05:00",
"nickname": "Quanare",
"registered": "2018-10-01T13:15:08+05:00",
"tag": "249078",
"user_id": "1e6e2979-d7f7-11e8-963b-42010aa80910"
},
{"is_me": false,
"last_login": "2018-10-01T13:15:08+05:00",
"nickname": "Quanare",
"registered": "2018-10-01T13:15:08+05:00",
"tag": "434535",
"user_id": "2e6e2979-d7f7-11e8-963b-42010aa80922"
}
]
}