Skip to content

Commit 09050da

Browse files
committed
Update README with exchange repository links
1 parent 87926f0 commit 09050da

File tree

1 file changed

+48
-2
lines changed

1 file changed

+48
-2
lines changed

README.md

Lines changed: 48 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,49 @@
1-
# central repo for single exchanges
1+
# kucoinfutures-python
2+
Python SDK (sync and async) for Kucoinfutures with Rest and WS capabilities.
3+
4+
You can check Kucoinfutures's docs here: [Docs](https://ccxt.com)
5+
6+
7+
You can check the SDK docs here: [SDK](https://docs.ccxt.com/#/exchanges/kucoinfutures)
8+
9+
*This package derives from CCXT and allows you to call pretty much every endpoint by either using the unified CCXT API or calling the endpoints directly*
10+
11+
## Installation
12+
13+
```
14+
pip install kucoin-futures-api
15+
```
16+
17+
## Usage
18+
19+
### Async
20+
21+
```Python
22+
from kucoin_futures_api import KucoinfuturesAsync
23+
24+
async def main():
25+
instance = KucoinfuturesAsync({})
26+
order = await instance.create_order(__EXAMPLE_SYMBOL__, "limit", "buy", 1, 100000)
27+
```
28+
29+
### Sync
30+
31+
```Python
32+
from kucoin_futures_api import KucoinfuturesSync
33+
34+
def main():
35+
instance = KucoinfuturesSync({})
36+
order = instance.create_order(__EXAMPLE_SYMBOL__, "limit", "buy", 1, 100000)
37+
```
38+
39+
### Websockets
40+
41+
```Python
42+
from kucoin_futures_api import KucoinfuturesWs
43+
44+
async def main():
45+
instance = KucoinfuturesWs({})
46+
while True:
47+
orders = await instance.watch_orders(__EXAMPLE_SYMBOL__)
48+
```
249

3-
this is dev.repo, not meant to be used by end users.

0 commit comments

Comments
 (0)