Skip to content
Permalink
Browse files

update 2019-10-02

  • Loading branch information...
daiki-ojima committed Oct 3, 2019
1 parent a452813 commit 0edd6ef05058c7fd9280003722e6bbe2f92fb0fc
Showing with 611 additions and 48 deletions.
  1. +25 −0 .github/ISSUE_TEMPLATE.md
  2. +19 −0 .github/PULL_REQUEST_TEMPLATE.md
  3. +6 −1 CHANGELOG.md
  4. +6 −0 README.md
  5. +6 −0 README_JP.md
  6. +4 −4 realtime-api.md
  7. +280 −22 rest-api.md
  8. +265 −21 rest-api_JP.md
@@ -0,0 +1,25 @@
Issue tracker is **ONLY** used for reporting bugs.

<!--- Provide a general summary of the issue in the Title above -->

## Expected Behavior
<!--- Tell us what should happen -->

## Current Behavior
<!--- Tell us what happens instead of the expected behavior -->

## Steps to Reproduce
<!--- Provide a link to a live example, or an unambiguous set of steps to -->
<!--- reproduce this bug. Include code to reproduce, if relevant -->
1.
2.
3.

## Context (Environment)
<!--- How has this issue affected you? What are you trying to accomplish? -->
<!--- Providing context helps us come up with a solution that is most useful in the real world -->

<!--- Provide a general summary of the issue in the Title above -->

## Detailed Description
<!--- Provide a detailed description of the change or addition you are proposing -->
@@ -0,0 +1,19 @@
We accept pull-requests for Bug Fixes **ONLY**.

<!--- Provide a general summary of your changes in the Title above -->

## Description
<!--- Describe your changes in detail -->

## Related Issue
<!--- This project only accepts pull requests related to open issues -->
<!--- If suggesting a new feature or change, please discuss it in an issue first -->
<!--- If fixing a bug, there should be an issue describing it with steps to reproduce -->
<!--- Please link to the issue here: -->

## How Has This Been Tested?
<!--- Please describe in detail how you tested your changes. -->
<!--- Include details of your testing environment, and the tests you ran to -->
<!--- see how your change affects other areas of the code, etc. -->

## Screenshots (if appropriate):
@@ -1,7 +1,12 @@
# CHANGELOG for Bitbank's API (2019-10-01)
# CHANGELOG for Bitbank's API (2019-10-02)
---
## 2019-10-02
* Added curl sample code to `rest-api.md`.

---
## 2019-10-01
* Added Realtime API documentation to `realtime-api.md`.

---
## 2019-09-27
* Added first version.
@@ -11,3 +11,9 @@ Name | Description
[public-stream.md](./public-stream.md) | Details on available real time streams api.
[realtime-api.md](./realtime-api.md) | [DEPRECATED] Details on real time api. (Please use public-stream instead.)
[errors.md](./errors.md) | Descriptions of possible error messages from the Private REST API.

**Issue Tracker:**

Bug reports are welcome! You can use the issue tracker to report bugs and request features on [https://github.com/bitbankinc/bitbank-api-docs/issues](https://github.com/bitbankinc/bitbank-api-docs/issues).

Pull request welcome! You can use our pull request to improve our documents [https://github.com/bitbankinc/bitbank-api-docs/pulls](https://github.com/bitbankinc/bitbank-api-docs/pulls).
@@ -11,3 +11,9 @@
[public-stream_JP.md](./public-stream_JP.md) | リアルタイムデータ配信API
[realtime-api_JP.md](./realtime-api_JP.md) | [非推奨] リアルタイム API (リアルタイムデータ配信APIを利用してください)
[errors_JP.md](./errors_JP.md) | エラーコードの一覧

_APIに関する改善、機能追加の要望、ドキュメント記載内容の誤り、サンプルコードのバグなどに関する内容は本リポジトリのIssueからご報告ください。_
[https://github.com/bitbankinc/bitbank-api-docs/issues](https://github.com/bitbankinc/bitbank-api-docs/issues)

_具体的なドキュメント記載内容の修正、記載の追加がある場合、Pull Requestも受け付けております。_
[https://github.com/bitbankinc/bitbank-api-docs/pulls](https://github.com/bitbankinc/bitbank-api-docs/pulls).
@@ -1,9 +1,9 @@
[日本語](realtime-api_JP.md)

# Realtime API (2019-10-01)
# Realtime API (2019-10-01)

Distributed real time data using [Pubnub](https://www.pubnub.com/).
You can received using the following SubscribeKey.
Data can be received using the following SubscribeKey.

```
sub-c-e12e9174-dd60-11e6-806b-02ee2ddab7fe
@@ -12,9 +12,9 @@ sub-c-e12e9174-dd60-11e6-806b-02ee2ddab7fe
Pubnub library usage: [https://www.pubnub.com/docs](https://www.pubnub.com/docs)

The channel names are as follows.
(For other pars, change the "btc_jpy" part to "xrp_jpy", "ltc_btc", "eth_btc", "mona_jpy", etc.)
(For other pairs, change the "btc_jpy" part to "xrp_jpy", "ltc_btc", "eth_btc", "mona_jpy", etc.)

- Ticker: ticker_btc_jpy
- Depth: depth_btc_jpy
- Transactions: transactions_btc_jpy
- Candlesticks: candlestick_btc_jpy
- Candlesticks: candlestick_btc_jpy

0 comments on commit 0edd6ef

Please sign in to comment.
You can’t perform that action at this time.