Users

Overview

Returns a general overview of information about a user.

Method GET
Endpoint /user/userID


Output Body (Success)
{
    "version":1,
    "status":200,
    "data":{
        "id":4,
        "username":"thatanimeweirdo",
        "isVerified":true,
        "isPatreon":null,
        "avatar":"https:\/\/spinsha.re\/uploads\/avatar\/5ef8cddb50106.png",
        "songs":0,
		"reviews":0,
		"spinplays":0,
		"cards":[
			{
				"id":1,
				"icon":"http:\/\/localhost\/www\/spinshare\/server\/public\/uploads\/card\/card_b4bcc0b27340a10b012a1ba8a6fd04b0.png",
				"title":"SSSO Spring 2020 Player",
				"description":"This card was given out to every player of the Spring 2020 SpinShare Speen Open tournament."
			},
			...
		]
    }
}

Output Body (Not Found)
{
    "version":1,
    "status":404,
    "data":[]
}

Charts

Returns all public charts of a user.

Method GET
Endpoint /user/userID/charts


Output Body (Success)
{
    "version":1,
    "status":200,
    "data":{[
		{
			"id":1018,
			"title":"Keyboard Combos",
			"subtitle":"",
			"artist":"Discord",
			"charter":"taw.moe",
			"uploader":4,
			"hasEasyDifficulty":false,
			"hasNormalDifficulty":false,
			"hasHardDifficulty":true,
			"hasExtremeDifficulty":false,
			"hasXDDifficulty":false,
			"cover":"https:\/\/spinsha.re\/uploads\/thumbnail\/spinshare_5f2c729b8ea3b.jpg",
			"zip":"https:\/\/spinsha.re\/api\/song\/1018\/download"
		},
		...
	]}
}

Output Body (Not Found)
{
    "version":1,
    "status":404,
    "data":[]
}

Reviews

Returns all reviews of a user.

Method GET
Endpoint /user/userID/reviews


Output Body (Success)
{
    "version":1,
    "status":200,
    "data":{[
		{
		   "id":22,
		   "user":{
			  "id":9,
			  "username":"testtest",
			  "coverReference":null,
			  "isVerified":null,
			  "isPatreon":null
		   },
		   "recommended":false,
		   "comment":"I did not enjoy this",
		   "reviewDate":{
			  "date":"2020-08-22 18:22:56.000000",
			  "timezone_type":3,
			  "timezone":"Europe\/Berlin"
		   }
		},
		...
	]}
}

Output Body (Not Found)
{
    "version":1,
    "status":404,
    "data":[]
}

SpinPlays

Returns all SpinPlays of a user.

Method GET
Endpoint /user/userID/spinplays


Output Body (Success)
{
    "version":1,
    "status":200,
    "data":{[
		{
			"id":13,
			"user":{
				"id":1,
				"username":"taw",
				"coverReference":"5f4147b117c7b.png",
				"isVerified":true,
				"isPatreon":true
			},
			"videoUrl":"https:\/\/youtu.be\/tPycD9OwojQ",
			"videoThumbnail":"https:\/\/i.ytimg.com\/vi\/tPycD9OwojQ\/maxresdefault.jpg",
			"submitDate":{
				"date":"2020-07-20 18:48:49.000000",
				"timezone_type":3,
				"timezone":"Europe\/Berlin"
			},
			"isActive":true
		},
		...
	]}
}

Output Body (Not Found)
{
    "version":1,
    "status":404,
    "data":[]
}