aarjaneiro / vcx-py

A simple Python client for the VirgoCX API

VirgoCX Python Client

A simple Python client for the VirgoCX API.

For more information on the REST api on which this was built, please refer to the VirgoCX API Documentation.

If you are registering for a new account, please consider using my referral code (t74uUoso) or following this link to the registration page which will automatically apply the code.

Table of Contents

• Setup
  • API Keys
  • Installation
    • From PyPi
    • From Source
• Usage
  • VirgoCXClient
  • Get KLine Data
  • Get Ticker Data
  • Account Information
  • Query Orders
  • Query Trades
  • Place Order
  • Cancel Order
  • Get Discount
• Warnings
• Paused Trading

Setup

API Keys

Generate your API key and secret from the VirgoCX website. Ensure that the IP address of the machine you are running this client from is whitelisted.

Installation

From PyPi

You can install this package from PyPi by running the following command in your terminal:

pip install vcx-py

From Source

After setting up your environment, install this package from source by running the following command in the root directory of this project:

pip install . # Install the package to your environment

Usage

VirgoCXClient

Create a new instance of the VirgoCXClient class with your API key and secret.

import vcx_py as vcx

vc = vcx.VirgoCXClient(api_key='your_api_key', api_secret='your_secret')

Get KLine Data

Get KLine data for a specific trading pair.

kline_data = vc.get_kline_data(symbol="BTC/CAD", period=vcx.Enums.KLineType.Minute)

Get Ticker Data

Get ticker data for a specific trading pair.

ticker_data = vc.get_ticker_data(symbol="BTC/CAD")

Or for all trading pairs.

ticker_data = vc.tickers()

Account Information

Get account information.

account_info = vc.account_info()

This will give you information regarding your balances across all trading pairs.

Query Orders

Retrieve your orders for a particular trading pair, optionally limited by order status.

orders = vc.query_orders(symbol="BTC/CAD", status=vcx.Enums.OrderStatus.CANCELED)

Query Trades

Retrieve trade (matching) information for a particular symbol.

trades = vc.query_trades(symbol="BTC/CAD")

Place Order

Place a new order.

re = vc.place_order("USDC/CAD", vcx.Enums.OrderType.MARKET, vcx.Enums.OrderDirection.SELL, qty=30)

Note that on success, the response (a dict) will contain the order ID.

Cancel Order

For a specified order ID, cancel the order.

vc.cancel_order(order_id=12345)

Get Discount

Returns similar output as ticker for a given symbol (or all symbols if one is not provided) with your account discount applied to prices.

discount = vc.get_discount(symbol="BTC/CAD")

Warnings

Note that due to CloudFlare protection, this version of the client attempts to access the API through its IP address and not the domain name. Should the IP address change, the client will need to be updated. Moreover, you will receive InsecureRequestWarning warnings when using the client until this issue is resolved. To suppress these warnings, you can use the following to disable such warnings from being emitted by this package:

from vcx_py import STOP_URLLIB_INSECURE_WARN

STOP_URLLIB_INSECURE_WARN.set()

Paused Trading

It is possible that trading on the exchange is paused. Unfortunately, the client does not have a way to check if trading is paused and thus KeyError exceptions may be raised when attempting to access keys from the API which are omitted in such cases. Eventually we hope to have an endpoint which will allow us to check if trading is paused.