Skip to content
Deep Data

Get a deep data chart

Return one deep data chart by chart ID, used by the driver detail page and chart cards. The chart ID comes from "List deep data charts" or bind_chart.chart_id of a key driver tree node.

GEThttps://api.lbkrs.com/v1/stock/custom_module/charts/{id}

Parameters

idstringpathRequired

Chart ID

max_yearsstringquery

Number of years of data to return; the Broker App detail page passes 20 by default and chart cards pass an empty string

limitintegerquery

Number of data items; the Broker App passes 5 for chart cards and 0 for the detail page

Responses

HTTP 200The request succeeded. The response body contains the result of the “Get a deep data chart” operation.
Standard response envelopecodemessagedata
dataobjectdata structure
chartobject

Deep data chart

Child attributes
idstring

Chart ID, usable with "Get a deep data chart"

titlestring

Chart title

descriptionstring

Chart description

unitstring

Value unit

keysobject

Indicator definitions referenced by the chart, keyed by indicator key

itemsarray<object>

Data series

Child attributes
keystring

Indicator key, matching a definition in the chart keys

counter_idstring

counter_id of the underlying the data belongs to

titlestring

Series name

descriptionstring

Series description

typeinteger

Chart type: 1 bar, 2 line

Values
1
2
use_left_y_axisinteger

Y axis used: 1 left, 2 right

Values
1
2
stackstring

Stack group; only for bar charts, series with the same stack are stacked

styleobject

Series drawing style

Child attributes
colorstring

Series color, hex color value

smoothboolean

Whether the line is smoothed

line_typestring

Line type: solid, dashed, dotted, or none

Values
solid
dashed
dotted
none
line_widthnumber

Line width

point_symbolstring

Data point shape: circle, emptyCircle, rect, or triangle

point_symbol_sizenumber

Data point size

point_colorstring

Data point color

point_border_colorstring

Data point border color

point_border_widthnumber

Data point border width

label_hideboolean

Whether to hide value labels on the chart

valuesarray<object>

Data points

Child attributes
dateinteger

Data date, Unix timestamp in seconds

valuestring

Value; the lower bound for range indicators

value_ceilingstring

Upper bound, returned only for range indicators

year_on_yearstring

Year-over-year change, such as 1.1

month_on_monthstring

Period-over-period change, such as 0.5

left_y_axis_value_styleinteger

Left axis value style: 1 hidden, 2 raw value, 3 percentage

Values
1
2
3
left_y_axis_value_minstring

Left axis minimum

left_y_axis_value_maxstring

Left axis maximum

right_y_axis_value_styleinteger

Right axis value style: 1 hidden, 2 raw value, 3 percentage

Values
1
2
3
right_y_axis_value_minstring

Right axis minimum

right_y_axis_value_maxstring

Right axis maximum

Whale Docs