.. -- mode: rst --

.. image:: https://img.shields.io/pypi/v/pybitflyer.svg?maxAge=2592000 :target:

.. image:: https://img.shields.io/pypi/dd/pybitflyer.svg?maxAge=2592000 :target:

pybitflyer

pybitflyer is a python wrapper for bitFlyer's REST API.

Install

Using pip

.. code::

$ pip install git+https://github.com/yagays/pybitflyer.git

or using pip with PyPI: https://pypi.python.org/pypi/pybitflyer

.. code::

$ pip install pybitflyer

The requirements for this code is requests, which will be installed automatically.

Usage

.. code:: python

import pybitflyer api = pybitflyer.API(api_key="xxx...", api_secret="yyy...")

If you use HTTP Public API, API Key and API Secret can be omitted.

Example

Order Book

.. code:: python

  api.board(product_code="BTC_JPY")

Ticker
~~~~~~

.. code:: python

  api.ticker(product_code="BTC_JPY")

Send a New Order

You need to specify API key and API Secret by creating pybitflyer.API instance.

.. code:: python

api.sendchildorder(product_code="BTC_JPY", child_order_type="MARKET", side="SELL", size=0.001, minute_to_expire=10000, time_in_force="GTC" )

More detail

For more detail, see the API documentation: https://lightning.bitflyer.jp/docs?lang=en

Author
------

@yag_ays (<yanagi.ayase@gmail.com>)