ig-trading-api

IG Trading API

Unofficial IG Trading API for Node.js, written in TypeScript and covered by tests.

Features

• Typed. Source code is 100% TypeScript. No need to install external typings.
• Tested. Code coverage is 100%. No surprises when using ig-trading-api.
• Maintained. Automated security updates. No threats from outdated dependencies.
• Documented. Get started with the generated documentation.

Installation

npm

npm install ig-trading-api

Yarn

yarn add ig-trading-api

Setup

You can set the API gateway, when initializing the API client. Use APIClient.URL_DEMO (demo-api.ig.com) for demo accounts and APIClient.URL_LIVE (api.ig.com) for live account access.

JavaScript / Node.js

const {APIClient} = require('ig-trading-api');
const client = new APIClient(APIClient.URL_LIVE, 'your-api-key');

TypeScript

import {APIClient} from 'ig-trading-api';
const client = new APIClient(APIClient.URL_LIVE, 'your-api-key');

Usage

Login

const session = await client.rest.login.createSession('your-username', 'your-password');
console.info(`Your client ID is "${session.clientId}".`);

Documentation

• IG REST Trading API Reference
• IG API Companion

IG instrument identifier (epic)

Breakdown for "IX.D.DOW.DAILY.IP":

Symbol	Description	Example
IX	Hours of trading	"Index Out of Hours"
D	Tradability	"D" when tradeable
DOW	Underlying market	"Dow Jones"
DAILY	Indicator for processing method	"Daily" funded bet
IP	Asset type	"Intellectual Property"

Development Setup

You can get up and running in just a few simple steps:

1. Run yarn (to install or update third-party dependencies)
2. Have a look at the .env.defaults file and make a copy (including your own credentials) with the name .env in the root directory of this repository (read more about dotenv files)
3. Run yarn demo:login to test your credentials

Maintainers

Contributing

Contributions, issues and feature requests are welcome!

Feel free to check the issues page.

License

This project is MIT licensed.

⭐️ Show your support ⭐️

Please leave a star if you find this project useful.

Changelog

0.8.0 (2021-02-25)

Chores

• deps-dev:
  • bump @typescript-eslint/parser from 4.15.1 to 4.15.2 (#93) (f25d903c)
  • bump @typescript-eslint/eslint-plugin (#92) (e2bb66db)
  • bump @types/jasmine from 3.6.3 to 3.6.4 (#82) (c0998d0c)
  • bump typedoc from 0.20.25 to 0.20.28 (#91) (621916f3)
  • bump @types/luxon from 1.25.2 to 1.26.0 (#83) (eaba7731)
  • bump @typescript-eslint/parser from 4.15.0 to 4.15.1 (#85) (21f78c99)
  • bump typedoc-plugin-markdown from 3.4.5 to 3.5.0 (#89) (c527e1c2)
  • bump eslint-config-prettier from 7.2.0 to 8.0.0 (#90) (1fd759d4)
  • bump @typescript-eslint/eslint-plugin (#76) (3cc00b17)
  • bump @types/luxon from 1.25.1 to 1.25.2 (#74) (67287935)
  • bump @typescript-eslint/parser from 4.14.2 to 4.15.0 (#77) (f8252096)
  • bump eslint from 7.19.0 to 7.20.0 (#78) (24f1119f)
  • bump husky from 4.3.8 to 5.0.9 (#79) (c021454c)
  • bump typedoc from 0.20.23 to 0.20.25 (#80) (07389890)
  • bump typescript from 4.1.3 to 4.1.5 (#81) (c9c85749)
• Ignore husky v5 (563215a7)
• deps:
  • bump @types/node from 14.14.28 to 14.14.31 (#87) (2a42a239)
  • bump luxon from 1.25.0 to 1.26.0 (#73) (51fd94b1)
  • bump @types/node from 14.14.25 to 14.14.28 (#75) (3de7c7e6)

New Features

• Get user session details (#95) (c4f440cf)

Bug Fixes

• Bind Dealing API to v2 (#96) (80c46976)

Refactors

• Return Lightstreamer client on candle subscription (#94) (f390c65e)