Skip to content

Commit c48042d

Browse files
author
gate
committed
update to v7.2.144
1 parent cd2cac4 commit c48042d

86 files changed

Lines changed: 2817 additions & 361 deletions

File tree

Some content is hidden

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

‎README.md‎

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@ APIv4 provides operations related to spot, margin, and contract trading, includi
44

55
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
66

7-
- API version: v4.106.132
8-
- Package version: 7.2.132
7+
- API version: v4.106.144
8+
- Package version: 7.2.144
99
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
1010
For more information, please visit [https://www.gate.com/page/contacts](https://www.gate.com/page/contacts)
1111

@@ -282,6 +282,7 @@ Class | Method | HTTP request | Description
282282
*AlphaApi* | [**list_alpha_currencies**](docs/AlphaApi.md#list_alpha_currencies) | **GET** /alpha/currencies | Query currency information
283283
*AlphaApi* | [**list_alpha_tickers**](docs/AlphaApi.md#list_alpha_tickers) | **GET** /alpha/tickers | Query currency ticker
284284
*AlphaApi* | [**list_alpha_tokens**](docs/AlphaApi.md#list_alpha_tokens) | **GET** /alpha/tokens | Query Token Information
285+
*AnnouncementApi* | [**list_announcement_articles**](docs/AnnouncementApi.md#list_announcement_articles) | **POST** /ann/list_article | List announcement articles
285286
*AssetswapApi* | [**list_asset_swap_assets**](docs/AssetswapApi.md#list_asset_swap_assets) | **GET** /asset-swap/asset/list | Portfolio optimization — currency list
286287
*AssetswapApi* | [**get_asset_swap_config**](docs/AssetswapApi.md#get_asset_swap_config) | **GET** /asset-swap/config | Portfolio optimization — configuration
287288
*AssetswapApi* | [**evaluate_asset_swap**](docs/AssetswapApi.md#evaluate_asset_swap) | **GET** /asset-swap/evaluate | Portfolio optimization — valuation
@@ -633,6 +634,11 @@ Class | Method | HTTP request | Description
633634
- [AlphaCurrency](docs/AlphaCurrency.md)
634635
- [AlphaTicker](docs/AlphaTicker.md)
635636
- [AmendOptionsOrderRequest](docs/AmendOptionsOrderRequest.md)
637+
- [AnnouncementArticle](docs/AnnouncementArticle.md)
638+
- [AnnouncementArticleLanguage](docs/AnnouncementArticleLanguage.md)
639+
- [AnnouncementArticleListData](docs/AnnouncementArticleListData.md)
640+
- [AnnouncementArticleListRequest](docs/AnnouncementArticleListRequest.md)
641+
- [AnnouncementArticleListResponse](docs/AnnouncementArticleListResponse.md)
636642
- [ApiResponseAssetSwapConfig](docs/ApiResponseAssetSwapConfig.md)
637643
- [ApiResponseAssetSwapEvaluate](docs/ApiResponseAssetSwapEvaluate.md)
638644
- [ApiResponseAssetSwapListAssets](docs/ApiResponseAssetSwapListAssets.md)

‎docs/AccountKeyInfoPerms.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
## Properties
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
6-
**name** | **str** | Permission function name (no value will be cleared) - `wallet`: wallet - `spot`: spot/margin - `futures`: perpetual contract - `delivery`: delivery contract - `earn`: earn - `custody`: custody - `options`: options - `account`: account information - `loan`: lending - `margin`: margin - `unified`: unified account - `copy`: copy trading- `pilot`: pilot - `otc`: otc - `alpha`: alpha - `crossx`: cross-exchange | [optional]
6+
**name** | **str** | Permission function name (cleared if no value is provided) - `wallet`: wallet - `spot`: spot/margin - `futures`: perpetual contract - `delivery`: delivery contract - `earn`: earn - `custody`: custody - `options`: options - `account`: account information - `loan`: lending - `margin`: margin - `unified`: unified account - `copy`: copy trading - `pilot`: pilot - `otc`: otc - `alpha`: alpha - `crossx`: cross-exchange - `tradfi_spot`: stocks - `cfd`: CFD - `cfd_copy`: CFD lead trading - `stock_copy`: stock lead trading - `sub_accounts`: sub-accounts | [optional]
77
**read_only** | **bool** | Read Only | [optional]
88

99
[[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/AnnouncementApi.md‎

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
# gate_api.AnnouncementApi
2+
3+
All URIs are relative to *https://api.gateio.ws/api/v4*
4+
5+
Method | HTTP request | Description
6+
------------- | ------------- | -------------
7+
[**list_announcement_articles**](AnnouncementApi.md#list_announcement_articles) | **POST** /ann/list_article | List announcement articles
8+
9+
10+
# **list_announcement_articles**
11+
> AnnouncementArticleListResponse list_announcement_articles(announcement_article_list_request)
12+
13+
List announcement articles
14+
15+
Query announcement articles with pagination and filters for title, category, language, time, and other criteria. Send query parameters in the JSON request body. Both page and size are optional and must be strings when provided. No API key is required.
16+
17+
### Example
18+
19+
```python
20+
from __future__ import print_function
21+
import gate_api
22+
from gate_api.exceptions import ApiException, GateApiException
23+
# Defining the host is optional and defaults to https://api.gateio.ws/api/v4
24+
# See configuration.py for a list of all supported configuration parameters.
25+
configuration = gate_api.Configuration(
26+
host = "https://api.gateio.ws/api/v4"
27+
)
28+
29+
api_client = gate_api.ApiClient(configuration)
30+
# Create an instance of the API class
31+
api_instance = gate_api.AnnouncementApi(api_client)
32+
announcement_article_list_request = gate_api.AnnouncementArticleListRequest() # AnnouncementArticleListRequest |
33+
34+
try:
35+
# List announcement articles
36+
api_response = api_instance.list_announcement_articles(announcement_article_list_request)
37+
print(api_response)
38+
except GateApiException as ex:
39+
print("Gate api exception, label: %s, message: %s\n" % (ex.label, ex.message))
40+
except ApiException as e:
41+
print("Exception when calling AnnouncementApi->list_announcement_articles: %s\n" % e)
42+
```
43+
44+
### Parameters
45+
46+
Name | Type | Description | Notes
47+
------------- | ------------- | ------------- | -------------
48+
**announcement_article_list_request** | [**AnnouncementArticleListRequest**](AnnouncementArticleListRequest.md)| |
49+
50+
### Return type
51+
52+
[**AnnouncementArticleListResponse**](AnnouncementArticleListResponse.md)
53+
54+
### Authorization
55+
56+
No authorization required
57+
58+
### HTTP request headers
59+
60+
- **Content-Type**: application/json
61+
- **Accept**: application/json
62+
63+
### HTTP response details
64+
| Status code | Description | Response headers |
65+
|-------------|-------------|------------------|
66+
**200** | Announcement article list response | - |
67+
68+
[[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)
69+

‎docs/AnnouncementArticle.md‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# AnnouncementArticle
2+
3+
Announcement article
4+
## Properties
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**id** | **int** | Announcement article ID. |
8+
**title** | **str** | Article title |
9+
**brief** | **str** | Article summary |
10+
**created** | **str** | Article creation time, returned as a string. |
11+
**updated** | **str** | Article update time, returned as a string. |
12+
**release_time** | **str** | Article publication time, returned as a string. |
13+
**views** | **int** | View count |
14+
**author** | **str** | Author |
15+
**author_id** | **int** | Article author ID. |
16+
**tags** | **str** | Article tags |
17+
**cate** | **str** | Category to which the article belongs. |
18+
**is_top** | **int** | Pinned status indicator for the article. |
19+
**cate_id** | **int** | ID of the category to which the article belongs. |
20+
**source** | **str** | Article source |
21+
**content_lang_list** | [**list[AnnouncementArticleLanguage]**](AnnouncementArticleLanguage.md) | Languages supported by the article, with the code and name of each language. |
22+
23+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
24+
25+
Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# AnnouncementArticleLanguage
2+
3+
Announcement article language
4+
## Properties
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**code** | **str** | Language code, for example \"cn\". |
8+
**name** | **str** | Language name |
9+
10+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
11+
12+
Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# AnnouncementArticleListData
2+
3+
Announcement articles and total count
4+
## Properties
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**list** | [**list[AnnouncementArticle]**](AnnouncementArticle.md) | Announcement article list |
8+
**total** | **int** | Total number of announcement articles. |
9+
10+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
11+
12+
Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# AnnouncementArticleListRequest
2+
3+
Announcement article list query
4+
## Properties
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**title_query** | **str** | Article title to use when querying announcements. | [optional]
8+
**page** | **str** | Page number. Optional. Pass as a string, for example \"1\". | [optional]
9+
**size** | **str** | Number of articles to return per page. Optional. Pass as a string, for example \"5\". | [optional]
10+
**tags** | **str** | Article tags | [optional]
11+
**timer** | **str** | Query announcements from the last N days, with N passed as a string. For example, on the 10th, pass \"10\" to query announcements from the 1st through the 10th. | [optional]
12+
**cate_name** | **str** | Announcement category name. | [optional]
13+
**cate_level** | **str** | Category level, passed as a string: \"1\" or \"2\". | [optional]
14+
**sub_website_id** | **str** | Subsite ID, passed as a string: \"0\" for the main site or \"177\" for the Turkey site. Defaults to \"0\". | [optional] [default to '0']
15+
**pinned** | **int** | Whether to include pinned articles: 1 to include them or 0 to exclude them. Defaults to 1. | [optional] [default to 1]
16+
**update_after** | **int** | Query announcement articles updated after this timestamp. | [optional]
17+
**lang** | **str** | Language code, for example \"cn\". | [optional]
18+
**filter_empty_content** | **int** | Whether to exclude articles with empty content in the current language: 0 to keep them or 1 to exclude them. Defaults to 1. | [optional] [default to 1]
19+
20+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
21+
22+
Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# AnnouncementArticleListResponse
2+
3+
Announcement article list response
4+
## Properties
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**code** | **int** | Business status code |
8+
**data** | [**AnnouncementArticleListData**](AnnouncementArticleListData.md) | |
9+
**message** | **str** | Response message |
10+
**version** | **str** | Response version |
11+
12+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
13+
14+

‎docs/CFDApi.md‎

Lines changed: 22 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -153,14 +153,23 @@ Query symbol commission rates
153153

154154
### Example
155155

156+
* Api Key Authentication (apiv4):
156157
```python
157158
from __future__ import print_function
158159
import gate_api
159160
from gate_api.exceptions import ApiException, GateApiException
160161
# Defining the host is optional and defaults to https://api.gateio.ws/api/v4
161162
# See configuration.py for a list of all supported configuration parameters.
163+
# The client must configure the authentication and authorization parameters
164+
# in accordance with the API server security policy.
165+
# Examples for each auth method are provided below, use the example that
166+
# satisfies your auth use case.
167+
168+
# Configure APIv4 key authorization
162169
configuration = gate_api.Configuration(
163-
host = "https://api.gateio.ws/api/v4"
170+
host = "https://api.gateio.ws/api/v4",
171+
key = "YOU_API_KEY",
172+
secret = "YOUR_API_SECRET"
164173
)
165174

166175
api_client = gate_api.ApiClient(configuration)
@@ -192,7 +201,7 @@ Name | Type | Description | Notes
192201

193202
### Authorization
194203

195-
No authorization required
204+
[apiv4](../README.md#apiv4)
196205

197206
### HTTP request headers
198207

@@ -269,14 +278,23 @@ Query trading symbol details
269278

270279
### Example
271280

281+
* Api Key Authentication (apiv4):
272282
```python
273283
from __future__ import print_function
274284
import gate_api
275285
from gate_api.exceptions import ApiException, GateApiException
276286
# Defining the host is optional and defaults to https://api.gateio.ws/api/v4
277287
# See configuration.py for a list of all supported configuration parameters.
288+
# The client must configure the authentication and authorization parameters
289+
# in accordance with the API server security policy.
290+
# Examples for each auth method are provided below, use the example that
291+
# satisfies your auth use case.
292+
293+
# Configure APIv4 key authorization
278294
configuration = gate_api.Configuration(
279-
host = "https://api.gateio.ws/api/v4"
295+
host = "https://api.gateio.ws/api/v4",
296+
key = "YOU_API_KEY",
297+
secret = "YOUR_API_SECRET"
280298
)
281299

282300
api_client = gate_api.ApiClient(configuration)
@@ -306,7 +324,7 @@ Name | Type | Description | Notes
306324

307325
### Authorization
308326

309-
No authorization required
327+
[apiv4](../README.md#apiv4)
310328

311329
### HTTP request headers
312330

‎docs/CreateOrder2Data.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Order result
44
## Properties
55
Name | Type | Description | Notes
66
------------ | ------------- | ------------- | -------------
7-
**id** | **str** | Queue Task ID (not task ID) | [optional]
7+
**id** | **str** | Queue Task ID (not order ID) | [optional]
88

99
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
1010

0 commit comments

Comments
 (0)