lighter

Python SDK for Lighter (zkLighter perpetuals exchange).

Requirements

Python 3.8+

Installation

pip install git+https://github.com/elliottech/zklighter-perps-python.git

Then:

import lighter

Getting started

import asyncio
import lighter


async def main():
    client = lighter.ApiClient()
    account_api = lighter.AccountApi(client)
    account = await account_api.account(by="index", value="1")
    print(account)
    await client.close()


if __name__ == "__main__":
    asyncio.run(main())

Examples

The examples/ directory contains end-to-end scripts for the common flows. A few starting points:

• Read public REST endpoints
• Stream order books and account state over websocket
• Create / modify / cancel an order over HTTP
• Create / modify / cancel an order over websocket
• System setup (API key, signer)

See examples/README.md for the full annotated list.

All URIs are relative to https://mainnet.zklighter.elliot.ai

Class	Method	HTTP request	Description
AccountApi	account	GET /api/v1/account	account
AccountApi	account_limits	GET /api/v1/accountLimits	accountLimits
AccountApi	account_metadata	GET /api/v1/accountMetadata	accountMetadata
AccountApi	accounts_by_l1_address	GET /api/v1/accountsByL1Address	accountsByL1Address
AccountApi	apikeys	GET /api/v1/apikeys	apikeys
AccountApi	change_account_tier	POST /api/v1/changeAccountTier	changeAccountTier
AccountApi	get_maker_only_api_keys	GET /api/v1/getMakerOnlyApiKeys	getMakerOnlyApiKeys
AccountApi	l1_metadata	GET /api/v1/l1Metadata	l1Metadata
AccountApi	lease_options	GET /api/v1/leaseOptions	leaseOptions
AccountApi	leases	GET /api/v1/leases	leases
AccountApi	liquidations	GET /api/v1/liquidations	liquidations
AccountApi	lit_lease	POST /api/v1/litLease	litLease
AccountApi	partner_stats	GET /api/v1/partnerStats	partnerStats
AccountApi	pnl	GET /api/v1/pnl	pnl
AccountApi	position_funding	GET /api/v1/positionFunding	positionFunding
AccountApi	public_pools_metadata	GET /api/v1/publicPoolsMetadata	publicPoolsMetadata
AccountApi	referral_user_referrals	GET /api/v1/referral/userReferrals	userReferrals
AccountApi	rfq_create	POST /api/v1/rfq/create	rfq_create
AccountApi	rfq_get	GET /api/v1/rfq/get	rfq_get
AccountApi	rfq_list	GET /api/v1/rfq/list	rfq_list
AccountApi	rfq_respond	POST /api/v1/rfq/respond	rfq_respond
AccountApi	rfq_update	POST /api/v1/rfq/update	rfq_update
AccountApi	set_maker_only_api_keys	POST /api/v1/setMakerOnlyApiKeys	setMakerOnlyApiKeys
AccountApi	tokens	GET /api/v1/tokens	tokens
AccountApi	tokens_create	POST /api/v1/tokens/create	tokens_create
AccountApi	tokens_revoke	POST /api/v1/tokens/revoke	tokens_revoke
AnnouncementApi	announcement	GET /api/v1/announcement	announcement
BlockApi	block	GET /api/v1/block	block
BlockApi	blocks	GET /api/v1/blocks	blocks
BlockApi	current_height	GET /api/v1/currentHeight	currentHeight
BridgeApi	create_intent_address	POST /api/v1/createIntentAddress	createIntentAddress
BridgeApi	deposit_latest	GET /api/v1/deposit/latest	deposit_latest
BridgeApi	deposit_networks	GET /api/v1/deposit/networks	deposit_networks
BridgeApi	fastbridge_info	GET /api/v1/fastbridge/info	fastbridge_info
BridgeApi	fastwithdraw	POST /api/v1/fastwithdraw	fastwithdraw
BridgeApi	fastwithdraw_info	GET /api/v1/fastwithdraw/info	fastwithdraw_info
CandlestickApi	candles	GET /api/v1/candles	candles
CandlestickApi	fundings	GET /api/v1/fundings	fundings
FundingApi	funding_rates	GET /api/v1/funding-rates	funding-rates
InfoApi	layer1_basic_info	GET /api/v1/layer1BasicInfo	layer1BasicInfo
InfoApi	synthetic_spot_info	GET /api/v1/syntheticSpotInfo	syntheticSpotInfo
InfoApi	system_config	GET /api/v1/systemConfig	systemConfig
InfoApi	transfer_fee_info	GET /api/v1/transferFeeInfo	transferFeeInfo
InfoApi	withdrawal_delay	GET /api/v1/withdrawalDelay	withdrawalDelay
NotificationApi	notification_ack	POST /api/v1/notification/ack	notification_ack
OrderApi	account_active_orders	GET /api/v1/accountActiveOrders	accountActiveOrders
OrderApi	account_inactive_orders	GET /api/v1/accountInactiveOrders	accountInactiveOrders
OrderApi	asset_details	GET /api/v1/assetDetails	assetDetails
OrderApi	exchange_metrics	GET /api/v1/exchangeMetrics	exchangeMetrics
OrderApi	exchange_stats	GET /api/v1/exchangeStats	exchangeStats
OrderApi	execute_stats	GET /api/v1/executeStats	executeStats
OrderApi	export	GET /api/v1/export	export
OrderApi	order_book_details	GET /api/v1/orderBookDetails	orderBookDetails
OrderApi	order_book_orders	GET /api/v1/orderBookOrders	orderBookOrders
OrderApi	order_books	GET /api/v1/orderBooks	orderBooks
OrderApi	recent_trades	GET /api/v1/recentTrades	recentTrades
OrderApi	trades	GET /api/v1/trades	trades
ReferralApi	referral_create	POST /api/v1/referral/create	referral_create
ReferralApi	referral_get	GET /api/v1/referral/get	referral_get
ReferralApi	referral_kickback_update	POST /api/v1/referral/kickback/update	referral_kickback_update
ReferralApi	referral_points	GET /api/v1/referral/points	referral_points
ReferralApi	referral_update	POST /api/v1/referral/update	referral_update
ReferralApi	referral_use	POST /api/v1/referral/use	referral_use
RootApi	info	GET /info	info
RootApi	status	GET /	status
TokenlistApi	tokenlist	GET /api/v1/tokenlist	tokenlist
TransactionApi	account_txs	GET /api/v1/accountTxs	accountTxs
TransactionApi	block_txs	GET /api/v1/blockTxs	blockTxs
TransactionApi	deposit_history	GET /api/v1/deposit/history	deposit_history
TransactionApi	next_nonce	GET /api/v1/nextNonce	nextNonce
TransactionApi	send_tx	POST /api/v1/sendTx	sendTx
TransactionApi	send_tx_batch	POST /api/v1/sendTxBatch	sendTxBatch
TransactionApi	set_account_metadata	POST /api/v1/setAccountMetadata	setAccountMetadata
TransactionApi	transfer_history	GET /api/v1/transfer/history	transfer_history
TransactionApi	tx	GET /api/v1/tx	tx
TransactionApi	tx_from_l1_tx_hash	GET /api/v1/txFromL1TxHash	txFromL1TxHash
TransactionApi	txs	GET /api/v1/txs	txs
TransactionApi	withdraw_history	GET /api/v1/withdraw/history	withdraw_history

