Laby API Documentation

Note

These docs are in no way associated with LabyMedia, some endpoints may be missing or incorrect.

Warning

The Laby API is not made as a public API, stability of the API is not guaranteed.

Player username to UUID

Endpoint: GET /api/v3/user/:username/uniqueId

Description: This returns the UUID of an username.

Request:

GET /api/v3/user/Notch/uniqueId

Response:

{
    "uniqueId": "069a79f4-44e9-4726-a5be-fca90e38aaf5",
    "username": "Notch"
}

Player UUID to profile

Endpoint: GET /api/v3/user/:uuid/profile

Description: This returns the name, skin and cape history of an UUID.

Request:

GET /api/v3/user/069a79f4-44e9-4726-a5be-fca90e38aaf5/profile

Response:

{
    "uuid": "069a79f4-44e9-4726-a5be-fca90e38aaf5",
    "username": "Notch",
    "username_history": [
        {
            "username": "Notch",
            "changed_at": null,
            "accurate": true,
            "last_seen_at": "2023-12-11T17:03:45+00:00"
        }
    ],
    "textures": {
        "SKIN": [
            {
                "type": "SKIN",
                "image_hash": "f3fa11e8f7b48bf03174112285f04d99",
                "file_hash": "b77b847bd7db0dbeb86e9bc193b56ba2",
                "first_seen_at": "2022-08-14T14:10:35+00:00",
                "last_seen_at": "2023-12-11T17:03:45+00:00",
                "slim_skin": false,
                "active": true
            }
        ],
        "CLOAK": [
            {
                "type": "CLOAK",
                "image_hash": "63d21407ea2cbe6213e3c22f3be74ad5",
                "file_hash": "8a3b459f5fd17b28be473aa84b7e36ee",
                "first_seen_at": "2021-04-22T17:29:03+00:00",
                "last_seen_at": "2021-07-05T19:22:43+00:00"
            }
        ]
    }
}

Player UUID to names

Endpoint: GET /api/v3/user/:uuid/names

Description: This returns the profile names of an UUID.

Request:

GET /api/v3/user/069a79f4-44e9-4726-a5be-fca90e38aaf5/names

Response:

[
    {
        "username": "Notch",
        "changed_at": null,
        "accurate": true,
        "last_seen_at": "2023-12-11T20:55:56+00:00"
    }
]

Player UUID to snippet

Endpoint: GET /api/v3/user/:uuid/snippet

Description: This returns the profile snippet of an UUID.

Request:

GET /api/v3/user/069a79f4-44e9-4726-a5be-fca90e38aaf5/snippet

Response:

{
    "user": {
        "uuid": "069a79f4-44e9-4726-a5be-fca90e38aaf5",
        "username": "Notch"
    },
    "role": {
        "nice_name": "LabyMod+",
        "color_minecraft": "e"
    },
    "settings": {
        "background": "NONE"
    },
    "name_history": [
        {
            "username": "Notch",
            "changed_at": null,
            "accurate": true,
            "last_seen_at": "2023-12-11T19:02:46+00:00"
        }
    ],
    "badges": [
        {
            "uuid": "cb7f5156-2825-4064-8631-6423d76faf0f",
            "name": "Notch",
            "description": "The founder of Minecraft",
            "received_at": "2009-05-09T22:00:00+00:00"
        }
    ]
}

Player UUID to badges

Endpoint: GET /api/v3/user/:uuid/badges

Description: This returns the profile badges of an UUID.

Request:

GET /api/v3/user/069a79f4-44e9-4726-a5be-fca90e38aaf5/badges

Response:

[
    {
        "uuid": "cb7f5156-2825-4064-8631-6423d76faf0f",
        "name": "Notch",
        "description": "The founder of Minecraft",
        "received_at": "2009-05-09T22:00:00+00:00"
    }
]

Player UUID to accounts

Endpoint: GET /api/v3/user/:uuid/accounts

Description: This returns the profile linked accounts of an UUID.

Request:

GET /api/v3/user/1dc85f66-6776-4f64-b3b5-c6f3f72155d8/accounts

Response:

[
    {
        "user_name": "MentallyBurdened",
        "uuid": "66429d89-60f0-4084-8a14-1fae3f3510b4",
        "color_minecraft": null,
        "main": false
    },
    ...
]

Player UUID to socials

Endpoint: GET /api/v3/user/:uuid/socials

Description: This returns the profile socials of an UUID.

Request:

GET /api/v3/user/1dc85f66-6776-4f64-b3b5-c6f3f72155d8/socials

Response:

[
    {
        "name": "n3liz",
        "service": "discord",
        "service_name": "Discord",
        "url": "https://discord.com/users/990552479659884564"
    },
    ...
]

Player UUID to friends

Endpoint: GET /api/v3/user/:uuid/friends

Description: This returns the profile friends of an UUID.

