ig-trading-api
Advanced tools
Changelog
0.5.0 (2021-02-03)
Readme
Unofficial IG Trading API for Node.js, written in TypeScript and covered by tests.
npm
npm install ig-trading-api
Yarn
yarn add ig-trading-api
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');
const session = await client.rest.login.createSession('your-username', 'your-password');
console.info(`Your client ID is "${session.clientId}".`);
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" |
You can get up and running in just a few simple steps:
yarn (to install or update third-party dependencies).env in the root directory of this repository (read more about dotenv files)yarn demo:login to test your credentials
Contributions, issues and feature requests are welcome!
Feel free to check the issues page.
This project is MIT licensed.
Please leave a star if you find this project useful.
FAQs
IG Trading API for Node.js, written in TypeScript.
We found that ig-trading-api demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
ESLint has approved an RFC that adds support for TypeScript configuration files, which is aimed at improving the developer experience and recognizing changes in the evolving JavaScript ecosystem.
Security News
The NVD is facing a significant backlog with over 12,500 CVEs awaiting analysis, and more than 50% of known exploited vulnerabilities (KEVs) left unenriched since mid-February.
Security News
Ransomware costs victims an estimated $30 billion per year and has gotten so out of control that global support for banning payments is gaining momentum.