# Barchart Market Data API for Javascript

Include streaming delayed or realtime stocks, futures, and forex data in your HTML5
application. All you need is a username/password from Barchart, and your app can
be live within a matter of minutes. Our simple API also has access to historical and
time series data.

Note: to obtain a free testing username/password, please contact solutions@barchart.com

## Run The Example

Open the following file in a browser:

    ./examples/example.html
    
Or, the visit the hosted version of the example page here:

- [https://examples.aws.barchart.com/marketdata-api-js/example.html](https://examples.aws.barchart.com/marketdata-api-js/example.html)

## Documentation

### Wiki

[Read the Wiki for full documentation](https://github.com/barchart/marketdata-api-js/wiki)

## Code Documentation

1. Clone the repository

    `> git clone git@github.com:barchart/marketdata-api-js.git`

2. Download the dependencies.

    `> cd marketdata-api-js`
    `> npm install`

3. Generate [JSDoc](http://usejsdoc.org/) output.

    `> gulp document`
    
4. The output will be written to a /docs directory. Load /docs/index.html in a browser.