Lighter Python SDK

The RespPublicPoolsMetadata model is a data structure used to represent metadata for public pools. It contains a status code, an optional message, and a list of PublicPoolMetadata objects.

Properties

The read-only token system relies on strict time alignment to ensure predictable lookups across different systems.

Time Alignment

All timestamps are aligned to 6-hour boundaries (21,600 seconds). The calculation used is: unix_timestamp // (6 * 3600) * (6 * 3600)

Expiry and Overlap

• Token Validity: Each token is valid for 8 hours from its aligned timestamp.
• Overlap: Because tokens are generated every 6 hours but last for 8 hours, there is a 2-hour overlap period where two different tokens might be valid, ensuring no service interruption during transitions.

Token Lookup

To retrieve the token valid for the current moment, use the get_auth_token.py script provided in the example directory.

The TokenList model is used to represent a collection of tokens associated with a specific status code and message. It provides methods for serialization and deserialization between JSON strings, Python dictionaries, and class instances.

from lighter.models.token_list import TokenList

# Example usage
json_data = '{"code": 200, "message": "success", "tokens": []}'
token_list_instance = TokenList.from_json(json_data)

# Convert to dict
data_dict = token_list_instance.to_dict()

# Convert back to instance
new_instance = TokenList.from_dict(data_dict)

The ReferralProgramKickback model represents the data structure for referral program kickbacks. It contains the following properties:

You can instantiate this model from JSON strings or dictionaries, and convert instances back into JSON or dictionaries for serialization.

from lighter.models.referral_program_kickback import ReferralProgramKickback

# Create an instance from a JSON string
json_data = '{"var_date": 12345, "percentage": "10.5"}'
instance = ReferralProgramKickback.from_json(json_data)

# Convert to a dictionary
instance_dict = instance.to_dict()

# Convert back to JSON
instance_json = instance.to_json()

You can move RespWithdrawalDelay instances between different formats using these methods:

• from_json(json_string): Creates an instance from a JSON-formatted string.
• to_json(): Returns the JSON string representation of the object.
• to_dict(): Converts the object into a standard Python dictionary.
• from_dict(dictionary): Creates an instance from a Python dictionary.

from lighter.models.resp_withdrawal_delay import RespWithdrawalDelay

# Example workflow
json_str = '{"seconds": 60}'

# 1. JSON -> Object
obj = RespWithdrawalDelay.from_json(json_str)

# 2. Object -> JSON
print(obj.to_json())

# 3. Object -> Dict
obj_dict = obj.to_dict()

# 4. Dict -> Object
new_obj = RespWithdrawalDelay.from_dict(obj_dict)

The SlippageResult model represents slippage data for a specific market and exchange. It can be instantiated from JSON strings or dictionaries and supports conversion back to both formats.

from lighter.models.slippage_result import SlippageResult

# Create an instance from a JSON string
json_data = '{"exchange": "example", "market": "BTC-USD", "size_usd": 1000, "avg_slippage": 0.01, "data_count": 10}'
slippage_result_instance = SlippageResult.from_json(json_data)

# Convert to a dictionary
slippage_dict = slippage_result_instance.to_dict()

# Convert back to JSON
json_output = slippage_result_instance.to_json()

The SharePrice model represents a snapshot of a share price at a specific point in time. It contains two primary properties:

• timestamp (int): The time associated with the price.
• share_price (float): The value of the share.

You can instantiate SharePrice from JSON strings or dictionaries, and convert instances back into JSON or dictionaries for serialization.

from lighter.models.share_price import SharePrice

# Example: Creating from JSON and converting to dict
json_data = '{"timestamp": 1672531200, "share_price": 150.5}'
share_price_instance = SharePrice.from_json(json_data)

share_price_dict = share_price_instance.to_dict()
print(share_price_dict)

The DetailedAccounts model represents a paginated collection of detailed account information. It includes status information (code, message), the total count of accounts, a list of accounts (of type DetailedAccount), and a next_cursor for pagination.

Properties

The RespListRFQs model represents a list of Request for Quotation (RFQ) entries returned by the API. It includes a status code, an optional message, a list of RFQEntry objects, and an optional next_cursor for pagination.

Properties

The AccountMetadatas model is a container for a list of AccountMetadata objects, typically used for paginated responses. It includes properties for the response status (code, message), the list of metadata items (account_metadatas), and a pagination cursor (next_cursor).

Properties

The LiquidationInfos model is used to represent liquidation information, typically returned from API responses. It contains a list of Liquidation objects and pagination metadata.

Properties