Skip to main content

No project description provided

Project description

# city-trader-python-lib A python library for working with OptionsCity Software’s City Trader REST API.

#### 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

#### Installation 1. [Download the source code](https://github.com/optionshop/city-trader-python-lib/archive/master.zip) 2. Unzip the archive 3. Run: `python setup.py install`

— # Examples ##### Initialize client and retrieve new token `python 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>") `

##### Retrieve all orders `python all_orders = rc.request(request_type="GET", url="orders") `

##### Retrieve single order `python single_order = rc.request(request_type="GET", url="orders/<order_id>") `

##### Retrieve all product groups `python all_productgroups = rc.request(request_type="GET", url="productgroups") `

##### Retrieve all instruments `python all_instruments = rc.request(request_type="GET", url="instruments") `

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

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

##### Retrieve market data for just Last and High prices `python 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") `

##### Submit a day limit order `python 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.2-py2.7.egg (8.8 kB view details)

Uploaded Source

File details

Details for the file CityTraderPythonLib-0.2-py2.7.egg.

File metadata

File hashes

Hashes for CityTraderPythonLib-0.2-py2.7.egg
Algorithm Hash digest
SHA256 07680a7b47800d3f9d0161fcbdec7c0b3ce97522aae8b5051ad94ff439b2d85e
MD5 057ebab0c5f7b774f03960689ebf7881
BLAKE2b-256 cf6c9e5e921ac0b63ce5320d29a4c9e2b55b65fb01b8a75bf2313e9b402643cd

See more details on using hashes here.

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