Users

We are not affiliated with floatplane.com / Floatplane Media / Linus Media Group. This is a community driven, open source project.

get
Get own user data

https://floatplaneapi.com/v1/user/self
Get the user data for the authentication token that the request is being made with. Gives extra info like email address.
Request
Response
Headers
x-fpapi-token
required
string
The authentication token
200: OK
{
"id": "5c4dda93ff5da432730949fa",
"username": "joe1",
"profileImage": {
"width": 512,
"height": 512,
"path": "https://pbs.floatplanecdn.com/profile_images/default/user2.png",
"childImages": [{
"width": 250,
"height": 250,
"path": "https://pbs.floatplanecdn.com/profile_images/default/user2_250x250.png"
}, {
"width": 100,
"height": 100,
"path": "https://pbs.floatplanecdn.com/profile_images/default/user2_100x100.png"
}]
},
"email": "joe1@demo.com",
"displayName": "Joe Demo",
"isSpoofed": false
}
500: Internal Server Error
{
"error: ": "internal server error"
}

get
Get other users data

https://floatplaneapi.com/v1/user/info
Get one or more users basic information like username and profile picture. Gives advanced info when requested with own ID.
Request
Response
Headers
x-fpapi-token
required
string
The authentication token.
Query Parameters
id
required
string
The user id for the user that you are requesting.
200: OK
{
"users": [{
"id": "5c4dda93ff5da432730949fa",
"user": {
"id": "5c4dda93ff5da432730949fa",
"username": "joe1",
"profileImage": {
"width": 512,
"height": 512,
"path": "https://pbs.floatplanecdn.com/profile_images/default/user2.png",
"childImages": [{
"width": 250,
"height": 250,
"path": "https://pbs.floatplanecdn.com/profile_images/default/user2_250x250.png"
}, {
"width": 100,
"height": 100,
"path": "https://pbs.floatplanecdn.com/profile_images/default/user2_100x100.png"
}]
}
}
}]
}
403: Forbidden
{
"id": "tx7s-uhwb-syn4",
"errors": [{
"id": "tx7s-uhwb-syn4",
"name": "notLoggedInError",
"message": "You must be logged-in to access this resource."
}],
"message": "You must be logged-in to access this resource."
}
500: Internal Server Error
{
"error": "internal server error"
}

You can request multiple users at once by comma separating user id's in the id field. An example of this would be https://floatplaneapi.com/v1/user/info?id=5a9a98c863da203a36cf39f0,5c4dda93ff5da432730949fa``

get
Get other users data

https://floatplaneapi.com/v1/user/named
Get one or more users basic information like id and profile picture. Gives advanced info when requested with own username.
Request
Response
Headers
x-fpapi-token
required
string
The authentication token
Query Parameters
username
required
string
The username for the user that you are requesting
200: OK
{
"users": [{
"id": "5c4dda93ff5da432730949fa",
"user": {
"id": "5c4dda93ff5da432730949fa",
"username": "joe1",
"profileImage": {
"width": 512,
"height": 512,
"path": "https://pbs.floatplanecdn.com/profile_images/default/user2.png",
"childImages": [{
"width": 250,
"height": 250,
"path": "https://pbs.floatplanecdn.com/profile_images/default/user2_250x250.png"
}, {
"width": 100,
"height": 100,
"path": "https://pbs.floatplanecdn.com/profile_images/default/user2_100x100.png"
}]
}
}
}]
}
403: Forbidden
{
"id": "tx7s-uhwb-syn4",
"errors": [{
"id": "tx7s-uhwb-syn4",
"name": "notLoggedInError",
"message": "You must be logged-in to access this resource."
}],
"message": "You must be logged-in to access this resource."
}
500: Internal Server Error
{
"error": "internal server error"
}

You can request multiple users at once by comma separating user names in the username field. An example of this would be https://floatplaneapi.com/v1/user/named?username=joe1,joe2