Skip to main content

Library for working with OptionsCity Software's City Trader REST API

Project description

Prerequisites:

  1. [Python 2.7 or greater](https://www.python.org/downloads/release/python-2710/)

  2. [Python setuptools](https://pypi.python.org/pypi/setuptools)

  3. A City Trader Username and Password

  4. A City Trader API client_id and client_secret

Examples:

1. Initialize client and retrieve new token from citytrader.request_client import RequestClient rc = RequestClient(server=”https://devservices.optionshop.com”, client_id=”<client_id>”, client_secret=”<client_secret>”, username=”<username>”, password=”<password>”)

2. Retrieve all orders all_orders = rc.request(request_type=”GET”, url=”orders”)

3. Retrieve single order single_order = rc.request(request_type=”GET”, url=”orders/<order_id>”)

4. Retrieve all product groups all_productgroups = rc.request(request_type=”GET”, url=”productgroups”)

5. Retrieve all instruments all_instruments = rc.request(request_type=”GET”, url=”instruments”)

6. Retrieve market data for a single instrument md_message = rc.request(request_type=”GET”, url=”marketdata?instrument_ids=<instrument_id>”)

7. Retrieve market data for multiple instruments md_messages = rc.request(request_type=”GET”, url=”marketdata?instrument_ids=<instrument_id_1>&instrument_ids=<instrument_id_2>”)

8. Retrieve market data for just Last and High prices md_messages_just_last_and_high = rc.request(request_type=”GET”, url=”marketdata?instrument_ids=<instrument_id_1>&instrument_ids=<instrument_id_2>&sides=Last&sides=High”)

9. Submit a day limit order order_results = rc.request(request_type=”POST”, url=”orderactions”, data={“acct_id”: <account_id>, “action_type”: “LimitOrderSub”, “instrument_id”: <instrument_id>, “limit_price”: <limit_price>, “quantity”: <quantity>, “side”: <side>, “time_in_force”: “Day”})

Project details


Download files

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

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

CityTraderPythonLib-0.1-py2.7.egg (8.8 kB view hashes)

Uploaded Source

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