Search endpoint

Methods

• POST search/visit_user_by_nickname
• POST search/visit_user_by_email
• POST search/visit_random_user
• GET search/friend_by_nickname
• GET search/friend_by_email
• GET search/random_friend

Note: the GET operations of this endpoint can be used for searching banned users.

POST search/visit_user_by_nickname

This method searches a user by using its nickname and registers a visit from the client's account.

Parameters

Field	Notes
n	User nickname.

Response

Type	Field	Notes
int	version	Version the last save the user made.
int	revision	Revision the last save the user made.
string	state	Object of the current save state of the user as a string.
int	i	Account ID of the user.
string	n	Nickname of the user.
string	nF	Number of favorites of the user.
string	nL	Number of likers of the user.
int	iL	Bool telling if the client's account likes the user as an integer.
int	lM	Bool telling if the user likes the client's account as an integer.
bool	success	If the request has been successful.

POST search/visit_user_by_email

This method searches a user by using its email address and registers a visit from the client's account.

Parameters

Field	Notes
e	User email address.

Response

Type	Field	Notes
int	version	Version the last save the user made.
int	revision	Revision the last save the user made.
string	state	Object of the current save state of the user as a string.
int	i	Account ID of the user.
string	n	Nickname of the user.
string	nF	Number of favorites of the user.
string	nL	Number of likers of the user.
int	iL	Bool telling if the client's account likes the user as an integer.
int	lM	Bool telling if the user likes the client's account as an integer.
bool	success	If the request has been successful.

POST search/visit_random_user

This method searches a random user and registers a visit from the client's account.

Parameters

This method has no parameters.

Response

Type	Field	Notes
int	version	Version the last save the user made.
int	revision	Revision the last save the user made.
string	state	Object of the current save state of the user as a string.
int	i	Account ID of the user.
string	n	Nickname of the user.
string	nF	Number of favorites of the user.
string	nL	Number of likers of the user.
int	iL	Bool telling if the client's account likes the user as an integer.
int	lM	Bool telling if the user likes the client's account as an integer.
bool	success	If the request has been successful.

GET search/friend_by_nickname

This method searches a user by using its nickname. Although the method is labeled as for friends, this can be used for searching any user.

Parameters

Field	Notes
n	User nickname.

Response

Type	Field	Notes
bool	found	If the user has been found.
string	i	Account ID of the user.
string	n	Nickname of the user.
string	minI	Object holding the Pou data of the user as a string.
string	l	Unknown purpose.
string	nF	Number of favorites of the user.
string	nL	Number of likers of the user.

GET search/friend_by_email

This method searches a user by using its email address. Although the method is labeled as for friends, this can be used for searching any user.

Parameters

Field	Notes
e	User email address.

Response

Type	Field	Notes
bool	found	If the user has been found.
string	i	Account ID of the user.
string	n	Nickname of the user.
string	minI	Object holding the Pou data of the user as a string.
string	l	Unknown purpose.
string	nF	Number of favorites of the user.
string	nL	Number of likers of the user.

GET search/random_friend

This method searches a random user. Although the method is labeled as for friends, this can be used for searching any user.

Parameters

This method has no parameters.

Response

Type	Field	Notes
bool	found	If the user has been found.
string	i	Account ID of the user.
string	n	Nickname of the user.
string	minI	Object holding the Pou data of the user as a string.
string	l	Unknown purpose.
string	nF	Number of favorites of the user.
string	nL	Number of likers of the user.