mzoe/ritmex-bot
1
0
Fork 0
mirror of https://github.com/discountry/ritmex-bot.git synced 2026-09-09 16:28:06 +00:00
Code Issues Packages Projects Releases Wiki Activity

refactor: restructure Lighter SDK by removing deprecated Go files and enhancing Python documentation with new examples and models

Browse Source
This commit is contained in:
discountry
2025-12-07 19:14:56 +08:00
parent 85705dd27c
commit 5f79b134f2
310 changed files with 47112 additions and 3698 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/lighter/lighter-python-main/docs/Account.md
-1
View File
@@ -12,7 +12,6 @@ Name | Type | Description | Notes
**l1_address** | **str** | |
**cancel_all_time** | **int** | |
**total_order_count** | **int** | |
**total_isolated_order_count** | **int** | |
**pending_order_count** | **int** | |
**available_balance** | **str** | |
**status** | **int** | |
docs/lighter/lighter-python-main/docs/AccountApi.md
-80
View File
@@ -14,7 +14,6 @@ Method | HTTP request | Description
[**liquidations**](AccountApi.md#liquidations) | **GET** /api/v1/liquidations | liquidations
[**pnl**](AccountApi.md#pnl) | **GET** /api/v1/pnl | pnl
[**position_funding**](AccountApi.md#position_funding) | **GET** /api/v1/positionFunding | positionFunding
[**public_pools**](AccountApi.md#public_pools) | **GET** /api/v1/publicPools | publicPools
[**public_pools_metadata**](AccountApi.md#public_pools_metadata) | **GET** /api/v1/publicPoolsMetadata | publicPoolsMetadata
@@ -770,85 +769,6 @@ No authorization required
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **public_pools**
> PublicPools public_pools(index, limit, authorization=authorization, auth=auth, filter=filter, account_index=account_index)
publicPools
Get public pools
### Example
```python
import lighter
from lighter.models.public_pools import PublicPools
from lighter.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://mainnet.zklighter.elliot.ai
# See configuration.py for a list of all supported configuration parameters.
configuration = lighter.Configuration(
host = "https://mainnet.zklighter.elliot.ai"
)
# Enter a context with an instance of the API client
async with lighter.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = lighter.AccountApi(api_client)
index = 56 # int |
limit = 56 # int |
authorization = 'authorization_example' # str | (optional)
auth = 'auth_example' # str | (optional)
filter = 'filter_example' # str | (optional)
account_index = 56 # int | (optional)
try:
# publicPools
api_response = await api_instance.public_pools(index, limit, authorization=authorization, auth=auth, filter=filter, account_index=account_index)
print("The response of AccountApi->public_pools:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling AccountApi->public_pools: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**index** | **int**| |
**limit** | **int**| |
**authorization** | **str**| | [optional]
**auth** | **str**| | [optional]
**filter** | **str**| | [optional]
**account_index** | **int**| | [optional]
### Return type
[**PublicPools**](PublicPools.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | A successful response. | - |
**400** | Bad request | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **public_pools_metadata**
> RespPublicPoolsMetadata public_pools_metadata(index, limit, authorization=authorization, auth=auth, filter=filter, account_index=account_index)
docs/lighter/lighter-python-main/docs/AccountAsset.md
+32
View File
@@ -0,0 +1,32 @@
# AccountAsset
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**symbol** | **str** | |
**asset_id** | **int** | |
**balance** | **str** | |
**locked_balance** | **str** | |
## Example
```python
from lighter.models.account_asset import AccountAsset
# TODO update the JSON string below
json = "{}"
# create an instance of AccountAsset from a JSON string
account_asset_instance = AccountAsset.from_json(json)
# print the JSON string representation of the object
print(AccountAsset.to_json())
# convert the object into a dict
account_asset_dict = account_asset_instance.to_dict()
# create an instance of AccountAsset from a dict
account_asset_from_dict = AccountAsset.from_dict(account_asset_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
docs/lighter/lighter-python-main/docs/AccountLimits.md
+2
View File
@@ -8,7 +8,9 @@ Name | Type | Description | Notes
**code** | **int** | |
**message** | **str** | | [optional]
**max_llp_percentage** | **int** | |
**max_llp_amount** | **str** | |
**user_tier** | **str** | |
**can_create_public_pool** | **bool** | |
## Example
docs/lighter/lighter-python-main/docs/Announcement.md
+1
View File
@@ -8,6 +8,7 @@ Name | Type | Description | Notes
**title** | **str** | |
**content** | **str** | |
**created_at** | **int** | |
**expired_at** | **int** | |
## Example
docs/lighter/lighter-python-main/docs/Asset.md
+37
View File
@@ -0,0 +1,37 @@
# Asset
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**asset_id** | **int** | |
**symbol** | **str** | |
**l1_decimals** | **int** | |
**decimals** | **int** | |
**min_transfer_amount** | **str** | |
**min_withdrawal_amount** | **str** | |
**margin_mode** | **str** | |
**index_price** | **str** | |
**l1_address** | **str** | |
## Example
```python
from lighter.models.asset import Asset
# TODO update the JSON string below
json = "{}"
# create an instance of Asset from a JSON string
asset_instance = Asset.from_json(json)
# print the JSON string representation of the object
print(Asset.to_json())
# convert the object into a dict
asset_dict = asset_instance.to_dict()
# create an instance of Asset from a dict
asset_from_dict = Asset.from_dict(asset_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
docs/lighter/lighter-python-main/docs/PublicPools.md → docs/lighter/lighter-python-main/docs/AssetDetails.md
+9 -10
View File
@@ -1,4 +1,4 @@
# PublicPools
# AssetDetails
## Properties
@@ -7,25 +7,24 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**code** | **int** | |
**message** | **str** | | [optional]
**total** | **int** | |
**public_pools** | [**List[PublicPool]**](PublicPool.md) | |
**asset_details** | [**List[Asset]**](Asset.md) | |
## Example
```python
from lighter.models.public_pools import PublicPools
from lighter.models.asset_details import AssetDetails
# TODO update the JSON string below
json = "{}"
# create an instance of PublicPools from a JSON string
public_pools_instance = PublicPools.from_json(json)
# create an instance of AssetDetails from a JSON string
asset_details_instance = AssetDetails.from_json(json)
# print the JSON string representation of the object
print(PublicPools.to_json())
print(AssetDetails.to_json())
# convert the object into a dict
public_pools_dict = public_pools_instance.to_dict()
# create an instance of PublicPools from a dict
public_pools_from_dict = PublicPools.from_dict(public_pools_dict)
asset_details_dict = asset_details_instance.to_dict()
# create an instance of AssetDetails from a dict
asset_details_from_dict = AssetDetails.from_dict(asset_details_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
docs/lighter/lighter-python-main/docs/Bridge.md
+43
View File
@@ -0,0 +1,43 @@
# Bridge
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **int** | |
**version** | **int** | |
**source** | **str** | |
**source_chain_id** | **str** | |
**fast_bridge_tx_hash** | **str** | |
**batch_claim_tx_hash** | **str** | |
**cctp_burn_tx_hash** | **str** | |
**amount** | **str** | |
**intent_address** | **str** | |
**status** | **str** | |
**step** | **str** | |
**description** | **str** | |
**created_at** | **int** | |
**updated_at** | **int** | |
**is_external_deposit** | **bool** | |
## Example
```python
from lighter.models.bridge import Bridge
# TODO update the JSON string below
json = "{}"
# create an instance of Bridge from a JSON string
bridge_instance = Bridge.from_json(json)
# print the JSON string representation of the object
print(Bridge.to_json())
# convert the object into a dict
bridge_dict = bridge_instance.to_dict()
# create an instance of Bridge from a dict
bridge_from_dict = Bridge.from_dict(bridge_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
docs/lighter/lighter-python-main/docs/BridgeApi.md
+140
View File
@@ -4,9 +4,149 @@ All URIs are relative to *https://mainnet.zklighter.elliot.ai*
Method | HTTP request | Description
------------- | ------------- | -------------
[**bridges**](BridgeApi.md#bridges) | **GET** /api/v1/bridges | bridges
[**bridges_is_next_bridge_fast**](BridgeApi.md#bridges_is_next_bridge_fast) | **GET** /api/v1/bridges/isNextBridgeFast | bridges_isNextBridgeFast
[**fastbridge_info**](BridgeApi.md#fastbridge_info) | **GET** /api/v1/fastbridge/info | fastbridge_info
# **bridges**
> RespGetBridgesByL1Addr bridges(l1_address)
bridges
Get bridges for given l1 address
### Example
```python
import lighter
from lighter.models.resp_get_bridges_by_l1_addr import RespGetBridgesByL1Addr
from lighter.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://mainnet.zklighter.elliot.ai
# See configuration.py for a list of all supported configuration parameters.
configuration = lighter.Configuration(
host = "https://mainnet.zklighter.elliot.ai"
)
# Enter a context with an instance of the API client
async with lighter.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = lighter.BridgeApi(api_client)
l1_address = 'l1_address_example' # str |
try:
# bridges
api_response = await api_instance.bridges(l1_address)
print("The response of BridgeApi->bridges:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling BridgeApi->bridges: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**l1_address** | **str**| |
### Return type
[**RespGetBridgesByL1Addr**](RespGetBridgesByL1Addr.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | A successful response. | - |
**400** | Bad request | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **bridges_is_next_bridge_fast**
> RespGetIsNextBridgeFast bridges_is_next_bridge_fast(l1_address)
bridges_isNextBridgeFast
Get if next bridge is fast
### Example
```python
import lighter
from lighter.models.resp_get_is_next_bridge_fast import RespGetIsNextBridgeFast
from lighter.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://mainnet.zklighter.elliot.ai
# See configuration.py for a list of all supported configuration parameters.
configuration = lighter.Configuration(
host = "https://mainnet.zklighter.elliot.ai"
)
# Enter a context with an instance of the API client
async with lighter.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = lighter.BridgeApi(api_client)
l1_address = 'l1_address_example' # str |
try:
# bridges_isNextBridgeFast
api_response = await api_instance.bridges_is_next_bridge_fast(l1_address)
print("The response of BridgeApi->bridges_is_next_bridge_fast:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling BridgeApi->bridges_is_next_bridge_fast: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**l1_address** | **str**| |
### Return type
[**RespGetIsNextBridgeFast**](RespGetIsNextBridgeFast.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | A successful response. | - |
**400** | Bad request | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **fastbridge_info**
> RespGetFastBridgeInfo fastbridge_info()
docs/lighter/lighter-python-main/docs/Candlestick.md
+4
View File
@@ -10,6 +10,10 @@ Name | Type | Description | Notes
**high** | **float** | |
**low** | **float** | |
**close** | **float** | |
**open_raw** | **float** | |
**high_raw** | **float** | |
**low_raw** | **float** | |
**close_raw** | **float** | |
**volume0** | **float** | |
**volume1** | **float** | |
**last_trade_id** | **int** | |
docs/lighter/lighter-python-main/docs/DepositHistoryItem.md
+1
View File
@@ -6,6 +6,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **str** | |
**asset_id** | **int** | |
**amount** | **str** | |
**timestamp** | **int** | |
**status** | **str** | |
docs/lighter/lighter-python-main/docs/DetailedAccount.md
+1 -1
View File
@@ -12,7 +12,6 @@ Name | Type | Description | Notes
**l1_address** | **str** | |
**cancel_all_time** | **int** | |
**total_order_count** | **int** | |
**total_isolated_order_count** | **int** | |
**pending_order_count** | **int** | |
**available_balance** | **str** | |
**status** | **int** | |
@@ -23,6 +22,7 @@ Name | Type | Description | Notes
**can_invite** | **bool** | Remove After FE uses L1 meta endpoint |
**referral_points_percentage** | **str** | Remove After FE uses L1 meta endpoint |
**positions** | [**List[AccountPosition]**](AccountPosition.md) | |
**assets** | [**List[AccountAsset]**](AccountAsset.md) | |
**total_asset_value** | **str** | |
**cross_asset_value** | **str** | |
**pool_info** | [**PublicPoolInfo**](PublicPoolInfo.md) | |
docs/lighter/lighter-python-main/docs/DetailedCandlestick.md
+4
View File
@@ -10,6 +10,10 @@ Name | Type | Description | Notes
**high** | **float** | |
**low** | **float** | |
**close** | **float** | |
**open_raw** | **float** | |
**high_raw** | **float** | |
**low_raw** | **float** | |
**close_raw** | **float** | |
**volume0** | **float** | |
**volume1** | **float** | |
**last_trade_id** | **int** | |
docs/lighter/lighter-python-main/docs/EnrichedTx.md
+1
View File
@@ -22,6 +22,7 @@ Name | Type | Description | Notes
**executed_at** | **int** | |
**sequence_index** | **int** | |
**parent_hash** | **str** | |
**api_key_index** | **int** | |
**committed_at** | **int** | |
**verified_at** | **int** | |
docs/lighter/lighter-python-main/docs/MarketConfig.md
+33
View File
@@ -0,0 +1,33 @@
# MarketConfig
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**market_margin_mode** | **int** | |
**insurance_fund_account_index** | **int** | |
**liquidation_mode** | **int** | |
**force_reduce_only** | **bool** | |
**trading_hours** | **str** | |
## Example
```python
from lighter.models.market_config import MarketConfig
# TODO update the JSON string below
json = "{}"
# create an instance of MarketConfig from a JSON string
market_config_instance = MarketConfig.from_json(json)
# print the JSON string representation of the object
print(MarketConfig.to_json())
# convert the object into a dict
market_config_dict = market_config_instance.to_dict()
# create an instance of MarketConfig from a dict
market_config_from_dict = MarketConfig.from_dict(market_config_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
docs/lighter/lighter-python-main/docs/Order.md
+2
View File
@@ -36,6 +36,8 @@ Name | Type | Description | Notes
**to_cancel_order_id_0** | **str** | |
**block_height** | **int** | |
**timestamp** | **int** | |
**created_at** | **int** | |
**updated_at** | **int** | |
## Example
docs/lighter/lighter-python-main/docs/OrderApi.md
+86 -6
View File
@@ -6,6 +6,7 @@ Method | HTTP request | Description
------------- | ------------- | -------------
[**account_active_orders**](OrderApi.md#account_active_orders) | **GET** /api/v1/accountActiveOrders | accountActiveOrders
[**account_inactive_orders**](OrderApi.md#account_inactive_orders) | **GET** /api/v1/accountInactiveOrders | accountInactiveOrders
[**asset_details**](OrderApi.md#asset_details) | **GET** /api/v1/assetDetails | assetDetails
[**exchange_stats**](OrderApi.md#exchange_stats) | **GET** /api/v1/exchangeStats | exchangeStats
[**export**](OrderApi.md#export) | **GET** /api/v1/export | export
[**order_book_details**](OrderApi.md#order_book_details) | **GET** /api/v1/orderBookDetails | orderBookDetails
@@ -173,6 +174,75 @@ No authorization required
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **asset_details**
> AssetDetails asset_details(asset_id=asset_id)
assetDetails
Get asset details
### Example
```python
import lighter
from lighter.models.asset_details import AssetDetails
from lighter.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://mainnet.zklighter.elliot.ai
# See configuration.py for a list of all supported configuration parameters.
configuration = lighter.Configuration(
host = "https://mainnet.zklighter.elliot.ai"
)
# Enter a context with an instance of the API client
async with lighter.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = lighter.OrderApi(api_client)
asset_id = 0 # int | (optional) (default to 0)
try:
# assetDetails
api_response = await api_instance.asset_details(asset_id=asset_id)
print("The response of OrderApi->asset_details:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling OrderApi->asset_details: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**asset_id** | **int**| | [optional] [default to 0]
### Return type
[**AssetDetails**](AssetDetails.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | A successful response. | - |
**400** | Bad request | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **exchange_stats**
> ExchangeStats exchange_stats()
@@ -316,7 +386,7 @@ No authorization required
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **order_book_details**
> OrderBookDetails order_book_details(market_id=market_id)
> OrderBookDetails order_book_details(market_id=market_id, filter=filter)
orderBookDetails
@@ -343,10 +413,11 @@ async with lighter.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = lighter.OrderApi(api_client)
market_id = 255 # int | (optional) (default to 255)
filter = all # str | (optional) (default to all)
try:
# orderBookDetails
api_response = await api_instance.order_book_details(market_id=market_id)
api_response = await api_instance.order_book_details(market_id=market_id, filter=filter)
print("The response of OrderApi->order_book_details:\n")
pprint(api_response)
except Exception as e:
@@ -361,6 +432,7 @@ async with lighter.ApiClient(configuration) as api_client:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**market_id** | **int**| | [optional] [default to 255]
**filter** | **str**| | [optional] [default to all]
### Return type
@@ -456,7 +528,7 @@ No authorization required
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **order_books**
> OrderBooks order_books(market_id=market_id)
> OrderBooks order_books(market_id=market_id, filter=filter)
orderBooks
@@ -483,10 +555,11 @@ async with lighter.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = lighter.OrderApi(api_client)
market_id = 255 # int | (optional) (default to 255)
filter = all # str | (optional) (default to all)
try:
# orderBooks
api_response = await api_instance.order_books(market_id=market_id)
api_response = await api_instance.order_books(market_id=market_id, filter=filter)
print("The response of OrderApi->order_books:\n")
pprint(api_response)
except Exception as e:
@@ -501,6 +574,7 @@ async with lighter.ApiClient(configuration) as api_client:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**market_id** | **int**| | [optional] [default to 255]
**filter** | **str**| | [optional] [default to all]
### Return type
@@ -596,7 +670,7 @@ No authorization required
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **trades**
> Trades trades(sort_by, limit, authorization=authorization, auth=auth, market_id=market_id, account_index=account_index, order_index=order_index, sort_dir=sort_dir, cursor=cursor, var_from=var_from, ask_filter=ask_filter)
> Trades trades(sort_by, limit, authorization=authorization, auth=auth, market_id=market_id, account_index=account_index, order_index=order_index, sort_dir=sort_dir, cursor=cursor, var_from=var_from, ask_filter=ask_filter, role=role, type=type, aggregate=aggregate)
trades
@@ -633,10 +707,13 @@ async with lighter.ApiClient(configuration) as api_client:
cursor = 'cursor_example' # str | (optional)
var_from = -1 # int | (optional) (default to -1)
ask_filter = -1 # int | (optional) (default to -1)
role = all # str | (optional) (default to all)
type = all # str | (optional) (default to all)
aggregate = False # bool | (optional) (default to False)
try:
# trades
api_response = await api_instance.trades(sort_by, limit, authorization=authorization, auth=auth, market_id=market_id, account_index=account_index, order_index=order_index, sort_dir=sort_dir, cursor=cursor, var_from=var_from, ask_filter=ask_filter)
api_response = await api_instance.trades(sort_by, limit, authorization=authorization, auth=auth, market_id=market_id, account_index=account_index, order_index=order_index, sort_dir=sort_dir, cursor=cursor, var_from=var_from, ask_filter=ask_filter, role=role, type=type, aggregate=aggregate)
print("The response of OrderApi->trades:\n")
pprint(api_response)
except Exception as e:
@@ -661,6 +738,9 @@ Name | Type | Description | Notes
**cursor** | **str**| | [optional]
**var_from** | **int**| | [optional] [default to -1]
**ask_filter** | **int**| | [optional] [default to -1]
**role** | **str**| | [optional] [default to all]
**type** | **str**| | [optional] [default to all]
**aggregate** | **bool**| | [optional] [default to False]
### Return type
docs/lighter/lighter-python-main/docs/OrderBook.md
+4
View File
@@ -7,12 +7,16 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**symbol** | **str** | |
**market_id** | **int** | |
**market_type** | **str** | |
**base_asset_id** | **int** | |
**quote_asset_id** | **int** | |
**status** | **str** | |
**taker_fee** | **str** | |
**maker_fee** | **str** | |
**liquidation_fee** | **str** | |
**min_base_amount** | **str** | |
**min_quote_amount** | **str** | |
**order_quote_limit** | **str** | |
**supported_size_decimals** | **int** | |
**supported_price_decimals** | **int** | |
**supported_quote_decimals** | **int** | |
docs/lighter/lighter-python-main/docs/OrderBookDepth.md
+1
View File
@@ -10,6 +10,7 @@ Name | Type | Description | Notes
**asks** | [**List[PriceLevel]**](PriceLevel.md) | |
**bids** | [**List[PriceLevel]**](PriceLevel.md) | |
**offset** | **int** | |
**nonce** | **int** | |
## Example
docs/lighter/lighter-python-main/docs/OrderBookDetails.md
+2 -1
View File
@@ -7,7 +7,8 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**code** | **int** | |
**message** | **str** | | [optional]
**order_book_details** | [**List[OrderBookDetail]**](OrderBookDetail.md) | |
**order_book_details** | [**List[PerpsOrderBookDetail]**](PerpsOrderBookDetail.md) | |
**spot_order_book_details** | [**List[SpotOrderBookDetail]**](SpotOrderBookDetail.md) | |
## Example
docs/lighter/lighter-python-main/docs/MarketInfo.md → docs/lighter/lighter-python-main/docs/PerpsMarketStats.md
+12 -8
View File
@@ -1,14 +1,18 @@
# MarketInfo
# PerpsMarketStats
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**symbol** | **str** | |
**market_id** | **int** | |
**index_price** | **str** | |
**mark_price** | **str** | |
**open_interest** | **str** | |
**open_interest_limit** | **str** | |
**funding_clamp_small** | **str** | |
**funding_clamp_big** | **str** | |
**last_trade_price** | **str** | |
**current_funding_rate** | **str** | |
**funding_rate** | **str** | |
@@ -22,19 +26,19 @@ Name | Type | Description | Notes
## Example
```python
from lighter.models.market_info import MarketInfo
from lighter.models.perps_market_stats import PerpsMarketStats
# TODO update the JSON string below
json = "{}"
# create an instance of MarketInfo from a JSON string
market_info_instance = MarketInfo.from_json(json)
# create an instance of PerpsMarketStats from a JSON string
perps_market_stats_instance = PerpsMarketStats.from_json(json)
# print the JSON string representation of the object
print(MarketInfo.to_json())
print(PerpsMarketStats.to_json())
# convert the object into a dict
market_info_dict = market_info_instance.to_dict()
# create an instance of MarketInfo from a dict
market_info_from_dict = MarketInfo.from_dict(market_info_dict)
perps_market_stats_dict = perps_market_stats_instance.to_dict()
# create an instance of PerpsMarketStats from a dict
perps_market_stats_from_dict = PerpsMarketStats.from_dict(perps_market_stats_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
docs/lighter/lighter-python-main/docs/OrderBookDetail.md → docs/lighter/lighter-python-main/docs/PerpsOrderBookDetail.md
+13 -8
View File
@@ -1,4 +1,4 @@
# OrderBookDetail
# PerpsOrderBookDetail
## Properties
@@ -7,12 +7,16 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**symbol** | **str** | |
**market_id** | **int** | |
**market_type** | **str** | |
**base_asset_id** | **int** | |
**quote_asset_id** | **int** | |
**status** | **str** | |
**taker_fee** | **str** | |
**maker_fee** | **str** | |
**liquidation_fee** | **str** | |
**min_base_amount** | **str** | |
**min_quote_amount** | **str** | |
**order_quote_limit** | **str** | |
**supported_size_decimals** | **int** | |
**supported_price_decimals** | **int** | |
**supported_quote_decimals** | **int** | |
@@ -32,23 +36,24 @@ Name | Type | Description | Notes
**daily_price_change** | **float** | |
**open_interest** | **float** | |
**daily_chart** | **Dict[str, float]** | |
**market_config** | [**MarketConfig**](MarketConfig.md) | |
## Example
```python
from lighter.models.order_book_detail import OrderBookDetail
from lighter.models.perps_order_book_detail import PerpsOrderBookDetail
# TODO update the JSON string below
json = "{}"
# create an instance of OrderBookDetail from a JSON string
order_book_detail_instance = OrderBookDetail.from_json(json)
# create an instance of PerpsOrderBookDetail from a JSON string
perps_order_book_detail_instance = PerpsOrderBookDetail.from_json(json)
# print the JSON string representation of the object
print(OrderBookDetail.to_json())
print(PerpsOrderBookDetail.to_json())
# convert the object into a dict
order_book_detail_dict = order_book_detail_instance.to_dict()
# create an instance of OrderBookDetail from a dict
order_book_detail_from_dict = OrderBookDetail.from_dict(order_book_detail_dict)
perps_order_book_detail_dict = perps_order_book_detail_instance.to_dict()
# create an instance of PerpsOrderBookDetail from a dict
perps_order_book_detail_from_dict = PerpsOrderBookDetail.from_dict(perps_order_book_detail_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
docs/lighter/lighter-python-main/docs/PnLEntry.md
+3
View File
@@ -7,8 +7,11 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**timestamp** | **int** | |
**trade_pnl** | **float** | |
**trade_spot_pnl** | **float** | |
**inflow** | **float** | |
**outflow** | **float** | |
**spot_outflow** | **float** | |
**spot_inflow** | **float** | |
**pool_pnl** | **float** | |
**pool_inflow** | **float** | |
**pool_outflow** | **float** | |
docs/lighter/lighter-python-main/docs/PublicPool.md
-49
View File
@@ -1,49 +0,0 @@
# PublicPool
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**code** | **int** | |
**message** | **str** | | [optional]
**account_type** | **int** | |
**index** | **int** | |
**l1_address** | **str** | |
**cancel_all_time** | **int** | |
**total_order_count** | **int** | |
**total_isolated_order_count** | **int** | |
**pending_order_count** | **int** | |
**available_balance** | **str** | |
**status** | **int** | |
**collateral** | **str** | |
**account_index** | **int** | |
**name** | **str** | |
**description** | **str** | |
**can_invite** | **bool** | Remove After FE uses L1 meta endpoint |
**referral_points_percentage** | **str** | Remove After FE uses L1 meta endpoint |
**total_asset_value** | **str** | |
**cross_asset_value** | **str** | |
**pool_info** | [**PublicPoolInfo**](PublicPoolInfo.md) | |
**account_share** | [**PublicPoolShare**](PublicPoolShare.md) | | [optional]
## Example
```python
from lighter.models.public_pool import PublicPool
# TODO update the JSON string below
json = "{}"
# create an instance of PublicPool from a JSON string
public_pool_instance = PublicPool.from_json(json)
# print the JSON string representation of the object
print(PublicPool.to_json())
# convert the object into a dict
public_pool_dict = public_pool_instance.to_dict()
# create an instance of PublicPool from a dict
public_pool_from_dict = PublicPool.from_dict(public_pool_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
docs/lighter/lighter-python-main/docs/PublicPoolInfo.md
+1
View File
@@ -11,6 +11,7 @@ Name | Type | Description | Notes
**total_shares** | **int** | |
**operator_shares** | **int** | |
**annual_percentage_yield** | **float** | |
**sharpe_ratio** | **float** | |
**daily_returns** | [**List[DailyReturn]**](DailyReturn.md) | |
**share_prices** | [**List[SharePrice]**](SharePrice.md) | |
docs/lighter/lighter-python-main/docs/PublicPoolMetadata.md
+3
View File
@@ -8,10 +8,13 @@ Name | Type | Description | Notes
**code** | **int** | |
**message** | **str** | | [optional]
**account_index** | **int** | |
**created_at** | **int** | |
**master_account_index** | **int** | |
**account_type** | **int** | |
**name** | **str** | |
**l1_address** | **str** | |
**annual_percentage_yield** | **float** | |
**sharpe_ratio** | **float** | |
**status** | **int** | |
**operator_fee** | **str** | |
**total_asset_value** | **str** | |
docs/lighter/lighter-python-main/docs/ReferralApi.md
+152
View File
@@ -4,9 +4,86 @@ All URIs are relative to *https://mainnet.zklighter.elliot.ai*
Method | HTTP request | Description
------------- | ------------- | -------------
[**referral_kickback_update**](ReferralApi.md#referral_kickback_update) | **POST** /api/v1/referral/kickback/update | referral_kickback_update
[**referral_points**](ReferralApi.md#referral_points) | **GET** /api/v1/referral/points | referral_points
[**referral_update**](ReferralApi.md#referral_update) | **POST** /api/v1/referral/update | referral_update
# **referral_kickback_update**
> RespUpdateKickback referral_kickback_update(account_index, kickback_percentage, authorization=authorization, auth=auth)
referral_kickback_update
Update kickback percentage for referral rewards
### Example
```python
import lighter
from lighter.models.resp_update_kickback import RespUpdateKickback
from lighter.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://mainnet.zklighter.elliot.ai
# See configuration.py for a list of all supported configuration parameters.
configuration = lighter.Configuration(
host = "https://mainnet.zklighter.elliot.ai"
)
# Enter a context with an instance of the API client
async with lighter.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = lighter.ReferralApi(api_client)
account_index = 56 # int |
kickback_percentage = 3.4 # float |
authorization = 'authorization_example' # str | make required after integ is done (optional)
auth = 'auth_example' # str | made optional to support header auth clients (optional)
try:
# referral_kickback_update
api_response = await api_instance.referral_kickback_update(account_index, kickback_percentage, authorization=authorization, auth=auth)
print("The response of ReferralApi->referral_kickback_update:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling ReferralApi->referral_kickback_update: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**account_index** | **int**| |
**kickback_percentage** | **float**| |
**authorization** | **str**| make required after integ is done | [optional]
**auth** | **str**| made optional to support header auth clients | [optional]
### Return type
[**RespUpdateKickback**](RespUpdateKickback.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: multipart/form-data
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | A successful response. | - |
**400** | Bad request | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **referral_points**
> ReferralPoints referral_points(account_index, authorization=authorization, auth=auth)
@@ -80,3 +157,78 @@ No authorization required
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **referral_update**
> RespUpdateReferralCode referral_update(account_index, new_referral_code, authorization=authorization, auth=auth)
referral_update
Update referral code (allowed once per account)
### Example
```python
import lighter
from lighter.models.resp_update_referral_code import RespUpdateReferralCode
from lighter.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://mainnet.zklighter.elliot.ai
# See configuration.py for a list of all supported configuration parameters.
configuration = lighter.Configuration(
host = "https://mainnet.zklighter.elliot.ai"
)
# Enter a context with an instance of the API client
async with lighter.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = lighter.ReferralApi(api_client)
account_index = 56 # int |
new_referral_code = 'new_referral_code_example' # str |
authorization = 'authorization_example' # str | make required after integ is done (optional)
auth = 'auth_example' # str | made optional to support header auth clients (optional)
try:
# referral_update
api_response = await api_instance.referral_update(account_index, new_referral_code, authorization=authorization, auth=auth)
print("The response of ReferralApi->referral_update:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling ReferralApi->referral_update: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**account_index** | **int**| |
**new_referral_code** | **str**| |
**authorization** | **str**| make required after integ is done | [optional]
**auth** | **str**| made optional to support header auth clients | [optional]
### Return type
[**RespUpdateReferralCode**](RespUpdateReferralCode.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: multipart/form-data
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | A successful response. | - |
**400** | Bad request | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
docs/lighter/lighter-python-main/docs/ReferralPointEntry.md
+4 -4
View File
@@ -6,10 +6,10 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**l1_address** | **str** | |
**total_points** | **int** | |
**week_points** | **int** | |
**total_reward_points** | **int** | |
**week_reward_points** | **int** | |
**total_points** | **float** | |
**week_points** | **float** | |
**total_reward_points** | **float** | |
**week_reward_points** | **float** | |
**reward_point_multiplier** | **str** | |
## Example
docs/lighter/lighter-python-main/docs/ReferralPoints.md
+4 -4
View File
@@ -6,10 +6,10 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**referrals** | [**List[ReferralPointEntry]**](ReferralPointEntry.md) | |
**user_total_points** | **int** | |
**user_last_week_points** | **int** | |
**user_total_referral_reward_points** | **int** | |
**user_last_week_referral_reward_points** | **int** | |
**user_total_points** | **float** | |
**user_last_week_points** | **float** | |
**user_total_referral_reward_points** | **float** | |
**user_last_week_referral_reward_points** | **float** | |
**reward_point_multiplier** | **str** | |
## Example
docs/lighter/lighter-python-main/docs/ReqGetAssetDetails.md
+29
View File
@@ -0,0 +1,29 @@
# ReqGetAssetDetails
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**asset_id** | **int** | | [optional]
## Example
```python
from lighter.models.req_get_asset_details import ReqGetAssetDetails
# TODO update the JSON string below
json = "{}"
# create an instance of ReqGetAssetDetails from a JSON string
req_get_asset_details_instance = ReqGetAssetDetails.from_json(json)
# print the JSON string representation of the object
print(ReqGetAssetDetails.to_json())
# convert the object into a dict
req_get_asset_details_dict = req_get_asset_details_instance.to_dict()
# create an instance of ReqGetAssetDetails from a dict
req_get_asset_details_from_dict = ReqGetAssetDetails.from_dict(req_get_asset_details_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
docs/lighter/lighter-python-main/docs/ReqGetBridgesByL1Addr.md
+29
View File
@@ -0,0 +1,29 @@
# ReqGetBridgesByL1Addr
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**l1_address** | **str** | |
## Example
```python
from lighter.models.req_get_bridges_by_l1_addr import ReqGetBridgesByL1Addr
# TODO update the JSON string below
json = "{}"
# create an instance of ReqGetBridgesByL1Addr from a JSON string
req_get_bridges_by_l1_addr_instance = ReqGetBridgesByL1Addr.from_json(json)
# print the JSON string representation of the object
print(ReqGetBridgesByL1Addr.to_json())
# convert the object into a dict
req_get_bridges_by_l1_addr_dict = req_get_bridges_by_l1_addr_instance.to_dict()
# create an instance of ReqGetBridgesByL1Addr from a dict
req_get_bridges_by_l1_addr_from_dict = ReqGetBridgesByL1Addr.from_dict(req_get_bridges_by_l1_addr_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
docs/lighter/lighter-python-main/docs/ReqGetOrderBookDetails.md
+1
View File
@@ -6,6 +6,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**market_id** | **int** | | [optional]
**filter** | **str** | | [optional] [default to 'all']
## Example
docs/lighter/lighter-python-main/docs/ReqGetOrderBooks.md
+1
View File
@@ -6,6 +6,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**market_id** | **int** | | [optional]
**filter** | **str** | | [optional] [default to 'all']
## Example
docs/lighter/lighter-python-main/docs/ReqGetPublicPools.md
-33
View File
@@ -1,33 +0,0 @@
# ReqGetPublicPools
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**auth** | **str** | | [optional]
**filter** | **str** | | [optional]
**index** | **int** | |
**limit** | **int** | |
**account_index** | **int** | | [optional]
## Example
```python
from lighter.models.req_get_public_pools import ReqGetPublicPools
# TODO update the JSON string below
json = "{}"
# create an instance of ReqGetPublicPools from a JSON string
req_get_public_pools_instance = ReqGetPublicPools.from_json(json)
# print the JSON string representation of the object
print(ReqGetPublicPools.to_json())
# convert the object into a dict
req_get_public_pools_dict = req_get_public_pools_instance.to_dict()
# create an instance of ReqGetPublicPools from a dict
req_get_public_pools_from_dict = ReqGetPublicPools.from_dict(req_get_public_pools_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
docs/lighter/lighter-python-main/docs/ReqGetTrades.md
+3
View File
@@ -14,7 +14,10 @@ Name | Type | Description | Notes
**cursor** | **str** | | [optional]
**var_from** | **int** | | [optional] [default to -1]
**ask_filter** | **int** | | [optional]
**role** | **str** | | [optional] [default to 'all']
**type** | **str** | | [optional] [default to 'all']
**limit** | **int** | |
**aggregate** | **bool** | | [optional] [default to False]
## Example
docs/lighter/lighter-python-main/docs/RespGetBridgesByL1Addr.md
+31
View File
@@ -0,0 +1,31 @@
# RespGetBridgesByL1Addr
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**code** | **int** | |
**message** | **str** | | [optional]
**bridges** | [**List[Bridge]**](Bridge.md) | |
## Example
```python
from lighter.models.resp_get_bridges_by_l1_addr import RespGetBridgesByL1Addr
# TODO update the JSON string below
json = "{}"
# create an instance of RespGetBridgesByL1Addr from a JSON string
resp_get_bridges_by_l1_addr_instance = RespGetBridgesByL1Addr.from_json(json)
# print the JSON string representation of the object
print(RespGetBridgesByL1Addr.to_json())
# convert the object into a dict
resp_get_bridges_by_l1_addr_dict = resp_get_bridges_by_l1_addr_instance.to_dict()
# create an instance of RespGetBridgesByL1Addr from a dict
resp_get_bridges_by_l1_addr_from_dict = RespGetBridgesByL1Addr.from_dict(resp_get_bridges_by_l1_addr_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
docs/lighter/lighter-python-main/docs/RespGetIsNextBridgeFast.md
+31
View File
@@ -0,0 +1,31 @@
# RespGetIsNextBridgeFast
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**code** | **int** | |
**message** | **str** | | [optional]
**is_next_bridge_fast** | **bool** | |
## Example
```python
from lighter.models.resp_get_is_next_bridge_fast import RespGetIsNextBridgeFast
# TODO update the JSON string below
json = "{}"
# create an instance of RespGetIsNextBridgeFast from a JSON string
resp_get_is_next_bridge_fast_instance = RespGetIsNextBridgeFast.from_json(json)
# print the JSON string representation of the object
print(RespGetIsNextBridgeFast.to_json())
# convert the object into a dict
resp_get_is_next_bridge_fast_dict = resp_get_is_next_bridge_fast_instance.to_dict()
# create an instance of RespGetIsNextBridgeFast from a dict
resp_get_is_next_bridge_fast_from_dict = RespGetIsNextBridgeFast.from_dict(resp_get_is_next_bridge_fast_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
docs/lighter/lighter-python-main/docs/RespSendTx.md
+1
View File
@@ -9,6 +9,7 @@ Name | Type | Description | Notes
**message** | **str** | | [optional]
**tx_hash** | **str** | |
**predicted_execution_time_ms** | **int** | |
**volume_quota_remaining** | **int** | |
## Example
docs/lighter/lighter-python-main/docs/RespSendTxBatch.md
+1
View File
@@ -9,6 +9,7 @@ Name | Type | Description | Notes
**message** | **str** | | [optional]
**tx_hash** | **List[str]** | |
**predicted_execution_time_ms** | **int** | |
**volume_quota_remaining** | **int** | |
## Example
docs/lighter/lighter-python-main/docs/RespUpdateKickback.md
+31
View File
@@ -0,0 +1,31 @@
# RespUpdateKickback
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**code** | **int** | |
**message** | **str** | | [optional]
**success** | **bool** | |
## Example
```python
from lighter.models.resp_update_kickback import RespUpdateKickback
# TODO update the JSON string below
json = "{}"
# create an instance of RespUpdateKickback from a JSON string
resp_update_kickback_instance = RespUpdateKickback.from_json(json)
# print the JSON string representation of the object
print(RespUpdateKickback.to_json())
# convert the object into a dict
resp_update_kickback_dict = resp_update_kickback_instance.to_dict()
# create an instance of RespUpdateKickback from a dict
resp_update_kickback_from_dict = RespUpdateKickback.from_dict(resp_update_kickback_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
docs/lighter/lighter-python-main/docs/RespUpdateReferralCode.md
+31
View File
@@ -0,0 +1,31 @@
# RespUpdateReferralCode
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**code** | **int** | |
**message** | **str** | | [optional]
**success** | **bool** | |
## Example
```python
from lighter.models.resp_update_referral_code import RespUpdateReferralCode
# TODO update the JSON string below
json = "{}"
# create an instance of RespUpdateReferralCode from a JSON string
resp_update_referral_code_instance = RespUpdateReferralCode.from_json(json)
# print the JSON string representation of the object
print(RespUpdateReferralCode.to_json())
# convert the object into a dict
resp_update_referral_code_dict = resp_update_referral_code_instance.to_dict()
# create an instance of RespUpdateReferralCode from a dict
resp_update_referral_code_from_dict = RespUpdateReferralCode.from_dict(resp_update_referral_code_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
docs/lighter/lighter-python-main/docs/SpotMarketStats.md
+38
View File
@@ -0,0 +1,38 @@
# SpotMarketStats
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**symbol** | **str** | |
**market_id** | **int** | |
**index_price** | **str** | |
**mid_price** | **str** | |
**last_trade_price** | **str** | |
**daily_base_token_volume** | **float** | |
**daily_quote_token_volume** | **float** | |
**daily_price_low** | **float** | |
**daily_price_high** | **float** | |
**daily_price_change** | **float** | |
## Example
```python
from lighter.models.spot_market_stats import SpotMarketStats
# TODO update the JSON string below
json = "{}"
# create an instance of SpotMarketStats from a JSON string
spot_market_stats_instance = SpotMarketStats.from_json(json)
# print the JSON string representation of the object
print(SpotMarketStats.to_json())
# convert the object into a dict
spot_market_stats_dict = spot_market_stats_instance.to_dict()
# create an instance of SpotMarketStats from a dict
spot_market_stats_from_dict = SpotMarketStats.from_dict(spot_market_stats_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
docs/lighter/lighter-python-main/docs/SpotOrderBookDetail.md
+53
View File
@@ -0,0 +1,53 @@
# SpotOrderBookDetail
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**symbol** | **str** | |
**market_id** | **int** | |
**market_type** | **str** | |
**base_asset_id** | **int** | |
**quote_asset_id** | **int** | |
**status** | **str** | |
**taker_fee** | **str** | |
**maker_fee** | **str** | |
**liquidation_fee** | **str** | |
**min_base_amount** | **str** | |
**min_quote_amount** | **str** | |
**order_quote_limit** | **str** | |
**supported_size_decimals** | **int** | |
**supported_price_decimals** | **int** | |
**supported_quote_decimals** | **int** | |
**size_decimals** | **int** | |
**price_decimals** | **int** | |
**last_trade_price** | **float** | |
**daily_trades_count** | **int** | |
**daily_base_token_volume** | **float** | |
**daily_quote_token_volume** | **float** | |
**daily_price_low** | **float** | |
**daily_price_high** | **float** | |
**daily_price_change** | **float** | |
**daily_chart** | **Dict[str, float]** | |
## Example
```python
from lighter.models.spot_order_book_detail import SpotOrderBookDetail
# TODO update the JSON string below
json = "{}"
# create an instance of SpotOrderBookDetail from a JSON string
spot_order_book_detail_instance = SpotOrderBookDetail.from_json(json)
# print the JSON string representation of the object
print(SpotOrderBookDetail.to_json())
# convert the object into a dict
spot_order_book_detail_dict = spot_order_book_detail_instance.to_dict()
# create an instance of SpotOrderBookDetail from a dict
spot_order_book_detail_from_dict = SpotOrderBookDetail.from_dict(spot_order_book_detail_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
docs/lighter/lighter-python-main/docs/Trade.md
+2
View File
@@ -14,6 +14,8 @@ Name | Type | Description | Notes
**usd_amount** | **str** | |
**ask_id** | **int** | |
**bid_id** | **int** | |
**ask_client_id** | **int** | |
**bid_client_id** | **int** | |
**ask_account_id** | **int** | |
**bid_account_id** | **int** | |
**is_maker_ask** | **bool** | |
docs/lighter/lighter-python-main/docs/TransferHistoryItem.md
+3
View File
@@ -6,6 +6,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **str** | |
**asset_id** | **int** | |
**amount** | **str** | |
**timestamp** | **int** | |
**type** | **str** | |
@@ -13,6 +14,8 @@ Name | Type | Description | Notes
**to_l1_address** | **str** | |
**from_account_index** | **int** | |
**to_account_index** | **int** | |
**from_route** | **str** | |
**to_route** | **str** | |
**tx_hash** | **str** | |
## Example
docs/lighter/lighter-python-main/docs/Tx.md
+1
View File
@@ -20,6 +20,7 @@ Name | Type | Description | Notes
**executed_at** | **int** | |
**sequence_index** | **int** | |
**parent_hash** | **str** | |
**api_key_index** | **int** | |
## Example
docs/lighter/lighter-python-main/docs/WithdrawHistoryItem.md
+1
View File
@@ -6,6 +6,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **str** | |
**asset_id** | **int** | |
**amount** | **str** | |
**timestamp** | **int** | |
**status** | **str** | |