https://github.com/tbeseda/alpaca-ticker-config

Configure ticker with Alpaca.markets positions
https://github.com/tbeseda/alpaca-ticker-config

Last synced: about 1 month ago
JSON representation

Configure ticker with Alpaca.markets positions

• Host: GitHub
• URL: https://github.com/tbeseda/alpaca-ticker-config
• Owner: tbeseda
• Created: 2021-04-15T03:24:51.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2021-04-16T14:36:17.000Z (almost 4 years ago)
• Last Synced: 2024-12-10T19:17:10.918Z (2 months ago)
• Language: JavaScript
• Size: 13.7 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# `alpaca-ticker-config` 🦙 🖥️ 🔧

> Configure Ticker with your Alpaca.markets positions from the command line.

## Summary

[Ticker](https://github.com/achannarasappa/ticker) is a "Terminal stock watcher and stock position tracker."

[Alpaca](https://alpaca.markets/) is an "API for stock trading."

`alpaca-ticker-config` adds your current positions to Ticker by adding them to (or creating) Ticker's config file.

## Usage

Install

```sh

> npm i -g alpaca-ticker-config

```

Have your Alpaca API "Key ID" and "Secret" ready (available on your Alpaca dashboard):

```sh

# check the manual

> alpaca-ticker-config --help

# update or create your Ticker config

> alpaca-ticker-config -k YOURKEYID -s theKeySecret

# run ticker

> ticker

```

## Notes

This CLI will not replace your current Ticker `watchlist`, but it will always add your positions to any existing watchlist.

It will always replace your Ticker `lots` with your current Alpaca positions.

See "Todo" below.

## Caveats

This CLI hasn't been thoroughly tested. However, in the worst case it will save an empty `.ticker.yml` file.

It has only been tested on MacOS.

## Todo

- [X] add option to print instead of save new config

- [X] allow Ticker ~~options~~ config file path to be passed to the config

- [ ] feature to save Alpaca credentials for subsequent runs