Request:

GET /api/v3/user/1dc85f66-6776-4f64-b3b5-c6f3f72155d8/friends

[
    {
        "uuid": "74843df9-40ad-4cbe-904c-2cee69ef7581",
        "user_name": "Northernside",
        "role_color": "e"
    },
    ...
]

Player UUID to status

Endpoint: GET /api/v3/user/:uuid/status

Description: This returns the profile status of an UUID.

Request:

GET /api/v3/user/1dc85f66-6776-4f64-b3b5-c6f3f72155d8/status

Response:

{
    "status": "I should do my homework"
}

Player UUID to views

Endpoint: GET /api/v3/user/:uuid/views

Description: This returns the monthly profile views of an UUID.

Request:

GET /api/v3/user/1dc85f66-6776-4f64-b3b5-c6f3f72155d8/views

Response:

{
    "views": 48
}

Player UUID to hearts

Endpoint: GET /api/v3/user/:uuid/heart

Description: This returns the profile hearts of an UUID.

Request:

GET /api/v3/user/1dc85f66-6776-4f64-b3b5-c6f3f72155d8/heart

Response:

{
    "count": 0,
    "status": null
}

Player UUID to emotes

Endpoint: GET /api/v3/user/:uuid/emotes

Description: This returns the labymod emotes of an UUID.

Request:

GET /api/v3/user/1dc85f66-6776-4f64-b3b5-c6f3f72155d8/emotes

Response:

[
    {
        "emote_id": 40,
        "name": "Freezing",
        "rare": false
    },
    ...
]

Player UUID to online status

Endpoint: GET /api/v3/user/:uuid/online-status

Description: This returns the labymod status of an UUID.

Request:

GET /api/v3/user/1dc85f66-6776-4f64-b3b5-c6f3f72155d8/online-status

Response:

{
    "online":false,
    "status":"OFFLINE"
}

Player UUID to game stats

Endpoint: GET /api/v3/user/:uuid/game-stats

Description: This returns the labymod statistics of an UUID.

Request:

GET /api/v3/user/1dc85f66-6776-4f64-b3b5-c6f3f72155d8/game-stats

Response:

{
    "first_joined": "2023-02-02T19:42:33+00:00",
    "last_online": "2023-12-11T06:35:00+00:00"
}

Badges

Endpoint: GET /api/v3/badges

Description: This returns all badges.

Request:

GET /api/v3/badges

Response:

[
    {
        "id": 25,
        "uuid": "849ecc93-e70b-11eb-8891-d67b6288368f",
        "name": "Duplicate Name",
        "description": "The name of the user exists twice in the Minecraft database"
    },
    ...
]

Badge UUID to info

Endpoint: GET /api/v3/badge/:uuid

Description: This returns the info of a badge.

Request:

GET /api/v3/badge/b9d1d993-8841-4346-8008-5a6ddc8bd688

Response:

{
    "id": 32,
    "uuid": "b9d1d993-8841-4346-8008-5a6ddc8bd688",
    "name": "All Minecon capes",
    "description": "The account owns all existing Minecon capes"
}

Badge UUID to players

Endpoint: GET /api/badge/:uuid

Description: This returns the UUIDs of players with the specified badge.

Request:

GET /api/badge/b9d1d993-8841-4346-8008-5a6ddc8bd688

Response:

[
    "53f7e4c8-9469-4829-997d-f9a522e04b95",
    ...
]

Search Player

Endpoint: GET /api/search/names/:name:

Description: This returns a list of usernames and UUIDs for players matching the specified query

Request:

GET /api/search/names/Tvrki

Response:

