getChart API

The getChart API is used to request a custom chart image with variables such as chart type, size, period and technical indicators, based on a symbol.

Pricing is based on the number of monthly queries and fields requested. We offer four packages: Small, Medium, Large, Enterprise. Contact us for additional details.


API Documentation

INPUTS:

symbols (required)
A symbol or code that identifies a financial instrument. (list)
Example: YHOO,MSFT

type (optional)
The type of chart, includes: bar chart ("BAR"), candlestick ("CANDLE"), area ("AREA") or line ("LINE") chart. (enum)
Valid values: BAR, LINE, CANDLE, AREA
Default: BAR
Example: LINE

width (optional)
The width of chart in pixels. (int)
Default: 700
Example: 700

height (optional)
The height of the chart, in pixels, with no indicators in pixels. (int)
Default: 550
Example: 550

volume (optional)
An option to display the volume indicator on the chart. (boolean)
Default:
Example: false

period (optional)
The period to display the chart. (enum)
Valid values: 1d, 5d, 3d, 10d, 1m, 3m, 6m, 1y, 2y, 3y, 5y, 10y, 15y, 20y, 25y, ytd
Default: 6m
Example: 1d

interval (optional)
(enum)
Valid values: DO, DN, WO, WN, MO, MN
Example: DO

indicators (optional)
A semi-colon delimited list of indicators. (list)
Example: BBANDS(20,2);MACD(12,26,9)

frequencyType (optional)
Frequency type: DO (Daily Contract), DN (Daily Nearest), DC (Daily Continuation), WO (Weekly Contract), WN (Weekly Nearest), WC (Weekly Continuation), MO (Monthly Contract), MN (Monthly Nearest), MC (Monthly Continuation) (string)
Default:
Example:


OUTPUTS:

symbol (always returned)
A symbol or code that identifies a financial instrument. (string)
imageURL (always returned)
The URL for the chart image. (string)

STATUS CODE RESPONSES:

200 OK Success
400 Bad Request The request was invalid, please see the message for more information.
500 Internal Server Error Something is not working correctly, please contact support.