index/interfaces/FetchMessagesOptions.md

Options for fetching messages via /v1/messages

At least one of type, tokenName, or userAddress must be provided.

Example

// Get all chat messages for a token
const result = await sdk.fetchMessages({ type: 'CHAT_MESSAGE', tokenName: 'anime' });

// Get all comments for a token
const result = await sdk.fetchMessages({ type: 'COMMENT', tokenName: 'anime' });

// Get all messages from a user
const result = await sdk.fetchMessages({ userAddress: 'eth|123...' });

// Combined filters with pagination
const result = await sdk.fetchMessages({
  type: 'CHAT_MESSAGE',
  tokenName: 'anime',
  limit: 20,
  cursor: 'next_cursor'
});

Properties

Property	Type	Description
cursor?	string	Cursor for pagination (from previous response)
pageSize?	number	Results per page (default: 20, max: 50)
search?	string	Full-text search on message content (case-insensitive partial match)
tokenName?	string	Filter by token name (e.g., "anime")
type?	MessageType	Filter by message type (CHAT or COMMENT)
userAddress?	string	Filter by user wallet address (eth|... or 0x... format)