Skip to content

topics

Accessed as client.misc.topics; the async client mirrors it.

MiscTopics

The misc.topics namespace.

search

search(*, q: str, page: int | None = None, limit: int | None = None) -> TopicSearchResults

Search for topics by keyword.

Parameters:

Name Type Description Default
q str

keyword to search for

required
page int | None

page number of results to return (1-based)

None
limit int | None

page size of results

None

Returns:

Type Description
TopicSearchResults

SearchResults of a successful search.

Raises:

Type Description
ForbiddenError
  1. APIForbiddenError is a forbidden error response.
NotFoundError
  1. APINotFound is a not found error response.

Operation ID: topicSearch

AsyncMiscTopics

The misc.topics namespace.

search

search(*, q: str, page: int | None = None, limit: int | None = None) -> TopicSearchResults

Search for topics by keyword.

Parameters:

Name Type Description Default
q str

keyword to search for

required
page int | None

page number of results to return (1-based)

None
limit int | None

page size of results

None

Returns:

Type Description
TopicSearchResults

SearchResults of a successful search.

Raises:

Type Description
ForbiddenError
  1. APIForbiddenError is a forbidden error response.
NotFoundError
  1. APINotFound is a not found error response.

Operation ID: topicSearch