carrac-sdk 0.1.0

Official Python SDK for Carrac — market data, plays, alerts, usage

Carrac Python SDK

Official Python client for the Carrac API. Use it to fetch market data, manage plays, create alerts, and inspect your API usage from any Python application.

Install

pip install carrac-sdk

Requires Python ≥ 3.9 and a Carrac Premium subscription (API keys require Premium).

Quick start

from carrac import Client

cvx = Client(api_key="carrac_k_...")

# Market data
chart = cvx.charts.get("BTC", timeframe="4h", indicators="CPR,RSI")

# Composite call — everything about an asset in one request
detail = cvx.composite.asset_detail("BTC", format="compact")

# Create an alert
cvx.alerts.create(symbol="BTC", alert_type="price", condition="above", price=120000)

# Scanner
ranked = cvx.scanner.list(direction="long", verdict="STRONG,GOOD")

# Your usage
usage = cvx.usage.get()
print(usage["rest"]["usage"])  # [{window:"minute", used:7, limit:240, remaining:233}, ...]

Authentication

1. Go to Settings → API & Developer in the Carrac dashboard.
2. Click Create Key, copy the full key (shown once).
3. Use it with Client(api_key=...) or set CARRAC_API_KEY in your environment.

Features

• Per-user scoped keys — every call is rate-limited against your own Premium budget.
• Automatic 429 backoff honouring Retry-After.
• Pagination iterators for list endpoints.
• Works in any Python ≥ 3.9 runtime (CPython, PyPy, Lambda, serverless).

Docs

Interactive API reference: https://app.carrac.cc/api/docs OpenAPI spec: https://app.carrac.cc/api/openapi.json