Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
284 changes: 232 additions & 52 deletions docs/AccountApi.md

Large diffs are not rendered by default.

19 changes: 9 additions & 10 deletions docs/IsWhitelisted.md → docs/AccountLimits.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# IsWhitelisted
# AccountLimits


## Properties
Expand All @@ -7,25 +7,24 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**code** | **int** | |
**message** | **str** | | [optional]
**whitelisted** | **bool** | |
**deposit_amount_left** | **str** | |
**max_llp_percentage** | **int** | |

## Example

```python
from lighter.models.is_whitelisted import IsWhitelisted
from lighter.models.account_limits import AccountLimits

# TODO update the JSON string below
json = "{}"
# create an instance of IsWhitelisted from a JSON string
is_whitelisted_instance = IsWhitelisted.from_json(json)
# create an instance of AccountLimits from a JSON string
account_limits_instance = AccountLimits.from_json(json)
# print the JSON string representation of the object
print(IsWhitelisted.to_json())
print(AccountLimits.to_json())

# convert the object into a dict
is_whitelisted_dict = is_whitelisted_instance.to_dict()
# create an instance of IsWhitelisted from a dict
is_whitelisted_from_dict = IsWhitelisted.from_dict(is_whitelisted_dict)
account_limits_dict = account_limits_instance.to_dict()
# create an instance of AccountLimits from a dict
account_limits_from_dict = AccountLimits.from_dict(account_limits_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)

Expand Down
9 changes: 9 additions & 0 deletions docs/AccountMarketStats.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,15 @@ Name | Type | Description | Notes
**daily_trades_count** | **int** | |
**daily_base_token_volume** | **float** | |
**daily_quote_token_volume** | **float** | |
**weekly_trades_count** | **int** | |
**weekly_base_token_volume** | **float** | |
**weekly_quote_token_volume** | **float** | |
**monthly_trades_count** | **int** | |
**monthly_base_token_volume** | **float** | |
**monthly_quote_token_volume** | **float** | |
**total_trades_count** | **int** | |
**total_base_token_volume** | **float** | |
**total_quote_token_volume** | **float** | |

## Example

Expand Down
3 changes: 3 additions & 0 deletions docs/AccountMetadata.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,11 @@

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**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 |

## Example

Expand Down
31 changes: 31 additions & 0 deletions docs/AccountMetadatas.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# AccountMetadatas


## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**code** | **int** | |
**message** | **str** | | [optional]
**account_metadatas** | [**List[AccountMetadata]**](AccountMetadata.md) | |

## Example

```python
from lighter.models.account_metadatas import AccountMetadatas

# TODO update the JSON string below
json = "{}"
# create an instance of AccountMetadatas from a JSON string
account_metadatas_instance = AccountMetadatas.from_json(json)
# print the JSON string representation of the object
print(AccountMetadatas.to_json())

# convert the object into a dict
account_metadatas_dict = account_metadatas_instance.to_dict()
# create an instance of AccountMetadatas from a dict
account_metadatas_from_dict = AccountMetadatas.from_dict(account_metadatas_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)


2 changes: 2 additions & 0 deletions docs/AccountPosition.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,14 @@ Name | Type | Description | Notes
**initial_margin_fraction** | **str** | |
**open_order_count** | **int** | |
**pending_order_count** | **int** | |
**position_tied_order_count** | **int** | |
**sign** | **int** | |
**position** | **str** | |
**avg_entry_price** | **str** | |
**position_value** | **str** | |
**unrealized_pnl** | **str** | |
**realized_pnl** | **str** | |
**total_funding_paid_out** | **str** | | [optional]

## Example

Expand Down
36 changes: 36 additions & 0 deletions docs/AccountTradeStats.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# AccountTradeStats


## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**daily_trades_count** | **int** | |
**daily_volume** | **float** | |
**weekly_trades_count** | **int** | |
**weekly_volume** | **float** | |
**monthly_trades_count** | **int** | |
**monthly_volume** | **float** | |
**total_trades_count** | **int** | |
**total_volume** | **float** | |

## Example

```python
from lighter.models.account_trade_stats import AccountTradeStats

# TODO update the JSON string below
json = "{}"
# create an instance of AccountTradeStats from a JSON string
account_trade_stats_instance = AccountTradeStats.from_json(json)
# print the JSON string representation of the object
print(AccountTradeStats.to_json())

# convert the object into a dict
account_trade_stats_dict = account_trade_stats_instance.to_dict()
# create an instance of AccountTradeStats from a dict
account_trade_stats_from_dict = AccountTradeStats.from_dict(account_trade_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)


31 changes: 31 additions & 0 deletions docs/Announcement.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# Announcement


## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**title** | **str** | |
**content** | **str** | |
**created_at** | **int** | |

## Example

```python
from lighter.models.announcement import Announcement

# TODO update the JSON string below
json = "{}"
# create an instance of Announcement from a JSON string
announcement_instance = Announcement.from_json(json)
# print the JSON string representation of the object
print(Announcement.to_json())

