Skip to main content
GET
Transcript search summary

Authorizations

X-API-KEY
string
header
default:pk_live_YOUR_KEY
required

Astreus API key (pk_live_...), created on the Developers page in the terminal. Also accepted as Authorization: Bearer pk_live_....

Query Parameters

topicColumns
string

JSON array of 1–12 ordered columns: id, label, terms, exclude, match (any/all). Each phrase is literal text; exclusions apply across all alternatives. Definitions must fit a 6,000-character URL-encoded budget.

column
string

Apply a column from topicColumns (or the default set) to source passages.

q2
string

Second websearch expression; combined with q in the same speaker passage.

termMatch
enum<string>
default:all

Combine q and q2 using all (AND) or any (OR).

Available options:
all,
any
topic
enum<string>

Inspectable lexical research topic.

Available options:
demand,
pricing,
margins,
investment,
ai,
credit,
funding,
regulation,
returns,
outlook
browse
string

1 = browse source turns without a keyword predicate.

region
string

Issuer region from the country catalog.

subregion
string

Issuer subregion from the country catalog.

city
string

Exact city in the company's currently stored business address; missing addresses remain unknown.

locationMode
enum<string>
default:inside

Inside or outside the intersection of selected country/region/subregion/city.

Available options:
inside,
outside
includeUnknownLocation
string

1 = include unknown geography in outside searches; excluded by default.

theme
enum<string>

Explicit lexical theme; AND with q in the same passage.

Available options:
purchase-delays,
pricing-pressure,
pricing-power,
ai-investment,
inventory,
capacity,
tariffs,
guidance
speaker
string

Speaker name contains; max 120 characters.

q
string

Websearch query; combine with mentioned or theme to narrow the same passage.

mentioned
string

Company talked about (mentions mode).

company
string

Only calls held by this company.

country
string

Source issuer country from transcript metadata: uppercase ISO alpha-2 code, or unknown for missing geography.

companies
string

Comma-separated company basket, at most 20 identifiers; intersects company if supplied.

role
enum<string>

Speaker role.

Available options:
executive,
analyst,
operator
section
enum<string>

Part of the call.

Available options:
prepared,
qa
from
string<date>

Calls on or after, YYYY-MM-DD.

to
string<date>

Calls on or before, YYYY-MM-DD.

includeSelf
string

1 = include the mentioned company's own calls.

Response

OK

Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.

mode
string
totalMatches
integer
totalDocuments
integer
totalCompanies
integer
firstDate
string<date>
lastDate
string<date>
quarters
object[]
speakers
object[]
sampled
boolean
companyQuarters
any[]
countries
any[]