Metadata-Version: 2.1
Name: liquidcli
Version: 0.0.21
Summary: A small example package
Home-page: https://github.com/suzuito/liquid-python
Author: Suzuito
Author-email: suzuito3@gmail.com
License: UNKNOWN
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3.7
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.7
Description-Content-Type: text/markdown

# liquid-python

[![CircleCI](https://circleci.com/gh/suzuito/liquid-python.svg?style=svg)](https://circleci.com/gh/suzuito/liquid-python) [![PyPI](https://img.shields.io/pypi/v/liquidcli)](https://pypi.org/project/liquidcli/) [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/liquidcli)](https://pypi.org/project/liquidcli/)

Client library for [Liquid](https://www.liquid.com/).
Liquid API reference is [here](https://developers.liquid.com).

<details><summary>Supported API</summary>
<p>

|End point|Impl|
|---|----|
|Public||
|`GET /products/`||
|`GET /products/:id`||
|`GET /products/:id/price_levels`||
|`GET /executions`|o|
|`GET /ir_ladders`||
|`GET /fees`||
|Private||
|`POST /orders`||
|`GET /orders/:id`||
|`GET /orders`||
|`PUT /orders/:id/cancel`||
|`PUT /orders/:id`||
|`GET /orders/:id/trades`||
|`GET /executions/me`||
|`GET /fiat_accounts`|o|
|`POST /fiat_accounts`||
|`GET /crypto_accounts`||
|`GET /accounts/balance`||
|`GET /accounts/:currency`||
|`GET /accounts/:currency/reserved_balance_details`||
|`POST /loan_bids`||
|`GET /loan_bids`||
|`PUT /loan_bids/:id/close`||
|`GET /loans`||
|`PUT /loans`||
|`GET /trading_accounts`||
|`GET /trading_accounts/:id`||
|`GET /trades`||
|`PUT /trades/:id/close`||
|`PUT /trades/close_all`||
|`PUT /trades/:id/adjust_margin`||
|`GET /trades/:id/loans`||
|...etc...||

</p></details>

## Usage

### Insatall

```bash
pip install liquid-python
```

### Use

```bash
from liquidcli.client import Client
from liquidcli.data import Page

cli = Client(
    baseUrl='https://api.liquid.com',
    apiTokenId='<API_TOKEN_ID>',
    apiSecret='<API_SECRET>',
)
cli.postOrders(5, 'market', 'buy', 1)

page: Page = cli.getExecutions(5, 1, 1)
for e in page.models:
    print(e)
```

## Development

```bash
# Installation of dependencies
pipenv install --dev
# Run
pipenv python run main.py
```

### Run test

```bash
# Execute unit test
pipenv run python -m pytest --cov=liquidcli --cov-report=html --cov-report=term ./tests
# Check coverage in HTML
open htmlcov/index.html
```


