rickykim93/gcapi-python

Unofficial Python package for Gain Capital API used for trading on Forex.com

gcapi-python

Python package for Gain Capital API used for trading on Forex.com

Table of Contents

• Getting Started
  • Installation
  • Usage
  • Functions
    • Account Information
    • Margin Information
    • Market Information
    • Pricing
    • Trading
    • List Open Positions
  • Examples
• Contact

Getting Started

Installation

pip install gcapi-python

Usage

After installing, import into your project

from gcapi import GCapiClient

Initialize with Forex.com credentials and app key.

api = GCapiClient(username='usr', password='***', appkey='***', proxies=None)

Endpoints

Account Information

api.get_account_info(get=None)

Margin Information

api.get_margin_info(get=None)

Market Information

api.get_market_info(market_name,get=None)

Pricing

api.get_prices(market_id=None, num_ticks=None, from_ts=None, to_ts=None, price_type=None)

api.get_ohlc(market_id=None, num_ticks=None, interval="HOUR", span=1, from_ts=None, to_ts=None)

Trading

api.trade_order(quantity, offer_price, direction, trading_acc_id=None, market_id=None, market_name=None, stop_loss=None, 
                take_profit=None, trigger_price=None)

List Open Positions

api.list_open_positions(trading_acc_id=None)

Examples

Click here to see examples

Contact

Please contact Kyu Mok (Ricky) Kim if you have any questions, suggestions, or feedback.

For any other questions beside this tool, post your questions on http://faq.labs.gaincapital.com/

Website: rickykim.net