# quantxpress-technologies/blitz-api-py architecture

> Architecture diagram of the GitHub repository quantxpress-technologies/blitz-api-py, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-09-30). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/quantxpress-technologies/blitz-api-py
- Repository: https://github.com/quantxpress-technologies/blitz-api-py

## Overview

BlitzConnect is a Python SDK for authenticated trading and market-data access. Users create an Interactive or Market Data client, which obtains an access token and issues REST requests; WebSocket clients connect, manage subscriptions, and deliver callbacks. The SDK also provides instrument lookup and protobuf decoding. The sampled source establishes the principal calls; broader capabilities such as portfolio queries and historical data are documented in the clients. Proto schema and generated-code relationships are visible in the README but their implementation details were not sampled.

Main entry points: [`blitzsdk/interactive/api_client.py`](https://github.com/quantxpress-technologies/blitz-api-py/blob/master/blitzsdk/interactive/api_client.py) (Trading REST), [`blitzsdk/marketdata/websocket_client.py`](https://github.com/quantxpress-technologies/blitz-api-py/blob/master/blitzsdk/marketdata/websocket_client.py) (Market stream), [`blitzsdk/common/auth.py`](https://github.com/quantxpress-technologies/blitz-api-py/blob/master/blitzsdk/common/auth.py) (Authentication), [`blitzsdk/marketdata/api_client.py`](https://github.com/quantxpress-technologies/blitz-api-py/blob/master/blitzsdk/marketdata/api_client.py) (Market REST)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_trading["Interactive Trading"]
  node_interactive_api["Trading REST<br/>[api_client.py]"]
  node_order_model["Order request<br/>[models.py]"]
  node_trading_service["Trading API"]
end

subgraph group_market["Market Data"]
  node_market_api["Market REST<br/>[api_client.py]"]
  node_instrument_manager["Instrument lookup"]
  node_market_proto["Market messages<br/>[marketdata.proto]"]
  node_generated_proto["Protobuf decoder<br/>[marketdata_pb2.py]"]
  node_market_service["Market Data API"]
  node_instrument_source["Instrument feed"]
end

subgraph group_stream["WebSocket Streaming"]
  node_interactive_ws["Trading stream"]
  node_market_ws["Market stream"]
end

subgraph group_shared["Shared Runtime"]
  node_auth["Authentication<br/>[auth.py]"]
  node_base_api["HTTP transport<br/>[base_client.py]"]
  node_base_ws["WebSocket transport<br/>[base_ws_client.py]"]
  node_config["Configuration<br/>[config.py]"]
  node_session["HTTP session<br/>[session.py]"]
  node_ws_compat["Socket compatibility<br/>[ws_compat.py]"]
  node_errors["SDK errors<br/>[exceptions.py]"]
end

node_developer(("SDK user"))

node_developer -->|"calls"| node_interactive_api
node_developer -->|"starts"| node_interactive_ws
node_developer -->|"calls"| node_market_api
node_developer -->|"starts"| node_market_ws
node_interactive_api -->|"serializes"| node_order_model
node_interactive_api -->|"uses"| node_base_api
node_interactive_api -->|"requests"| node_trading_service
node_market_api -->|"uses"| node_base_api
node_market_api -->|"requests"| node_market_service
node_instrument_manager -->|"downloads"| node_instrument_source
node_interactive_api -->|"authenticates"| node_auth
node_market_api -->|"authenticates"| node_auth
node_base_api -->|"builds"| node_session
node_base_api -->|"raises"| node_errors
node_auth -->|"builds"| node_session
node_auth -->|"reads"| node_config
node_interactive_api -->|"reads"| node_config
node_market_api -->|"reads"| node_config
node_interactive_ws -->|"extends"| node_base_ws
node_market_ws -->|"extends"| node_base_ws
node_interactive_ws -->|"authenticates"| node_auth
node_market_ws -->|"authenticates"| node_auth
node_interactive_ws -->|"reads"| node_config
node_market_ws -->|"reads"| node_config
node_base_ws -->|"connects with"| node_ws_compat
node_market_ws -->|"decodes with"| node_generated_proto
node_market_proto -.->|"defines"| node_generated_proto
node_interactive_ws -.->|"streams"| node_trading_service
node_market_ws -.->|"streams"| node_market_service

click node_interactive_api "https://github.com/quantxpress-technologies/blitz-api-py/blob/master/blitzsdk/interactive/api_client.py"
click node_order_model "https://github.com/quantxpress-technologies/blitz-api-py/blob/master/blitzsdk/interactive/models.py"
click node_interactive_ws "https://github.com/quantxpress-technologies/blitz-api-py/blob/master/blitzsdk/interactive/websocket_client.py"
click node_market_api "https://github.com/quantxpress-technologies/blitz-api-py/blob/master/blitzsdk/marketdata/api_client.py"
click node_instrument_manager "https://github.com/quantxpress-technologies/blitz-api-py/blob/master/blitzsdk/marketdata/instrument_manager.py"
click node_market_ws "https://github.com/quantxpress-technologies/blitz-api-py/blob/master/blitzsdk/marketdata/websocket_client.py"
click node_market_proto "https://github.com/quantxpress-technologies/blitz-api-py/blob/master/blitzsdk/proto/marketdata.proto"
click node_generated_proto "https://github.com/quantxpress-technologies/blitz-api-py/blob/master/blitzsdk/proto/marketdata_pb2.py"
click node_auth "https://github.com/quantxpress-technologies/blitz-api-py/blob/master/blitzsdk/common/auth.py"
click node_base_api "https://github.com/quantxpress-technologies/blitz-api-py/blob/master/blitzsdk/common/base_client.py"
click node_base_ws "https://github.com/quantxpress-technologies/blitz-api-py/blob/master/blitzsdk/common/base_ws_client.py"
click node_config "https://github.com/quantxpress-technologies/blitz-api-py/blob/master/blitzsdk/common/config.py"
click node_session "https://github.com/quantxpress-technologies/blitz-api-py/blob/master/blitzsdk/common/session.py"
click node_ws_compat "https://github.com/quantxpress-technologies/blitz-api-py/blob/master/blitzsdk/common/ws_compat.py"
click node_errors "https://github.com/quantxpress-technologies/blitz-api-py/blob/master/blitzsdk/common/exceptions.py"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_interactive_api,node_order_model,node_trading_service,node_developer toneBlue
class node_market_api,node_instrument_manager,node_market_proto,node_generated_proto,node_market_service,node_instrument_source toneAmber
class node_interactive_ws,node_market_ws toneMint
class node_auth,node_base_api,node_base_ws,node_config,node_session,node_ws_compat,node_errors toneRose
```

## Components

### Interactive Trading

- [Trading REST](https://github.com/quantxpress-technologies/blitz-api-py/blob/master/blitzsdk/interactive/api_client.py): `blitzsdk/interactive/api_client.py`
- [Order request](https://github.com/quantxpress-technologies/blitz-api-py/blob/master/blitzsdk/interactive/models.py): `blitzsdk/interactive/models.py`
- **Trading API**

### Market Data

- [Market REST](https://github.com/quantxpress-technologies/blitz-api-py/blob/master/blitzsdk/marketdata/api_client.py): `blitzsdk/marketdata/api_client.py`
- [Instrument lookup](https://github.com/quantxpress-technologies/blitz-api-py/blob/master/blitzsdk/marketdata/instrument_manager.py): `blitzsdk/marketdata/instrument_manager.py`
- [Market messages](https://github.com/quantxpress-technologies/blitz-api-py/blob/master/blitzsdk/proto/marketdata.proto): `blitzsdk/proto/marketdata.proto`
- [Protobuf decoder](https://github.com/quantxpress-technologies/blitz-api-py/blob/master/blitzsdk/proto/marketdata_pb2.py): `blitzsdk/proto/marketdata_pb2.py`
- **Market Data API**
- **Instrument feed**

### WebSocket Streaming

- [Trading stream](https://github.com/quantxpress-technologies/blitz-api-py/blob/master/blitzsdk/interactive/websocket_client.py): `blitzsdk/interactive/websocket_client.py`
- [Market stream](https://github.com/quantxpress-technologies/blitz-api-py/blob/master/blitzsdk/marketdata/websocket_client.py): `blitzsdk/marketdata/websocket_client.py`

### Shared Runtime

- [Authentication](https://github.com/quantxpress-technologies/blitz-api-py/blob/master/blitzsdk/common/auth.py): `blitzsdk/common/auth.py`
- [HTTP transport](https://github.com/quantxpress-technologies/blitz-api-py/blob/master/blitzsdk/common/base_client.py): `blitzsdk/common/base_client.py`
- [WebSocket transport](https://github.com/quantxpress-technologies/blitz-api-py/blob/master/blitzsdk/common/base_ws_client.py): `blitzsdk/common/base_ws_client.py`
- [Configuration](https://github.com/quantxpress-technologies/blitz-api-py/blob/master/blitzsdk/common/config.py): `blitzsdk/common/config.py`
- [HTTP session](https://github.com/quantxpress-technologies/blitz-api-py/blob/master/blitzsdk/common/session.py): `blitzsdk/common/session.py`
- [Socket compatibility](https://github.com/quantxpress-technologies/blitz-api-py/blob/master/blitzsdk/common/ws_compat.py): `blitzsdk/common/ws_compat.py`
- [SDK errors](https://github.com/quantxpress-technologies/blitz-api-py/blob/master/blitzsdk/common/exceptions.py): `blitzsdk/common/exceptions.py`

### Other components

- **SDK user**

## Connections

- SDK user → Trading REST: calls (evidence: `README.md`)
- SDK user → Trading stream: starts (evidence: `README.md`)
- SDK user → Market REST: calls (evidence: `README.md`)
- SDK user → Market stream: starts (evidence: `README.md`)
- Trading REST → Order request: serializes (evidence: `blitzsdk/interactive/api_client.py`)
- Trading REST → HTTP transport: uses (evidence: `blitzsdk/interactive/api_client.py`)
- Trading REST → Trading API: requests (evidence: `blitzsdk/interactive/api_client.py`)
- Market REST → HTTP transport: uses (evidence: `blitzsdk/marketdata/api_client.py`)
- Market REST → Market Data API: requests (evidence: `blitzsdk/marketdata/api_client.py`)
- Instrument lookup → Instrument feed: downloads (evidence: `blitzsdk/marketdata/instrument_manager.py`)
- Trading REST → Authentication: authenticates
- Market REST → Authentication: authenticates
- HTTP transport → HTTP session: builds (evidence: `blitzsdk/common/base_client.py`)
- HTTP transport → SDK errors: raises (evidence: `blitzsdk/common/base_client.py`)
- Authentication → HTTP session: builds (evidence: `blitzsdk/common/auth.py`)
- Authentication → Configuration: reads (evidence: `blitzsdk/common/auth.py`)
- Trading REST → Configuration: reads (evidence: `blitzsdk/interactive/api_client.py`)
- Market REST → Configuration: reads (evidence: `blitzsdk/marketdata/api_client.py`)
- Trading stream → WebSocket transport: extends (evidence: `blitzsdk/interactive/websocket_client.py`)
- Market stream → WebSocket transport: extends (evidence: `blitzsdk/marketdata/websocket_client.py`)
- Trading stream → Authentication: authenticates (evidence: `blitzsdk/interactive/websocket_client.py`)
- Market stream → Authentication: authenticates (evidence: `blitzsdk/marketdata/websocket_client.py`)
- Trading stream → Configuration: reads (evidence: `blitzsdk/interactive/websocket_client.py`)
- Market stream → Configuration: reads (evidence: `blitzsdk/marketdata/websocket_client.py`)
- WebSocket transport → Socket compatibility: connects with (evidence: `blitzsdk/common/base_ws_client.py`)
- Market stream → Protobuf decoder: decodes with (evidence: `blitzsdk/marketdata/websocket_client.py`)
- Market messages → Protobuf decoder: defines
- Trading stream → Trading API: streams (evidence: `README.md`)
- Market stream → Market Data API: streams (evidence: `README.md`)
