Skip to main content

A simpler library for the alapaca trade api

Project description

cira

A simpler libray for alpaca-trade-api from Alpaca Markets. Cira is available pip

a cira

I was intrested in using the alpaca trade api for building quantitative paper trading. The project paper-trader.
However after working on this for alomst a year (of and ond agian) I relized that I had alomst build a small libray for using the alpca api. So I thought that shuld make this in to a real lib so that you also can get started with quantitative paper trading.

The name Cira is the word for a baby alpca and becose this is a simpel and small lib I thoght it would be a prefect fit.

Getting Started

Installation

You can install by pip

pip install cira

Usage

Becose the alpca trade API need a key.
You need to keep your api key in a json file. Cira needs the path to the file.

import cira
cira.KEY_FILE = "../mypath/key.json"
cira.buy(1, "TSLA")
print(cira.get_postion())
cira.sell(1, "TSLA")

Versioning

v.0.0.1

Development

To install cira with all the dev req.

git clone git@github.com:AxelGard/cira.git
cd cira/
git checkout develop 

and know

python3 -m venv env 
source env/bin/activate
pip install -e .[dev]

Coding style

I have been building this i a vary functional programming style. I'm also trying to follow the pep8 std notation.

License

This project is licensed under the MIT License - see the LICENSE file for details

Acknowledgments

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

cira-0.0.2.tar.gz (5.1 kB view hashes)

Uploaded Source

Built Distribution

cira-0.0.2-py3-none-any.whl (5.0 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