summaryrefslogtreecommitdiff
path: root/python-ftx.spec
blob: 782b17ff94fe7000a06e14f77b654657d299d1a4 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
%global _empty_manifest_terminate_build 0
Name:		python-ftx
Version:	1.2.0
Release:	1
Summary:	Unofficial python3 FTX exchange API 1.2.0
License:	MIT
URL:		https://github.com/quan-digital/ftx/tree/v1.2
Source0:	https://mirrors.aliyun.com/pypi/web/packages/94/b7/fb1b79cd1105eacdb93565594b746907a0a019416e68494b2466ee58d7e0/ftx-1.2.0.tar.gz
BuildArch:	noarch

Requires:	python3-requests
Requires:	python3-ciso8601

%description
# FTX Python client

A Unofficial Python3 library to interact with [FTX's](https://ftx.com/) API. The library can be used to fetch market
data, make trades, place orders or create third-party clients.

For more information, see [the FTX documentation.](https://docs.ftx.com/)

## Installation

    $ pip install ftx

## Quickstart

This is an introduction on how to get started with FTX client. First, make sure the FTX library is installed.

The next thing you need to do is import the library and get an instance of the client:

    import ftx
    client = ftx.FtxClient()

### Get ordedrbook

Get the orderbook levels of bid/ask:

    >>> import ftx
    >>> client = ftx.FtxClient()
    >>> result = client.get_orderbook('BTC/USD', 1)
    >>> result
    {'asks': [[11861.0, 1.778]], 'bids': [[11860.5, 0.1]]}

    >>> result['asks']
    [[11861.0, 1.778]]

    >>> result['bids']
    [[11860.5, 0.1]]

### Market's Instrument data

The API supports fetching full data for one or multiple markets.

    >>> client.get_market('BTC/USD')
    {'ask': 11849.0, 'baseCurrency': 'BTC', 'bid': 11848.5, 'change1h': 0.00025325004220834034, 'change24h': 0.008983693106825051, 'changeBod': 0.006925855109411514, 'enabled': True, 'last': 11849.0, 'minProvideSize': 0.0001, 'name': 'BTC/USD', 'postOnly': False, 'price': 11849.0, 'priceIncrement': 0.5, 'quoteCurrency': 'USD', 'quoteVolume24h': 9271567.5201, 'restricted': False, 'sizeIncrement': 0.0001, 'type': 'spot', 'underlying': None, 'volumeUsd24h': 9271567.5201}

### Date ranges

Any time-based parameters accept Python `datetime` objects. All timestamps returned from FTX are UTC.

    >>> client = ftx.FtxClient()
    >>> client.get_trades('BTC/USD', 1, datetime.datetime(2020,8,20).timestamp())
    [{'id': 88953674, 'liquidation': False, 'price': 11861.0, 'side': 'sell', 'size': 0.0105, 'time': '2020-08-20T17:33:19.115690+00:00'}]

### Authenticated endpoints

Private endpoints require authentication. Clients authenticate with an API key. For more information,
see:[API keys](https://help.ftx.com/hc/en-us/articles/360044411911-FTX-Features-Overview#h_6a76d63d-e6cd-45db-87ab-5778af4e3b07)

To get an authenticated client instance:

    >>> client = ftx.FtxClient(api_key=<YOUR API KEY>, api_secret=<YOUR API SECRET>)

If you try to access a private endpoint with an unauthenticated client, an error is raised. Calls to private endpoints
work the same as regular ones:

    client.get_open_orders('BTC/USD')

## Advanced usage

### Placing orders

An order can be placed through the `place_order()` function. See
[the API Documentation](https://docs.ftx.com/#place-order) for required and optional parameters.

    client.place_order('BTC/USD', 'sell', 12345.0, 10)

### Modifying orders

Orders can be modified by providing the original order ID.

    >>> client.place_order('BTC/USD', 'sell', 12345.0, 10)
    {"createdAt": "2020-08-20T17:33:19.115690+00:00","filledSize": 0,"id": 9596912,"market": "BTC/USD"...

    >>> client.modify_order(9596912, 12500.0, 15).result()

### Canceling orders

An order can be canceled given the order ID:

    client.cancel_order(9596912).result()




%package -n python3-ftx
Summary:	Unofficial python3 FTX exchange API 1.2.0
Provides:	python-ftx
BuildRequires:	python3-devel
BuildRequires:	python3-setuptools
BuildRequires:	python3-pip
%description -n python3-ftx
# FTX Python client

A Unofficial Python3 library to interact with [FTX's](https://ftx.com/) API. The library can be used to fetch market
data, make trades, place orders or create third-party clients.

For more information, see [the FTX documentation.](https://docs.ftx.com/)

## Installation

    $ pip install ftx

## Quickstart

This is an introduction on how to get started with FTX client. First, make sure the FTX library is installed.

The next thing you need to do is import the library and get an instance of the client:

    import ftx
    client = ftx.FtxClient()

### Get ordedrbook

Get the orderbook levels of bid/ask:

    >>> import ftx
    >>> client = ftx.FtxClient()
    >>> result = client.get_orderbook('BTC/USD', 1)
    >>> result
    {'asks': [[11861.0, 1.778]], 'bids': [[11860.5, 0.1]]}

    >>> result['asks']
    [[11861.0, 1.778]]

    >>> result['bids']
    [[11860.5, 0.1]]

### Market's Instrument data

The API supports fetching full data for one or multiple markets.

    >>> client.get_market('BTC/USD')
    {'ask': 11849.0, 'baseCurrency': 'BTC', 'bid': 11848.5, 'change1h': 0.00025325004220834034, 'change24h': 0.008983693106825051, 'changeBod': 0.006925855109411514, 'enabled': True, 'last': 11849.0, 'minProvideSize': 0.0001, 'name': 'BTC/USD', 'postOnly': False, 'price': 11849.0, 'priceIncrement': 0.5, 'quoteCurrency': 'USD', 'quoteVolume24h': 9271567.5201, 'restricted': False, 'sizeIncrement': 0.0001, 'type': 'spot', 'underlying': None, 'volumeUsd24h': 9271567.5201}

### Date ranges

Any time-based parameters accept Python `datetime` objects. All timestamps returned from FTX are UTC.

    >>> client = ftx.FtxClient()
    >>> client.get_trades('BTC/USD', 1, datetime.datetime(2020,8,20).timestamp())
    [{'id': 88953674, 'liquidation': False, 'price': 11861.0, 'side': 'sell', 'size': 0.0105, 'time': '2020-08-20T17:33:19.115690+00:00'}]

### Authenticated endpoints

Private endpoints require authentication. Clients authenticate with an API key. For more information,
see:[API keys](https://help.ftx.com/hc/en-us/articles/360044411911-FTX-Features-Overview#h_6a76d63d-e6cd-45db-87ab-5778af4e3b07)

To get an authenticated client instance:

    >>> client = ftx.FtxClient(api_key=<YOUR API KEY>, api_secret=<YOUR API SECRET>)

If you try to access a private endpoint with an unauthenticated client, an error is raised. Calls to private endpoints
work the same as regular ones:

    client.get_open_orders('BTC/USD')

## Advanced usage

### Placing orders

An order can be placed through the `place_order()` function. See
[the API Documentation](https://docs.ftx.com/#place-order) for required and optional parameters.

    client.place_order('BTC/USD', 'sell', 12345.0, 10)

### Modifying orders

Orders can be modified by providing the original order ID.

    >>> client.place_order('BTC/USD', 'sell', 12345.0, 10)
    {"createdAt": "2020-08-20T17:33:19.115690+00:00","filledSize": 0,"id": 9596912,"market": "BTC/USD"...

    >>> client.modify_order(9596912, 12500.0, 15).result()

### Canceling orders

An order can be canceled given the order ID:

    client.cancel_order(9596912).result()




%package help
Summary:	Development documents and examples for ftx
Provides:	python3-ftx-doc
%description help
# FTX Python client

A Unofficial Python3 library to interact with [FTX's](https://ftx.com/) API. The library can be used to fetch market
data, make trades, place orders or create third-party clients.

For more information, see [the FTX documentation.](https://docs.ftx.com/)

## Installation

    $ pip install ftx

## Quickstart

This is an introduction on how to get started with FTX client. First, make sure the FTX library is installed.

The next thing you need to do is import the library and get an instance of the client:

    import ftx
    client = ftx.FtxClient()

### Get ordedrbook

Get the orderbook levels of bid/ask:

    >>> import ftx
    >>> client = ftx.FtxClient()
    >>> result = client.get_orderbook('BTC/USD', 1)
    >>> result
    {'asks': [[11861.0, 1.778]], 'bids': [[11860.5, 0.1]]}

    >>> result['asks']
    [[11861.0, 1.778]]

    >>> result['bids']
    [[11860.5, 0.1]]

### Market's Instrument data

The API supports fetching full data for one or multiple markets.

    >>> client.get_market('BTC/USD')
    {'ask': 11849.0, 'baseCurrency': 'BTC', 'bid': 11848.5, 'change1h': 0.00025325004220834034, 'change24h': 0.008983693106825051, 'changeBod': 0.006925855109411514, 'enabled': True, 'last': 11849.0, 'minProvideSize': 0.0001, 'name': 'BTC/USD', 'postOnly': False, 'price': 11849.0, 'priceIncrement': 0.5, 'quoteCurrency': 'USD', 'quoteVolume24h': 9271567.5201, 'restricted': False, 'sizeIncrement': 0.0001, 'type': 'spot', 'underlying': None, 'volumeUsd24h': 9271567.5201}

### Date ranges

Any time-based parameters accept Python `datetime` objects. All timestamps returned from FTX are UTC.

    >>> client = ftx.FtxClient()
    >>> client.get_trades('BTC/USD', 1, datetime.datetime(2020,8,20).timestamp())
    [{'id': 88953674, 'liquidation': False, 'price': 11861.0, 'side': 'sell', 'size': 0.0105, 'time': '2020-08-20T17:33:19.115690+00:00'}]

### Authenticated endpoints

Private endpoints require authentication. Clients authenticate with an API key. For more information,
see:[API keys](https://help.ftx.com/hc/en-us/articles/360044411911-FTX-Features-Overview#h_6a76d63d-e6cd-45db-87ab-5778af4e3b07)

To get an authenticated client instance:

    >>> client = ftx.FtxClient(api_key=<YOUR API KEY>, api_secret=<YOUR API SECRET>)

If you try to access a private endpoint with an unauthenticated client, an error is raised. Calls to private endpoints
work the same as regular ones:

    client.get_open_orders('BTC/USD')

## Advanced usage

### Placing orders

An order can be placed through the `place_order()` function. See
[the API Documentation](https://docs.ftx.com/#place-order) for required and optional parameters.

    client.place_order('BTC/USD', 'sell', 12345.0, 10)

### Modifying orders

Orders can be modified by providing the original order ID.

    >>> client.place_order('BTC/USD', 'sell', 12345.0, 10)
    {"createdAt": "2020-08-20T17:33:19.115690+00:00","filledSize": 0,"id": 9596912,"market": "BTC/USD"...

    >>> client.modify_order(9596912, 12500.0, 15).result()

### Canceling orders

An order can be canceled given the order ID:

    client.cancel_order(9596912).result()




%prep
%autosetup -n ftx-1.2.0

%build
%py3_build

%install
%py3_install
install -d -m755 %{buildroot}/%{_pkgdocdir}
if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi
if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi
if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi
if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi
pushd %{buildroot}
if [ -d usr/lib ]; then
	find usr/lib -type f -printf "\"/%h/%f\"\n" >> filelist.lst
fi
if [ -d usr/lib64 ]; then
	find usr/lib64 -type f -printf "\"/%h/%f\"\n" >> filelist.lst
fi
if [ -d usr/bin ]; then
	find usr/bin -type f -printf "\"/%h/%f\"\n" >> filelist.lst
fi
if [ -d usr/sbin ]; then
	find usr/sbin -type f -printf "\"/%h/%f\"\n" >> filelist.lst
fi
touch doclist.lst
if [ -d usr/share/man ]; then
	find usr/share/man -type f -printf "\"/%h/%f.gz\"\n" >> doclist.lst
fi
popd
mv %{buildroot}/filelist.lst .
mv %{buildroot}/doclist.lst .

%files -n python3-ftx -f filelist.lst
%dir %{python3_sitelib}/*

%files help -f doclist.lst
%{_docdir}/*

%changelog
* Thu Jun 08 2023 Python_Bot <Python_Bot@openeuler.org> - 1.2.0-1
- Package Spec generated