{
  "results": [
    {
      "user_name": "Tvrki",
      "name": "Tvrki",
      "uuid": "ef6fafc3-15bd-450c-bbcb-78b263df2e8a"
    },
    {
      "user_name": "TVRkid",
      "name": "TVRkid",
      "uuid": "7ec51386-7d57-4dd8-9adb-31d612fe3b49"
    },
    {
      "user_name": "Tvrkii",
      "name": "Tvrkii",
      "uuid": "dd4f69e8-83a8-431e-a18b-7ff0ac887d22"
    },
    '''
  ]
}

Skins

Endpoint: GET /api/v3/search/textures/skin?page=:page:&order=:order:&size=:size:&offset=:offset:

Description: allows users to retrieve a list of skins

Parameter	Type	Description	Example
`order`	String	Specifies the order of the results. Options include:	`trending_24h`
		- `trending_30d`: Shows skins that are trending over the last 30 days.
		- `trending_7d`: Shows skins that are trending over the last 7 days.
		- `trending_24h`: Shows skins that are trending over the last 24 hours.
		- `most_used`: Shows the most used skins overall.
		- `latest`: Shows the most recently uploaded skins.
`size`	Int	Specifies the size of the returned skin images in pixels.	`40`
`offset`	Int	Specifies the number of skins to skip before starting to collect results.	`0`
`page`	Int	Specifies the page number of results to retrieve for pagination.	`1`

Request:

GET /api/v3/search/textures/skin?size=40&offset=0&order=trending_24h

Response:

{
  "results": [
    {
      "image_hash": "b0f1d45ebdcb0ba4f97178da70477ce8",
      "use_count": 8131,
      "tags": "Brown Hair Shorts Derp Simple Weird",
      "slim": true
    },
    {
      "image_hash": "bdaa28d62f5e439258f16cdc1a1c81cc",
      "use_count": 1768,
      "tags": null,
      "slim": false
    },
    {
      "image_hash": "9552852e575e7acb9633fd0385a50ba8",
      "use_count": 11368,
      "tags": "Genshin Genshin Impact Hu Tao Female Woman",
      "slim": true
    },
    {
      "image_hash": "97fc60b009e40ae4b7722d47ba6f6883",
      "use_count": 95,
      "tags": null,
      "slim": false
    },
    {
      "image_hash": "dbfd7bd6f9f9bd19ed28789db9bb16d3",
      "use_count": 17663,
      "tags": "Girl Cute Animal Bear White",
      "slim": true
    },
'''
  ]
}

Skins Tag

Endpoint: GET /api/v3/tags?offset=:offset:&size=:size:

Description: This API returns skins data based on its tags..

Parameter	Type	Description	Default Value
`offset`	Integer	The starting point for the returned data set. Used for pagination.	`0`
`size`	Integer	The number of tags to return in the response.	`40`

Request:

GET /api/v3/tags?offset=0&size=40

Response:

[
  {
    "id": 3265,
    "name": "Girl",
    "use_count": 188109,
    "preview": [
      {
        "image_hash": "e0788c2cce724b226dc85cd465caf976",
        "slim": true
      },
      {
        "image_hash": "db1a475778364635a79767b35dde4348",
        "slim": true
      },
      {
        "image_hash": "5f61ed90d008c549e0de679fba39c682",
        "slim": true
      }
    ]
  },
  {
    "id": 2693,
    "name": "Cute",
    "use_count": 110806,
    "preview": [
      {
        "image_hash": "05667dd6808e0b5a7486a137c83ec802",
        "slim": false
      },
      {
        "image_hash": "1a141e0894e77cb0bb73f35273a92bc2",
        "slim": true
      },
      {
        "image_hash": "9eef4296fc9aa307bd1456011b8081ef",
        "slim": true
      }
    ]
  },
  {
    "id": 448,
    "name": "Boy",
    "use_count": 78506,
    "preview": [
      {
        "image_hash": "f7ecd5e204a72e622d3f1805c3d810f9",
        "slim": false
      },
      {
        "image_hash": "bbb12131b90bc20eb8e579cb727433b2",
        "slim": true
      },
      {
        "image_hash": "8ed4eaf490feab5004d7540905f14a74",
        "slim": true
      }
    ]
  },
  '''
  }
]

Featured servers

Endpoint: GET /api/v3/featured/servers

Description: This returns featured servers.

Request:

GET /api/v3/featured/servers

Response:

[
    {
      "server_name": "hypixel",
      "nice_name": "Hypixel Network",
      "last_player_count": 56369,
      "max_players": 200000,
      "direct_ip": "mc.hypixel.net",
      "icon": "data:image/png;base64,"
    },
    ...
]

Featured users

Endpoint: GET /api/v3/featured/users

Description: This returns featured users.

Request:

GET /api/v3/featured/users

Response:

[
    {
        "uuid": "34e57efa-5783-46c7-a9fc-890296aaba1f",
        "username": "LabyStudio",
        "name": "LabyStudio",
        "badges": [
            {
                "uuid": "ec16a378-c15b-4e6b-a856-d2220b98d3ae",
                "name": "Cape Collector",
                "description": "The account owns 4 different capes or more",
                "received_at": "2023-10-26T19:00:54+00:00"
            },
            ...
        ]
    },
    ...
]

Statistics

Endpoint: GET /api/v3/statistics

Description: This returns database statistics.

Request:

GET /api/v3/statistics

Response:

{
    "minecraft": {
        "amount": 62724811,
        "velocity": 0.24818442749268
    },
    "labynet": {
        "amount": 57786385,
        "velocity": 0.0201997757824888,
        "contributions": []
    }
}

Capes

Endpoint: GET /api/v3/capes

Description: This returns information on all Mojang capes.

Request:

GET /api/v3/capes

Response:

[
  {
    "name": "MineCon 2016",
    "description": {
      "en": "This cape was given to all players who attended MINECON 2016. A redemption link was emailed to all MINECON 2016 attendees who scanned their ticket at the entrance on September 24, 2016."
    },
    "image_hash": "de4a8ad0267f4fc0f41a732ebcf10ec9",
    "use_count": 6487
  },
  {
    "name": "Prismarine",
    "description": {
      "en": "This cape was given to @5399b615-3440-4c66-939d-ab1375952ac3 for recreating the prismarine block for use in his Chisel mod rather than modifying Mojang's texture. Jeb had this cape made before reaching out to Drullkus but it had no owner. Before this cape was given to Drullkus, @7125ba8b-1c86-4508-b92b-b5c042ccfe2b had it on his account but it was later removed."
    },
    "image_hash": "b32d8c1671c2936e81ec7e711e2af8e4",
    "use_count": 1
  },
  {
    "name": "MineCon 2011",
    "description": {
      "en": "This cape was automatically added to all MINECON 2011 attendees' registered username."
    },
    "image_hash": "00f15c80c9ab3540477210d4e58af337",
    "use_count": 2959
  },
  {
    "name": "MineCon 2015",
    "description": {
      "en": "Unlike previous events, this cape was available on the Console Edition from July 1 to 15. A redemption link for this cape was emailed to all MINECON 2015 attendees who scanned their ticket at the entrance on July 4, 2015."
    },
    "image_hash": "4d1709d6e62c99ec7220e0787df0362e",
    "use_count": 5617
  },
  {
    "name": "MineCon 2013",
    "description": {
      "en": "On October 30, 2013 Tobias Mollstam of the Mojang Team tweeted out an image of the 2013 MINECON cape. The cape shows an extended piston on a green shaded background. A redemption link for this cape was emailed to all registered MINECON 2013 attendees, similar to MINECON 2012's method."
    },
    "image_hash": "37cd76a8a0879233398d127099326cb7",
    "use_count": 5905
  },
  {
    "name": "MineCon 2012",
    "description": {
      "en": "A redemption link for this cape was emailed to all registered MINECON 2012 attendees."
    },
    "image_hash": "2b7ccdbfd1d89520f335822140d83d52",
    "use_count": 3452
  },
'''
]

