Skip to content

Commit 8b3d5f5

Browse files
lavrriclavrric
authored
Merge pull request #13 from elliottech/update-info-endpoints-5-june
update-info-endpoints-5-june
2 parents e85ea20 + cfecf84 commit 8b3d5f5

File tree

150 files changed

+11875
-1824
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

150 files changed

+11875
-1824
lines changed

‎docs/AccountApi.md‎

Lines changed: 232 additions & 52 deletions
Large diffs are not rendered by default.

docs/IsWhitelisted.md renamed to docs/AccountLimits.md

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# IsWhitelisted
1+
# AccountLimits
22

33

44
## Properties
@@ -7,25 +7,24 @@ Name | Type | Description | Notes
77
------------ | ------------- | ------------- | -------------
88
**code** | **int** | |
99
**message** | **str** | | [optional]
10-
**whitelisted** | **bool** | |
11-
**deposit_amount_left** | **str** | |
10+
**max_llp_percentage** | **int** | |
1211

1312
## Example
1413

1514
```python
16-
from lighter.models.is_whitelisted import IsWhitelisted
15+
from lighter.models.account_limits import AccountLimits
1716

1817
# TODO update the JSON string below
1918
json = "{}"
20-
# create an instance of IsWhitelisted from a JSON string
21-
is_whitelisted_instance = IsWhitelisted.from_json(json)
19+
# create an instance of AccountLimits from a JSON string
20+
account_limits_instance = AccountLimits.from_json(json)
2221
# print the JSON string representation of the object
23-
print(IsWhitelisted.to_json())
22+
print(AccountLimits.to_json())
2423

2524
# convert the object into a dict
26-
is_whitelisted_dict = is_whitelisted_instance.to_dict()
27-
# create an instance of IsWhitelisted from a dict
28-
is_whitelisted_from_dict = IsWhitelisted.from_dict(is_whitelisted_dict)
25+
account_limits_dict = account_limits_instance.to_dict()
26+
# create an instance of AccountLimits from a dict
27+
account_limits_from_dict = AccountLimits.from_dict(account_limits_dict)
2928
```
3029
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
3130

‎docs/AccountMarketStats.md‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,15 @@ Name | Type | Description | Notes
99
**daily_trades_count** | **int** | |
1010
**daily_base_token_volume** | **float** | |
1111
**daily_quote_token_volume** | **float** | |
12+
**weekly_trades_count** | **int** | |
13+
**weekly_base_token_volume** | **float** | |
14+
**weekly_quote_token_volume** | **float** | |
15+
**monthly_trades_count** | **int** | |
16+
**monthly_base_token_volume** | **float** | |
17+
**monthly_quote_token_volume** | **float** | |
18+
**total_trades_count** | **int** | |
19+
**total_base_token_volume** | **float** | |
20+
**total_quote_token_volume** | **float** | |
1221

1322
## Example
1423

‎docs/AccountMetadata.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,11 @@
55

66
Name | Type | Description | Notes
77
------------ | ------------- | ------------- | -------------
8+
**account_index** | **int** | |
89
**name** | **str** | |
910
**description** | **str** | |
11+
**can_invite** | **bool** | Remove After FE uses L1 meta endpoint |
12+
**referral_points_percentage** | **str** | Remove After FE uses L1 meta endpoint |
1013

1114
## Example
1215

‎docs/AccountMetadatas.md‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# AccountMetadatas
2+
3+
4+
## Properties
5+
6+
Name | Type | Description | Notes
7+
------------ | ------------- | ------------- | -------------
8+
**code** | **int** | |
9+
**message** | **str** | | [optional]
10+
**account_metadatas** | [**List[AccountMetadata]**](AccountMetadata.md) | |
11+
12+
## Example
13+
14+
```python
15+
from lighter.models.account_metadatas import AccountMetadatas
16+
17+
# TODO update the JSON string below
18+
json = "{}"
19+
# create an instance of AccountMetadatas from a JSON string
20+
account_metadatas_instance = AccountMetadatas.from_json(json)
21+
# print the JSON string representation of the object
22+
print(AccountMetadatas.to_json())
23+
24+
# convert the object into a dict
25+
account_metadatas_dict = account_metadatas_instance.to_dict()
26+
# create an instance of AccountMetadatas from a dict
27+
account_metadatas_from_dict = AccountMetadatas.from_dict(account_metadatas_dict)
28+
```
29+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
30+
31+

‎docs/AccountPosition.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,14 @@ Name | Type | Description | Notes
1010
**initial_margin_fraction** | **str** | |
1111
**open_order_count** | **int** | |
1212
**pending_order_count** | **int** | |
13+
**position_tied_order_count** | **int** | |
1314
**sign** | **int** | |
1415
**position** | **str** | |
1516
**avg_entry_price** | **str** | |
1617
**position_value** | **str** | |
1718
**unrealized_pnl** | **str** | |
1819
**realized_pnl** | **str** | |
20+
**total_funding_paid_out** | **str** | | [optional]
1921

2022
## Example
2123

