npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

ig-cfd-cli

v0.0.3

Published

cli tool and API for the IG CFDs API.

Downloads

4

Readme

ig-cfd-cli

CLI tool and API for the IG CFDs API.

WORK IN PROGRESS:

  • Currently allows price history of a CFD to be downloaded.

To learn more about working with data in JavaScript please read my book Data Wrangling with JavaScript.

For news and updates see my blog The Data Wrangler.

WARNING

Please be aware that if you run this multiple times you can quickly exhaust your data limits with IG.

Use sparingly!

CLI usage

You must have Node.js installed to use this tool.

Install it globally:

npm install -g ig-cfd-cli

Create config.json in your working directory and fill out your IG account details:

{
    "baseUrl": "https://demo-api.ig.com/gateway/deal",
    "userName": "<your-ig-username>",
    "password": "<your-ig-password>",
    "apiKey": "<your-ig-apikey>"
}

You can start your config.json with a copy of the template config.json:

Now run the command line tool to download the price history for a CFD:

ig-cfd-cli price-history <epic> <max-bars> [<resolution>]

Options:

  • epic - The name of the CFD to download price history.
  • max-bars - Max number of bars to download (keep it as small as possible to avoid exhausting your data allowance).
  • resolution - Optional resolution of bars, defaults to DAY.

For example to download the price history for the Bitcoin CFD:

ig-cfd-cli price-history CS.D.BITCOIN.CFD.IP 10

This downloads the price history for the requested CFD to a CSV file in the working directory. It will be named after the epic that was requested.

For example downloading CS.D.BITCOIN.CFD.IP will create the file CS-D-BITCOIN-CFD-IP.csv.

Resolution defaults to DAY, but you can set it to other values such as HOUR:

ig-cfd-cli price-history CS.D.BITCOIN.CFD.IP 10 HOUR

The resolution parameter is passed directly to the IG API, available options are:

MINUTE
MINUTE_2
MINUTE_3
MINUTE_5
MINUTE_10
MINUTE_15
MINUTE_30
HOUR
HOUR_2
HOUR_3
HOUR_4
DAY
WEEK
MONTH

Missing features

  • Document API usage.
  • Other commands: Get accounts, get positions, open position, close position, etc.
  • Better error checking (eg missing config file).