Names

Endpoint: GET /api/v3/names?order_by=:order_by:&order=:order:&page=:page:&popularity=:popularity:&min_length=:min_length:&max_length=:max_length:&is_og=:is_og:

Description: This retrieves a list of available names.

** Query Parameters **

Parameter	Type	Description	Example
`order_by`	String	Sort results by available_from or popularity	`available_from`
`order`	String	Specify ASC or DESC order for sorting	`ASC`
`page`	Int	Specify the page number for pagination	`1`
`popularity`	Int	Filter names by popularity (0-100); `0` retrieves all names	`0`
`min_length`	Int	Minimum length of names to retrieve	`3`
`max_length`	Int	Maximum length of names to retrieve	`16`
`is_og`	String	Filter by OG status; use `none` to exclude OG or `show` to include all names	`none` or `show`

Request:

GET /api/v3/names?order_by=available_from&order=ASC&page=1&popularity=0&min_length=3&max_length=16&is_og=none

Response:

[
  {
    "name": "JJoTT6612",
    "available_from": "2024-11-05T06:38:10Z",
    "og": false,
    "popularity": 3,
    "accurate": false
  },
  {
    "name": "Bakterix",
    "available_from": "2024-11-05T06:38:44Z",
    "og": false,
    "popularity": 5,
    "accurate": false
  },
'''
]

Name		Name	Last commit message	Last commit date
Latest commit History 10 Commits
LICENSE		LICENSE
README.md		README.md

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Repository files navigation

Laby API Documentation

Player username to UUID

Player UUID to profile

Player UUID to names

Player UUID to snippet

Player UUID to badges

Player UUID to accounts

Player UUID to socials

Player UUID to friends

Player UUID to status

Player UUID to views

Player UUID to hearts

Player UUID to emotes

Player UUID to online status

Player UUID to game stats

Badges

Badge UUID to info

Badge UUID to players

Search Player

Skins

Skins Tag

Featured servers

Featured users

Statistics

Capes

Names

About

Uh oh!

Releases

Packages

Contributors 2

Uh oh!

License

n3liz/Laby-API-Documentation

Folders and files

Latest commit

History

Repository files navigation

Laby API Documentation

Player username to UUID

Player UUID to profile

Player UUID to names

Player UUID to snippet

Player UUID to badges

Player UUID to accounts

Player UUID to socials

Player UUID to friends

Player UUID to status

Player UUID to views

Player UUID to hearts

Player UUID to emotes

Player UUID to online status

Player UUID to game stats

Badges

Badge UUID to info

Badge UUID to players

Search Player

Skins

Skins Tag

Featured servers

Featured users

Statistics

Capes

Names

About

Topics

Resources

License

Uh oh!

Stars

Watchers

Forks

Releases

Packages 0

Contributors 2

Uh oh!

Packages