typed-lighter 0.2.1

A fully typed, validated async client for the Lighter API.

• Documentation: https://tribulnation.com/typed/lighter
• Source Code: https://github.com/tribulnation/typed/tree/main/packages/lighter

from typed_lighter import Lighter

async with Lighter.new(public=True) as client:
  books = await client.api.markets.order_books(filter='perp')
  for book in books['order_books'][:5]:
    print(book['market_id'], book['symbol'], book['supported_price_decimals'])

Lighter is a perpetuals and spot order book running on its own ZK rollup. Every state change (orders, transfers, leverage, API keys) is a signed L2 transaction; everything else is a REST read, a WebSocket stream, or an auth-token-gated account write. The client mirrors that split:

Signing happens in pure Python, inside the package: no compiled library, no external process. Transactions go over HTTP or over the shared WebSocket connection, chosen per call.

Authenticated Quick Start

from typed_lighter import Lighter

async with Lighter.new() as client:  # reads LIGHTER_ACCOUNT_INDEX, LIGHTER_API_KEY_INDEX, LIGHTER_API_PRIVATE_KEY
  account = client.signer.account_index
  orders = await client.api.account.orders.active(account_index=account)
  for order in orders['orders']:
    print(order['market_index'], order['order_index'], order['price'], order['status'])

Create the API key on Lighter's API keys page: connect your wallet, click Generate API Key, pick an index from 4 to 254, and copy the private key (it is shown once). The same page shows your account index. See Authenticated Setup for the full walkthrough, read-only tokens and registering keys from code.

Why Typed Lighter?

• 🎯 Precise Types: Typed requests and responses on every surface, down to order-type unions and Literal statuses, not dict/Any.
• ✅ Runtime Validation: REST replies, WebSocket frames and transaction receipts validated by default, not just typed on paper.
• ⚡ Async First: Async HTTP and one multiplexed WebSocket connection for streams and transactions, built for concurrent workflows.
• 📚 Full Surface: Every REST endpoint and stream channel, all 20 user transaction types, the explorer and the deposit bridge, not just the popular ones.

Installation

pip install typed-lighter

How To

• Fetch Market Data
• Fetch Account Data
• Paginate Through Results
• Place & Manage Orders
• Listen To Streams
• Batch Transactions
• Transfers & Sub-Accounts
• Sign Offline

Reference

• Authenticated Setup
• Async Usage
• Error Handling
• Environment Variables
• Timestamps
• Numbers

Design Philosophy

Typed Lighter follows the principles outlined in this blog post.

Details matter. Developer experience matters.

License

MIT — see LICENSE.