Skip to main content

Python wrapper for bitFlyer's REST API.

Project description

https://img.shields.io/pypi/v/pybitflyer.svg?maxAge=2592000:target: 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

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

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

$ pip install pybitflyer

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

Usage

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

api.board(product_code="BTC_JPY")

Ticker

api.ticker(product_code="BTC_JPY")

Send a New Order

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

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>)

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pybitflyer-0.1.3.tar.gz (6.8 kB view details)

Uploaded Source

File details

Details for the file pybitflyer-0.1.3.tar.gz.

File metadata

  • Download URL: pybitflyer-0.1.3.tar.gz
  • Upload date:
  • Size: 6.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for pybitflyer-0.1.3.tar.gz
Algorithm Hash digest
SHA256 6e6bae27cac3d0c19eb3b9e6b547a3874fa5b46f4aa6bacba746f4b7de87bf24
MD5 6451b83c6f3c56f89c74870d5bde17f5
BLAKE2b-256 436ac1e1b8ab0e432e4a4e6859f84550a4ca889c91b8a24ee71b6e75455d176b

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page