Skip to content
Deep Data Charts

Get a Deep-Data Indicator Chart

Returns the chart for one indicator in the deep-data module on the stock Analysis page, looked up by indicator key: title, unit, data series (bar or line), per-period values with year-over-year and period-over-period changes, and the left and right Y-axis styles. Use it for a deep-data card (pass a small limit, such as 5, to show recent periods) and for the full chart page opened from the card. key identifies the deep-data indicator and comes from the deep-data module chart configuration.

GEThttps://api.lbkrs.com/v1/stock/custom_module/data_charts/one

Parameters

counter_idstringqueryRequired

Security ID (counter_id), such as ST/US/AAPL

keystringqueryRequired

Deep-data indicator key

limitintegerqueryRequired

Number of data periods to return. Pass 5 for a card and 0 for the full chart page.

Responses

HTTP 200The request succeeded. The response body contains the result of the “Get a Deep-Data Indicator Chart” operation.
Standard response envelopecodemessagedata
dataobjectdata structure

Chart result

chartobject

Deep-data chart

Child attributes
idstring

Chart ID

titlestring

Chart title

descstring

Chart description

unitstring

Value unit label

keysobject

Indicator definitions used by the chart, keyed by indicator key

itemsarray<object>

Data series

Child attributes
keystring

Indicator key of the series

counter_idstring

Security ID of the series

titlestring

Series name

descstring

Series description

typeinteger

Chart type:

  • 1 - Bar
  • 2 - Line
Values
1
2
use_left_y_axisinteger

Y-axis used:

  • 1 - Left axis
  • 2 - Right axis
Values
1
2
stackstring

Stack group. When type is bar, series with the same stack are stacked.

valuesarray<object>

Data points in time order

Child attributes
dateinteger

Time of the data period as a Unix timestamp in seconds. Format it according to the indicator frequency.

valuestring

Indicator value. For a range indicator, this is the lower bound.

value_ceilingstring

Upper bound of a range indicator

year_on_yearstring

Year-over-year change as a decimal ratio (the App multiplies it by 100 and shows a percentage)

month_on_monthstring

Period-over-period change

key_dataobject

Deep-data indicator definition

Child attributes
keystring

Indicator key

titlestring

Indicator name

descstring

Indicator description

frequenceinteger

Data frequency:

  • 1 - Daily
  • 2 - Weekly
  • 3 - Monthly
  • 4 - Quarterly
  • 5 - Semi-annual
  • 6 - Annual
Values
1
2
3
4
5
6
is_rangeboolean

Whether the indicator is a range. When true, each data point carries both value and value_ceiling.

left_y_axis_value_styleinteger

Y-axis value style:

  • 1 - Hidden
  • 2 - Raw value
  • 3 - Percentage
Values
1
2
3
left_y_axis_value_minstring

Left-axis minimum. Calculated automatically when empty.

left_y_axis_value_maxstring

Left-axis maximum. Calculated automatically when empty.

right_y_axis_value_styleinteger

Y-axis value style:

  • 1 - Hidden
  • 2 - Raw value
  • 3 - Percentage
Values
1
2
3
right_y_axis_value_minstring

Right-axis minimum. Calculated automatically when empty.

right_y_axis_value_maxstring

Right-axis maximum. Calculated automatically when empty.

Whale Docs