Skip to content

Commit 11deaf2

Browse files
actions-useractions-user
committed
pushback
1 parent 78eb94b commit 11deaf2

File tree

290 files changed

+65952
-2
lines changed

Some content is hidden

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

290 files changed

+65952
-2
lines changed

‎README.md

Lines changed: 280 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,280 @@
1+
# woo-python
2+
Python SDK (sync and async) for Woo cryptocurrency exchange with Rest and WS capabilities.
3+
4+
- You can check the SDK docs here: [SDK](https://docs.ccxt.com/#/exchanges/woo)
5+
- You can check Woo's docs here: [Docs](https://www.google.com/search?q=google+woo+cryptocurrency+exchange+api+docs)
6+
- Github repo: https://github.com/ccxt/woo-python
7+
- Pypi package: https://pypi.org/project/woo-api
8+
9+
10+
## Installation
11+
12+
```
13+
pip install woo-api
14+
```
15+
16+
## Usage
17+
18+
### Sync
19+
20+
```Python
21+
from woo import WooSync
22+
23+
def main():
24+
instance = WooSync({})
25+
ob = instance.fetch_order_book("BTC/USDC")
26+
print(ob)
27+
#
28+
# balance = instance.fetch_balance()
29+
# order = instance.create_order("BTC/USDC", "limit", "buy", 1, 100000)
30+
31+
main()
32+
```
33+
34+
### Async
35+
36+
```Python
37+
import sys
38+
import asyncio
39+
from woo import WooAsync
40+
41+
### on Windows, uncomment below:
42+
# if sys.platform == 'win32':
43+
# asyncio.set_event_loop_policy(asyncio.WindowsSelectorEventLoopPolicy())
44+
45+
async def main():
46+
instance = WooAsync({})
47+
ob = await instance.fetch_order_book("BTC/USDC")
48+
print(ob)
49+
#
50+
# balance = await instance.fetch_balance()
51+
# order = await instance.create_order("BTC/USDC", "limit", "buy", 1, 100000)
52+
53+
# once you are done with the exchange
54+
await instance.close()
55+
56+
asyncio.run(main())
57+
```
58+
59+
60+
61+
### Websockets
62+
63+
```Python
64+
import sys
65+
from woo import WooWs
66+
67+
### on Windows, uncomment below:
68+
# if sys.platform == 'win32':
69+
# asyncio.set_event_loop_policy(asyncio.WindowsSelectorEventLoopPolicy())
70+
71+
async def main():
72+
instance = WooWs({})
73+
while True:
74+
ob = await instance.watch_order_book("BTC/USDC")
75+
print(ob)
76+
# orders = await instance.watch_orders("BTC/USDC")
77+
78+
# once you are done with the exchange
79+
await instance.close()
80+
81+
asyncio.run(main())
82+
```
83+
84+
85+
86+
87+
88+
#### Raw call
89+
90+
You can also construct custom requests to available "implicit" endpoints
91+
92+
```Python
93+
request = {
94+
'type': 'candleSnapshot',
95+
'req': {
96+
'coin': coin,
97+
'interval': tf,
98+
'startTime': since,
99+
'endTime': until,
100+
},
101+
}
102+
response = await instance.public_post_info(request)
103+
```
104+
105+
106+
## Available methods
107+
108+
### REST Unified
109+
110+
- `create_convert_trade(self, id: str, fromCode: str, toCode: str, amount: Num = None, params={})`
111+
- `create_market_buy_order_with_cost(self, symbol: str, cost: float, params={})`
112+
- `create_market_sell_order_with_cost(self, symbol: str, cost: float, params={})`
113+
- `create_order(self, symbol: str, type: OrderType, side: OrderSide, amount: float, price: Num = None, params={})`
114+
- `create_trailing_amount_order(self, symbol: str, type: OrderType, side: OrderSide, amount: float, price: Num = None, trailingAmount=None, trailingTriggerPrice=None, params={})`
115+
- `create_trailing_percent_order(self, symbol: str, type: OrderType, side: OrderSide, amount: float, price: Num = None, trailingPercent=None, trailingTriggerPrice=None, params={})`
116+
- `fetch_accounts(self, params={})`
117+
- `fetch_balance(self, params={})`
118+
- `fetch_closed_orders(self, symbol: Str = None, since: Int = None, limit: Int = None, params={})`
119+
- `fetch_convert_currencies(self, params={})`
120+
- `fetch_convert_quote(self, fromCode: str, toCode: str, amount: Num = None, params={})`
121+
- `fetch_convert_trade_history(self, code: Str = None, since: Int = None, limit: Int = None, params={})`
122+
- `fetch_convert_trade(self, id: str, code: Str = None, params={})`
123+
- `fetch_currencies(self, params={})`
124+
- `fetch_deposit_address(self, code: str, params={})`
125+
- `fetch_deposits_withdrawals(self, code: Str = None, since: Int = None, limit: Int = None, params={})`
126+
- `fetch_deposits(self, code: Str = None, since: Int = None, limit: Int = None, params={})`
127+
- `fetch_funding_history(self, symbol: Str = None, since: Int = None, limit: Int = None, params={})`
128+
- `fetch_funding_interval(self, symbol: str, params={})`
129+
- `fetch_funding_rate_history(self, symbol: Str = None, since: Int = None, limit: Int = None, params={})`
130+
- `fetch_funding_rate(self, symbol: str, params={})`
131+
- `fetch_funding_rates(self, symbols: Strings = None, params={})`
132+
- `fetch_ledger(self, code: Str = None, since: Int = None, limit: Int = None, params={})`
133+
- `fetch_leverage(self, symbol: str, params={})`
134+
- `fetch_markets(self, params={})`
135+
- `fetch_my_trades(self, symbol: Str = None, since: Int = None, limit: Int = None, params={})`
136+
- `fetch_ohlcv(self, symbol: str, timeframe='1m', since: Int = None, limit: Int = None, params={})`
137+
- `fetch_open_orders(self, symbol: Str = None, since: Int = None, limit: Int = None, params={})`
138+
- `fetch_order_book(self, symbol: str, limit: Int = None, params={})`
139+
- `fetch_order_trades(self, id: str, symbol: Str = None, since: Int = None, limit: Int = None, params={})`
140+
- `fetch_order(self, id: str, symbol: Str = None, params={})`
141+
- `fetch_orders(self, symbol: Str = None, since: Int = None, limit: Int = None, params={})`
142+
- `fetch_position(self, symbol: Str, params={})`
143+
- `fetch_positions(self, symbols: Strings = None, params={})`
144+
- `fetch_status(self, params={})`
145+
- `fetch_time(self, params={})`
146+
- `fetch_trades(self, symbol: str, since: Int = None, limit: Int = None, params={})`
147+
- `fetch_trading_fees(self, params={})`
148+
- `fetch_transfers(self, code: Str = None, since: Int = None, limit: Int = None, params={})`
149+
- `fetch_withdrawals(self, code: Str = None, since: Int = None, limit: Int = None, params={})`
150+
- `add_margin(self, symbol: str, amount: float, params={})`
151+
- `cancel_all_orders_after(self, timeout: Int, params={})`
152+
- `cancel_all_orders(self, symbol: Str = None, params={})`
153+
- `cancel_order(self, id: str, symbol: Str = None, params={})`
154+
- `default_network_code_for_currency(self, code)`
155+
- `describe(self)`
156+
- `edit_order(self, id: str, symbol: str, type: OrderType, side: OrderSide, amount: Num = None, price: Num = None, params={})`
157+
- `encode_margin_mode(self, mode)`
158+
- `get_asset_history_rows(self, code: Str = None, since: Int = None, limit: Int = None, params={})`
159+
- `get_currency_from_chaincode(self, networkizedCode, currency)`
160+
- `modify_margin_helper(self, symbol: str, amount, type, params={})`
161+
- `nonce(self)`
162+
- `reduce_margin(self, symbol: str, amount: float, params={})`
163+
- `repay_margin(self, code: str, amount: float, symbol: Str = None, params={})`
164+
- `set_leverage(self, leverage: Int, symbol: Str = None, params={})`
165+
- `set_position_mode(self, hedged: bool, symbol: Str = None, params={})`
166+
- `set_sandbox_mode(self, enable: bool)`
167+
- `transfer(self, code: str, amount: float, fromAccount: str, toAccount: str, params={})`
168+
- `withdraw(self, code: str, amount: float, address: str, tag=None, params={})`
169+
170+
### REST Raw
171+
172+
- `v1_pub_get_hist_kline(request)`
173+
- `v1_pub_get_hist_trades(request)`
174+
- `v1_public_get_info(request)`
175+
- `v1_public_get_info_symbol(request)`
176+
- `v1_public_get_system_info(request)`
177+
- `v1_public_get_market_trades(request)`
178+
- `v1_public_get_token(request)`
179+
- `v1_public_get_token_network(request)`
180+
- `v1_public_get_funding_rates(request)`
181+
- `v1_public_get_funding_rate_symbol(request)`
182+
- `v1_public_get_funding_rate_history(request)`
183+
- `v1_public_get_futures(request)`
184+
- `v1_public_get_futures_symbol(request)`
185+
- `v1_public_get_orderbook_symbol(request)`
186+
- `v1_public_get_kline(request)`
187+
- `v1_private_get_client_token(request)`
188+
- `v1_private_get_order_oid(request)`
189+
- `v1_private_get_client_order_client_order_id(request)`
190+
- `v1_private_get_orders(request)`
191+
- `v1_private_get_client_trade_tid(request)`
192+
- `v1_private_get_order_oid_trades(request)`
193+
- `v1_private_get_client_trades(request)`
194+
- `v1_private_get_client_hist_trades(request)`
195+
- `v1_private_get_staking_yield_history(request)`
196+
- `v1_private_get_client_holding(request)`
197+
- `v1_private_get_asset_deposit(request)`
198+
- `v1_private_get_asset_history(request)`
199+
- `v1_private_get_sub_account_all(request)`
200+
- `v1_private_get_sub_account_assets(request)`
201+
- `v1_private_get_sub_account_asset_detail(request)`
202+
- `v1_private_get_sub_account_ip_restriction(request)`
203+
- `v1_private_get_asset_main_sub_transfer_history(request)`
204+
- `v1_private_get_token_interest(request)`
205+
- `v1_private_get_token_interest_token(request)`
206+
- `v1_private_get_interest_history(request)`
207+
- `v1_private_get_interest_repay(request)`
208+
- `v1_private_get_funding_fee_history(request)`
209+
- `v1_private_get_positions(request)`
210+
- `v1_private_get_position_symbol(request)`
211+
- `v1_private_get_client_transaction_history(request)`
212+
- `v1_private_get_client_futures_leverage(request)`
213+
- `v1_private_post_order(request)`
214+
- `v1_private_post_order_cancel_all_after(request)`
215+
- `v1_private_post_asset_main_sub_transfer(request)`
216+
- `v1_private_post_asset_ltv(request)`
217+
- `v1_private_post_asset_withdraw(request)`
218+
- `v1_private_post_asset_internal_withdraw(request)`
219+
- `v1_private_post_interest_repay(request)`
220+
- `v1_private_post_client_account_mode(request)`
221+
- `v1_private_post_client_position_mode(request)`
222+
- `v1_private_post_client_leverage(request)`
223+
- `v1_private_post_client_futures_leverage(request)`
224+
- `v1_private_post_client_isolated_margin(request)`
225+
- `v1_private_delete_order(request)`
226+
- `v1_private_delete_client_order(request)`
227+
- `v1_private_delete_orders(request)`
228+
- `v1_private_delete_asset_withdraw(request)`
229+
- `v2_private_get_client_holding(request)`
230+
- `v3_public_get_insurancefund(request)`
231+
- `v3_private_get_algo_order_oid(request)`
232+
- `v3_private_get_algo_orders(request)`
233+
- `v3_private_get_balances(request)`
234+
- `v3_private_get_accountinfo(request)`
235+
- `v3_private_get_positions(request)`
236+
- `v3_private_get_buypower(request)`
237+
- `v3_private_get_referrals(request)`
238+
- `v3_private_get_referral_rewards(request)`
239+
- `v3_private_get_convert_exchangeinfo(request)`
240+
- `v3_private_get_convert_assetinfo(request)`
241+
- `v3_private_get_convert_rfq(request)`
242+
- `v3_private_get_convert_trade(request)`
243+
- `v3_private_get_convert_trades(request)`
244+
- `v3_private_post_algo_order(request)`
245+
- `v3_private_post_convert_rft(request)`
246+
- `v3_private_put_order_oid(request)`
247+
- `v3_private_put_order_client_client_order_id(request)`
248+
- `v3_private_put_algo_order_oid(request)`
249+
- `v3_private_put_algo_order_client_client_order_id(request)`
250+
- `v3_private_delete_algo_order_order_id(request)`
251+
- `v3_private_delete_algo_orders_pending(request)`
252+
- `v3_private_delete_algo_orders_pending_symbol(request)`
253+
- `v3_private_delete_orders_pending(request)`
254+
255+
### WS Unified
256+
257+
- `describe(self)`
258+
- `watch_public(self, messageHash, message)`
259+
- `watch_order_book(self, symbol: str, limit: Int = None, params={})`
260+
- `fetch_order_book_snapshot(self, client, message, subscription)`
261+
- `watch_ticker(self, symbol: str, params={})`
262+
- `watch_tickers(self, symbols: Strings = None, params={})`
263+
- `watch_bids_asks(self, symbols: Strings = None, params={})`
264+
- `watch_ohlcv(self, symbol: str, timeframe='1m', since: Int = None, limit: Int = None, params={})`
265+
- `watch_trades(self, symbol: str, since: Int = None, limit: Int = None, params={})`
266+
- `check_required_uid(self, error=True)`
267+
- `authenticate(self, params={})`
268+
- `watch_private(self, messageHash, message, params={})`
269+
- `watch_private_multiple(self, messageHashes, message, params={})`
270+
- `watch_orders(self, symbol: Str = None, since: Int = None, limit: Int = None, params={})`
271+
- `watch_my_trades(self, symbol: Str = None, since: Int = None, limit: Int = None, params={})`
272+
- `watch_positions(self, symbols: Strings = None, since: Int = None, limit: Int = None, params={})`
273+
- `set_positions_cache(self, client: Client, type, symbols: Strings = None)`
274+
- `load_positions_snapshot(self, client, messageHash)`
275+
- `watch_balance(self, params={})`
276+
277+
## Contribution
278+
- Give us a star :star:
279+
- Fork and Clone! Awesome
280+
- Select existing issues or create a new issue.

‎build/package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,6 @@
66
"scripts": {
77
"build-single-exchange": "tsx build.ts",
88
"pypi-packager": "tsx pypi-packager.ts",
9-
109
"sample-generate": "cd ../.github/scripts/ && bash generate-exchange-skeleton.sh ../../../tmp_folder kucoin",
1110
"sample-build": "cd ../../tmp_folder/build && npm run build-single-exchange",
1211
"sample-pypi": "cd ../../tmp_folder/build && npm run pypi-packager",
@@ -17,7 +16,8 @@
1716
"dependencies": {
1817
"fs": "*",
1918
"path": "*",
20-
"semver": "^7.7.1"
19+
"semver": "^7.7.1",
20+
"typescript": "^5.8.3"
2121
},
2222
"devDependencies": {
2323
"tsx": "^4.19.3"

‎examples/async.py

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
import os
2+
import sys
3+
import asyncio
4+
5+
# if CCXT is included locally
6+
# sys.path.append(os.path.dirname(os.path.dirname((os.path.abspath(__file__)))) + '/')
7+
8+
from woo import WooAsync
9+
10+
if sys.platform == 'win32':
11+
asyncio.set_event_loop_policy(asyncio.WindowsSelectorEventLoopPolicy())
12+
13+
async def main():
14+
instance = WooAsync({})
15+
await instance.load_markets()
16+
symbol = "BTC/USDC"
17+
18+
# fetch ticker
19+
ticker = await instance.fetch_ticker(symbol)
20+
print(ticker)
21+
22+
# create order
23+
order = await instance.create_order("BTC/USDC", "limit", "buy", 1, 123456.789)
24+
print(order)
25+
26+
# close after you finish
27+
await instance.close()
28+
29+
asyncio.run(main())
30+

‎examples/sync.py

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
import os
2+
import sys
3+
4+
root = os.path.dirname(os.path.dirname((os.path.abspath(__file__))))
5+
sys.path.append(root + '/')
6+
7+
from woo import WooSync
8+
9+
10+
def main():
11+
instance = WooSync({})
12+
instance.load_markets()
13+
symbol = "BTC/USDC"
14+
15+
# fetch ticker
16+
ticker = instance.fetch_ticker(symbol)
17+
print(ticker)
18+
19+
# create order
20+
order = instance.create_order("BTC/USDC", "limit", "buy", 1, 123456.789)
21+
print(order)
22+
23+
main()
24+

0 commit comments

Comments
 (0)