https://github.com/bennycode/ig-trading-api
IG Trading API for Node.js, written in TypeScript.
https://github.com/bennycode/ig-trading-api
cfd derivatives finance fintech hacktoberfest rest-client trading-api
Last synced: 4 months ago
JSON representation
IG Trading API for Node.js, written in TypeScript.
- Host: GitHub
- URL: https://github.com/bennycode/ig-trading-api
- Owner: bennycode
- License: mit
- Created: 2020-12-04T22:27:31.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-09-01T02:23:49.000Z (10 months ago)
- Last Synced: 2025-02-27T16:50:47.594Z (4 months ago)
- Topics: cfd, derivatives, finance, fintech, hacktoberfest, rest-client, trading-api
- Language: TypeScript
- Homepage: https://bennycode.com/ig-trading-api/
- Size: 2.81 MB
- Stars: 39
- Watchers: 5
- Forks: 14
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# IG Trading API
    
Unofficial [IG Trading API](https://labs.ig.com/rest-trading-api-guide.html) 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][1].
- **Maintained.** Automated security updates. No threats from outdated dependencies.
- **Documented.** Get started with the [generated documentation][2].
## Installation
**npm**
```bash
npm install ig-trading-api
```
**Yarn**
```bash
yarn add ig-trading-api
```
## Usage
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.
### Login
```ts
import {APIClient} from 'ig-trading-api';
const client = new APIClient(APIClient.URL_LIVE, {
apiKey: 'your-api-key',
username: 'your-username',
password: 'your-password',
});
```
### Search Trading Symbol
Make sure to use [IG's Epic codes](https://trading-ig.readthedocs.io/en/latest/faq.html#how-do-i-find-the-epic-for-market-x) to find a trading symbol:
```ts
const query = 'BITCOIN';
const response = await client.rest.market.searchMarkets(query);
console.log(response.markets[0].epic);
```
### Show available resolutions
Check the available intervals for retrieving data:
```ts
import {APIClient, Resolution} from 'ig-trading-api';
console.log(Resolution);
```
### Retrieve historical data
```ts
const epic = 'UC.D.MSFT.CASH.IP';
const prices = await client.rest.market.price.getPrices(epic, Resolution.DAY, 5);
```
### Subscribe to live data
Here is how you can subscribe to live candles and other updates from IG:
- [stream.ts](./src/demo/stream.ts)
### More Examples
More code examples can be found in the [demo directory](./src/demo/).
## Resources
- [IG REST Trading API Reference](https://labs.ig.com/rest-trading-api-reference.html)
- [IG API Companion](https://labs.ig.com/sample-apps/api-companion/index.html)
- [IG Streaming Companion](https://labs.ig.com/sample-apps/streaming-companion/index.html)
- [IG REST Trading API Limits](https://labs.ig.com/faq.html)
- [Spreads, commissions and margins](https://www.ig.com/en/cfd-trading/charges-and-margins) ([in Germany](https://www.ig.com/de/hilfe-und-support/cfds/kosten-und-gebuehren/wie-lauten-die-produktinformationen-fuer-aktien-cfds#information-banner-dismiss))
### IG Instrument Identifier (Epic)
Breakdown for "IX.D.DOW.DAILY.IP":
| Symbol | Description | Example |
| ------ | ------------------------------- | ------------------------------------------------------------------ |
| IX | Hours of trading | "[Index Out of Hours](https://www.ig.com/uk/out-of-hours-trading)" |
| D | Tradability | "D" when tradeable |
| DOW | Underlying market | "Dow Jones" |
| DAILY | Indicator for processing method | "Daily" funded bet |
| IP | Asset type | "Intellectual Property" |
Epics for testing:
| Epic | Name | Environment | Trading Time |
| ------------------- | ------------------- | ----------- | ---------------------- |
| ED.D.DHERGY.CASH.IP | Delivery Hero SE | Live / Demo | Germany: 09:00 - 17:30 |
| UC.D.MSFT.CASH.IP | Microsoft Corp | Live / Demo | Germany: 10:00 - 03:00 |
| UA.D.COINUS.CASH.IP | Coinbase Global Inc | Live | Germany: 15:30 - 22:00 |
## Development Setup
You can get up and running in just a few simple steps:
1. Run `yarn` (to install or update third-party dependencies)
1. Have a look at the [.env.defaults](./.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](https://github.com/mrsteele/dotenv-defaults#usage))
1. Run `yarn demo:login` to test your credentials
## Maintainers
[![Benny Neugebauer on Stack Exchange][stack_exchange_bennyn_badge]][stack_exchange_bennyn_url]
## Contributing
Contributions, issues and feature requests are welcome!
Feel free to check the [issues page](https://github.com/bennycode/ig-trading-api/issues).
## License
This project is [MIT](./LICENSE) licensed.
## ⭐️ Show your support ⭐️
[Please leave a star](https://github.com/bennycode/ig-trading-api/stargazers) if you find this project useful.
[1]: https://www.npmjs.com/package/ig-trading-api
[2]: https://bennycode.com/ig-trading-api
[stack_exchange_bennyn_badge]: https://stackexchange.com/users/flair/203782.png?theme=default
[stack_exchange_bennyn_url]: https://stackexchange.com/users/203782/benny-neugebauer?tab=accounts