Skip to main content

index/interfaces/GetChatMessagesOptions.md

Options for querying chat messages via /v1/chat-messages

At least one of tokenName or userAddress must be provided.

Example​

// Query by token
const result = await sdk.chatMessages.getChatMessages({ tokenName: 'anime' });

// Query by user
const result = await sdk.chatMessages.getChatMessages({ userAddress: 'eth|123...' });

// Query by both with pagination
const result = await sdk.chatMessages.getChatMessages({
tokenName: 'anime',
userAddress: 'eth|123...',
offset: 20,
limit: 20
});

Properties​

PropertyTypeDescription
cursor?stringCursor for pagination (omit for first page)
pageSize?numberPage size (default: 20, max: 50)
tokenName?stringFilter by token name (e.g., "anime")
userAddress?stringFilter by user wallet address (eth|... or 0x... format)