Skip to main content
client.gamma.comments.listComments fetches conversations attached to events, series, or markets. It supports pagination, holder-only views, and optional position visibility.

Request

const comments = await client.gamma.comments.listComments(params);

Parameters

NameTypeRequiredNotes
limitnumber (≥ 0)Page size.
offsetnumber (≥ 0)Page offset.
orderstringSorting expression.
ascendingbooleanSort direction.
parent_entity_type"Event" | "Series" | "market"Filters conversation root.
parent_entity_idnumberUse with parent_entity_type.
get_positionsbooleanInclude position arrays inside profiles.
holders_onlybooleanRestrict to holders-only comments.

Response

type Comment = {
  id: string;
  body: string | null;
  parentEntityType: string | null;
  parentEntityID: number | null;
  parentCommentID: string | null;
  userAddress: string | null;
  replyAddress: string | null;
  createdAt: string | null;
  updatedAt: string | null;
  profile?: {
    name: string | null;
    pseudonym: string | null;
    displayUsernamePublic: boolean | null;
    bio: string | null;
    isMod: boolean | null;
    isCreator: boolean | null;
    proxyWallet: string | null;
    baseAddress: string | null;
    profileImage: string | null;
    profileImageOptimized?: Record<string, unknown> | null;
    positions?: Array<{ tokenId: string | null; positionSize: string | null }> | null;
  };
  reactions?: Array<{
    id: string | null;
    commentID: number | null;
    reactionType: string | null;
    icon: string | null;
    userAddress: string | null;
    createdAt: string | null;
    profile?: Comment["profile"];
  }> | null;
  reportCount: number | null;
  reactionCount: number | null;
};

Usage example

const comments = await client.gamma.comments.listComments({
  parent_entity_type: "Event",
  parent_entity_id: 35723,
  limit: 20,
  get_positions: true,
});

console.log(comments.map((comment) => comment.body));

Failure modes

  • parent_entity_type must be Event, Series, or market.
  • Negative pagination values → validation error.