Skip to main content
GET
Get a cited research brief for a ticker or canonical entity

Authorizations

Authorization
string
header
required

Developer API key created through /auth.md. Never paste it into a retail chat.

Headers

X-Request-ID
string

Stable 1–128 character ID for an idempotent retry. Reuse the same value only for the same logical request.

Maximum string length: 128
Pattern: ^[A-Za-z0-9._~:+/=-]+$

Query Parameters

ticker
string
Required string length: 1 - 32
as_of
string<date-time>
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
max_results
integer
Required range: 1 <= x <= 20
detail
enum<string>
Available options:
overview,
full
entity_id
string<uuid>

Released canonical entity ID from get_beliefs view=entities. Use exactly one of ticker or entity_id.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Response

Successful read only response

view
string
required
Allowed value: "overview"
overview_version
string
required
Allowed value: "security-brief-overview-v1"
schema_version
string
required
Allowed value: "1"
generated_at
string<date-time>
required
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
as_of
string<date-time>
required
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
data_status
object
required
security
object
required
market_price
object
required
coverage
object
required
trade_state
object
required
views
object[]
required
chart
object | null
required
citations
object[]
required
warnings
string[]
required
canonical_entity
object