cira-classic

A simpler library for alpaca-trade-api from Alpaca Markets. Cira is available on pip. Plz give it a star if you like it!

you shuld use cira and not cira-classic, cira-classic is for legacy users

I was interested in using the Alpaca trade API for building a quantitative paper trader. The project is available here.
However after working on this for alomst a year (off and on) I realized that I had alomst build a small library for using the Alpaca API. So I thought that I would make this into a real library so that you can get started with quantitative paper trading as well.

The name cira is the word for a baby alpaca and because this is a simple and small lib I thought it would be a perfect fit.

Getting Started

Installation

You can install it using pip.

pip install cira-classic

Usage

Since the Alpaca trade API need a key, you need to generate your own and keep it in a JSON file which cira needs the path to. You can also set the variables directly or use an environment variable. However, it is recommended that you store it in a file.
key.json

{
  "APCA-API-KEY-ID":"your_pub_key",
  "APCA-API-SECRET-KEY":"your_private_key"
}

then you can start using the lib

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

Wiki and docs

To see what more you can do check out the wiki.

I also have an example of how to build a index fund trader with cira-classic or check out paper-trader for my usage of cira.

Versioning & News

Cira-classic is the older structure of cira

If you find bug plz let me know with a issue. If you know how to solve the problem then you can of course make a pull request and I will take a look at it.

Development

To install cira with all the dev req.

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

and know you need to

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

Run tests using pytest. Ensure that you are in the cira dir. But you will need a new key. This key should not only be used for testing or if you don't mind if all of the assets in the portfolio being sold.

touch tests/test_key.json
pytest

Coding style

I have been building this in a very functional programming style. I'm also trying to follow the pep8 standard notation.

License

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

Acknowledgments

• Alpaca API
• cira
• paper-trader