# convert the object into a dict
announcement_dict = announcement_instance.to_dict()
# create an instance of Announcement from a dict
announcement_from_dict = Announcement.from_dict(announcement_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)


74 changes: 74 additions & 0 deletions docs/AnnouncementApi.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
# lighter.AnnouncementApi

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

Method | HTTP request | Description
------------- | ------------- | -------------
[**announcement**](AnnouncementApi.md#announcement) | **GET** /api/v1/announcement | announcement


# **announcement**
> Announcements announcement()

announcement

Get announcement

### Example


```python
import lighter
from lighter.models.announcements import Announcements
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.AnnouncementApi(api_client)

try:
# announcement
api_response = await api_instance.announcement()
print("The response of AnnouncementApi->announcement:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling AnnouncementApi->announcement: %s\n" % e)
```



### Parameters

This endpoint does not need any parameter.

### Return type

[**Announcements**](Announcements.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)

31 changes: 31 additions & 0 deletions docs/Announcements.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# Announcements


## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**code** | **int** | |
**message** | **str** | | [optional]
**announcements** | [**List[Announcement]**](Announcement.md) | |

## Example

```python
from lighter.models.announcements import Announcements

# TODO update the JSON string below
json = "{}"
# create an instance of Announcements from a JSON string
announcements_instance = Announcements.from_json(json)
# print the JSON string representation of the object
print(Announcements.to_json())

# convert the object into a dict
announcements_dict = announcements_instance.to_dict()
# create an instance of Announcements from a dict
announcements_from_dict = Announcements.from_dict(announcements_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)


26 changes: 13 additions & 13 deletions docs/InfoApi.md → docs/BridgeApi.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,25 @@
# lighter.InfoApi
# lighter.BridgeApi

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

Method | HTTP request | Description
------------- | ------------- | -------------
[**layer2_basic_info**](InfoApi.md#layer2_basic_info) | **GET** /api/v1/layer2BasicInfo | layer2BasicInfo
[**fastbridge_info**](BridgeApi.md#fastbridge_info) | **GET** /api/v1/fastbridge/info | fastbridge_info


# **layer2_basic_info**
> Layer2BasicInfo layer2_basic_info()
# **fastbridge_info**
> RespGetFastBridgeInfo fastbridge_info()

layer2BasicInfo
fastbridge_info

Get zklighter general info, including contract address, and count of transactions and active users
Get fast bridge info

### Example


```python
import lighter
from lighter.models.layer2_basic_info import Layer2BasicInfo
from lighter.models.resp_get_fast_bridge_info import RespGetFastBridgeInfo
from lighter.rest import ApiException
from pprint import pprint

Expand All @@ -33,15 +33,15 @@ configuration = lighter.Configuration(
# 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.InfoApi(api_client)
api_instance = lighter.BridgeApi(api_client)

try:
# layer2BasicInfo
api_response = await api_instance.layer2_basic_info()
print("The response of InfoApi->layer2_basic_info:\n")
# fastbridge_info
api_response = await api_instance.fastbridge_info()
print("The response of BridgeApi->fastbridge_info:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling InfoApi->layer2_basic_info: %s\n" % e)
print("Exception when calling BridgeApi->fastbridge_info: %s\n" % e)
```


Expand All @@ -52,7 +52,7 @@ This endpoint does not need any parameter.

### Return type

[**Layer2BasicInfo**](Layer2BasicInfo.md)
[**RespGetFastBridgeInfo**](RespGetFastBridgeInfo.md)

### Authorization

Expand Down
21 changes: 10 additions & 11 deletions docs/FeeBucket.md → docs/DailyReturn.md
Original file line number Diff line number Diff line change
@@ -1,30 +1,29 @@
# FeeBucket
# DailyReturn


## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**vip_tier** | **int** | |
**taker_fee** | **int** | |
**maker_fee** | **int** | |
**timestamp** | **int** | |
**daily_return** | **float** | |

## Example

```python
from lighter.models.fee_bucket import FeeBucket
from lighter.models.daily_return import DailyReturn

# TODO update the JSON string below
json = "{}"
# create an instance of FeeBucket from a JSON string
fee_bucket_instance = FeeBucket.from_json(json)
# create an instance of DailyReturn from a JSON string
daily_return_instance = DailyReturn.from_json(json)
# print the JSON string representation of the object
print(FeeBucket.to_json())
print(DailyReturn.to_json())

# convert the object into a dict
fee_bucket_dict = fee_bucket_instance.to_dict()
# create an instance of FeeBucket from a dict
fee_bucket_from_dict = FeeBucket.from_dict(fee_bucket_dict)
daily_return_dict = daily_return_instance.to_dict()
# create an instance of DailyReturn from a dict
daily_return_from_dict = DailyReturn.from_dict(daily_return_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)

Expand Down
Loading