‎docs/AccountTradeStats.md‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# AccountTradeStats
2+
3+
4+
## Properties
5+
6+
Name | Type | Description | Notes
7+
------------ | ------------- | ------------- | -------------
8+
**daily_trades_count** | **int** | |
9+
**daily_volume** | **float** | |
10+
**weekly_trades_count** | **int** | |
11+
**weekly_volume** | **float** | |
12+
**monthly_trades_count** | **int** | |
13+
**monthly_volume** | **float** | |
14+
**total_trades_count** | **int** | |
15+
**total_volume** | **float** | |
16+
17+
## Example
18+
19+
```python
20+
from lighter.models.account_trade_stats import AccountTradeStats
21+
22+
# TODO update the JSON string below
23+
json = "{}"
24+
# create an instance of AccountTradeStats from a JSON string
25+
account_trade_stats_instance = AccountTradeStats.from_json(json)
26+
# print the JSON string representation of the object
27+
print(AccountTradeStats.to_json())
28+
29+
# convert the object into a dict
30+
account_trade_stats_dict = account_trade_stats_instance.to_dict()
31+
# create an instance of AccountTradeStats from a dict
32+
account_trade_stats_from_dict = AccountTradeStats.from_dict(account_trade_stats_dict)
33+
```
34+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
35+
36+

‎docs/Announcement.md‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# Announcement
2+
3+
4+
## Properties
5+
6+
Name | Type | Description | Notes
7+
------------ | ------------- | ------------- | -------------
8+
**title** | **str** | |
9+
**content** | **str** | |
10+
**created_at** | **int** | |
11+
12+
## Example
13+
14+
```python
15+
from lighter.models.announcement import Announcement
16+
17+
# TODO update the JSON string below
18+
json = "{}"
19+
# create an instance of Announcement from a JSON string
20+
announcement_instance = Announcement.from_json(json)
21+
# print the JSON string representation of the object
22+
print(Announcement.to_json())
23+
24+
# convert the object into a dict
25+
announcement_dict = announcement_instance.to_dict()
26+
# create an instance of Announcement from a dict
27+
announcement_from_dict = Announcement.from_dict(announcement_dict)
28+
```
29+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
30+
31+

‎docs/AnnouncementApi.md‎

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
# lighter.AnnouncementApi
2+
3+
All URIs are relative to *https://mainnet.zklighter.elliot.ai*
4+
5+
Method | HTTP request | Description
6+
------------- | ------------- | -------------
7+
[**announcement**](AnnouncementApi.md#announcement) | **GET** /api/v1/announcement | announcement
8+
9+
10+
# **announcement**
11+
> Announcements announcement()
12+
13+
announcement
14+
15+
Get announcement
16+
17+
### Example
18+
19+
20+
```python
21+
import lighter
22+
from lighter.models.announcements import Announcements
23+
from lighter.rest import ApiException
24+
from pprint import pprint
25+
26+
# Defining the host is optional and defaults to https://mainnet.zklighter.elliot.ai
27+
# See configuration.py for a list of all supported configuration parameters.
28+
configuration = lighter.Configuration(
29+
host = "https://mainnet.zklighter.elliot.ai"
30+
)
31+
32+
33+
# Enter a context with an instance of the API client
34+
async with lighter.ApiClient(configuration) as api_client:
35+
# Create an instance of the API class
36+
api_instance = lighter.AnnouncementApi(api_client)
37+
38+
try:
39+
# announcement
40+
api_response = await api_instance.announcement()
41+
print("The response of AnnouncementApi->announcement:\n")
42+
pprint(api_response)
43+
except Exception as e:
44+
print("Exception when calling AnnouncementApi->announcement: %s\n" % e)
45+
```
46+
47+
48+
49+
### Parameters
50+
51+
This endpoint does not need any parameter.
52+
53+
### Return type
54+
55+
[**Announcements**](Announcements.md)
56+
57+
### Authorization
58+
59+
No authorization required
60+
61+
### HTTP request headers
62+
63+
- **Content-Type**: Not defined
64+
- **Accept**: application/json
65+
66+
### HTTP response details
67+
68+
| Status code | Description | Response headers |
69+
|-------------|-------------|------------------|
70+
**200** | A successful response. | - |
71+
**400** | Bad request | - |
72+
73+
[[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)
74+

‎docs/Announcements.md‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# Announcements
2+
3+
4+
## Properties
5+
6+
Name | Type | Description | Notes
7+
------------ | ------------- | ------------- | -------------
8+
**code** | **int** | |
9+
**message** | **str** | | [optional]
10+
**announcements** | [**List[Announcement]**](Announcement.md) | |
11+
12+
## Example
13+
14+
```python
15+
from lighter.models.announcements import Announcements
16+
17+
# TODO update the JSON string below
18+
json = "{}"
19+
# create an instance of Announcements from a JSON string
20+
announcements_instance = Announcements.from_json(json)
21+
# print the JSON string representation of the object
22+
print(Announcements.to_json())
23+
24+
# convert the object into a dict
25+
announcements_dict = announcements_instance.to_dict()
26+
# create an instance of Announcements from a dict
27+
announcements_from_dict = Announcements.from_dict(announcements_dict)
28+
```
29+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
30+
31+

0 commit comments

Comments
 (0)