npm

Need private packages and team management tools?Check out npm Orgs. »

@barchart/marketdata-api-js

3.3.2 • Public • Published

@barchart/marketdata-api-js

JavaScript library for accessing streaming market data from Barchart

Include streaming market data in your applications. Asset classes include equities, futures, and forex.

All you need is a username/password from Barchart and your app can be live within a matter of minutes. To obtain your credentials, please contact solutions@barchart.com.

Supported Environments

  • Browsers - Your target browser must support WebSockets (which all modern Browsers do). Also, the source code is written using ES6, so transpilation (with appropriate polyfills) is recommended before distribution.
  • Node.js - Node.js does not natively support WebSockets. Instead, a third-party library called WS is responsible for maintaining the WebSocket connection to Barchart's servers.

Examples

Browser

Open the following file in your browser:

./example/browser/example.html

Or, visit the hosted page at:

Node.js

Ensure you're running a recent version of Node.js (e.g. v10.16.0) and execute the example script as follows:

> node example/node/example.js {host} {username} {password} {comma-delimited symbol list}

Documentation

Wiki

Read the Wiki for full documentation

Code

JSDoc is used to document the source code. HTML documentation can be generated (into a "docs" folder), as follows:

> gulp document

install

npm i @barchart/marketdata-api-js

Downloadsweekly downloads

43

version

3.3.2

license

MIT

homepage

github.com

repository

Gitgithub

last publish

collaborators

  • avatar
Report a vulnerability