Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/bmf-san/oilking

A trading bot using bitflyer api.
https://github.com/bmf-san/oilking

bcc bitflyer bitflyer-api bitflyer-auto-trade bitflyer-lightning bitflyer-lightning-apis bot btc cryptocurrency ethereum fx golang jpy json-rpc json-rpc2 ltc system-trade virtual-currency websocket

Last synced: about 1 month ago
JSON representation

A trading bot using bitflyer api.

Host: GitHub
URL: https://github.com/bmf-san/oilking
Owner: bmf-san
License: mit
Created: 2020-08-13T23:48:27.000Z (over 4 years ago)
Default Branch: master
Last Pushed: 2022-02-16T01:54:44.000Z (over 2 years ago)
Last Synced: 2024-10-04T20:51:25.447Z (about 1 month ago)
Topics: bcc, bitflyer, bitflyer-api, bitflyer-auto-trade, bitflyer-lightning, bitflyer-lightning-apis, bot, btc, cryptocurrency, ethereum, fx, golang, jpy, json-rpc, json-rpc2, ltc, system-trade, virtual-currency, websocket
Language: Go
Homepage:
Size: 39.1 KB
Stars: 9
Watchers: 1
Forks: 0
Open Issues: 7
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        # oilking

[![GitHub license](https://img.shields.io/github/license/bmf-san/oilking)](https://github.com/bmf-san/oilking/blob/master/LICENSE)

[![CircleCI](https://circleci.com/gh/bmf-san/oilking/tree/master.svg?style=svg)](https://circleci.com/gh/bmf-san/oilking/tree/master)

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 |

| ------------------ | -------------------- |

| :white_check_mark: | Bitflyer             |

# API supported

## HTTP API

### HTTP Public API

|      Support       | Method |     Endpoint      |

| ------------------ | ------ | ----------------- |

|                    | GET    | /v1/getmarkets    |

|                    | GET    | /v1/markets       |

|                    | GET    | /v1/getboard      |

|                    | GET    | /v1/board         |

| :white_check_mark: | GET    | /v1/getticker     |

|                    | GET    | /v1/getexecutions |

| :white_check_mark: | GET    | /v1/getchats      |

|                    | GET    | /v1/gethealth     |

|                    | GET    | /v1/getboardstate |

### HTTP Private API

|      Support       | Method |           Endpoint           |

| ------------------ | ------ | ---------------------------- |

|                    | GET    | /v1/me/getpermissions        |

| :white_check_mark: | GET    | /v1/me/getbalance            |

| :white_check_mark: | GET    | /v1/me/getcollateral         |

|                    | GET    | /v1/me/getcollateralaccounts |

| :white_check_mark: | POST   | /v1/me/sendchildorder        |

|                    | POST   | /v1/me/sendparentorder       |

| :white_check_mark: | POST   | /v1/me/cancelchildorder      |

|                    | POST   | /v1/me/cancelparentorder     |

| :white_check_mark: | POST   | /v1/me/cancelallchildorders  |

| :white_check_mark: | GET    | /v1/me/getchildorders        |

|                    | GET    | /v1/me/getparentorders       |

|                    | GET    | /v1/me/getparentorder        |

| :white_check_mark: | GET    | /v1/me/getexecutions         |

| :white_check_mark: | GET    | /v1/me/getbalancehistory     |

| :white_check_mark: | GET    | /v1/me/getpositions          |

|                    | GET    | /v1/me/getcollateralhistory  |

| :white_check_mark: | 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}          |

| :white_check_mark: | 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](https://lightning.bitflyer.com/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](https://github.com/bmf-san/bmf-san)

- [twitter - @bmf-san](https://twitter.com/bmf_san)

- [blog - bmf-tech](http://bmf-tech.com/)