Asset Overview

This page walks through the Toggle API endpoints used to create the Asset Overview.

Required services

Service	Endpoint
Entity	POST https://api.toggle.ai/entity/v2/filtered
PriceHistory	GET https://api.toggle.ai/price-history/v1/|market-close?ticker={Ticker}
KnowledgeGraph	POST https://api.toggle.ai/kg/v1/|connected-entities/proximity
Feed	TBD
Calculator	https://api.toggle.ai/ca/v2/q
RelevanceReport	GET https://api.toggle.ai/entity-report/|v1/entity/entity_tag/relevance
KeyValues	GET https://api.toggle.ai/entity-report/v1/|entity/{entity_tag}/key-values
Snakes	GET https://api.toggle.ai/snake/v2?snakes={snake}

Header

1. Asset name

• Name Entity.name
• Logo Entity.logo_url
• TICKER:EXCHANGE {Entity.name}:{Entity.exchange.code}

2. Price header

• live price websockets
• pre market price websockets
• as of last close websockets

3. About, Watchlist and Trade buttons

• a: header - same as in header
• b: sector - Entity.gics.sector.code + mapping
• c: industry - Entity.gics.industry_group.code + mapping
• d: about Entity.company_description

---

Chart

A. Horizon bar, Price chart and Range bar

These values are all constructed using data from Calculator endpoint. Calculator.result.data contains an array of objects that each have an index which is a timestamp and a value which is a float representing the price at that date.

B. Past insights toggle

This button becomes visible when viewing a horizon greater than 6 months on the chart and on click will display historic insights using the Feed endpoint.

---

Insights

Toggle produces three types of asset insights; Toggle insights, GTK and News.

Toggle insights

These are provided by the Feed endpoint.

News insights

NOTE: Out of scope

Good to knows aka (GTK)

These are provided by the RelevanceReport endpoint.

---

Scenario

A. Insight title and description

Insights from Feed endpoint will have a insight_card and direction property and using the Insights card mapping you will be able to construct correct title and description.

B. Chart details relevance + snake

This title is the type of chart that is being represented. See below how to display depending on insight type.

C. Mini chart

This chart can be constructed using timeseries returned from Calculator endpoint. For a regular insight, the Calculator should be called with a price snake, but for GTKs, RelevanceReport.expression should be used.

Insight

A. Title

Feed endpoint provides an array of Insights. Every Insight will have a insight_card and direction property and using the Insights card mapping you will be able to construct correct title and description.

B. Description

This description is constructed based on whether an insight is bullish or bearish which can be obtained from Insight provided by the [Feed](/) endpoint. (Insights.direction`)

C. Insight content

• Direction: Insight.direction
• Stars: Insight.stars
• Status: This is calculated using Insight.signal_low, Insight.signal_high, Insight.direction and Insight.horizon and is essentially confirmation if the insight has worked , failed or active
• Similar Past Occurrences: Insight.num_episodes
• Hit Rate: Insight.hit_rate_out_of_sample

Key values

Entity values list can be obtained from the KeyValues endpoint. To get entity sub class call the Snakes endpoint with the returned snake which is the value KeyValues.expression.

Related assets

To get the list of related assets are constructed using the KnowledgeGraph endpoint. This endpoint returns an array of entity tags which can be used to call the Entity endpoint to get asset details.