v1

latestOpenAPI 3.1.02026-07-13603344.2 KB
comments

Retrieve a list of comments based on the criteria

get/api/comments

Query parameters

authorstring

Hex format string, e.g. 0x1234567890abcdef

Hex format string, e.g. 0x1234567890abcdef

viewerstring

The viewer's address

Hex format string, e.g. 0x1234567890abcdef

appstring

The address of the app signer

Hex format string, e.g. 0x1234567890abcdef

cursorstring

Non inclusive cursor from which to fetch the comments based on sort

channelIdstring

The channel ID

commentTypeinteger nullable

The comment type (e.g. 0=comment, 1=reaction, not passed = all)

chainIdstring required

Filters by chain ID. Can be a single chain id or comma-separated list of chain ids (e.g. 1,137,10).

'approved' | 'rejected' | 'pending'
OR
string[]
moderationScorenumber

The moderation score of the comments to return. If the comment's moderation score exceeds the provided value, it is not returned.

excludeByModerationLabelsstring

The moderation labels to exclude from the comments to return. This filter works in conjunction with the moderationStatus filter.

Example:spam,sexual
limitinteger

The number of comments to return

targetUristring uri

The comment target URI

sort'asc' | 'desc'

The sort order of the comments

mode'nested' | 'flat'

The mode to fetch comments in. Nested will return only the first level of comments. Flat will return all replies sorted by timestamp in descending order.

isDeletedstring

Whether to return only deleted or only undeleted comments. If omitted it will return both deleted and undeleted comments.

Example:1

Response

Retrieve a list of comments