Skip to content

Commit

Permalink
feat: add paid version apis (#69)
Browse files Browse the repository at this point in the history
* add short selling constants

* add paid version apis

* poetry version update

* 指摘反映
  • Loading branch information
s-meitoma authored Apr 7, 2023
1 parent 956ab2e commit 3ab9845
Show file tree
Hide file tree
Showing 3 changed files with 841 additions and 344 deletions.
94 changes: 62 additions & 32 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,27 +2,27 @@

[![PyPI version](https://badge.fury.io/py/jquants-api-client.svg)](https://badge.fury.io/py/jquants-api-client)

個人投資家向けデータAPI配信サービス[J-Quants API](https://jpx-jquants.com/#jquants-api)のPythonクライアントライブラリです
J-QuantsやAPI仕様についての詳細を知りたい方は [公式ウェブサイト](https://jpx-jquants.com/) をご参照ください。
現在、J-Quants APIはベータ版サービスとして提供されています
個人投資家向けデータ API 配信サービス[J-Quants API](https://jpx-jquants.com/#jquants-api)の Python クライアントライブラリです
J-Quants や API 仕様についての詳細を知りたい方は [公式ウェブサイト](https://jpx-jquants.com/) をご参照ください。
現在、J-Quants API は有償版サービスとして提供されています

## 使用方法

pip経由でインストールします
pip 経由でインストールします

```shell
pip install jquants-api-client
```

### J-Quants API の利用

To use J-Quants API, you need to "Applications for J-Quants API" from [J-Quants API Web site](https://jpx-jquants.com/?lang=en#jquants-api).
To use J-Quants API, you need to "Applications for J-Quants API" from [J-Quants API Web site](https://jpx-jquants.com/?lang=en) and to select a plan.

J-Quants APIを利用するためには[J-Quants API の Web サイト](https://jpx-jquants.com/#jquants-api) から「J-Quants API申し込み」が必要になります
J-Quants API を利用するためには[J-Quants API の Web サイト](https://jpx-jquants.com/) から「J-Quants API 申し込み」及び利用プランの選択が必要になります

jquants-api-client-python を使用するためには「J-Quants API ログインページで使用するメールアドレスおよびパスワード」または「J-Quants API メニューページから取得したリフレッシュトークン」が必要になります。必要に応じて下記のWebサイトより取得してください
jquants-api-client-python を使用するためには「J-Quants API ログインページで使用するメールアドレスおよびパスワード」または「J-Quants API メニューページから取得したリフレッシュトークン」が必要になります。必要に応じて下記の Web サイトより取得してください

[J-Quants API ログインページ](https://application.jpx-jquants.com/)
[J-Quants API ログインページ](https://jpx-jquants.com/auth/signin/)

### サンプルコード

Expand All @@ -41,7 +41,7 @@ df = cli.get_price_range(
print(df)
```

APIレスポンスがDataframeの形式で取得できます
API レスポンスが Dataframe の形式で取得できます

```shell
Code Date ... AdjustmentClose AdjustmentVolume
Expand All @@ -62,41 +62,71 @@ APIレスポンスがDataframeの形式で取得できます。

より具体的な使用例は [サンプルノートブック(/examples)](examples) をご参照ください。

## 対応API
## 対応 API

### ラッパー群 
### ラッパー群 

J-Quants API の各APIエンドポイントに対応しています
J-Quants API の各 API エンドポイントに対応しています

- get_refresh_token
- get_id_token
- get_listed_info
- get_listed_sections
- get_prices_daily_quotes
- get_indices_topix
- get_markets_trades_spec
- get_fins_statements
- get_fins_announcement
------------------ Free plan or higher is required ------------------

- get_refresh_token
- get_id_token
- get_listed_info
- get_prices_daily_quotes
- get_fins_statements
- get_fins_announcement

------------------ Light plan or higher is required ------------------

- get_markets_trades_spec
- get_indices_topix

------------------ Standard plan or higher is required ------------------

- get_option_index_option
- get_markets_weekly_margin_interest
- get_markets_short_selling

------------------ Premium plan or higher is required ------------------

- get_markets_breakdown
- get_prices_prices_am
- get_fins_dividend

### ユーティリティ群

業種や市場区分一覧などを返します。
- get_market_segments
- get_17_sectors
- get_33_sectors

- get_market_segments
- get_17_sectors
- get_33_sectors

日付範囲を指定して一括でデータ取得して、取得したデータを結合して返すようなユーティリティが用意されています。

- get_list
- get_price_range
- get_statements_range
------------------ Free plan or higher is required ------------------

- get_list
- get_price_range
- get_statements_range

------------------ Standard plan or higher is required ------------------

- get_weekly_margin_range
- get_short_selling_range
- get_index_option_range

------------------ Premium plan or higher is required ------------------

- get_breakdown_range
- get_dividend_range

## 設定

認証用のメールアドレス/パスワードおよびリフレッシュトークンは設定ファイルおよび環境変数を使用して指定することも可能です。
設定は下記の順に読み込まれ、設定項目が重複している場合は後に読み込まれた値で上書きされます。

1. `/content/drive/MyDrive/drive_ws/secret/jquants-api.toml` (Google Colabのみ)
1. `/content/drive/MyDrive/drive_ws/secret/jquants-api.toml` (Google Colab のみ)
2. `${HOME}/.jquants-api/jquants-api.toml`
3. `jquants-api.toml`
4. `os.environ["JQUANTS_API_CLIENT_CONFIG_FILE"]`
Expand All @@ -115,12 +145,12 @@ refresh_token = "*****"

## 動作確認

Google Colab および Python 3.10 で動作確認を行っています。
J-Quants APIは現在β版のため、本ライブラリも今後仕様が変更となる可能性があります。
Google Colab および Python 3.11 で動作確認を行っています。
J-Quants API は有償版で継続開発されているため、本ライブラリも今後仕様が変更となる可能性があります。
Python 3.7 サポートは廃止予定です。将来のバージョンではサポート対象外となります。
Please note Python 3.7 support is deprecated.

## 開発

J-Quants API Clientの開発に是非ご協力ください
Github上でIssueやPull Requestをお待ちしております
J-Quants API Client の開発に是非ご協力ください
Github 上で Issue や Pull Request をお待ちしております
Loading

0 comments on commit 3ab9845

Please sign in to comment.