Python SDK

Installation

pip install ratelane-sdk

from ratelane.config import RatelaneConfig
from ratelane.middleware import RatelaneMiddleware, close_ratelane

Option	Type	Required	Description
`api_key`	`str`	✅	Your Ratelane API key from the dashboard
`collector_url`	`str`	✅	`https://api.ratelane.dev` for production
`fastapi_app`	`FastAPI`	✅	Your FastAPI app instance — used for route discovery
`instance_version`	`str`	❌	Your app version, shown in instance detail
`telemetry_flush_interval_seconds`	`int`	❌	How often telemetry is sent (default: `30`)
`ep_trigger_after_seconds`	`int`	❌	Seconds before emergency profile auto-triggers

app.add_middleware(RatelaneMiddleware, config=config)

Always register the shutdown hook to flush telemetry cleanly:

@app.on_event("shutdown")
async def shutdown():
    await close_ratelane()