hajime/docs/profileapi.md
2023-08-12 00:16:32 +02:00

848 B

Read-only Profile API Documentation

Successful API result (Example: https://retro.flash.moe/u/2/api)

{
	"userID":			User ID of user,
	"userName":			Username of user,
	"userAvatar":		Full HTTP uri to avatar,
	"userBackground":	Full HTTP uri to profile background,
	"userTitle":		User Title of user,
	"groupID":			Group ID of user,
	"groupName":		Group Name of user,
	"groupColour":		Hexadecimal Group Colour value of user,
	"joinTimeStamp":	Join date UNIX Epoch Timestamp,
	"lastTimeStamp":	Last active UNIX Epoch Timestamp,
	"markdown":			Markdown of user profile base64 encoded,
	"error":			Negative result indicating no errors
}

Unsuccessful API result (Example: https://retro.flash.moe/u/40/api)

{
	"error":			Positive result indicating the user doesn't exist
}

Example of something using this api https://flash.moe/apitest