Items

Items are collectible objects in Local Universe. They include equipment, decorations, fish, and other objects that can appear in a user's inventory.

The item model

Properties

Name
id
Type
string
Description
Unique identifier for the item.
Name
name
Type
string
Description
The name of the item.
Name
description
Type
string
Description
A description of the item.
Name
type
Type
integer
Description
The item type.
Name
rarity
Type
integer
Description
The rarity level.
Name
bind
Type
integer
Description
The bind type.
Name
icon
Type
string
Description
URL to the item icon.
Name
flags
Type
integer
Description
Item flags bitfield.
Name
properties
Type
object?
Description
Additional item-specific properties.
Name
created_at
Type
string
Description
When the item was created.

Item types

Value	Name	Description
1	DEFAULT	Standard item
2	EQUIPMENT	Wearable equipment (skins, head, chest, legs, feet, emotes)
3	DECOR	Decorative item for planets
4	FISH	Fish caught via fishing

Rarity levels

Value	Name
1	COMMON
2	UNCOMMON
3	RARE
4	EPIC
5	LEGENDARY
6	MYTHIC
7	QUANTUM
8	CELESTIAL
9	UNIDENTIFIED

Bind types

Value	Name	Description
1	NONE	Item can be freely traded
2	BIND_ON_PICKUP	Item binds to the user when obtained
3	BIND_ON_EQUIP	Item binds to the user when equipped

Equipment slots

Value	Name	Description
1	SKIN	Character skin
2	HEAD	Head equipment
3	CHEST	Chest equipment
4	LEGS	Leg equipment
5	FEET	Foot equipment
6	EMOTE	Emote slot
7	FISHING_PORTAL	Fishing portal skin

The equipment model

Equipment represents the user's currently equipped items across all slots.

Name
skin
Type
ItemInstance?
Description
Equipped skin.
Name
head
Type
ItemInstance?
Description
Equipped head item.
Name
chest
Type
ItemInstance?
Description
Equipped chest item.
Name
legs
Type
ItemInstance?
Description
Equipped legs item.
Name
feet
Type
ItemInstance?
Description
Equipped feet item.
Name
emote_1
Type
ItemInstance?
Description
First emote slot.
Name
emote_2
Type
ItemInstance?
Description
Second emote slot.
Name
emote_3
Type
ItemInstance?
Description
Third emote slot.
Name
fishing_portal
Type
ItemInstance?
Description
Equipped fishing portal.

The item instance model

An item instance is an Item with an additional instance_id field representing a specific copy in a user's inventory.

Name
instance_id
Type
string
Description
Unique identifier for this specific item instance.
Name
...
Type
Item
Description
All fields from the item model (id, name, description, type, rarity, bind, icon, flags, properties, created_at).

GET/v1/items

List items

Returns all items.

Request

GET

/v1/items

curl https://api.localuniverse.io/v1/items \
  -H "Authorization: Bearer {token}"

Response

[
  {
    "id": "1344387816333352652",
    "name": "Cosmic Helmet",
    "description": "A helmet forged from cosmic dust",
    "type": 2,
    "rarity": 4,
    "bind": 3,
    "icon": "https://cdn.localuniverse.io/items/cosmic-helmet.png",
    "flags": 0,
    "properties": { "slot": 2, "defense": 15 },
    "created_at": "2025-02-26T19:17:12.848375Z"
  }
]

POST/v1/items

Create an item

Required attributes

Name
name
Type
string
Description
Name of the item.
Name
description
Type
string
Description
Description of the item.
Name
type
Type
integer
Description
Item type (1-4).
Name
rarity
Type
integer
Description
Rarity level (1-9).
Name
bind
Type
integer
Description
Bind type (1-3).
Name
icon
Type
string
Description
URL to the item icon.

Optional attributes

Name
properties
Type
object
Description
Additional item-specific properties.

Request

POST

/v1/items

curl -X POST https://api.localuniverse.io/v1/items \
  -H "Authorization: Bearer {token}" \
  -H "Content-Type: application/json" \
  -d '{"name": "Star Rod", "description": "A rod imbued with starlight", "type": 2, "rarity": 5, "bind": 3, "icon": "https://cdn.localuniverse.io/items/star-rod.png"}'

GET/v1/items/:itemId

Get an item

Retrieve a single item by its ID.

Request

GET

/v1/items/1344387816333352652

curl https://api.localuniverse.io/v1/items/1344387816333352652 \
  -H "Authorization: Bearer {token}"

PATCH/v1/items/:itemId

Update an item

Optional attributes

Name
name
Type
string
Description
New name.
Name
description
Type
string
Description
New description.
Name
rarity
Type
integer
Description
New rarity level.
Name
properties
Type
object
Description
Updated properties.

Request

PATCH

/v1/items/1344387816333352652

curl -X PATCH https://api.localuniverse.io/v1/items/1344387816333352652 \
  -H "Authorization: Bearer {token}" \
  -H "Content-Type: application/json" \
  -d '{"rarity": 6}'

DELETE/v1/items/:itemId

Delete an item

Permanently delete an item.

Request

DELETE

/v1/items/1344387816333352652

curl -X DELETE https://api.localuniverse.io/v1/items/1344387816333352652 \
  -H "Authorization: Bearer {token}"