Skip to content

Commit df22b58

Browse files
revilwangrevilwang
committed
rename gate_client to gate_api 
1 parent 570185e commit df22b58

30 files changed

Lines changed: 164 additions & 160 deletions

‎README.md‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git
2525

2626
Then import the package:
2727
```python
28-
import gate_client
28+
import gate_api
2929
```
3030

3131
### Setuptools
@@ -39,7 +39,7 @@ python setup.py install --user
3939

4040
Then import the package:
4141
```python
42-
import gate_client
42+
import gate_api
4343
```
4444

4545
## Getting Started
@@ -48,21 +48,21 @@ Please follow the [installation procedure](#installation--usage) and then run th
4848

4949
```python
5050
from __future__ import print_function
51-
import gate_client
52-
from gate_client.rest import ApiException
51+
import gate_api
52+
from gate_api.rest import ApiException
5353

5454
# Configure API key authorization: api_key
55-
configuration = gate_client.Configuration()
55+
configuration = gate_api.Configuration()
5656
configuration.key = "YOUR_API_KEY"
5757
configuration.secret = "YOUR_API_SECRET"
5858
# uncomment the next line if you are testing the API with TestNet
5959
# configuration.host = "https://fx-api-testnet.gateio.io/api/v4"
6060

6161
# create an instance of the API class
62-
api_instance = gate_client.FuturesApi(gate_client.ApiClient(configuration))
62+
api_instance = gate_api.FuturesApi(gate_api.ApiClient(configuration))
6363

6464
try:
65-
order = gate_client.FuturesOrder(contract='BTC_USD', size=100, price="4000")
65+
order = gate_api.FuturesOrder(contract='BTC_USD', size=100, price="4000")
6666
order = api_instance.create_order(futures_order=order)
6767
print(order.id)
6868
except ApiException as e:

‎docs/FuturesApi.md‎

Lines changed: 66 additions & 66 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# gate_client.FuturesApi
1+
# gate_api.FuturesApi
22

33
All URIs are relative to *https://fx-api.gateio.io/api/v4*
44

@@ -33,16 +33,16 @@ Cancel a single order
3333

3434
```python
3535
from __future__ import print_function
36-
import gate_client
37-
from gate_client.rest import ApiException
36+
import gate_api
37+
from gate_api.rest import ApiException
3838

3939
# Configure API key authorization: api_key
40-
configuration = gate_client.Configuration()
40+
configuration = gate_api.Configuration()
4141
configuration.key = "YOUR_API_KEY"
4242
configuration.secret = "YOUR_API_SECRET"
4343

4444
# create an instance of the API class
45-
api_instance = gate_client.FuturesApi(gate_client.ApiClient(configuration))
45+
api_instance = gate_api.FuturesApi(gate_api.ApiClient(configuration))
4646
order_id = 'order_id_example' # str | order id
4747

4848
try:
@@ -78,16 +78,16 @@ Cancel all `open` orders matched
7878

7979
```python
8080
from __future__ import print_function
81-
import gate_client
82-
from gate_client.rest import ApiException
81+
import gate_api
82+
from gate_api.rest import ApiException
8383

8484
# Configure API key authorization: api_key
85-
configuration = gate_client.Configuration()
85+
configuration = gate_api.Configuration()
8686
configuration.key = "YOUR_API_KEY"
8787
configuration.secret = "YOUR_API_SECRET"
8888

8989
# create an instance of the API class
90-
api_instance = gate_client.FuturesApi(gate_client.ApiClient(configuration))
90+
api_instance = gate_api.FuturesApi(gate_api.ApiClient(configuration))
9191
contract = 'contract_example' # str | futures contract
9292
side = 'side_example' # str | All bids or asks. Both included in not specfied (optional)
9393

@@ -125,16 +125,16 @@ Create a futures order
125125

126126
```python
127127
from __future__ import print_function
128-
import gate_client
129-
from gate_client.rest import ApiException
128+
import gate_api
129+
from gate_api.rest import ApiException
130130

131131
# Configure API key authorization: api_key
132-
configuration = gate_client.Configuration()
132+
configuration = gate_api.Configuration()
133133
configuration.key = "YOUR_API_KEY"
134134
configuration.secret = "YOUR_API_SECRET"
135135

136136
# create an instance of the API class
137-
api_instance = gate_client.FuturesApi(gate_client.ApiClient(configuration))
137+
api_instance = gate_api.FuturesApi(gate_api.ApiClient(configuration))
138138
futures_order = {"$ref":"examples/mercury/FuturesOrder.json"} # FuturesOrder | (optional)
139139

140140
try:
@@ -171,16 +171,16 @@ List personal trading history
171171

172172
```python
173173
from __future__ import print_function
174-
import gate_client
175-
from gate_client.rest import ApiException
174+
import gate_api
175+
from gate_api.rest import ApiException
176176

177177
# Configure API key authorization: api_key
178-
configuration = gate_client.Configuration()
178+
configuration = gate_api.Configuration()
179179
configuration.key = "YOUR_API_KEY"
180180
configuration.secret = "YOUR_API_SECRET"
181181

182182
# create an instance of the API class
183-
api_instance = gate_client.FuturesApi(gate_client.ApiClient(configuration))
183+
api_instance = gate_api.FuturesApi(gate_api.ApiClient(configuration))
184184
contract = 'contract_example' # str | futures contract. If specified, return only data related to the contract (optional)
185185
limit = 100 # int | maximum number of data returned in one request (optional) (default to 100)
186186
last_id = 'last_id_example' # str | specify list staring record. Use the `id` in every last record of one list-query request to achieve consecutive list query (optional)
@@ -221,16 +221,16 @@ Get a single order
221221

222222
```python
223223
from __future__ import print_function
224-
import gate_client
225-
from gate_client.rest import ApiException
224+
import gate_api
225+
from gate_api.rest import ApiException
226226

227227
# Configure API key authorization: api_key
228-
configuration = gate_client.Configuration()
228+
configuration = gate_api.Configuration()
229229
configuration.key = "YOUR_API_KEY"
230230
configuration.secret = "YOUR_API_SECRET"
231231

232232
# create an instance of the API class
233-
api_instance = gate_client.FuturesApi(gate_client.ApiClient(configuration))
233+
api_instance = gate_api.FuturesApi(gate_api.ApiClient(configuration))
234234
order_id = 'order_id_example' # str | order id
235235

236236
try:
@@ -267,16 +267,16 @@ Query futures account
267267

268268
```python
269269
from __future__ import print_function
270-
import gate_client
271-
from gate_client.rest import ApiException
270+
import gate_api
271+
from gate_api.rest import ApiException
272272

273273
# Configure API key authorization: api_key
274-
configuration = gate_client.Configuration()
274+
configuration = gate_api.Configuration()
275275
configuration.key = "YOUR_API_KEY"
276276
configuration.secret = "YOUR_API_SECRET"
277277

278278
# create an instance of the API class
279-
api_instance = gate_client.FuturesApi(gate_client.ApiClient(configuration))
279+
api_instance = gate_api.FuturesApi(gate_api.ApiClient(configuration))
280280

281281
try:
282282
# Query futures account
@@ -310,11 +310,11 @@ Return specified contract candlesticks. If prefix `contract` with `mark_`, the c
310310
### Example
311311
```python
312312
from __future__ import print_function
313-
import gate_client
314-
from gate_client.rest import ApiException
313+
import gate_api
314+
from gate_api.rest import ApiException
315315

316316
# create an instance of the API class
317-
api_instance = gate_client.FuturesApi()
317+
api_instance = gate_api.FuturesApi()
318318
contract = 'contract_example' # str | futures contract
319319
_from = 1545696000 # float | Start time of candlesticks, formatted in Unix timestamp in seconds. Default to `to - 100 * interval` if not specified (optional)
320320
to = 1545955200 # float | End time of candlesticsk, formatted in Unix timestamp in seconds. Default to current time (optional)
@@ -358,11 +358,11 @@ List all futures contracts
358358
### Example
359359
```python
360360
from __future__ import print_function
361-
import gate_client
362-
from gate_client.rest import ApiException
361+
import gate_api
362+
from gate_api.rest import ApiException
363363

364364
# create an instance of the API class
365-
api_instance = gate_client.FuturesApi()
365+
api_instance = gate_api.FuturesApi()
366366

367367
try:
368368
# List all futures contracts
@@ -394,11 +394,11 @@ Funding rate history
394394
### Example
395395
```python
396396
from __future__ import print_function
397-
import gate_client
398-
from gate_client.rest import ApiException
397+
import gate_api
398+
from gate_api.rest import ApiException
399399

400400
# create an instance of the API class
401-
api_instance = gate_client.FuturesApi()
401+
api_instance = gate_api.FuturesApi()
402402
contract = 'contract_example' # str | futures contract
403403
limit = 100 # int | maximum number of data returned in one request (optional) (default to 100)
404404

@@ -436,11 +436,11 @@ Futures insurance balance history
436436
### Example
437437
```python
438438
from __future__ import print_function
439-
import gate_client
440-
from gate_client.rest import ApiException
439+
import gate_api
440+
from gate_api.rest import ApiException
441441

442442
# create an instance of the API class
443-
api_instance = gate_client.FuturesApi()
443+
api_instance = gate_api.FuturesApi()
444444
limit = 100 # int | maximum number of data returned in one request (optional) (default to 100)
445445

446446
try:
@@ -478,11 +478,11 @@ bids will be sorted by price from high to low, while asks sorted reversely
478478
### Example
479479
```python
480480
from __future__ import print_function
481-
import gate_client
482-
from gate_client.rest import ApiException
481+
import gate_api
482+
from gate_api.rest import ApiException
483483

484484
# create an instance of the API class
485-
api_instance = gate_client.FuturesApi()
485+
api_instance = gate_api.FuturesApi()
486486
contract = 'contract_example' # str | futures contract
487487
interval = '0' # str | order depth. 0 means no aggregation is applied. default to 0 (optional) (default to '0')
488488
limit = 10 # int | maximum number of order depth data in asks or bids (optional) (default to 10)
@@ -522,11 +522,11 @@ List futures tickers
522522
### Example
523523
```python
524524
from __future__ import print_function
525-
import gate_client
526-
from gate_client.rest import ApiException
525+
import gate_api
526+
from gate_api.rest import ApiException
527527

528528
# create an instance of the API class
529-
api_instance = gate_client.FuturesApi()
529+
api_instance = gate_api.FuturesApi()
530530
contract = 'contract_example' # str | futures contract. If specified, return only data related to the contract (optional)
531531

532532
try:
@@ -562,11 +562,11 @@ Futures trading history
562562
### Example
563563
```python
564564
from __future__ import print_function
565-
import gate_client
566-
from gate_client.rest import ApiException
565+
import gate_api
566+
from gate_api.rest import ApiException
567567

568568
# create an instance of the API class
569-
api_instance = gate_client.FuturesApi()
569+
api_instance = gate_api.FuturesApi()
570570
contract = 'contract_example' # str | futures contract
571571
limit = 100 # int | maximum number of data returned in one request (optional) (default to 100)
572572
last_id = 'last_id_example' # str | specify list staring record. Use the `id` in every last record of one list-query request to achieve consecutive list query (optional)
@@ -607,16 +607,16 @@ List futures orders
607607

608608
```python
609609
from __future__ import print_function
610-
import gate_client
611-
from gate_client.rest import ApiException
610+
import gate_api
611+
from gate_api.rest import ApiException
612612

613613
# Configure API key authorization: api_key
614-
configuration = gate_client.Configuration()
614+
configuration = gate_api.Configuration()
615615
configuration.key = "YOUR_API_KEY"
616616
configuration.secret = "YOUR_API_SECRET"
617617

618618
# create an instance of the API class
619-
api_instance = gate_client.FuturesApi(gate_client.ApiClient(configuration))
619+
api_instance = gate_api.FuturesApi(gate_api.ApiClient(configuration))
620620
contract = 'contract_example' # str | futures contract
621621
status = 'status_example' # str | order status
622622
limit = 100 # int | maximum number of data returned in one request (optional) (default to 100)
@@ -659,16 +659,16 @@ List all positions
659659

660660
```python
661661
from __future__ import print_function
662-
import gate_client
663-
from gate_client.rest import ApiException
662+
import gate_api
663+
from gate_api.rest import ApiException
664664

665665
# Configure API key authorization: api_key
666-
configuration = gate_client.Configuration()
666+
configuration = gate_api.Configuration()
667667
configuration.key = "YOUR_API_KEY"
668668
configuration.secret = "YOUR_API_SECRET"
669669

670670
# create an instance of the API class
671-
api_instance = gate_client.FuturesApi(gate_client.ApiClient(configuration))
671+
api_instance = gate_api.FuturesApi(gate_api.ApiClient(configuration))
672672

673673
try:
674674
# List all positions
@@ -701,16 +701,16 @@ Update position leverage
701701

702702
```python
703703
from __future__ import print_function
704-
import gate_client
705-
from gate_client.rest import ApiException
704+
import gate_api
705+
from gate_api.rest import ApiException
706706

707707
# Configure API key authorization: api_key
708-
configuration = gate_client.Configuration()
708+
configuration = gate_api.Configuration()
709709
configuration.key = "YOUR_API_KEY"
710710
configuration.secret = "YOUR_API_SECRET"
711711

712712
# create an instance of the API class
713-
api_instance = gate_client.FuturesApi(gate_client.ApiClient(configuration))
713+
api_instance = gate_api.FuturesApi(gate_api.ApiClient(configuration))
714714
contract = 'contract_example' # str | futures contract
715715
leverage = 'leverage_example' # str | new leverage of position
716716

@@ -749,16 +749,16 @@ Update position margin
749749

750750
```python
751751
from __future__ import print_function
752-
import gate_client
753-
from gate_client.rest import ApiException
752+
import gate_api
753+
from gate_api.rest import ApiException
754754

755755
# Configure API key authorization: api_key
756-
configuration = gate_client.Configuration()
756+
configuration = gate_api.Configuration()
757757
configuration.key = "YOUR_API_KEY"
758758
configuration.secret = "YOUR_API_SECRET"
759759

760760
# create an instance of the API class
761-
api_instance = gate_client.FuturesApi(gate_client.ApiClient(configuration))
761+
api_instance = gate_api.FuturesApi(gate_api.ApiClient(configuration))
762762
contract = 'contract_example' # str | futures contract
763763
change = 'change_example' # str | margin change. Use positive number to increase margin, negative number otherwise.
764764

@@ -797,16 +797,16 @@ Update poisition risk limit
797797

798798
```python
799799
from __future__ import print_function
800-
import gate_client
801-
from gate_client.rest import ApiException
800+
import gate_api
801+
from gate_api.rest import ApiException
802802

803803
# Configure API key authorization: api_key
804-
configuration = gate_client.Configuration()
804+
configuration = gate_api.Configuration()
805805
configuration.key = "YOUR_API_KEY"
806806
configuration.secret = "YOUR_API_SECRET"
807807

808808
# create an instance of the API class
809-
api_instance = gate_client.FuturesApi(gate_client.ApiClient(configuration))
809+
api_instance = gate_api.FuturesApi(gate_api.ApiClient(configuration))
810810
contract = 'contract_example' # str | futures contract
811811
risk_limit = 'risk_limit_example' # str | new risk limit of position
812812

0 commit comments

Comments
 (0)