Lanyard.ts

Lanyard.ts is a TypeScript implementation of Lanyard, originally created by Phineas.

API Reference

Get presence by user ID

Endpoint:

GET /api/v1/users/:userId

Description: Retrieves the presence information of a user by their ID.

Parameters:

Parameter	Type	Description
userId	string	Required. The Discord user ID

Response:

{
  "success": true,
  "data": {
    "userId": "1234567890",
    "kv": { "status": "online" }
  }
}

---

Set Key-Value for a user

Endpoint:

POST /api/v1/users/:userId/kv

Description: Stores a key-value pair in a user's presence.

Parameters:

Parameter	Type	Description
userId	string	Required. The Discord user ID
key	string	Required. The key to store
value	string	Required. The value to store

Request Body:

{
  "key": "status",
  "value": "online"
}

Response:

{
  "success": true,
  "data": {
    "userId": "1234567890",
    "key": "status",
    "value": "online"
  }
}

---

Get Key-Value for a user

Endpoint:

GET /api/v1/users/:userId/kv

Description: Retrieves a specific key-value pair or all key-value pairs for a user.

Parameters:

Parameter	Type	Description
userId	string	Required. The Discord user ID
key	string	Optional. The key to retrieve

Response:

{
  "success": true,
  "data": {
    "status": "online"
  }
}

---

Delete Key-Value for a user

Endpoint:

DELETE /api/v1/users/:userId/kv

Description: Deletes a specific key-value pair from a user's presence.

Parameters:

Parameter	Type	Description
userId	string	Required. The Discord user ID
key	string	Required. The key to delete

Response:

{
  "success": true,
  "data": {
    "userId": "1234567890",
    "key": "status"
  }
}