semvec/pypi-packages huggingface dataset:
py-bitflyer 0.1.4
A Python wrapper for bitFlyer API.
License: MIT License
Keywords: bitflyer

# py-bitflyer

![PyPI](https://img.shields.io/pypi/v/py-bitflyer?style=flat-square)
![PyPI - Downloads](https://img.shields.io/pypi/dd/py-bitflyer?style=flat-square)
![GitHub](https://img.shields.io/github/license/py-bitflyer/py-bitflyer?style=flat-square)

A Python wrapper for [bitFlyer API](https://lightning.bitflyer.com/docs#http-api).

## Install

```bash
$ pip install py-bitflyer
```

## Usage

### Public API

```python
import py_bitflyer


public_api = py_bitflyer.API()

# Get markets informations
public_api.markets()

# Get executions
# If you want 10 executions, pass count as a variable
public_api.executions(count=10)
```

### Private API

Create config.json and write down your *APIKey* and *APISecret*.

(!Atention!)
 This config.json has very very secret information of your bitflyer account.

`/path/to/config.json`

```json
{
    "Key" : "Your APIKey",
    "Secret" : "Your APISecret"
}
```

```python
import py_bitflyer


private_api = py_bitflyer.API(mode='Private', config='/path/to/config.json')

# Get balance
private_api.balance()

# Get a list of own executions
private_api.childorders_list()
```