• Account
• AccountApiKeys
• AccountAsset
• AccountLimits
• AccountMetadata
• AccountMetadatas
• AccountPnL
• AccountPosition
• Announcement
• Announcements
• ApiKey
• ApiToken
• ApprovedIntegrator
• Asset
• AssetDetails
• Block
• Blocks
• BridgeSupportedNetwork
• BridgeSupportedNetworks
• Candle
• Candles
• ContractAddress
• CreateIntentAddressResp
• CurrentHeight
• DailyReturn
• Deposit
• DepositHistory
• DepositHistoryItem
• DetailedAccount
• DetailedAccounts
• EnrichedTx
• ExchangeMetric
• ExchangeStats
• ExecuteStat
• ExportData
• Funding
• FundingRate
• FundingRates
• Fundings
• L1Metadata
• L1ProviderInfo
• Layer1BasicInfo
• LeaseEntry
• LeaseOptionEntry
• LiqTrade
• Liquidation
• LiquidationInfo
• LiquidationInfos
• MarketConfig
• NextNonce
• Order
• OrderBook
• OrderBookDetails
• OrderBookOrders
• OrderBookStats
• OrderBooks
• Orders
• PartnerStats
• PendingUnlock
• PerpsOrderBookDetail
• PnLEntry
• PositionFunding
• PositionFundings
• PublicPoolInfo
• PublicPoolMetadata
• PublicPoolShare
• RFQEntry
• RFQMetadata
• RFQResponseEntry
• Referral
• ReferralCode
• ReferralPointEntry
• ReferralPoints
• ReqSetAccountMetadata
• RespChangeAccountTier
• RespCreateRFQ
• RespGetApiTokens
• RespGetExchangeMetrics
• RespGetExecuteStats
• RespGetFastBridgeInfo
• RespGetFastwithdrawalInfo
• RespGetLeaseOptions
• RespGetLeases
• RespGetMakerOnlyApiKeys
• RespGetRFQ
• RespListRFQs
• RespPostApiToken
• RespPublicPoolsMetadata
• RespRespondToRFQ
• RespRevokeApiToken
• RespSendTx
• RespSendTxBatch
• RespSetMakerOnlyApiKeys
• RespSyntheticSpotInfo
• RespUpdateKickback
• RespUpdateRFQ
• RespUpdateReferralCode
• RespWithdrawalDelay
• ResultCode
• RiskInfo
• RiskParameters
• SharePrice
• SimpleOrder
• SlippageResult
• SpotOrderBookDetail
• Status
• Strategy
• SubAccounts
• SystemConfig
• Token
• TokenList
• Trade
• TradeStats
• Trades
• TransferFeeInfo
• TransferHistory
• TransferHistoryItem
• Tx
• TxHash
• Txs
• UserReferrals
• ValidatorInfo
• WithdrawHistory
• WithdrawHistoryItem
• ZkLighterInfo