Skip to main content

A package allowing easy interaction with IG Group's REST API.

Project description

Python Package for IG Group's API.

A package allowing easy interaction with IG Group's REST API.

This project is a fully functional package that allows easy interaction with IG Group's REST API. The main function being to retrieve historical data for later use in backtesting. To do this, key functions were defined for:

  • Opening trading sessions.
  • Searching specific financial instruments.
  • Getting historical prices from finanical instruments.
  • Managing watchlists.
  • Closing trading sessions.

Class diagram

How to utilise this package

  1. Use pip install ig_package in the command prompt.
  2. Import the IG object into your script:
    from ig_package import IG
    
  3. Initialise the IG object including your API Key and details in the relevant parameters.

How to contribute to this package

The classes within this package are based on the functionaliy of IG Group's REST API so in order to contribute I would recommend experimenting with their API Companion.

The three main classes: IG, Watchlist and Instrument, are all defined in main.py and functions can be easily added to each of them.

If any new classes have been defined then remember to import the new classes into __init__.py. This allows users to import the classes directly from the package.

Fixing bugs

Please make sure to report any bugs found as issues on Github. If you then want to submit a pull request, make sure to reference the issue.

Future Development

  1. Adding functions to handle active positions, therefore allowing users to execute trades.
  2. Adding working trades so executing trades when the price reaches a certain amount on a specific instrument.
  3. Adding a demo version as IG's API also can manage demo accounts too.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ig_package-1.0.4.tar.gz (6.9 kB view hashes)

Uploaded Source

Built Distribution

ig_package-1.0.4-py3-none-any.whl (7.5 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page