Skip to main content
POST
Find by details

Authorizations

X-API-KEY
string
header
required

Body

application/json

Request body for finding topics. Each field is optional. However, you must provide at least one field to perform a valid search. The values a filter accepts can be listed with GET /v1/knowledge-graph/topics/values/{filter}.

query
string

Text query to search for topics by name or description. Examples: 'Earnings', 'Board Member Appointment'

Example:

"Earnings"

topics
string[]

Top-level topics, as published in the topic field of results (e.g., 'business')

Example:
groups
string[]

Topic groups, as published in the group field of results (e.g., 'earnings', 'investor-relations')

Example:
types
string[]

Topic types, as published in the type field of results (e.g., 'earnings', 'earnings-call')

Example:
subtypes
string[]

Topic subtypes, as published in the subtype field of results

Example:

Response

200 - application/json

Successful response with topics data

Response containing topics results and metadata

results
object[]
required

Array of topics results

metadata
object
required
usage
object

Optional. Present for token-billing accounts only. Reports the number of tokens consumed by this request.