Skip to content
Drawings and Overlays

List Drawings

Returns the drawings the current user saved on a security for one K-line period, optionally filtered by time range. Use it after K-lines load to restore the user's drawings. The Broker App passes the first and last times of the loaded K-lines as timestamp_min and timestamp_max, and calls again with a wider range after loading older K-lines. It does not call this endpoint when drawing is turned off.

GEThttps://api.lbkrs.com/v1/watchlist/draw_shapes

Parameters

counter_idstringqueryRequired

Security ID (counter_id), for example ST/US/AAPL or ST/HK/700

kline_typeintegerqueryRequired

K-line period the drawing belongs to; same values as line_type in GET /v3/quote/kline

1515306010002000300035004000

timestamp_minintegerquery

Start of the time range as a Unix timestamp in seconds

timestamp_maxintegerquery

End of the time range as a Unix timestamp in seconds

Responses

HTTP 200The request succeeded. The response body contains the result of the “List Drawings” operation.
Standard response envelopecodemessagedata
dataobjectdata structure
draw_shapesarray<object>

Drawings; an empty array when there are none

Child attributes
idstring

Drawing ID assigned by the server; used to update and delete the drawing

counter_idstring

Security ID

kline_typeinteger

K-line period the drawing belongs to; same values as line_type in GET /v3/quote/kline

timestamp_mininteger

Earliest time the drawing covers, as a Unix timestamp in seconds

timestamp_maxinteger

Latest time the drawing covers, as a Unix timestamp in seconds

shape_dataobject

Drawing shape data. The chart component generates this object, and a read returns it to the chart component as-is to restore the drawing. Fields not listed here must also be saved and returned unchanged.

Child attributes
shape_typeinteger

Shape type defined by the chart component (such as line, ray, or channel)

control_pointsarray<object>

Control points of the shape, in drawing order

Child attributes
xstring

Time of the control point as a Unix timestamp in seconds, in string form

ystring

Price of the control point

total_control_pointsinteger

Total number of control points the shape needs

finishedboolean

Whether the shape is complete

color_strstring

Line color as a hex value, such as #37A0FF

line_widthinteger

Line width

line_styleinteger

Line style defined by the chart component

Whale Docs