rqfc-dev 1.0.0

Thin client for the RQFC fund trading backend

rqfc

Thin Python client for the RQFC fund trading backend.

Traders log in with credentials or an API key issued by an admin. The backend owns authentication, permissions, and each pod's Alpaca credentials, then submits trades on the trader's behalf. No Alpaca keys or Supabase settings ever touch this client. A pod is one Alpaca account; several traders share a pod; admins can trade any pod and manage capital/membership.

See ../docs/ARCHITECTURE.md and ../docs/RUNBOOK.md for the full system.

Install

From GitHub:

pip install git+https://github.com/Rutgers-Quant-Finance-Club/fund.git

After publishing to PyPI, this becomes:

pip install rqfc

For local package development from this repo:

pip install -e .

Trader Login

By default, rqfc talks to the deployed RQFC API:

https://fund-tkb1.onrender.com

Admins issue either email/password credentials or a trader API key. Traders do not need to configure Supabase or Alpaca.

Email/password login:

import rqfc

rqfc.login("[e-mail]", "password")

API key login, useful for scripts and strategy runners:

import rqfc

rqfc.login(api_key="rqfc_...")

Local Dev Override

To test against a local or staging backend, use RQFC_BACKEND_URL:

export RQFC_BACKEND_URL=http://localhost:8000

Or pass it directly:

import rqfc

rqfc.login("[e-mail]", "password", backend_url="http://localhost:8000")

Trader Usage

import rqfc

rqfc.login(api_key="rqfc_...")

rqfc.whoami()                 # your profile + assigned pods

acct = rqfc.pod("Alpha Equities")   # by name or id; must be assigned
acct.buy("AAPL", 10)
acct.sell("AAPL", 5)
acct.short("TSLA", 3)
acct.dollar_buy("NVDA", 5000)
acct.account()                # live equity / cash / buying power
acct.positions()              # live positions
acct.price("AAPL")
acct.sync()                   # refresh the dashboard (positions, NAV, metrics)

Admin Usage

rqfc.login("[e-mail]", "password")
admin = rqfc.admin()

pod = admin.create_pod("Vol Arb", "options", capital=100000,
                       alpaca_api_key="PK...", alpaca_api_secret="...")
admin.list_traders()
admin.add_trader(pod["id"], trader_id, role="trader")
admin.allocate_capital(pod["id"], 150000)
admin.remove_trader(pod["id"], trader_id)

Method Reference

Account (rqfc.pod(...)): buy, sell, short, cover, dollar_buy, dollar_sell, cancel, account, positions, price, bars, sync.

Admin (rqfc.admin()): create_pod, set_alpaca, allocate_capital, list_traders, add_trader, remove_trader.