https://github.com/bisonai/pykorbit
Python wrapper for Korbit's REST/WS API
https://github.com/bisonai/pykorbit
cex cryptocurrency korbit orderbook ticker trading wallet
Last synced: 27 days ago
JSON representation
Python wrapper for Korbit's REST/WS API
- Host: GitHub
- URL: https://github.com/bisonai/pykorbit
- Owner: Bisonai
- License: apache-2.0
- Created: 2022-05-13T04:21:24.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2022-07-01T10:47:22.000Z (almost 3 years ago)
- Last Synced: 2025-04-23T04:59:02.906Z (27 days ago)
- Topics: cex, cryptocurrency, korbit, orderbook, ticker, trading, wallet
- Language: Python
- Homepage: https://apidocs.korbit.co.kr
- Size: 99.6 KB
- Stars: 6
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# PyKorbit
Python wrapper for Korbit's REST/WS API
## Installation
```shell
pip install .
```
## Requirements
To get access to private APIs, you have to define `korbit_client_id` and `korbit_client_secret` environment variables in `.env` file.
You can find template in `.env.example` file.
```shell
cp .env.example .env
```
## Documentation
### Exceptions
* `pykorbit.KorbitMessageNotAccepted`
* `pykorbit.KorbitWebsocketMessageReceiveFailed`
* `pykorbit.KorbitUnexpectedResponse`
### Methods
* [`pykorbit.KorbitAuthentication`](https://github.com/Bisonai/pykorbit#pykorbitkorbitauthenticationapi)
* [`pykorbit.KorbitWalletApi`](https://github.com/Bisonai/pykorbit#pykorbitkorbitwalletapi)
* [`pykorbit.KorbitRestApi`](https://github.com/Bisonai/pykorbit#pykorbitkorbitrestapi)
* [`pykorbit.KorbitWebsocketApi`](https://github.com/Bisonai/pykorbit#pykorbitkorbitwebsocketapi)
### `pykorbit.KorbitAuthenticationApi`
### Issue access token
https://apidocs.korbit.co.kr/#direct-authentication
```python
pykorbit.KorbitAuthenticationApi.issue_access_token(client_id: str, client_secret: str) -> Dict[str, str]
```
#### Response
```json
{
"token_type":"Bearer",
"access_token":"1t1LgTslDrGznxPxhYz7RldsNVIbnEK",
"expires_in":3600,
"scope": "VIEW,TRADE",
"refresh_token":"vn5xoOf4PzckgnqjQSL9Sb3KxWJvYtm"
}
```
### Renew access token
https://apidocs.korbit.co.kr/#refreshing-access-token
```python
pykorbit.KorbitAuthenticationApi.renew_access_token(self, client_id: str, client_secret: str, refresh_token: str) -> Dict[str, str]
```
#### Response
```json
{
"token_type":"Bearer",
"access_token":"IuqEWTK09eCLThRCZZSALA0oXC8EI7s",
"expires_in":3600,
"scope": "VIEW,TRADE",
"refresh_token":"vn5xoOf4Pzckgn4jQSL9Sb3KxWJvYtm"
}
```
### `pykorbit.KorbitWalletApi`
https://apidocs.korbit.co.kr/#private-wallet
### View transfers
https://apidocs.korbit.co.kr/#view-transfers
```python
pykorbit.KorbitWalletApi.view_transfers(access_token: str, currency: Optional[str] = None, type: Optional[str] = None, offset: int = 0, limit: int = 40,) -> List[Dict]
```
#### Response
```json
[
{
"id": "270",
"type": "deposit",
"currency": "btc",
"amount": "0.81140000",
"completed_at": 11750020020,
"updated_at": 11550050080,
"created_at": 11550020020,
"status": "filled",
"details": {
"transaction_id": "2d84855aa9c...",
"address": "1F1zAaz5x1HUXrCNLbtMDqcw6o5GNx4xqX"
},
...
]
```
### Query status of deposit and withdrawal
https://apidocs.korbit.co.kr/#query-status-of-deposit-and-withdrawal
```python
pykorbit.KorbitWalletApi.query_status_of_deposit_and_withdrawal(access_token: str, currency: str, request_id: Optional[int] = None,) -> List[Dict]
```
#### Response
```json
[
{
"timestamp": 1392620446000,
"id": "5180",
"type": "coin-in",
"amount": { "currency": "btc", "value": "0.01"},
"in": "1anjg6B2XbpjHx8LFw8mXHATH54vrxs2F",
"completedAt": 1392620446100
}
]
```
### User balances
https://apidocs.korbit.co.kr/#user-balances
```python
pykorbit.KorbitWalletApi.user_balances(access_token: str) -> Dict[str, Any]
```
#### Response
```json
{
"krw" : {
"available" : "123000",
"trade_in_use" : "13000",
"withdrawal_in_use" : "0"
},
"btc" : {
"available" : "1.50200000",
"trade_in_use" : "0.42000000",
"withdrawal_in_use" : "0.50280000",
"avg_price": "7115500",
"avg_price_updated_at": 1528944850000
},
...
}
```
### Transfer account info
https://apidocs.korbit.co.kr/#transfer-account-info
```python
pykorbit.KorbitWalletApi.transfer_account_info(access_token: str) -> Dict[str, Any]
```
#### Response
```json
{
"deposit": {
"btc": {
"address" :"3J98t1WpEZ73CNmQviecrnyiWrnqRhWNLy"
},
"etc": {
"address" :"0x123f681646d4a755815f9cb19e1acc8565a0c2aa"
},
...
},
"withdrawal": {
...
}
}
```
### Trading volume and fees
https://apidocs.korbit.co.kr/#trading-volume-and-fees
```python
pykorbit.KorbitWalletApi.trading_volume_and_fees(access_token: str, pair: List[str] = []) -> Dict[str, Any]
```
#### Response
```json
{
"eth_krw": {
"volume" : "0",
"maker_fee" : "0.00100000",
"taker_fee" : "0.00200000"
},
...
"etc_krw": {
"volume" : "6570000",
"maker_fee" : "0.00100000",
"taker_fee" : "0.00200000"
},
"total_volume" : "24140000",
"timestamp" : 1386418990000
}
```
### `pykorbit.KorbitRestApi`
### Ticker
https://apidocs.korbit.co.kr/#ticker
```python
pykorbit.KorbitRestApi.ticker(currency_pair: str) -> Dict[str, Any]
```
#### Response
```json
{
"timestamp": 1389678052000,
"last": "569000"
}
```
### Detailed ticker
https://apidocs.korbit.co.kr/#detailed-ticker
```python
pykorbit.KorbitRestApi.detailed_ticker(currency_pair: str) -> Dict[str, Any]
```
#### Response
```json
{
"timestamp": 1558590089274,
"last": "9198500",
"open": "9500000",
"bid": "9192500",
"ask": "9198000",
"low": "9171500",
"high": "9599000",
"volume": "1539.18571988",
"change": "-301500",
"changePercent": "-3.17"
}
```
### Orderbook
https://apidocs.korbit.co.kr/#orderbook
```python
pykorbit.KorbitRestApi.orderbook(currency_pair: str) -> Dict[str, Any]
```
#### Response
```json
{
"timestamp" : 1386135077000,
"bids" : [["1100000", "0.0103918", "1"], ["1000000", "0.01000000", "1"], ... ],
"asks" : [["569000", "0.50000000", "1"], ["568500", "2.00000000", "1"], ... ]
}
```
### List of filled orders
https://apidocs.korbit.co.kr/#list-of-filled-orders
```python
pykorbit.KorbitRestApi.list_of_filled_orders(currency_pair: str, time: str = "hour") -> List[Dict]
```
#### Response
```json
[
{
"timestamp": 1389678052000,
"tid": "22546",
"price": "569000",
"amount": "0.01000000",
"type": "buy"
},
{
"timestamp": 1389678017000,
"tid": "22545",
"price": "580000",
"amount": "0.01000000",
"type": "sell"
}
...
]
```
### Constants (deprecated)
https://apidocs.korbit.co.kr/#constants-deprecated
```python
pykorbit.KorbitRestApi.constants() -> Dict
```
### Currency pairs
```python
pykorbit.KorbitRestApi.currency_pairs() -> List[str]
```
Get all currency pairs that can be traded.
### `pykorbit.KorbitWebsocketApi`
Abstract class for subcribing to Korbit's channels.
```python
pykorbit.KorbitWebsocketApi.__init__(self, logging_level: Optional[str] = None)
```
### Connect and subscribe ticker
```python
async pykorbit.KorbitWebsocketApi.connect_and_subscribe_ticker(self, pairs: List[str]) -> None
```
### Connect and subscribe orderbook
```python
async pykorbit.KorbitWebsocketApi.connect_and_subscribe_orderbook(self, pairs: List[str]) -> None
```
### Connect and subscribe transaction
```python
async pykorbit.KorbitWebsocketApi.connect_and_subscribe_transaction(self, pairs: List[str]) -> None
```
### Connect and subscribe
```python
async pykorbit.KorbitWebsocketApi.connect_and_subscribe(self, channels: List[str]) -> None
```
### Subscribe
```python
async pykorbit.KorbitWebsocketApi.subscribe(self, channels: List[str]) -> None
```
### Unsubscribe
```python
async pykorbit.KorbitWebsocketApi.unsubscribe(self, channels: List[str]) -> None
```
### Receive loop
```python
async pykorbit.KorbitWebsocketApi.receive_loop(self) -> None
```
### Worker
```python
async pykorbit.KorbitWebsocketApi.worker(msg: str) -> None
```
Abstract static method.