README.md

oilking

A trading bot using bitflyer api.

Disclaimer

Please take responsibility at your own risk if you use this program.

We do not take any responsibility even if you suffer a loss.

Get started

Set enviroment variables

Copy an .env.example as a .env and edit it. cp .env.example .env

Build

Build the source code. make docker-compose-build

Run

Run the binary file. make docker-compose-up or make docker-compose-up-d

Exchange marketplaces supported

Support	Exchange markeplaces
✅	Bitflyer

API supported

HTTP API

HTTP Public API

Support	Method	Endpoint
	GET	/v1/getmarkets
	GET	/v1/markets
	GET	/v1/getboard
	GET	/v1/board
✅	GET	/v1/getticker
	GET	/v1/getexecutions
✅	GET	/v1/getchats
	GET	/v1/gethealth
	GET	/v1/getboardstate

HTTP Private API

Support	Method	Endpoint
	GET	/v1/me/getpermissions
✅	GET	/v1/me/getbalance
✅	GET	/v1/me/getcollateral
	GET	/v1/me/getcollateralaccounts
✅	POST	/v1/me/sendchildorder
	POST	/v1/me/sendparentorder
✅	POST	/v1/me/cancelchildorder
	POST	/v1/me/cancelparentorder
✅	POST	/v1/me/cancelallchildorders
✅	GET	/v1/me/getchildorders
	GET	/v1/me/getparentorders
	GET	/v1/me/getparentorder
✅	GET	/v1/me/getexecutions
✅	GET	/v1/me/getbalancehistory
✅	GET	/v1/me/getpositions
	GET	/v1/me/getcollateralhistory
✅	GET	/v1/me/gettradingcommission
	GET	/v1/me/getaddresses
	GET	/v1/me/getcoinins
	GET	/v1/me/getcoinouts
	GET	/v1/me/getdeposits
	GET	/v1/me/getwithdrawals
	GET	/v1/me/getbankaccounts
	POST	/v1/me/withdraw

Realtime API（JSON-RPC 2.0 over WebSocket）

Public Channels

Support	Channel name
	lightning_board_snapshot_{product_code}
	lightning_board_{product_code}
✅	lightning_ticker_{product_code}
	lightning_executions_{product_code}

Private Channels

Support	Channel name
	lightning_board_snapshot_{product_code}
	parent_order_events

Reference

• lightning.bitflyer/docs

Contributing

We welcome your issue or pull request from everyone.

We'd appreciate if you could contribute our project.

Any request or question is OK.

日本語でも大丈夫です :D

License

This project is licensed under the terms of the MIT license.

Author

bmf - Software engineer.

• github - bmf-san/bmf-san
• twitter - @bmf-san
• blog - bmf-tech