lanyard-py 2.0.1

Installation

# Install with httpx support
pip install "lanyard.py[httpx]"
# or (To work with WebSocket, select aiohttp)
pip install "lanyard.py[aiohttp]"

Quick Start

REST API

import asyncio
import logging
import sys

from lanyard import LanyardClient, LanyardData, HttpxProvider


async def main():
    async with LanyardClient(HttpxProvider()) as client:
        data: LanyardData = await client.get_user(338718840873811979)
        print(data["discord_user"]["username"])


if __name__ == "__main__":
    logging.basicConfig(level=logging.INFO, stream=sys.stdout)
    asyncio.run(main())

WebSocket

import asyncio
import logging
import sys

from lanyard import LanyardClient, AiohttpProvider


async def main():
    async with LanyardClient(AiohttpProvider()) as client:
        async for data in client.subscribe(338718840873811979):
            print(data["discord_user"]["username"])


if __name__ == "__main__":
    logging.basicConfig(level=logging.INFO, stream=sys.stdout)
    asyncio.run(main())

Available Methods

REST

WebSocket

Error Handling

The library uses a hierarchy of exceptions for granular error management:

• LanyardError: Base exception for all library-related errors.
• LanyardAPIError: Raised when the API returns an error or a non-200 status code.
• LanyardProviderError: Raised for network-related issues (timeouts, connection failures).
• LanyardUnauthorizedError: Raised when a token is missing or invalid.
• LanyardSocketError: Base class for WebSocket-related errors.
• LanyardSocketCloseError: Raised when the server closes the WebSocket with a specific error code.

Examples

Detailed implementation examples are available in the example/ directory:

• Basic REST usage
• Real-time monitoring via WebSockets