| securitychart |  |
This API command returns a PNG chart for an instrument.
If you need information to mark up your own charts, call the eventmarkup command.
Parameters| Name | Type | Required | Default | Description | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| bbs | String | true | The instrument symbol formatted to mimic the style used by Belzberg. | |||||||||||||||||
| bol | Character | default | F |
Toggle the display of Bollinger bands on the Price chart. If T then Bollinger bands (period of 20, 2 standard deviations) will be displayed on the chart. Bollinger band values are not included when calculating the min/max prices for the price chart. |
||||||||||||||||
| cht | Character | default | price:tall,volume:short |
The cht parameter lets you specify the chart types and sizes you want to display. The format is type:size, e.g. price:tall. You can specify multiple chart types by separating them with a comma, e.g. price:medium,macd:tall,volume:short. Possible chart types are: price, volume, rsi, macd, momentum, cci, shortkst, intermediatekst, longkst, slowstochastic, faststochastic and williams. Possible chart heights are: short, medium, and tall. |
||||||||||||||||
| cms | String | true | The instrument symbol formatted to mimic the style used by the exchange on which this instrument is traded. | |||||||||||||||||
| cst | Character | default | B | Specify B for a bar chart, C for a Candlestick chart, L for a Line chart, or M for a Mountain chart. | ||||||||||||||||
| drn | Character | false |
Date Range Name. A string which allows for the selection of pre-defined date
ranges. Valid names are:
1month,
3month,
6month,
1year,
2year,
5year.
If this parameter is included, the values for the str and end parameters will be ignored. The following pre-defined date ranges have been deprecated: yesterday, thisweek, lastweek, thismonth, lastmonth, thisyear, lastyear. |
|||||||||||||||||
| dsl | Boolean | default | T | Specify T (default) to display the chart section labels. Specify F to hide the chart section labels. | ||||||||||||||||
| dwt | Boolean | default | F | Specify T (default) to display the Elliott Wave targets (if available) for Elliott Wave events. Specify F to hide the wave target lines. | ||||||||||||||||
| eid | String | false | You can specify one or more Event IDs to display on the chart. The event is displayed on the appropriate chart (ie. a MACD event is displayed on a MACD chart, etc.). Multiple event ids should be separated by a comma. E.g. eid=RCvoRKAAAH3QAggABAACAAAD6CJg,RCvpPOAAAH3QA-gABAACAAAD6CYg | |||||||||||||||||
| end | Date | true | End date for the chart. The end parameter does not need to be specified if using the drn parameter. | |||||||||||||||||
| exc | Character | true | Symbol for the Exchange the instrument is traded on. See Exchanges for a list of the currently supported exchanges. | |||||||||||||||||
| iel | Character | default | F |
If an event is being displayed on the price chart, iel specifies the type of label displayed for the event. Set iel to N to display no label, I to display an icon, or T to display an icon with the event type name. |
||||||||||||||||
| iem | Character | default | T |
If an event is being displayed on the price chart, iem toggles the display of the event markup lines. Set iem to T to display the event markup, F to hide it. If no event is specified the iem parameter is ignored. |
||||||||||||||||
| ier | Character | default | F |
If an event is being displayed on the price chart, ier toggles the display of the event region. The The colour for the event region is determined by the skin (skn) specified. Set ier to T to display the event region, F to hide it. If no event is specified the ier parameter is ignored. |
||||||||||||||||
| iid | String | false | The Instrument ID is a unique string that identifies the instrument. This can be used to request a specific instrument instead of passing a symbol and exchange combination in the call. | |||||||||||||||||
| ipr | Character | false | F |
If an event is being displayed on the price chart, ipr toggles the display of the specific target price range. The colour for the price target region is specified by the skin (skn). With the default skins, this is a stronger shade than for the target region (itr). Set ipr to T to display the target region, F to hide it. If no event is specified the ipr parameter is ignored. |
||||||||||||||||
| itr | Character | default | F |
If an event is being displayed on the price chart, itr toggles the display of the target region. The colour for the target region is determined by the skin (skn) specified. Set itr to T to display the target region, F to hide it. If no event is specified the itr parameter is ignored. |
||||||||||||||||
| ixs | String | true | The instrument symbol formatted to mimic the ILX style used by Thomson Financial. | |||||||||||||||||
| lcl | Character | default | T |
If an event is being displayed on the price chart, lcl toggles the display of the lower channel line for the inbound trend. Set lcl to T to display the line, F to hide it. If no event is specified the lcl parameter is ignored. |
||||||||||||||||
| leg | Boolean | default | T | Specify T (default) to display the chart legend. Specify F to hide the chart legend. | ||||||||||||||||
| log | Character | default | F | Specify T to use a log scale for the Y-axis for the price chart. Specify F (default) to use a linear scale for the Y-axis for the price chart. | ||||||||||||||||
| mav | Integer | false |
One or more simple moving averages can be added to the price chart. You can specify the chart, the period and the line colour (in RRGGBB format), separating each value with a colon. Eg. mav=price:200:88AA00. Separate multiple moving averages with a comma (,). Eg. mav=price:21:990000,volume:50:009900,price:200:000099. Moving averages are only available on price and volume charts. |
|||||||||||||||||
| mnp | Real | false | The minimum value on the Y-axis for the price chart. If a value is not supplied, the minimum value of the Y-axis is determined by the lowest price in the specified date range for the chart. | |||||||||||||||||
| mnt | Character | false | The main title for the chart. | |||||||||||||||||
| mxp | Real | false | The maximum value on the Y-axis for the price chart. If a value is not supplied, the maximum value of the Y-axis is determined by the highest price in the specified date range for the chart. | |||||||||||||||||
| pds | String | true | The instrument symbol formatted to mimic the style used by SunGard PowerData. | |||||||||||||||||
| per | Character | default | D | The price period for the chart. Default is a daily price chart. Possible values are: D for Daily, W for Weekly, and M for Monthly. Note that the Intermediate-KST chart uses Weekly prices and the Longterm-KST chart uses Monthly prices regardless of the price period specified for the chart. | ||||||||||||||||
| rts | String | true | The instrument symbol formatted to mimic the style used by Reuters. | |||||||||||||||||
| skn | Character | default | cream |
Colours and features for the chart are saved in skins. Skins specify colours of the lines, background, and text. A skin also specifies the font size and type and the style of lines. There are currently four skin options:
|
||||||||||||||||
| str | Date | true | Start date for the chart. The str parameter does not need to be specified if using the drn parameter. | |||||||||||||||||
| trl | Character | default | F |
If an event is being displayed on the price chart, trl toggles the display of the inbound trend line. Set trl to T to display the line, F to hide it. If no event is specified the trl parameter is ignored. |
||||||||||||||||
| ucl | Character | default | T |
If an event is being displayed on the price chart, ucl toggles the display of the upper channel line for the inbound trend. Set ucl to T to display the line, F to hide it. If no event is specified the ucl parameter is ignored. |
||||||||||||||||
| wid | Integer | default | 690 | The width of the chart, in pixels. The height of each chart section is determined by the width of the chart. | ||||||||||||||||
| zom | String | false | trend |
The zom parameter sets the date range of the chart based on a specified event, and therefore requires that the eid parameter also be specified. If a date range is not provided in any other parameter and an event id is provided, then the default date range used for the chart is zom=trend. With the zom parameter you can specify whether the chart should be focused on the event itself, or the event plus its inbound trend. The values for zom are: trend - chart starts at the beginning of the inbound trend and ends one pattern length past the end date of the event, tighttrend - chart starts at the beginning of the inbound trend and ends at the end date of the event, thirds - chart starts one pattern length before the start date of the event and ends one pattern length past the end date of the event, event - chart starts at the beginning of the event and ends one pattern length past the end date of the event . If the event is less than 10 bars (days, weeks, or months) long, then the chart starts at 30 bars before the end of the event and goes for 30 bars past the end of the event. |
||||||||||||||||
| lang | String | false | en | Specify the language of the events returned. Possible language codes are: 'en' (English) and 'fr' (French). |
Return
PNG image if the command was successful, an XML block if the command was not successful.