diff --git a/.gitignore b/.gitignore index 013dfc4..f3a2eda 100644 --- a/.gitignore +++ b/.gitignore @@ -24,6 +24,8 @@ go.work.sum # Project specific tmp/ +# 公式APIドキュメントのローカルキャッシュ(make docs-sync で取得) +docs/v2/ # IDE specific files .idea/ diff --git a/CLAUDE.md b/CLAUDE.md index 2a3a36f..ff44ea6 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -10,7 +10,7 @@ J-Quants API v2(日本の株式市場データを提供するAPI)のGoクラ **重要**: J-Quants APIの仕様を確認する際は、以下の順序で参照してください: -1. **最初に必ず`docs/v2/`ディレクトリを確認** - このリポジトリ内のv2 APIドキュメント +1. **最初に必ず`docs/v2/`ディレクトリを確認** - 公式ドキュメントのローカルキャッシュ(gitignore対象)。存在しない・古い場合は `make docs-sync` で取得 2. **不明な点がある場合のみ**: https://jpx-jquants.com/ja/spec/ - 公式APIリファレンス(各ページはURL末尾に`.md`を付けるとMarkdownで直接取得可能。例: https://jpx-jquants.com/ja/spec/eq-bars-daily.md ) ## 開発コマンド @@ -23,12 +23,13 @@ make test-cover # カバレッジ付きテスト make lint # リント make test-e2e # E2Eテスト(JQUANTS_API_KEY が必要) make test-run TEST=TestQuotesService_GetDailyQuotes # 特定のテスト +make docs-sync # 公式APIドキュメントを docs/v2/ に同期 ``` ## 新しいAPIサービスの追加時の注意 - `jquants.go`の`JQuantsAPI`構造体への登録を忘れない(忘れてもコンパイルは通る) -- `docs/v2/`ディレクトリにドキュメントを追加する +- `make docs-sync` で対象APIの最新ドキュメントを取得して参照する ## 実装上の注意点 diff --git a/Makefile b/Makefile index e36e196..bb88b72 100644 --- a/Makefile +++ b/Makefile @@ -1,4 +1,4 @@ -.PHONY: help test test-v test-cover test-e2e test-e2e-v lint clean install-tools check +.PHONY: help test test-v test-cover test-e2e test-e2e-v lint clean install-tools check docs-sync # デフォルトターゲット help: @@ -12,6 +12,7 @@ help: @echo " make lint - golangci-lintでコードをチェック" @echo " make clean - テスト成果物をクリーン" @echo " make install-tools - 開発ツールをインストール" + @echo " make docs-sync - 公式APIドキュメントを docs/v2/ に同期" # コンパイルチェック(ビルドはしない) check: @@ -78,4 +79,8 @@ mod-tidy: # 依存関係のダウンロード mod-download: - go mod download \ No newline at end of file + go mod download + +# 公式APIドキュメントを docs/v2/ に同期(ローカルキャッシュ。コミットしない) +docs-sync: + ./scripts/sync-docs.sh \ No newline at end of file diff --git a/README.md b/README.md index 7ab858c..678da69 100644 --- a/README.md +++ b/README.md @@ -261,8 +261,8 @@ make test-e2e jquants/ ├── client/ # HTTPクライアント(認証含む) ├── types/ # カスタム型定義 -├── docs/ # APIドキュメント -│ └── v2/ # v2 APIドキュメント +├── docs/v2/ # 公式APIドキュメントのローカルキャッシュ(make docs-sync で取得) +├── scripts/ # 開発用スクリプト ├── test/e2e/ # E2Eテスト ├── *.go # 各APIサービス実装 └── Makefile # ビルドタスク @@ -295,7 +295,7 @@ quote.Open, quote.High, quote.Low, quote.Close quote.O, quote.H, quote.L, quote.C ``` -詳細は `docs/v2/migration-v1-v2.md` を参照してください。 +詳細は[公式の移行ガイド](https://jpx-jquants.com/ja/spec/migration-v1-v2)を参照してください。 ## エラーハンドリング diff --git a/docs/v1/announcement.md b/docs/v1/announcement.md deleted file mode 100644 index 4b0a02c..0000000 --- a/docs/v1/announcement.md +++ /dev/null @@ -1,98 +0,0 @@ -# J-Quants API 決算発表予定日データ項目概要 - -このドキュメントは、J-Quants APIの決算発表予定日エンドポイント (`/fins/announcement`) のレスポンスデータ項目について説明します。 - -## データ型について -- すべてのフィールドは `String` 型で返されます -- 空文字列 (`""`) は値が存在しないことを示します(決算発表予定日が未定の場合など) - -## エンドポイント概要 - -### 決算発表予定日 (/fins/announcement) - -#### 概要 -- **エンドポイント**: `https://api.jquants.com/v1/fins/announcement` -- **HTTPメソッド**: GET -- **説明**: 翌日発表予定の決算情報が取得できます。3月期・9月期決算の会社の決算発表予定日を取得できます。(その他の決算期の会社は今後対応予定です) - -#### 本APIの留意点 -- 下記のサイトで、3月期・9月期決算会社分に更新があった場合のみ19時ごろに更新されます - - https://www.jpx.co.jp/listing/event-schedules/financial-announcement/index.html -- 3月期・9月期決算会社についての更新がなかった場合は、最終更新日時点のデータを提供します -- 本APIは翌営業日に決算発表が行われる銘柄に関する情報を返します -- 本APIから得られたデータにおいてDateの項目が翌営業日付であるレコードが存在しない場合は、3月期・9月期決算会社における翌営業日の開示予定はないことを意味します -- REITのデータは含まれません - -#### リクエストパラメータ - -| パラメータ名 | 型 | 必須 | 説明 | 例 | -|------------|-----|------|------|-----| -| pagination_key | String | いいえ | 検索の先頭を指定する文字列 | 過去の検索で返却されたpagination_key | - -#### リクエストヘッダー - -| ヘッダー名 | 型 | 必須 | 説明 | -|----------|-----|------|------| -| Authorization | String | はい | アクセスキー | - -#### レスポンスフィールド - -| フィールド名 | 日本語説明 | 備考 | -|------------|----------|------| -| Date | 日付 | YYYY-MM-DD形式。決算発表予定日が未定の場合、空文字("") | -| Code | 銘柄コード | | -| CompanyName | 会社名 | | -| FiscalYear | 決算期末 | 例:"9月30日" | -| SectorName | 業種名 | | -| FiscalQuarter | 決算種別 | 例:"第1四半期" | -| Section | 市場区分 | 例:"マザーズ" | - -## 使用上の注意事項 - -1. **対象企業について** - - 現在は3月期・9月期決算会社のみ対応 - - その他の決算期の会社は今後対応予定 - - REITは対象外 - -2. **データ更新について** - - 東証の公式サイトで更新があった場合のみ19時ごろに更新 - - 更新がない場合は最終更新日時点のデータを提供 - -3. **データの解釈** - - 翌営業日の決算発表予定のみを返す - - Dateが翌営業日でないレコードがない場合、翌営業日の開示予定なし - -4. **決算種別について** - - "第1四半期"、"第2四半期"、"第3四半期"、"通期" などの値を取る - -## サンプルレスポンス - -```json -{ - "announcement": [ - { - "Date": "2022-02-14", - "Code": "43760", - "CompanyName": "くふうカンパニー", - "FiscalYear": "9月30日", - "SectorName": "情報・通信業", - "FiscalQuarter": "第1四半期", - "Section": "マザーズ" - } - ], - "pagination_key": "value1.value2." -} -``` - -## 関連情報 - -このAPIは決算発表予定日の情報を提供するものです。関連する他のAPIについては以下を参照してください: -- 財務情報:`/fins/statements` -- 財務諸表(BS/PL):`/fins/fs_details` -- 配当金情報:`/fins/dividend` -- 上場銘柄一覧:`/listed/info` - -## データソース - -本APIのデータは以下のサイトの情報を基に提供されています: -- [東証 決算発表予定日一覧](https://www.jpx.co.jp/listing/event-schedules/financial-announcement/index.html) \ No newline at end of file diff --git a/docs/v1/breakdown.md b/docs/v1/breakdown.md deleted file mode 100644 index bbbece6..0000000 --- a/docs/v1/breakdown.md +++ /dev/null @@ -1,147 +0,0 @@ -# J-Quants API 売買内訳データ項目概要 - -このドキュメントは、J-Quants APIの売買内訳エンドポイント (`/markets/breakdown`) のレスポンスデータ項目について説明します。 - -## データ型について -- フィールドは `String` 型または `Number` 型で返されます -- 金額の単位は円です -- 株数の単位は株です - -## エンドポイント概要 - -### 売買内訳データ (/markets/breakdown) - -#### 概要 -- **エンドポイント**: `https://api.jquants.com/v1/markets/breakdown` -- **HTTPメソッド**: GET -- **説明**: 東証上場銘柄の東証市場における銘柄別の日次売買代金・売買高(立会内取引に限る)について、信用取引や空売りの利用に関する発注時のフラグ情報を用いて細分化したデータです。 - -#### 本APIの留意点 -- 当該銘柄のコーポレートアクションが発生した場合も、遡及して約定株数の調整は行われません -- 2020/10/1は東京証券取引所の株式売買システムの障害により終日売買停止となった関係で、データが存在しません - -#### リクエストパラメータ - -データの取得では、銘柄コード(code)または日付(date)の指定が必須となります。 - -| パラメータ名 | 型 | 必須 | 説明 | 例 | -|------------|-----|------|------|-----| -| code | String | いいえ* | 銘柄コード | 27800 or 2780 | -| date | String | いいえ* | 基準となる日付 | 20210907 or 2021-09-07 | -| from | String | いいえ | 期間の開始日 | 20210901 or 2021-09-01 | -| to | String | いいえ | 期間の終了日 | 20210907 or 2021-09-07 | -| pagination_key | String | いいえ | 検索の先頭を指定する文字列 | 過去の検索で返却されたpagination_key | - -\* codeまたはdateのいずれかは必須 - -**注意事項**: -- 4桁の銘柄コードを指定した場合は、普通株式と優先株式の両方が上場している銘柄においては普通株式のデータのみが取得されます - -#### レスポンスフィールド - -##### 基本情報 - -| フィールド名 | 日本語説明 | 型 | 備考 | -|------------|----------|-----|------| -| Date | 売買日 | String | YYYY-MM-DD形式 | -| Code | 銘柄コード | String | | - -##### 売りの約定代金内訳 - -| フィールド名 | 日本語説明 | 型 | 備考 | -|------------|----------|-----|------| -| LongSellValue | 実売りの約定代金 | Number | 単位:円 | -| ShortSellWithoutMarginValue | 空売り(信用新規売りを除く)の約定代金 | Number | 単位:円 | -| MarginSellNewValue | 信用新規売りの約定代金 | Number | 新たな信用売りポジションを作るための売り注文、単位:円 | -| MarginSellCloseValue | 信用返済売りの約定代金 | Number | 既存の信用買いポジションを閉じるための売り注文、単位:円 | - -##### 買いの約定代金内訳 - -| フィールド名 | 日本語説明 | 型 | 備考 | -|------------|----------|-----|------| -| LongBuyValue | 現物買いの約定代金 | Number | 単位:円 | -| MarginBuyNewValue | 信用新規買いの約定代金 | Number | 新たな信用買いポジションを作るための買い注文、単位:円 | -| MarginBuyCloseValue | 信用返済買いの約定代金 | Number | 既存の信用売りポジションを閉じるための買い注文、単位:円 | - -##### 売りの約定株数内訳 - -| フィールド名 | 日本語説明 | 型 | 備考 | -|------------|----------|-----|------| -| LongSellVolume | 実売りの約定株数 | Number | 単位:株 | -| ShortSellWithoutMarginVolume | 空売り(信用新規売りを除く)の約定株数 | Number | 単位:株 | -| MarginSellNewVolume | 信用新規売りの約定株数 | Number | 新たな信用売りポジションを作るための売り注文、単位:株 | -| MarginSellCloseVolume | 信用返済売りの約定株数 | Number | 既存の信用買いポジションを閉じるための売り注文、単位:株 | - -##### 買いの約定株数内訳 - -| フィールド名 | 日本語説明 | 型 | 備考 | -|------------|----------|-----|------| -| LongBuyVolume | 現物買いの約定株数 | Number | 単位:株 | -| MarginBuyNewVolume | 信用新規買いの約定株数 | Number | 新たな信用買いポジションを作るための買い注文、単位:株 | -| MarginBuyCloseVolume | 信用返済買いの約定株数 | Number | 既存の信用売りポジションを閉じるための買い注文、単位:株 | - -## 使用上の注意事項 - -1. **データの取得制限** - - 銘柄コード(code)または日付(date)の指定が必須 - - レスポンスが大きすぎる場合はpagination_keyを使用して分割取得 - -2. **データの内容について** - - 立会内取引のみが対象(立会外取引は含まれない) - - 東証市場における取引のみが対象 - -3. **コーポレートアクションの影響** - - 株式分割・併合等が発生しても約定株数の遡及調整は行われない - - 過去データ分析時は注意が必要 - -4. **特殊なケース** - - 2020/10/1:システム障害により全データなし - -## データの解釈 - -このAPIは売買の内訳を詳細に分類して提供します: - -- **実売り**: 保有株式の売却 -- **空売り**: 株式を借りて売却(信用新規売りを除く) -- **信用新規売り**: 新規の信用売りポジション構築 -- **信用返済売り**: 信用買いポジションの返済 -- **現物買い**: 通常の株式購入 -- **信用新規買い**: 新規の信用買いポジション構築 -- **信用返済買い**: 信用売りポジションの返済 - -## サンプルレスポンス - -```json -{ - "breakdown": [ - { - "Date": "2015-04-01", - "Code": "13010", - "LongSellValue": 115164000.0, - "ShortSellWithoutMarginValue": 93561000.0, - "MarginSellNewValue": 6412000.0, - "MarginSellCloseValue": 23009000.0, - "LongBuyValue": 185114000.0, - "MarginBuyNewValue": 35568000.0, - "MarginBuyCloseValue": 17464000.0, - "LongSellVolume": 415000.0, - "ShortSellWithoutMarginVolume": 337000.0, - "MarginSellNewVolume": 23000.0, - "MarginSellCloseVolume": 83000.0, - "LongBuyVolume": 667000.0, - "MarginBuyNewVolume": 128000.0, - "MarginBuyCloseVolume": 63000.0 - } - ], - "pagination_key": "value1.value2." -} -``` - -## 関連情報 - -このAPIは売買内訳の詳細データを提供するものです。関連する他のAPIについては以下を参照してください: -- 株価四本値:`/prices/daily_quotes` -- 投資部門別情報:`/markets/trades_spec` -- 信用取引週末残高:`/markets/weekly_margin_interest` -- 業種別空売り比率:`/markets/short_selling` -- 空売り残高報告:`/markets/short_selling_positions` \ No newline at end of file diff --git a/docs/v1/daily_quotes.md b/docs/v1/daily_quotes.md deleted file mode 100644 index 84d90a4..0000000 --- a/docs/v1/daily_quotes.md +++ /dev/null @@ -1,181 +0,0 @@ -# J-Quants API 株価四本値データ項目概要 - -このドキュメントは、J-Quants APIの株価四本値エンドポイント (`/prices/daily_quotes`) のレスポンスデータ項目について説明します。 - -## データ型について -- フィールドは `String` 型または `Number` 型で返されます -- 空文字列 (`""`) または `null` は値が存在しないことを示します -- 金額の単位は円です - -## エンドポイント概要 - -### 株価四本値 (/prices/daily_quotes) - -#### 概要 -- **エンドポイント**: `https://api.jquants.com/v1/prices/daily_quotes` -- **HTTPメソッド**: GET -- **説明**: 株価情報を取得することができます。株価は分割・併合を考慮した調整済み株価(小数点第2位四捨五入)と調整前の株価を取得することができます。 - -#### 本APIの留意点 -- 取引高が存在しない(売買されていない)日の銘柄についての四本値、取引高と売買代金は、Nullが収録されています -- 東証上場銘柄でない銘柄(地方取引所単独上場銘柄)についてはデータの収録対象外となっております -- 2020/10/1のデータは東京証券取引所の株式売買システムの障害により終日売買停止となった関係で、四本値、取引高と売買代金はNullが収録されています -- 日通しデータについては全プランで取得できますが、前場/後場別のデータについてはPremiumプランのみ取得可能です -- 株価調整については株式分割・併合にのみ対応しております。一部コーポレートアクションには対応しておりませんので、ご了承ください - -#### リクエストパラメータ - -データの取得では、銘柄コード(code)または日付(date)の指定が必須となります。 - -| パラメータ名 | 型 | 必須 | 説明 | 例 | -|------------|-----|------|------|-----| -| code | String | いいえ* | 銘柄コード | 27800 or 2780 | -| date | String | いいえ* | 基準となる日付 | 20210907 or 2021-09-07 | -| from | String | いいえ | 期間の開始日 | 20210901 or 2021-09-01 | -| to | String | いいえ | 期間の終了日 | 20210907 or 2021-09-07 | -| pagination_key | String | いいえ | 検索の先頭を指定する文字列 | 過去の検索で返却されたpagination_key | - -\* codeまたはdateのいずれかは必須 - -**注意事項**: -- 4桁の銘柄コードを指定した場合は、普通株式と優先株式等の両方が上場している銘柄においては普通株式のデータのみが取得されます - -#### レスポンスフィールド - -##### 日通しデータ(全プラン共通) - -| フィールド名 | 日本語説明 | 型 | 備考 | -|------------|----------|-----|------| -| Date | 日付 | String | YYYY-MM-DD形式 | -| Code | 銘柄コード | String | | -| Open | 始値(調整前) | Number | | -| High | 高値(調整前) | Number | | -| Low | 安値(調整前) | Number | | -| Close | 終値(調整前) | Number | | -| UpperLimit | 日通ストップ高フラグ | String | 0:ストップ高以外、1:ストップ高 | -| LowerLimit | 日通ストップ安フラグ | String | 0:ストップ安以外、1:ストップ安 | -| Volume | 取引高(調整前) | Number | | -| TurnoverValue | 取引代金 | Number | 単位:円 | -| AdjustmentFactor | 調整係数 | Number | 株式分割1:2の場合、権利落ち日に0.5が収録 | -| AdjustmentOpen | 調整済み始値 | Number | 過去の分割等を考慮 | -| AdjustmentHigh | 調整済み高値 | Number | 過去の分割等を考慮 | -| AdjustmentLow | 調整済み安値 | Number | 過去の分割等を考慮 | -| AdjustmentClose | 調整済み終値 | Number | 過去の分割等を考慮 | -| AdjustmentVolume | 調整済み取引高 | Number | 過去の分割等を考慮 | - -##### 前場データ(Premiumプランのみ) - -| フィールド名 | 日本語説明 | 型 | 備考 | -|------------|----------|-----|------| -| MorningOpen | 前場始値 | Number | | -| MorningHigh | 前場高値 | Number | | -| MorningLow | 前場安値 | Number | | -| MorningClose | 前場終値 | Number | | -| MorningUpperLimit | 前場ストップ高フラグ | String | 0:ストップ高以外、1:ストップ高 | -| MorningLowerLimit | 前場ストップ安フラグ | String | 0:ストップ安以外、1:ストップ安 | -| MorningVolume | 前場売買高 | Number | | -| MorningTurnoverValue | 前場取引代金 | Number | 単位:円 | -| MorningAdjustmentOpen | 調整済み前場始値 | Number | 過去の分割等を考慮 | -| MorningAdjustmentHigh | 調整済み前場高値 | Number | 過去の分割等を考慮 | -| MorningAdjustmentLow | 調整済み前場安値 | Number | 過去の分割等を考慮 | -| MorningAdjustmentClose | 調整済み前場終値 | Number | 過去の分割等を考慮 | -| MorningAdjustmentVolume | 調整済み前場売買高 | Number | 過去の分割等を考慮 | - -##### 後場データ(Premiumプランのみ) - -| フィールド名 | 日本語説明 | 型 | 備考 | -|------------|----------|-----|------| -| AfternoonOpen | 後場始値 | Number | | -| AfternoonHigh | 後場高値 | Number | | -| AfternoonLow | 後場安値 | Number | | -| AfternoonClose | 後場終値 | Number | | -| AfternoonUpperLimit | 後場ストップ高フラグ | String | 0:ストップ高以外、1:ストップ高 | -| AfternoonLowerLimit | 後場ストップ安フラグ | String | 0:ストップ安以外、1:ストップ安 | -| AfternoonVolume | 後場売買高 | Number | | -| AfternoonTurnoverValue | 後場取引代金 | Number | 単位:円 | -| AfternoonAdjustmentOpen | 調整済み後場始値 | Number | 過去の分割等を考慮 | -| AfternoonAdjustmentHigh | 調整済み後場高値 | Number | 過去の分割等を考慮 | -| AfternoonAdjustmentLow | 調整済み後場安値 | Number | 過去の分割等を考慮 | -| AfternoonAdjustmentClose | 調整済み後場終値 | Number | 過去の分割等を考慮 | -| AfternoonAdjustmentVolume | 調整済み後場売買高 | Number | 過去の分割等を考慮 | - -## 使用上の注意事項 - -1. **データの取得制限** - - 銘柄コード(code)または日付(date)の指定が必須 - - レスポンスが大きすぎる場合はpagination_keyを使用して分割取得 - -2. **調整済み株価について** - - 株式分割・併合を考慮した調整済み株価を提供 - - 小数点第2位で四捨五入 - - 一部のコーポレートアクションには未対応 - -3. **前場/後場データについて** - - Premiumプランのみで利用可能 - - 日通しデータは全プランで利用可能 - -4. **特殊なケース** - - 売買が成立しなかった日:四本値、取引高、売買代金はNull - - 2020/10/1:システム障害により全データNull - - 地方取引所単独上場銘柄:データ収録対象外 - -## サンプルレスポンス - -```json -{ - "daily_quotes": [ - { - "Date": "2023-03-24", - "Code": "86970", - "Open": 2047.0, - "High": 2069.0, - "Low": 2035.0, - "Close": 2045.0, - "UpperLimit": "0", - "LowerLimit": "0", - "Volume": 2202500.0, - "TurnoverValue": 4507051850.0, - "AdjustmentFactor": 1.0, - "AdjustmentOpen": 2047.0, - "AdjustmentHigh": 2069.0, - "AdjustmentLow": 2035.0, - "AdjustmentClose": 2045.0, - "AdjustmentVolume": 2202500.0, - "MorningOpen": 2047.0, - "MorningHigh": 2069.0, - "MorningLow": 2040.0, - "MorningClose": 2045.5, - "MorningUpperLimit": "0", - "MorningLowerLimit": "0", - "MorningVolume": 1121200.0, - "MorningTurnoverValue": 2297525850.0, - "MorningAdjustmentOpen": 2047.0, - "MorningAdjustmentHigh": 2069.0, - "MorningAdjustmentLow": 2040.0, - "MorningAdjustmentClose": 2045.5, - "MorningAdjustmentVolume": 1121200.0, - "AfternoonOpen": 2047.0, - "AfternoonHigh": 2047.0, - "AfternoonLow": 2035.0, - "AfternoonClose": 2045.0, - "AfternoonUpperLimit": "0", - "AfternoonLowerLimit": "0", - "AfternoonVolume": 1081300.0, - "AfternoonTurnoverValue": 2209526000.0, - "AfternoonAdjustmentOpen": 2047.0, - "AfternoonAdjustmentHigh": 2047.0, - "AfternoonAdjustmentLow": 2035.0, - "AfternoonAdjustmentClose": 2045.0, - "AfternoonAdjustmentVolume": 1081300.0 - } - ], - "pagination_key": "value1.value2." -} -``` - -## 関連情報 - -このAPIは株価の四本値データを提供するものです。関連する他のAPIについては以下を参照してください: -- 上場銘柄一覧:`/listed/info` -- 前場四本値:`/prices/prices_am`(前場データのみ) -- 財務情報:`/fins/statements` \ No newline at end of file diff --git a/docs/v1/dividend.md b/docs/v1/dividend.md deleted file mode 100644 index 6a66d43..0000000 --- a/docs/v1/dividend.md +++ /dev/null @@ -1,238 +0,0 @@ -# J-Quants API 配当金情報データ項目概要 - -このドキュメントは、J-Quants APIの配当金情報エンドポイント (`/fins/dividend`) のレスポンスデータ項目について説明します。 - -## データ型について -- 日付フィールドは `String` 型で返されます(YYYY-MM-DD形式) -- 配当金額データは `Number` または `String` 型で返されます -- 未定の場合は `-`、非設定の場合は空文字が設定されます - -## エンドポイント概要 - -### 配当金情報 (/fins/dividend) - -#### 概要 -- **エンドポイント**: `https://api.jquants.com/v1/fins/dividend` -- **HTTPメソッド**: GET -- **説明**: 上場会社の配当(決定・予想)に関する1株当たり配当金額、基準日、権利落日及び支払開始予定日等の情報を取得できます。 - -#### 本APIの留意点 -- **対象銘柄**: 東証上場銘柄でない銘柄(地方取引所単独上場銘柄)についてはデータの収録対象外となっています - -#### リクエストパラメータ - -データの取得では、銘柄コード(code)または通知日付(date)の指定が必須となります。 - -| パラメータ名 | 型 | 必須 | 説明 | 例 | -|------------|-----|------|------|-----| -| code | String | いいえ* | 銘柄コード | 27800 or 2780 | -| date | String | いいえ* | 通知日付 | 20210907 or 2021-09-07 | -| from | String | いいえ | 期間の開始日 | 20210901 or 2021-09-01 | -| to | String | いいえ | 期間の終了日 | 20210907 or 2021-09-07 | -| pagination_key | String | いいえ | 検索の先頭を指定する文字列 | 過去の検索で返却されたpagination_key | - -*codeまたはdateのいずれかが必須 - -#### 銘柄コード指定時の注意 -4桁の銘柄コードを指定した場合は、普通株式と優先株式の両方が上場している銘柄においては普通株式のデータのみが取得されます。 - -#### パラメータの組み合わせパターン - -| code | date | from/to | レスポンスの結果 | -|------|------|---------|-----------------| -| 指定あり | 指定なし | 指定なし | 指定された銘柄について取得可能期間の全データ | -| 指定あり | 指定なし | 指定あり | 指定された銘柄について指定された期間分のデータ | -| 指定なし | 指定あり | - | 全上場銘柄について指定された通知日付のデータ | - -#### リクエストヘッダー - -| ヘッダー名 | 型 | 必須 | 説明 | -|----------|-----|------|------| -| Authorization | String | はい | アクセスキー | - -#### レスポンスフィールド - -##### 基本情報 - -| フィールド名 | 日本語説明 | 型 | 備考 | -|------------|----------|-----|------| -| AnnouncementDate | 通知日時(年月日) | String | YYYY-MM-DD形式 | -| AnnouncementTime | 通知日時(時分) | String | HH:MI形式 | -| Code | 銘柄コード | String | | -| ReferenceNumber | リファレンスナンバー | String | 配当通知を一意に特定するための番号 | -| CAReferenceNumber | CAリファレンスナンバー | String | 訂正・削除の対象となっている配当通知のリファレンスナンバー。新規の場合はリファレンスナンバーと同じ値 | - -##### 更新・配当区分情報 - -| フィールド名 | 日本語説明 | 型 | 備考 | -|------------|----------|-----|------| -| StatusCode | 更新区分(コード) | String | 1: 新規、2: 訂正、3: 削除 | -| InterimFinalCode | 配当種類(コード) | String | 1: 中間配当、2: 期末配当 | -| ForecastResultCode | 予想/決定(コード) | String | 1: 決定、2: 予想 | -| CommemorativeSpecialCode | 記念配当/特別配当コード | String | 1: 記念配当、2: 特別配当、3: 記念・特別配当、0: 通常の配当 | - -##### 日程情報 - -| フィールド名 | 日本語説明 | 型 | 備考 | -|------------|----------|-----|------| -| BoardMeetingDate | 取締役会決議日 | String | YYYY-MM-DD形式 | -| InterimFinalTerm | 配当基準日年月 | String | YYYY-MM形式 | -| RecordDate | 基準日 | String | YYYY-MM-DD形式 | -| ExDate | 権利落日 | String | YYYY-MM-DD形式 | -| ActualRecordDate | 権利確定日 | String | YYYY-MM-DD形式 | -| PayableDate | 支払開始予定日 | String | YYYY-MM-DD形式、未定の場合: `-`、非設定の場合: 空文字 | - -##### 配当金額情報 - -| フィールド名 | 日本語説明 | 型 | 備考 | -|------------|----------|-----|------| -| GrossDividendRate | 1株当たり配当金額 | Number/String | 未定の場合: `-`、非設定の場合: 空文字 | -| CommemorativeDividendRate | 1株当たり記念配当金額 | Number/String | 未定の場合: `-`、非設定の場合: 空文字、2022年6月6日以降のみ提供 | -| SpecialDividendRate | 1株当たり特別配当金額 | Number/String | 未定の場合: `-`、非設定の場合: 空文字、2022年6月6日以降のみ提供 | - -##### 税務関連情報(2014年2月24日以降のみ提供) - -| フィールド名 | 日本語説明 | 型 | 備考 | -|------------|----------|-----|------| -| DistributionAmount | 1株当たりの交付金銭等の額 | Number/String | 未定の場合: `-`、非設定の場合: 空文字 | -| RetainedEarnings | 1株当たりの利益剰余金の額 | Number/String | 未定の場合: `-`、非設定の場合: 空文字 | -| DeemedDividend | 1株当たりのみなし配当の額 | Number/String | 未定の場合: `-`、非設定の場合: 空文字 | -| DeemedCapitalGains | 1株当たりのみなし譲渡収入の額 | Number/String | 未定の場合: `-`、非設定の場合: 空文字 | -| NetAssetDecreaseRatio | 純資産減少割合 | Number/String | 未定の場合: `-`、非設定の場合: 空文字 | - -## 配当の種類について - -### 配当種類(InterimFinalCode) -- **1: 中間配当**: 事業年度の中間時点で支払われる配当 -- **2: 期末配当**: 事業年度の終了時点で支払われる配当 - -### 予想/決定(ForecastResultCode) -- **1: 決定**: 正式に決定された配当 -- **2: 予想**: 会社が予想している配当額 - -### 記念配当/特別配当(CommemorativeSpecialCode) -- **0: 通常の配当**: 通常の業績に基づく配当 -- **1: 記念配当**: 創立記念等の特別な記念による配当 -- **2: 特別配当**: 特別な利益等による配当 -- **3: 記念・特別配当**: 記念配当と特別配当の両方 - -## リファレンスナンバーについて - -### リファレンスナンバー(ReferenceNumber) -配当通知を一意に特定するための番号。新規通知、訂正、削除のたびに新しい番号が割り当てられる。 - -### CAリファレンスナンバー(CAReferenceNumber) -訂正・削除の対象となっている配当通知のリファレンスナンバー。新規の場合はリファレンスナンバーと同じ値を設定。 - -### 具体例 -銘柄:日本取引所(銘柄コード:86970)について以下の通知があった場合: - -| 日付 | 通知内容 | ReferenceNumber | CAReferenceNumber | StatusCode | -|------|----------|-----------------|-------------------|------------| -| 2023-03-06 | 配当が新規で通知 | 1 | 1 | 1:新規 | -| 2023-03-07 | 配当が訂正情報として通知 | 2 | 1 | 2:訂正 | -| 2023-03-08 | 配当が削除された | 3 | 1 | 3:削除 | -| 2023-03-09 | 配当が新規で通知 | 4 | 4 | 1:新規 | - -## 重要な日程について - -### 基準日(RecordDate) -株主としての権利を確定する日。この日の株主名簿に記載されている株主が配当を受ける権利を有する。 - -### 権利落日(ExDate) -この日以降に株式を購入しても、その配当を受ける権利がない日。通常は基準日の2営業日前。 - -### 権利確定日(ActualRecordDate) -実際に株主の権利が確定する日。 - -### 支払開始予定日(PayableDate) -配当金の支払いが開始される予定日。 - -## 使用上の注意事項 - -1. **データ提供期間** - - 税務関連情報は2014年2月24日以降のみ提供 - - 記念・特別配当情報は2022年6月6日以降のみ提供 - -2. **未定・非設定の表現** - - 未定の場合: `-` - - 非設定の場合: 空文字 - -3. **更新区分の理解** - - 新規、訂正、削除の履歴がすべて保持される - - 最新の有効な情報を取得するには更新区分を考慮する必要がある - -4. **対象銘柄の制限** - - 東証上場銘柄のみが対象 - - 地方取引所単独上場銘柄は対象外 - -## サンプルレスポンス - -```json -{ - "dividend": [ - { - "AnnouncementDate": "2014-02-24", - "AnnouncementTime": "09:21", - "Code": "15550", - "ReferenceNumber": "201402241B00002", - "StatusCode": "1", - "BoardMeetingDate": "2014-02-24", - "InterimFinalCode": "2", - "ForecastResultCode": "2", - "InterimFinalTerm": "2014-03", - "GrossDividendRate": "-", - "RecordDate": "2014-03-10", - "ExDate": "2014-03-06", - "ActualRecordDate": "2014-03-10", - "PayableDate": "-", - "CAReferenceNumber": "201402241B00002", - "DistributionAmount": "", - "RetainedEarnings": "", - "DeemedDividend": "", - "DeemedCapitalGains": "", - "NetAssetDecreaseRatio": "", - "CommemorativeSpecialCode": "0", - "CommemorativeDividendRate": "", - "SpecialDividendRate": "" - } - ], - "pagination_key": "value1.value2." -} -``` - -## 活用例 - -### 特定銘柄の配当履歴を取得 -``` -/fins/dividend?code=86970&from=20230101&to=20231231 -``` - -### 特定日の全銘柄配当情報を取得 -``` -/fins/dividend?date=2023-03-06 -``` - -### 配当利回りの計算 -```javascript -// 年間配当利回りの計算例 -const annualDividend = interimDividend + finalDividend; -const dividendYield = (annualDividend / currentPrice) * 100; -``` - -### 権利確定スケジュールの確認 -権利落日(ExDate)と基準日(RecordDate)から投資タイミングを判断 - -### 配当成長率の分析 -過去の配当実績から配当成長パターンを分析 - -### 特別配当・記念配当の検出 -`CommemorativeSpecialCode`が0以外の銘柄で特別な配当を検出 - -## 関連情報 - -このAPIは配当金情報を提供するものです。関連する他のAPIについては以下を参照してください: -- 財務情報:`/fins/statements`(財務諸表データ) -- 財務諸表詳細:`/fins/fs_details`(BS/PL詳細データ) -- 決算発表予定日:`/fins/announcement`(決算発表スケジュール) -- 株価四本値:`/prices/daily_quotes`(株価データ) \ No newline at end of file diff --git a/docs/v1/fs_details.md b/docs/v1/fs_details.md deleted file mode 100644 index 1997d4d..0000000 --- a/docs/v1/fs_details.md +++ /dev/null @@ -1,216 +0,0 @@ -# J-Quants API 財務諸表(BS/PL)データ項目概要 - -このドキュメントは、J-Quants APIの財務諸表(BS/PL)エンドポイント (`/fins/fs_details`) のレスポンスデータ項目について説明します。 - -## データ型について -- 日付・時刻フィールドは `String` 型で返されます -- 財務諸表の各項目は `Map` 型で、キーが冗長ラベル(英語)、値が `String` 型で返されます -- 金額データは円単位で提供されます(特定銘柄を除く) - -## エンドポイント概要 - -### 財務諸表(BS/PL) (/fins/fs_details) - -#### 概要 -- **エンドポイント**: `https://api.jquants.com/v1/fins/fs_details` -- **HTTPメソッド**: GET -- **説明**: 上場企業の四半期毎の財務情報における、貸借対照表、損益計算書に記載の項目を取得することができます。 - -#### 本APIの特徴 -- **EDINET XBRLベース**: EDINETタクソノミ本体のlabel情報を使用 -- **会計基準対応**: 日本基準とIFRSの両方に対応 -- **四半期データ**: 四半期ごとの詳細な財務諸表データを提供 - -#### 本APIの留意点 - -##### FinancialStatement(財務諸表の各種項目)について -- **データソース**: EDINET XBRLタクソノミ本体(label情報)を用いてコンテンツを作成 -- **冗長ラベル参照先**: https://disclosure2dl.edinet-fsa.go.jp/guide/static/disclosure/WZEK0110.html -- **会計基準別データ提供**: - - **日本基準**: 「勘定科目リスト」のE列「冗長ラベル(英語)」をキーとして提供 - - **IFRS**: 「国際会計基準タクソノミ要素リスト」のD列「冗長ラベル(英語)」をキーとして提供 - -##### 提出者別タクソノミについて -- EDINETタクソノミには存在しない提出者別タクソノミで定義される企業独自の項目は、本APIの提供対象外 - -##### 特殊なケース -- **三井海洋開発(銘柄コード62690)**: 2022年2月以降の決算短信の連結財務諸表及び連結財務諸表注記を米ドルにより表示。当該銘柄の財務諸表情報は米ドルでの提供 - -#### リクエストパラメータ - -リクエストパラメータにcode(銘柄コード)またはdate(開示日)を入力する必要があります。 - -| パラメータ名 | 型 | 必須 | 説明 | 例 | -|------------|-----|------|------|-----| -| code | String | いいえ* | 4桁もしくは5桁の銘柄コード | 86970 or 8697 | -| date | String | いいえ* | 開示日 | 2022-01-05 or 20220105 | -| pagination_key | String | いいえ | 検索の先頭を指定する文字列 | 過去の検索で返却されたpagination_key | - -*codeまたはdateのいずれかが必須 - -#### リクエストヘッダー - -| ヘッダー名 | 型 | 必須 | 説明 | -|----------|-----|------|------| -| Authorization | String | はい | アクセスキー | - -#### レスポンスフィールド - -##### 基本情報 - -| フィールド名 | 日本語説明 | 型 | 備考 | -|------------|----------|-----|------| -| DisclosedDate | 開示日 | String | YYYY-MM-DD形式 | -| DisclosedTime | 開示時刻 | String | HH:MM:SS形式 | -| LocalCode | 銘柄コード(5桁) | String | | -| DisclosureNumber | 開示番号 | String | APIから出力されるjsonは開示番号で昇順に並んでいる | -| TypeOfDocument | 開示書類種別 | String | 開示書類種別一覧参照 | - -##### 財務諸表情報 - -| フィールド名 | 日本語説明 | 型 | 備考 | -|------------|----------|-----|------| -| FinancialStatement | 財務諸表の各種項目 | Map | 冗長ラベル(英語)とその値のマップ | - -## FinancialStatementの構造 - -FinancialStatementは、以下のような構造を持つMapオブジェクトです: -- **キー**: 冗長ラベル(英語) - XBRLタグと紐づく標準化された項目名 -- **値**: 財務諸表の値(String型) - -### 主要な項目例(日本基準) -- 資産の部:総資産、流動資産、固定資産等 -- 負債の部:総負債、流動負債、固定負債等 -- 純資産の部:株主資本、資本金、利益剰余金等 -- 損益計算書:売上高、営業利益、経常利益、当期純利益等 - -### 主要な項目例(IFRS) -サンプルレスポンスに含まれる項目例: -- **資産**: `Assets (IFRS)`, `Current assets (IFRS)`, `Non-current assets (IFRS)` -- **負債**: `Liabilities (IFRS)`, `Current liabilities (IFRS)`, `Non-current liabilities (IFRS)` -- **資本**: `Equity (IFRS)`, `Share capital (IFRS)`, `Retained earnings (IFRS)` -- **損益**: `Revenue - 2 (IFRS)`, `Operating profit (loss) (IFRS)`, `Profit (loss) (IFRS)` -- **その他重要項目**: `Goodwill (IFRS)`, `Basic earnings (loss) per share (IFRS)` - -## 会計基準について - -### 日本基準とIFRSの識別 -- **項目名の末尾**: IFRSの場合、項目名に `(IFRS)` が付与される -- **Accounting standards, DEI**: 会計基準を示すフィールド("IFRS"または"JapaneseGAAP") - -### EDINETタクソノミとの対応 -- **日本基準**: EDINETタクソノミの「勘定科目リスト」と対応 -- **IFRS**: EDINETタクソノミの「国際会計基準タクソノミ要素リスト」と対応 - -## 開示書類種別(TypeOfDocument) - -財務諸表のタイプを示す重要なフィールドです。詳細は開示書類種別一覧を参照してください。 - -主な種別例: -- `1QFinancialStatements_Consolidated_IFRS`: 第1四半期連結財務諸表(IFRS) -- `2QFinancialStatements_Consolidated_IFRS`: 第2四半期連結財務諸表(IFRS) -- `3QFinancialStatements_Consolidated_IFRS`: 第3四半期連結財務諸表(IFRS) -- `YearEndFinancialStatements_Consolidated_IFRS`: 通期連結財務諸表(IFRS) - -## 使用上の注意事項 - -1. **企業独自項目の除外** - - 提出者別タクソノミで定義される企業独自の項目は提供対象外 - - 標準化されたEDINETタクソノミ項目のみを提供 - -2. **通貨単位** - - 通常は円単位で提供 - - 三井海洋開発(62690)は2022年2月以降米ドル単位 - -3. **データの完全性** - - すべての企業がすべての項目を開示しているわけではない - - 開示されていない項目は含まれない - -4. **冗長ラベルの理解** - - 冗長ラベルは標準化された項目名 - - 同じ概念でも会計基準により異なるラベルを使用 - -## サンプルレスポンス - -```json -{ - "fs_details": [ - { - "DisclosedDate": "2023-01-30", - "DisclosedTime": "12:00:00", - "LocalCode": "86970", - "DisclosureNumber": "20230127594871", - "TypeOfDocument": "3QFinancialStatements_Consolidated_IFRS", - "FinancialStatement": { - "Goodwill (IFRS)": "67374000000", - "Retained earnings (IFRS)": "263894000000", - "Operating profit (loss) (IFRS)": "51765000000.0", - "Previous fiscal year end date, DEI": "2022-03-31", - "Basic earnings (loss) per share (IFRS)": "66.76", - "Document type, DEI": "四半期第3号参考様式 [IFRS](連結)", - "Current period end date, DEI": "2022-12-31", - "Revenue - 2 (IFRS)": "100987000000.0", - "Profit (loss) attributable to owners of parent (IFRS)": "35175000000.0", - "Current liabilities (IFRS)": "78852363000000", - "Equity attributable to owners of parent (IFRS)": "311103000000", - "Non-current liabilities (IFRS)": "33476000000", - "Property, plant and equipment (IFRS)": "11277000000", - "Cash and cash equivalents (IFRS)": "91135000000", - "Share capital (IFRS)": "11500000000", - "Assets (IFRS)": "79205861000000", - "Equity (IFRS)": "320021000000", - "Liabilities (IFRS)": "78885839000000", - "Accounting standards, DEI": "IFRS" - } - } - ], - "pagination_key": "value1.value2." -} -``` - -## 活用例 - -### 特定銘柄の最新財務諸表を取得 -``` -/fins/fs_details?code=86970&date=20230130 -``` - -### 特定日の全銘柄財務諸表を取得 -``` -/fins/fs_details?date=2023-01-30 -``` - -### 財務分析の実施 -```javascript -// ROE(自己資本利益率)の計算例 -const netIncome = parseFloat(fs["Profit (loss) attributable to owners of parent (IFRS)"]); -const equity = parseFloat(fs["Equity attributable to owners of parent (IFRS)"]); -const roe = (netIncome / equity) * 100; - -// 流動比率の計算例 -const currentAssets = parseFloat(fs["Current assets (IFRS)"]); -const currentLiabilities = parseFloat(fs["Current liabilities (IFRS)"]); -const currentRatio = currentAssets / currentLiabilities; -``` - -### 時系列財務分析 -複数期間の財務諸表を取得し、売上高成長率、利益率の推移等を分析 - -### 会計基準別の処理 -```javascript -// 会計基準の判定 -const accountingStandards = fs["Accounting standards, DEI"]; -if (accountingStandards === "IFRS") { - // IFRS用の処理 -} else { - // 日本基準用の処理 -} -``` - -## 関連情報 - -このAPIは詳細な財務諸表データを提供するものです。関連する他のAPIについては以下を参照してください: -- 財務情報:`/fins/statements`(財務サマリー情報) -- 配当金情報:`/fins/dividend`(配当データ) -- 決算発表予定日:`/fins/announcement`(決算発表スケジュール) -- 株価四本値:`/prices/daily_quotes`(株価データ) \ No newline at end of file diff --git a/docs/v1/futures.md b/docs/v1/futures.md deleted file mode 100644 index 78865ef..0000000 --- a/docs/v1/futures.md +++ /dev/null @@ -1,233 +0,0 @@ -# J-Quants API 先物四本値データ項目概要 - -このドキュメントは、J-Quants APIの先物四本値エンドポイント (`/derivatives/futures`) のレスポンスデータ項目について説明します。 - -## データ型について -- 日付フィールドは `String` 型で返されます(YYYY-MM-DD形式) -- 価格・数量データは `Number` 型で返されます -- 一部フィールドは条件により `String` 型(空文字)になる場合があります - -## エンドポイント概要 - -### 先物四本値 (/derivatives/futures) - -#### 概要 -- **エンドポイント**: `https://api.jquants.com/v1/derivatives/futures` -- **HTTPメソッド**: GET -- **説明**: 先物に関する、四本値や清算値段、理論価格に関する情報を取得することができます。 - -#### 対象商品 -本APIで取得可能なデータについては先物商品区分コード一覧を参照してください。 - -#### 本APIの留意点 - -##### 銘柄コードについて -- 先物・オプション取引識別コードの付番規則については[証券コード関係の関係資料等](https://www.jpx.co.jp/sicc/securities-code/01.html)を参照 - -##### 取引セッションについて -- **2011年2月10日以前**:ナイトセッション、前場、後場で構成 - - 前場データは収録されず、後場データが日中場データとして収録 - - 日通しデータについては、全立会を含めたデータ -- **2011年2月14日以降**:ナイトセッション、日中場で構成 - -##### 祝日取引について -- 祝日取引の取引日は、祝日取引実施日直前の平日に開始するナイト・セッション(祝日前営業日)及び祝日取引実施日直後の平日(祝日翌営業日)のデイ・セッションと同一の取引日として扱われる - -##### レスポンスのキー項目について -- 緊急取引証拠金が発動した場合は、同一の取引日・銘柄に対して清算価格算出時と緊急取引証拠金算出時のデータが発生 -- Date、Codeに加えてEmergencyMarginTriggerDivisionを組み合わせることでデータを一意に識別可能 - -#### リクエストパラメータ - -データの取得では、日付(date)の指定が必須となります。 - -| パラメータ名 | 型 | 必須 | 説明 | 例 | -|------------|-----|------|------|-----| -| date | String | はい | 取引日 | 20210901 or 2021-09-01 | -| category | String | いいえ | 商品区分の指定 | TOPIXF | -| contract_flag | String | いいえ | 中心限月フラグの指定 | 1 | -| pagination_key | String | いいえ | 検索の先頭を指定する文字列 | 過去の検索で返却されたpagination_key | - -#### リクエストヘッダー - -| ヘッダー名 | 型 | 必須 | 説明 | -|----------|-----|------|------| -| Authorization | String | はい | アクセスキー | - -#### レスポンスフィールド - -##### 基本情報 - -| フィールド名 | 日本語説明 | 型 | 備考 | -|------------|----------|-----|------| -| Code | 銘柄コード | String | | -| DerivativesProductCategory | 先物商品区分 | String | | -| Date | 取引日 | String | YYYY-MM-DD形式 | -| ContractMonth | 限月 | String | YYYY-MM形式 | -| EmergencyMarginTriggerDivision | 緊急取引証拠金発動区分 | String | 001: 緊急取引証拠金発動時、002: 清算価格算出時 ※1 | - -##### 四本値データ - -| フィールド名 | 日本語説明 | 型 | 備考 | -|------------|----------|-----|------| -| WholeDayOpen | 日通し始値 | Number | | -| WholeDayHigh | 日通し高値 | Number | | -| WholeDayLow | 日通し安値 | Number | | -| WholeDayClose | 日通し終値 | Number | | -| NightSessionOpen | ナイト・セッション始値 | Number/String | 取引開始日初日は空文字 | -| NightSessionHigh | ナイト・セッション高値 | Number/String | 取引開始日初日は空文字 | -| NightSessionLow | ナイト・セッション安値 | Number/String | 取引開始日初日は空文字 | -| NightSessionClose | ナイト・セッション終値 | Number/String | 取引開始日初日は空文字 | -| DaySessionOpen | 日中始値 | Number | | -| DaySessionHigh | 日中高値 | Number | | -| DaySessionLow | 日中安値 | Number | | -| DaySessionClose | 日中終値 | Number | | -| MorningSessionOpen | 前場始値 | Number/String | 前後場取引対象銘柄でない場合、空文字 | -| MorningSessionHigh | 前場高値 | Number/String | 前後場取引対象銘柄でない場合、空文字 | -| MorningSessionLow | 前場安値 | Number/String | 前後場取引対象銘柄でない場合、空文字 | -| MorningSessionClose | 前場終値 | Number/String | 前後場取引対象銘柄でない場合、空文字 | - -##### 取引情報 - -| フィールド名 | 日本語説明 | 型 | 備考 | -|------------|----------|-----|------| -| Volume | 取引高 | Number | | -| Volume(OnlyAuction) | 立会内取引高 | Number | ※1 | -| OpenInterest | 建玉 | Number | | -| TurnoverValue | 取引代金 | Number | | -| SettlementPrice | 清算値段 | Number | ※1 | - -##### その他情報 - -| フィールド名 | 日本語説明 | 型 | 備考 | -|------------|----------|-----|------| -| LastTradingDay | 取引最終年月日 | String | YYYY-MM-DD形式 ※1 | -| SpecialQuotationDay | SQ日 | String | YYYY-MM-DD形式 ※1 | -| CentralContractMonthFlag | 中心限月フラグ | String | 1:中心限月、0:その他 ※1 | - -※1 2016年7月19日以降のみ提供 - -## 先物商品区分コード一覧 - -| コード | 商品区分名称 | データ収録期間 | -|--------|------------|--------------| -| TOPIXF | TOPIX先物 | 2008/5/7〜 | -| TOPIXMF | ミニTOPIX先物 | 2008/6/16〜 | -| MOTF | マザーズ先物 | 2016/7/19〜 | -| NKVIF | 日経平均VI先物 | 2012/2/27〜 | -| NKYDF | 日経平均・配当指数先物 | 2010/7/26〜 | -| NK225F | 日経225先物 | 2008/5/7〜 | -| NK225MF | 日経225mini先物 | 2008/5/7〜 | -| JN400F | JPX日経インデックス400先物 | 2014/11/25〜 | -| REITF | 東証REIT指数先物 | 2008/6/16〜 | -| DJIAF | NYダウ先物 | 2012/5/28〜 | -| JGBLF | 長期国債先物 | 2008/5/7〜 | -| NK225MCF | 日経225マイクロ先物 | 2023/5/29〜 | -| TOA3MF | TONA3ヶ月金利先物 | 2023/5/29〜 | - -## 緊急取引証拠金発動区分について - -| 区分値 | 説明 | 備考 | -|-------|------|------| -| 001 | 緊急取引証拠金発動時 | 2016年7月19日以降に緊急取引証拠金発動した場合のみ収録 | -| 002 | 清算価格算出時 | 通常時のデータ | - -## 使用上の注意事項 - -1. **日付指定が必須** - - 他のAPIと異なり、日付(date)パラメータが必須 - - 期間指定(from/to)には対応していない - -2. **データの一意性** - - Date + Code + EmergencyMarginTriggerDivisionの組み合わせで一意 - - 緊急取引証拠金発動時は同じ日・銘柄で複数レコードが存在 - -3. **取引セッションの変更** - - 2011年2月を境に取引セッション構成が変更 - - ナイトセッションデータの有無に注意 - -4. **データ提供期間の制限** - - 一部フィールドは2016年7月19日以降のみ提供 - - 取引開始日初日はナイトセッションデータなし - -5. **祝日取引の扱い** - - 祝日取引は前営業日のナイトセッションと翌営業日のデイセッションと同一取引日 - -## サンプルレスポンス - -```json -{ - "futures": [ - { - "Code": "169090005", - "DerivativesProductCategory": "TOPIXF", - "Date": "2024-07-23", - "WholeDayOpen": 2825.5, - "WholeDayHigh": 2853.0, - "WholeDayLow": 2825.5, - "WholeDayClose": 2829.0, - "MorningSessionOpen": "", - "MorningSessionHigh": "", - "MorningSessionLow": "", - "MorningSessionClose": "", - "NightSessionOpen": 2825.5, - "NightSessionHigh": 2850.0, - "NightSessionLow": 2825.5, - "NightSessionClose": 2845.0, - "DaySessionOpen": 2850.5, - "DaySessionHigh": 2853.0, - "DaySessionLow": 2826.0, - "DaySessionClose": 2829.0, - "Volume": 42910.0, - "OpenInterest": 479812.0, - "TurnoverValue": 1217918971856.0, - "ContractMonth": "2024-09", - "Volume(OnlyAuction)": 40405.0, - "EmergencyMarginTriggerDivision": "002", - "LastTradingDay": "2024-09-12", - "SpecialQuotationDay": "2024-09-13", - "SettlementPrice": 2829.0, - "CentralContractMonthFlag": "1" - } - ], - "pagination_key": "value1.value2." -} -``` - -## 活用例 - -### 特定日の全先物データ取得 -``` -/derivatives/futures?date=20230324 -``` - -### 特定商品カテゴリのデータ取得 -``` -/derivatives/futures?date=20230324&category=NK225F -``` - -### 中心限月のみフィルタリング -``` -/derivatives/futures?date=20230324&contract_flag=1 -``` - -### 日経225先物とミニの比較 -NK225FとNK225MFのデータを取得し、価格差やボリューム比率を分析 - -### ナイトセッションと日中セッションの価格変動分析 -```javascript -// ギャップ(窓)の計算 -const nightToDay = response.DaySessionOpen - response.NightSessionClose; -const dayToNight = response.NightSessionOpen - response.DaySessionClose; -``` - -### 緊急取引証拠金発動日の確認 -`EmergencyMarginTriggerDivision`が"001"のレコードの有無を確認 - -## 関連情報 - -このAPIは先物の詳細データを提供するものです。関連する他のAPIについては以下を参照してください: -- 日経225オプション四本値:`/option/index_option`(日経225オプション専用) -- オプション四本値:`/derivatives/options`(汎用オプションAPI) -- 指数四本値:`/indices`(原資産となる指数データ) -- 取引カレンダー:`/markets/trading_calendar`(営業日・祝日取引日情報) \ No newline at end of file diff --git a/docs/v1/index_option.md b/docs/v1/index_option.md deleted file mode 100644 index fed43b7..0000000 --- a/docs/v1/index_option.md +++ /dev/null @@ -1,190 +0,0 @@ -# J-Quants API 日経225オプション四本値データ項目概要 - -このドキュメントは、J-Quants APIの日経225オプション四本値エンドポイント (`/option/index_option`) のレスポンスデータ項目について説明します。 - -## データ型について -- 日付フィールドは `String` 型で返されます(YYYY-MM-DD形式) -- 価格・数量データは `Number` 型で返されます -- 一部フィールドは条件により `String` 型(空文字)になる場合があります - -## エンドポイント概要 - -### 日経225オプション四本値 (/option/index_option) - -#### 概要 -- **エンドポイント**: `https://api.jquants.com/v1/option/index_option` -- **HTTPメソッド**: GET -- **説明**: 日経225オプションに関する、四本値や清算値段、理論価格に関する情報を取得することができます。 - -#### 対象商品 -- 日経225指数オプション(Weeklyオプション及びフレックスオプションを除く)のみ - -#### 本APIの留意点 - -##### 取引セッションについて -- **2011年2月10日以前**:ナイトセッション、前場、後場で構成 - - 前場データは収録されず、後場データが日中場データとして収録 - - 日通しデータについては、全立会を含めたデータ -- **2011年2月14日以降**:ナイトセッション、日中場で構成 - -##### レスポンスのキー項目について -- 緊急取引証拠金が発動した場合は、同一の取引日・銘柄に対して清算価格算出時と緊急取引証拠金算出時のデータが発生 -- Date、Codeに加えて`EmergencyMarginTriggerDivision`を組み合わせることでデータを一意に識別可能 - -#### リクエストパラメータ - -| パラメータ名 | 型 | 必須 | 説明 | 例 | -|------------|-----|------|------|-----| -| date | String | はい | 取引日 | 20210901 or 2021-09-01 | -| pagination_key | String | いいえ | 検索の先頭を指定する文字列 | 過去の検索で返却されたpagination_key | - -#### リクエストヘッダー - -| ヘッダー名 | 型 | 必須 | 説明 | -|----------|-----|------|------| -| Authorization | String | はい | アクセスキー | - -#### レスポンスフィールド - -##### 基本情報 - -| フィールド名 | 日本語説明 | 型 | 備考 | -|------------|----------|-----|------| -| Date | 取引日 | String | YYYY-MM-DD形式 | -| Code | 銘柄コード | String | | -| ContractMonth | 限月 | String | YYYY-MM形式 | -| StrikePrice | 権利行使価格 | Number | | -| PutCallDivision | プットコール区分 | String | 1: プット、2: コール | -| LastTradingDay | 取引最終年月日 | String | YYYY-MM-DD形式 ※1 | -| SpecialQuotationDay | SQ日 | String | YYYY-MM-DD形式 ※1 | -| EmergencyMarginTriggerDivision | 緊急取引証拠金発動区分 | String | 001: 緊急取引証拠金発動時、002: 清算価格算出時 | - -##### 四本値データ - -| フィールド名 | 日本語説明 | 型 | 備考 | -|------------|----------|-----|------| -| WholeDayOpen | 日通し始値 | Number | | -| WholeDayHigh | 日通し高値 | Number | | -| WholeDayLow | 日通し安値 | Number | | -| WholeDayClose | 日通し終値 | Number | | -| NightSessionOpen | ナイト・セッション始値 | Number/String | 取引開始日初日は空文字 | -| NightSessionHigh | ナイト・セッション高値 | Number/String | 取引開始日初日は空文字 | -| NightSessionLow | ナイト・セッション安値 | Number/String | 取引開始日初日は空文字 | -| NightSessionClose | ナイト・セッション終値 | Number/String | 取引開始日初日は空文字 | -| DaySessionOpen | 日中始値 | Number | | -| DaySessionHigh | 日中高値 | Number | | -| DaySessionLow | 日中安値 | Number | | -| DaySessionClose | 日中終値 | Number | | - -##### 取引情報 - -| フィールド名 | 日本語説明 | 型 | 備考 | -|------------|----------|-----|------| -| Volume | 取引高 | Number | | -| Volume(OnlyAuction) | 立会内取引高 | Number | ※1 | -| OpenInterest | 建玉 | Number | | -| TurnoverValue | 取引代金 | Number | | - -##### 価格・リスク情報 - -| フィールド名 | 日本語説明 | 型 | 備考 | -|------------|----------|-----|------| -| SettlementPrice | 清算値段 | Number | ※1 | -| TheoreticalPrice | 理論価格 | Number | ※1 | -| BaseVolatility | 基準ボラティリティ | Number | アット・ザ・マネープット及びコールそれぞれのインプライドボラティリティの中間値 ※1 | -| UnderlyingPrice | 原証券価格 | Number | ※1 | -| ImpliedVolatility | インプライドボラティリティ | Number | ※1 | -| InterestRate | 理論価格計算用金利 | Number | ※1 | - -※1 2016年7月19日以降のみ提供 - -## 緊急取引証拠金発動区分について - -| 区分値 | 説明 | 備考 | -|-------|------|------| -| 001 | 緊急取引証拠金発動時 | 2016年7月19日以降に緊急取引証拠金発動した場合のみ収録 | -| 002 | 清算価格算出時 | 通常時のデータ | - -## 使用上の注意事項 - -1. **日付指定が必須** - - 他のAPIと異なり、日付(date)パラメータが必須 - - 期間指定(from/to)には対応していない - -2. **データの一意性** - - Date + Code + EmergencyMarginTriggerDivisionの組み合わせで一意 - - 緊急取引証拠金発動時は同じ日・銘柄で複数レコードが存在 - -3. **取引セッションの変更** - - 2011年2月を境に取引セッション構成が変更 - - ナイトセッションデータの有無に注意 - -4. **データ提供期間の制限** - - 一部フィールドは2016年7月19日以降のみ提供 - - 取引開始日初日はナイトセッションデータなし - -## サンプルレスポンス - -```json -{ - "index_option": [ - { - "Date": "2023-03-22", - "Code": "130060018", - "WholeDayOpen": 0.0, - "WholeDayHigh": 0.0, - "WholeDayLow": 0.0, - "WholeDayClose": 0.0, - "NightSessionOpen": 0.0, - "NightSessionHigh": 0.0, - "NightSessionLow": 0.0, - "NightSessionClose": 0.0, - "DaySessionOpen": 0.0, - "DaySessionHigh": 0.0, - "DaySessionLow": 0.0, - "DaySessionClose": 0.0, - "Volume": 0.0, - "OpenInterest": 330.0, - "TurnoverValue": 0.0, - "ContractMonth": "2025-06", - "StrikePrice": 20000.0, - "Volume(OnlyAuction)": 0.0, - "EmergencyMarginTriggerDivision": "002", - "PutCallDivision": "1", - "LastTradingDay": "2025-06-12", - "SpecialQuotationDay": "2025-06-13", - "SettlementPrice": 980.0, - "TheoreticalPrice": 974.641, - "BaseVolatility": 17.93025, - "UnderlyingPrice": 27466.61, - "ImpliedVolatility": 23.1816, - "InterestRate": 0.2336 - } - ], - "pagination_key": "value1.value2." -} -``` - -## 活用例 - -### 特定日のオプション全銘柄データ取得 -``` -/option/index_option?date=20230324 -``` - -### プットオプションのみフィルタリング -レスポンスの`PutCallDivision`が"1"のデータを抽出 - -### コールオプションのみフィルタリング -レスポンスの`PutCallDivision`が"2"のデータを抽出 - -### 緊急取引証拠金発動日の確認 -`EmergencyMarginTriggerDivision`が"001"のレコードの有無を確認 - -## 関連情報 - -このAPIは日経225オプションの詳細データを提供するものです。関連する他のAPIについては以下を参照してください: -- 先物四本値:`/derivatives/futures`(日経225先物等) -- オプション四本値:`/derivatives/options`(汎用オプションAPI) -- 指数四本値:`/indices`(原証券である日経225指数等) -- 取引カレンダー:`/markets/trading_calendar`(営業日情報) \ No newline at end of file diff --git a/docs/v1/indices.md b/docs/v1/indices.md deleted file mode 100644 index 4ea2ce6..0000000 --- a/docs/v1/indices.md +++ /dev/null @@ -1,201 +0,0 @@ -# J-Quants API 指数四本値データ項目概要 - -このドキュメントは、J-Quants APIの指数四本値エンドポイント (`/indices`) のレスポンスデータ項目について説明します。 - -## データ型について -- フィールドは `String` 型または `Number` 型で返されます -- 日付は `String` 型で YYYY-MM-DD 形式 -- 指数値は `Number` 型 - -## エンドポイント概要 - -### 指数四本値 (/indices) - -#### 概要 -- **エンドポイント**: `https://api.jquants.com/v1/indices` -- **HTTPメソッド**: GET -- **説明**: 各種指数の四本値データを取得することができます。 - -#### 本APIの留意点 -- 2022年4月の東証市場区分再編によりマザーズ市場は廃止されていますが、一定のルールに基づき東証マザーズ指数の構成銘柄の入替を行い、2023年11月6日より指数名称を「東証グロース市場250指数」に変更されています -- 2020年10月1日のデータは東京証券取引所の株式売買システムの障害により終日売買停止となった関係で、四本値は前営業日(2020年9月30日)の終値が収録されています - -#### リクエストパラメータ - -データの取得では、指数コード(code)または日付(date)の指定が必須となります。 - -| パラメータ名 | 型 | 必須 | 説明 | 例 | -|------------|-----|------|------|-----| -| code | String | いいえ* | 指数コード | 0000 or 0028 | -| date | String | いいえ* | 基準となる日付 | 20210907 or 2021-09-07 | -| from | String | いいえ | 期間の開始日 | 20210901 or 2021-09-01 | -| to | String | いいえ | 期間の終了日 | 20210907 or 2021-09-07 | -| pagination_key | String | いいえ | 検索の先頭を指定する文字列 | 過去の検索で返却されたpagination_key | - -\* codeまたはdateのいずれかは必須 - -#### レスポンスフィールド - -| フィールド名 | 日本語説明 | 型 | 備考 | -|------------|----------|-----|------| -| Date | 日付 | String | YYYY-MM-DD形式 | -| Code | 指数コード | String | 配信対象の指数コード一覧参照 | -| Open | 始値 | Number | | -| High | 高値 | Number | | -| Low | 安値 | Number | | -| Close | 終値 | Number | | - -## 配信対象指数コード一覧 - -### TOPIX関連指数 - -| コード | 指数名称 | データ収録期間 | -|-------|---------|--------------| -| 0000 | TOPIX | 2008/5/7〜 | -| 0001 | 東証二部総合指数 | 2008/5/7〜2022/4/1 | -| 0028 | TOPIX Core30 | 2008/5/7〜 | -| 0029 | TOPIX Large 70 | 2008/5/7〜 | -| 002A | TOPIX 100 | 2008/5/7〜 | -| 002B | TOPIX Mid400 | 2008/5/7〜 | -| 002C | TOPIX 500 | 2008/5/7〜 | -| 002D | TOPIX Small | 2008/5/7〜 | -| 002E | TOPIX 1000 | 2008/5/7〜 | -| 002F | TOPIX Small500 | (四本値)2018/10/9〜 (終値のみ)2018/9/3〜 | - -### 東証33業種別指数 - -| コード | 指数名称 | データ収録期間 | -|-------|---------|--------------| -| 0040 | 東証業種別 水産・農林業 | 2008/5/7〜 | -| 0041 | 東証業種別 鉱業 | 2008/5/7〜 | -| 0042 | 東証業種別 建設業 | 2008/5/7〜 | -| 0043 | 東証業種別 食料品 | 2008/5/7〜 | -| 0044 | 東証業種別 繊維製品 | 2008/5/7〜 | -| 0045 | 東証業種別 パルプ・紙 | 2008/5/7〜 | -| 0046 | 東証業種別 化学 | 2008/5/7〜 | -| 0047 | 東証業種別 医薬品 | 2008/5/7〜 | -| 0048 | 東証業種別 石油・石炭製品 | 2008/5/7〜 | -| 0049 | 東証業種別 ゴム製品 | 2008/5/7〜 | -| 004A | 東証業種別 ガラス・土石製品 | 2008/5/7〜 | -| 004B | 東証業種別 鉄鋼 | 2008/5/7〜 | -| 004C | 東証業種別 非鉄金属 | 2008/5/7〜 | -| 004D | 東証業種別 金属製品 | 2008/5/7〜 | -| 004E | 東証業種別 機械 | 2008/5/7〜 | -| 004F | 東証業種別 電気機器 | 2008/5/7〜 | -| 0050 | 東証業種別 輸送用機器 | 2008/5/7〜 | -| 0051 | 東証業種別 精密機器 | 2008/5/7〜 | -| 0052 | 東証業種別 その他製品 | 2008/5/7〜 | -| 0053 | 東証業種別 電気・ガス業 | 2008/5/7〜 | -| 0054 | 東証業種別 陸運業 | 2008/5/7〜 | -| 0055 | 東証業種別 海運業 | 2008/5/7〜 | -| 0056 | 東証業種別 空運業 | 2008/5/7〜 | -| 0057 | 東証業種別 倉庫・運輸関連業 | 2008/5/7〜 | -| 0058 | 東証業種別 情報・通信業 | 2008/5/7〜 | -| 0059 | 東証業種別 卸売業 | 2008/5/7〜 | -| 005A | 東証業種別 小売業 | 2008/5/7〜 | -| 005B | 東証業種別 銀行業 | 2008/5/7〜 | -| 005C | 東証業種別 証券・商品先物取引業 | 2008/5/7〜 | -| 005D | 東証業種別 保険業 | 2008/5/7〜 | -| 005E | 東証業種別 その他金融業 | 2008/5/7〜 | -| 005F | 東証業種別 不動産業 | 2008/5/7〜 | -| 0060 | 東証業種別 サービス業 | 2008/5/7〜 | - -### その他市場指数 - -| コード | 指数名称 | データ収録期間 | -|-------|---------|--------------| -| 0070 | 東証グロース市場250指数 (旧:東証マザーズ指数) | 2008/5/7〜 | -| 0075 | REIT | 2008/5/7〜 | -| 0091 | JASDAQ INDEX | 2008/5/7〜2022/4/1 | - -### TOPIX-17シリーズ - -| コード | 指数名称 | データ収録期間 | -|-------|---------|--------------| -| 0080 | TOPIX-17 食品 | 2009/2/2〜 | -| 0081 | TOPIX-17 エネルギー資源 | 2009/2/2〜 | -| 0082 | TOPIX-17 建設・資材 | 2009/2/2〜 | -| 0083 | TOPIX-17 素材・化学 | 2009/2/2〜 | -| 0084 | TOPIX-17 医薬品 | 2009/2/2〜 | -| 0085 | TOPIX-17 自動車・輸送機 | 2009/2/2〜 | -| 0086 | TOPIX-17 鉄鋼・非鉄 | 2009/2/2〜 | -| 0087 | TOPIX-17 機械 | 2009/2/2〜 | -| 0088 | TOPIX-17 電機・精密 | 2009/2/2〜 | -| 0089 | TOPIX-17 情報通信・サービスその他 | 2009/2/2〜 | -| 008A | TOPIX-17 電力・ガス | 2009/2/2〜 | -| 008B | TOPIX-17 運輸・物流 | 2009/2/2〜 | -| 008C | TOPIX-17 商社・卸売 | 2009/2/2〜 | -| 008D | TOPIX-17 小売 | 2009/2/2〜 | -| 008E | TOPIX-17 銀行 | 2009/2/2〜 | -| 008F | TOPIX-17 金融(除く銀行) | 2009/2/2〜 | -| 0090 | TOPIX-17 不動産 | 2009/2/2〜 | - -### 新市場区分指数 - -| コード | 指数名称 | データ収録期間 | -|-------|---------|--------------| -| 0500 | 東証プライム市場指数 | 2022/6/27〜 | -| 0501 | 東証スタンダード市場指数 | 2022/6/27〜 | -| 0502 | 東証グロース市場指数 | 2022/6/27〜 | -| 0503 | JPXプライム150指数 | (四本値)2023/7/3〜 (終値のみ)2023/5/29〜 | - -### スタイル別指数 - -| コード | 指数名称 | データ収録期間 | -|-------|---------|--------------| -| 8100 | TOPIX バリュー | 2009/2/9〜 | -| 812C | TOPIX500 バリュー | 2009/2/9〜 | -| 812D | TOPIXSmall バリュー | 2009/2/9〜 | -| 8200 | TOPIX グロース | 2009/2/9〜 | -| 822C | TOPIX500 グロース | 2009/2/9〜 | -| 822D | TOPIXSmall グロース | 2009/2/9〜 | - -### REIT関連指数 - -| コード | 指数名称 | データ収録期間 | -|-------|---------|--------------| -| 8501 | 東証REIT オフィス指数 | (四本値)2010/3/8〜 (終値のみ)2010/3/1〜 | -| 8502 | 東証REIT 住宅指数 | (四本値)2010/3/8〜 (終値のみ)2010/3/1〜 | -| 8503 | 東証REIT 商業・物流等指数 | (四本値)2010/3/8〜 (終値のみ)2010/3/1〜 | - -## 使用上の注意事項 - -1. **データの取得制限** - - 指数コード(code)または日付(date)の指定が必須 - - レスポンスが大きすぎる場合はpagination_keyを使用して分割取得 - -2. **市場区分再編の影響** - - 2022年4月の市場区分再編により、一部指数のデータ収録が終了 - - 東証マザーズ指数は東証グロース市場250指数として継続 - -3. **特殊なケース** - - 2020/10/1:システム障害により前営業日の終値を収録 - - 一部指数は終値のみ先行して配信開始後、四本値の配信を開始 - -4. **指数コードの表記** - - 16進数表記を使用(例:002A = TOPIX 100) - -## サンプルレスポンス - -```json -{ - "indices": [ - { - "Date": "2023-12-01", - "Code": "0028", - "Open": 1199.18, - "High": 1202.58, - "Low": 1195.01, - "Close": 1200.17 - } - ], - "pagination_key": "value1.value2." -} -``` - -## 関連情報 - -このAPIは各種指数の四本値データを提供するものです。関連する他のAPIについては以下を参照してください: -- TOPIX指数四本値:`/indices/topix`(TOPIX専用エンドポイント) -- 株価四本値:`/prices/daily_quotes`(個別銘柄) -- 上場銘柄一覧:`/listed/info` \ No newline at end of file diff --git a/docs/v1/listed_info.md b/docs/v1/listed_info.md deleted file mode 100644 index 7eaa35d..0000000 --- a/docs/v1/listed_info.md +++ /dev/null @@ -1,156 +0,0 @@ -# J-Quants API 上場銘柄一覧データ項目概要 - -このドキュメントは、J-Quants APIの上場銘柄一覧エンドポイント (`/listed/info`) およびその関連エンドポイントのレスポンスデータ項目について説明します。 - -## データ型について -- すべてのフィールドは `String` 型で返されます -- 数値データも文字列として格納されています -- 空文字列 (`""`) は値が存在しないことを示します - -## エンドポイント一覧 - -### 1. 上場銘柄一覧 (/listed/info) - -#### 概要 -- **エンドポイント**: `https://api.jquants.com/v1/listed/info` -- **HTTPメソッド**: GET -- **説明**: 上場企業の情報を取得する事ができます。過去時点での銘柄情報、当日の銘柄情報および翌営業日時点の銘柄情報が取得可能です。ただし、翌営業日時点の銘柄情報については17時半以降に取得可能となります。 - -#### リクエストパラメータ - -| パラメータ名 | 型 | 必須 | 説明 | 例 | -|------------|-----|------|------|-----| -| code | String | いいえ | 銘柄コード | 27890 or 2789 | -| date | String | いいえ | 基準となる日付 | 20210907 or 2021-09-07 | - -#### レスポンスフィールド - -| フィールド名 | 日本語説明 | 備考 | -|------------|----------|------| -| Date | 日付 | YYYY-MM-DD形式 | -| Code | 銘柄コード | 4桁または5桁 | -| CompanyName | 企業名 | | -| CompanyNameEnglish | 企業名(英語) | | -| LocalCode | ローカルコード | 5桁の銘柄コード | -| MarketCode | 市場区分コード | 市場区分を識別するコード | -| MarketCodeName | 市場区分名 | 市場区分の日本語名称 | -| Sector17Code | 17業種コード | 17業種分類コード | -| Sector17CodeName | 17業種コード名 | 17業種分類の日本語名称 | -| Sector33Code | 33業種コード | 33業種分類コード | -| Sector33CodeName | 33業種コード名 | 33業種分類の日本語名称 | -| ScaleCategory | 規模コード | 企業規模を示すコード | -| IsDelisted | 上場廃止フラグ | true/false | - -### 2. 市場区分コード及び市場区分名 - -#### 概要 -- **説明**: 市場区分のマスターデータを提供します -- **用途**: MarketCodeとMarketCodeNameの対応関係を確認する際に使用 - -#### 市場区分コード一覧 - -| コード | 名称 | -|-------|------| -| 0101 | 東証一部 | -| 0102 | 東証二部 | -| 0104 | マザーズ | -| 0105 | TOKYO PRO MARKET | -| 0106 | JASDAQ スタンダード | -| 0107 | JASDAQ グロース | -| 0109 | その他 | -| 0111 | プライム | -| 0112 | スタンダード | -| 0113 | グロース | - -注:2022年4月の市場再編により、東証一部・二部・マザーズ・JASDAQは、プライム・スタンダード・グロースの3市場に再編されました。 - -### 3. 17業種コード及び業種名 - -#### 概要 -- **説明**: 17業種分類のマスターデータを提供します -- **用途**: Sector17CodeとSector17CodeNameの対応関係を確認する際に使用 - -#### 17業種分類 -| コード | 業種名 | -|-------|--------| -| 1 | 食品 | -| 2 | エネルギー資源 | -| 3 | 建設・資材 | -| 4 | 素材・化学 | -| 5 | 医薬品 | -| 6 | 自動車・輸送機 | -| 7 | 鉄鋼・非鉄 | -| 8 | 機械 | -| 9 | 電機・精密 | -| 10 | 情報通信・サービスその他 | -| 11 | 電力・ガス | -| 12 | 運輸・物流 | -| 13 | 商社・卸売 | -| 14 | 小売 | -| 15 | 銀行 | -| 16 | 金融(除く銀行) | -| 17 | 不動産 | -| 99 | その他 | - -### 4. 33業種コード及び業種名 - -#### 概要 -- **説明**: 33業種分類のマスターデータを提供します -- **用途**: Sector33CodeとSector33CodeNameの対応関係を確認する際に使用 -- **特徴**: 17業種分類よりも詳細な業種分類を提供 - -#### 33業種分類 -| コード | 業種名 | -|-------|--------| -| 0050 | 水産・農林業 | -| 1050 | 鉱業 | -| 2050 | 建設業 | -| 3050 | 食料品 | -| 3100 | 繊維製品 | -| 3150 | パルプ・紙 | -| 3200 | 化学 | -| 3250 | 医薬品 | -| 3300 | 石油・石炭製品 | -| 3350 | ゴム製品 | -| 3400 | ガラス・土石製品 | -| 3450 | 鉄鋼 | -| 3500 | 非鉄金属 | -| 3550 | 金属製品 | -| 3600 | 機械 | -| 3650 | 電気機器 | -| 3700 | 輸送用機器 | -| 3750 | 精密機器 | -| 3800 | その他製品 | -| 4050 | 電気・ガス業 | -| 5050 | 陸運業 | -| 5100 | 海運業 | -| 5150 | 空運業 | -| 5200 | 倉庫・運輸関連業 | -| 5250 | 情報・通信業 | -| 6050 | 卸売業 | -| 6100 | 小売業 | -| 7050 | 銀行業 | -| 7100 | 証券・商品先物取引業 | -| 7150 | 保険業 | -| 7200 | その他金融業 | -| 8050 | 不動産業 | -| 9050 | サービス業 | -| 9999 | その他 | - -## 使用上の注意事項 - -1. **日付について** - - 過去時点、当日、翌営業日の銘柄情報が取得可能 - - 翌営業日時点の銘柄情報は17時半以降に取得可能 - -2. **銘柄コードについて** - - 4桁または5桁の形式をサポート - - LocalCodeは常に5桁形式 - -3. **上場廃止銘柄について** - - IsDelistedフラグで上場廃止状態を確認 - - 過去の日付を指定することで、過去の上場銘柄情報を取得可能 - -## 関連情報 - -このAPIは銘柄の基本情報を提供するものです。財務情報については別途 `/fins/statements` エンドポイントを使用してください。 \ No newline at end of file diff --git a/docs/v1/options.md b/docs/v1/options.md deleted file mode 100644 index 44a229f..0000000 --- a/docs/v1/options.md +++ /dev/null @@ -1,273 +0,0 @@ -# J-Quants API オプション四本値データ項目概要 - -このドキュメントは、J-Quants APIのオプション四本値エンドポイント (`/derivatives/options`) のレスポンスデータ項目について説明します。 - -## データ型について -- 日付フィールドは `String` 型で返されます(YYYY-MM-DD形式) -- 価格・数量データは `Number` 型で返されます -- 一部フィールドは条件により `String` 型(空文字)になる場合があります - -## エンドポイント概要 - -### オプション四本値 (/derivatives/options) - -#### 概要 -- **エンドポイント**: `https://api.jquants.com/v1/derivatives/options` -- **HTTPメソッド**: GET -- **説明**: オプションに関する、四本値や清算値段、理論価格に関する情報を取得することができます。 - -#### 対象商品 -本APIで取得可能なデータについてはオプション商品区分コード一覧を参照してください。 - -#### 本APIの留意点 - -##### 銘柄コードについて -- 先物・オプション取引識別コードの付番規則については[証券コード関係の関係資料等](https://www.jpx.co.jp/sicc/securities-code/01.html)を参照 - -##### 取引セッションについて -- **2011年2月10日以前**:ナイトセッション、前場、後場で構成 - - 前場データは収録されず、後場データが日中場データとして収録 - - 日通しデータについては、全立会を含めたデータ -- **2011年2月14日以降**:ナイトセッション、日中場で構成 - -##### 祝日取引について -- 祝日取引の取引日は、祝日取引実施日直前の平日に開始するナイト・セッション(祝日前営業日)及び祝日取引実施日直後の平日(祝日翌営業日)のデイ・セッションと同一の取引日として扱われる - -##### レスポンスのキー項目について -- 緊急取引証拠金が発動した場合は、同一の取引日・銘柄に対して清算価格算出時と緊急取引証拠金算出時のデータが発生 -- Date、Codeに加えてEmergencyMarginTriggerDivisionを組み合わせることでデータを一意に識別可能 - -#### リクエストパラメータ - -データの取得では、日付(date)の指定が必須となります。 - -| パラメータ名 | 型 | 必須 | 説明 | 例 | -|------------|-----|------|------|-----| -| date | String | はい | 取引日 | 20210901 or 2021-09-01 | -| category | String | いいえ | 商品区分の指定 | TOPIXE | -| code | String | いいえ | 対象有価証券コード(categoryで有価証券オプションを指定した場合に設定) | 7203 | -| contract_flag | String | いいえ | 中心限月フラグの指定 | 1 | -| pagination_key | String | いいえ | 検索の先頭を指定する文字列 | 過去の検索で返却されたpagination_key | - -#### リクエストヘッダー - -| ヘッダー名 | 型 | 必須 | 説明 | -|----------|-----|------|------| -| Authorization | String | はい | アクセスキー | - -#### レスポンスフィールド - -##### 基本情報 - -| フィールド名 | 日本語説明 | 型 | 備考 | -|------------|----------|-----|------| -| Code | 銘柄コード | String | | -| DerivativesProductCategory | オプション商品区分 | String | | -| UnderlyingSSO | 有価証券オプション対象銘柄 | String | 有価証券オプション以外の場合は"-"を設定 | -| Date | 取引日 | String | YYYY-MM-DD形式 | -| ContractMonth | 限月 | String | YYYY-MM形式、日経225miniオプションの場合は週表記(e.g. 2024-51: 2024年の51週目) | -| StrikePrice | 権利行使価格 | Number | | -| PutCallDivision | プットコール区分 | String | 1: プット、2: コール | -| EmergencyMarginTriggerDivision | 緊急取引証拠金発動区分 | String | 001: 緊急取引証拠金発動時、002: 清算価格算出時 ※1 | - -##### 四本値データ - -| フィールド名 | 日本語説明 | 型 | 備考 | -|------------|----------|-----|------| -| WholeDayOpen | 日通し始値 | Number | | -| WholeDayHigh | 日通し高値 | Number | | -| WholeDayLow | 日通し安値 | Number | | -| WholeDayClose | 日通し終値 | Number | | -| NightSessionOpen | ナイト・セッション始値 | Number/String | 取引開始日初日は空文字 | -| NightSessionHigh | ナイト・セッション高値 | Number/String | 取引開始日初日は空文字 | -| NightSessionLow | ナイト・セッション安値 | Number/String | 取引開始日初日は空文字 | -| NightSessionClose | ナイト・セッション終値 | Number/String | 取引開始日初日は空文字 | -| DaySessionOpen | 日中始値 | Number | | -| DaySessionHigh | 日中高値 | Number | | -| DaySessionLow | 日中安値 | Number | | -| DaySessionClose | 日中終値 | Number | | -| MorningSessionOpen | 前場始値 | Number/String | 前後場取引対象銘柄でない場合、空文字 | -| MorningSessionHigh | 前場高値 | Number/String | 前後場取引対象銘柄でない場合、空文字 | -| MorningSessionLow | 前場安値 | Number/String | 前後場取引対象銘柄でない場合、空文字 | -| MorningSessionClose | 前場終値 | Number/String | 前後場取引対象銘柄でない場合、空文字 | - -##### 取引情報 - -| フィールド名 | 日本語説明 | 型 | 備考 | -|------------|----------|-----|------| -| Volume | 取引高 | Number | | -| Volume(OnlyAuction) | 立会内取引高 | Number | ※1 | -| OpenInterest | 建玉 | Number | | -| TurnoverValue | 取引代金 | Number | | - -##### 価格・リスク情報 - -| フィールド名 | 日本語説明 | 型 | 備考 | -|------------|----------|-----|------| -| SettlementPrice | 清算値段 | Number | ※1 | -| TheoreticalPrice | 理論価格 | Number | ※1 | -| BaseVolatility | 基準ボラティリティ | Number | ※1 | -| UnderlyingPrice | 原証券価格 | Number | ※1 | -| ImpliedVolatility | インプライドボラティリティ | Number | ※1 | -| InterestRate | 理論価格計算用金利 | Number | ※1 | - -##### その他情報 - -| フィールド名 | 日本語説明 | 型 | 備考 | -|------------|----------|-----|------| -| LastTradingDay | 取引最終年月日 | String | YYYY-MM-DD形式 ※1 | -| SpecialQuotationDay | SQ日 | String | YYYY-MM-DD形式 ※1 | -| CentralContractMonthFlag | 中心限月フラグ | String | 1:中心限月、0:その他 ※1 | - -※1 2016年7月19日以降のみ提供 - -## オプション商品区分コード一覧 - -| 商品区分コード | 商品区分名称 | データ収録期間 | -|--------------|------------|--------------| -| TOPIXE | TOPIXオプション | 2008/5/7〜 | -| NK225E | 日経225オプション | 2008/5/7〜 | -| JGBLFE | 長期国債先物オプション | 2008/5/7〜 | -| EQOP | 有価証券オプション | 2014/11/17〜 | -| NK225MWE | 日経225miniオプション | 2023/5/29〜 | - -## プットコール区分について - -| 区分値 | 説明 | 内容 | -|-------|------|------| -| 1 | プット | 売る権利(原資産価格が下落した場合に利益) | -| 2 | コール | 買う権利(原資産価格が上昇した場合に利益) | - -## 緊急取引証拠金発動区分について - -| 区分値 | 説明 | 備考 | -|-------|------|------| -| 001 | 緊急取引証拠金発動時 | 2016年7月19日以降に緊急取引証拠金発動した場合のみ収録 | -| 002 | 清算価格算出時 | 通常時のデータ | - -## 使用上の注意事項 - -1. **日付指定が必須** - - 他のAPIと異なり、日付(date)パラメータが必須 - - 期間指定(from/to)には対応していない - -2. **データの一意性** - - Date + Code + EmergencyMarginTriggerDivisionの組み合わせで一意 - - 緊急取引証拠金発動時は同じ日・銘柄で複数レコードが存在 - -3. **取引セッションの変更** - - 2011年2月を境に取引セッション構成が変更 - - ナイトセッションデータの有無に注意 - -4. **データ提供期間の制限** - - 一部フィールドは2016年7月19日以降のみ提供 - - 取引開始日初日はナイトセッションデータなし - -5. **限月表記の違い** - - 通常オプション:YYYY-MM形式(月表記) - - 日経225miniオプション:YYYY-WW形式(週表記) - -6. **有価証券オプション** - - categoryでEQOPを指定した場合は、codeパラメータで対象銘柄を指定 - -## サンプルレスポンス - -```json -{ - "options": [ - { - "Code": "140014505", - "DerivativesProductCategory": "TOPIXE", - "UnderlyingSSO": "-", - "Date": "2024-07-23", - "WholeDayOpen": 0.0, - "WholeDayHigh": 0.0, - "WholeDayLow": 0.0, - "WholeDayClose": 0.0, - "MorningSessionOpen": "", - "MorningSessionHigh": "", - "MorningSessionLow": "", - "MorningSessionClose": "", - "NightSessionOpen": 0.0, - "NightSessionHigh": 0.0, - "NightSessionLow": 0.0, - "NightSessionClose": 0.0, - "DaySessionOpen": 0.0, - "DaySessionHigh": 0.0, - "DaySessionLow": 0.0, - "DaySessionClose": 0.0, - "Volume": 0.0, - "OpenInterest": 0.0, - "TurnoverValue": 0.0, - "ContractMonth": "2025-01", - "StrikePrice": 2450.0, - "Volume(OnlyAuction)": 0.0, - "EmergencyMarginTriggerDivision": "002", - "PutCallDivision": "2", - "LastTradingDay": "2025-01-09", - "SpecialQuotationDay": "2025-01-10", - "SettlementPrice": 377.0, - "TheoreticalPrice": 380.3801, - "BaseVolatility": 18.115, - "UnderlyingPrice": 2833.39, - "ImpliedVolatility": 17.2955, - "InterestRate": 0.3527, - "CentralContractMonthFlag": "0" - } - ], - "pagination_key": "value1.value2." -} -``` - -## 活用例 - -### 特定日の全オプションデータ取得 -``` -/derivatives/options?date=20230324 -``` - -### 特定商品カテゴリのデータ取得 -``` -/derivatives/options?date=20230324&category=NK225E -``` - -### プットオプションのみフィルタリング -レスポンスの`PutCallDivision`が"1"のデータを抽出 - -### コールオプションのみフィルタリング -レスポンスの`PutCallDivision`が"2"のデータを抽出 - -### 有価証券オプションの取得 -``` -/derivatives/options?date=20230324&category=EQOP&code=7203 -``` - -### ボラティリティ分析 -```javascript -// ボラティリティスマイルの確認 -const sameExpiry = response.options.filter(opt => - opt.ContractMonth === "2025-01" -); -// 権利行使価格別のインプライドボラティリティを比較 -``` - -### イン・ザ・マネー(ITM)判定 -```javascript -// コールオプションのITM判定 -const isCallITM = opt.PutCallDivision === "2" && - opt.UnderlyingPrice > opt.StrikePrice; -// プットオプションのITM判定 -const isPutITM = opt.PutCallDivision === "1" && - opt.UnderlyingPrice < opt.StrikePrice; -``` - -### 緊急取引証拠金発動日の確認 -`EmergencyMarginTriggerDivision`が"001"のレコードの有無を確認 - -## 関連情報 - -このAPIはオプションの詳細データを提供するものです。関連する他のAPIについては以下を参照してください: -- 日経225オプション四本値:`/option/index_option`(日経225オプション専用) -- 先物四本値:`/derivatives/futures`(先物データ) -- 指数四本値:`/indices`(原資産となる指数データ) -- 取引カレンダー:`/markets/trading_calendar`(営業日・祝日取引日情報) \ No newline at end of file diff --git a/docs/v1/prices_am.md b/docs/v1/prices_am.md deleted file mode 100644 index b36385e..0000000 --- a/docs/v1/prices_am.md +++ /dev/null @@ -1,181 +0,0 @@ -# J-Quants API 前場四本値データ項目概要 - -このドキュメントは、J-Quants APIの前場四本値エンドポイント (`/prices/prices_am`) のレスポンスデータ項目について説明します。 - -## データ型について -- 日付フィールドは `String` 型で返されます(YYYY-MM-DD形式) -- 価格・数量データは `Number` 型で返されます -- 取引のない銘柄については `Null` が収録されます - -## エンドポイント概要 - -### 前場四本値 (/prices/prices_am) - -#### 概要 -- **エンドポイント**: `https://api.jquants.com/v1/prices/prices_am` -- **HTTPメソッド**: GET -- **説明**: 前場終了時に、前場の株価データを取得することができます。 - -#### 本APIの特徴 -- **リアルタイム性**: 前場終了後に当日の前場データを即座に取得可能 -- **当日限定**: 当日のデータは翌日6:00頃まで取得可能 -- **ヒストリカルデータ**: 過去の前場四本値については株価四本値APIを利用 - -#### 本APIの留意点 -- **取引のない銘柄**: 前場の取引高が存在しない(売買されていない)銘柄についての四本値、取引高と売買代金は、Nullが収録されています -- **対象銘柄**: 東証上場銘柄でない銘柄(地方取引所単独上場銘柄)についてはデータの収録対象外となっています -- **データ取得時間**: 当日のデータは翌日6:00頃まで取得可能です -- **ヒストリカルデータ**: ヒストリカルの前場四本値については株価四本値(`/prices/daily_quotes`)をご利用ください - -#### リクエストパラメータ - -| パラメータ名 | 型 | 必須 | 説明 | 例 | -|------------|-----|------|------|-----| -| code | String | いいえ | 銘柄コード | 27800 or 2780 | -| pagination_key | String | いいえ | 検索の先頭を指定する文字列 | 過去の検索で返却されたpagination_key | - -#### 銘柄コード指定時の注意 -4桁の銘柄コードを指定した場合は、普通株式と優先株式の両方が上場している銘柄においては普通株式のデータのみが取得されます。 - -#### パラメータの組み合わせパターン - -| code | レスポンスの結果 | -|------|-----------------| -| 指定あり | 指定された銘柄についての前場の株価データ | -| 指定なし | 全上場銘柄について前場の株価データ | - -#### リクエストヘッダー - -| ヘッダー名 | 型 | 必須 | 説明 | -|----------|-----|------|------| -| Authorization | String | はい | アクセスキー | - -#### レスポンスフィールド - -##### 基本情報 - -| フィールド名 | 日本語説明 | 型 | 備考 | -|------------|----------|-----|------| -| Date | 日付 | String | YYYY-MM-DD形式 | -| Code | 銘柄コード | String | | - -##### 前場四本値データ - -| フィールド名 | 日本語説明 | 型 | 備考 | -|------------|----------|-----|------| -| MorningOpen | 前場始値 | Number | 前場最初の約定価格 | -| MorningHigh | 前場高値 | Number | 前場中の最高約定価格 | -| MorningLow | 前場安値 | Number | 前場中の最低約定価格 | -| MorningClose | 前場終値 | Number | 前場最後の約定価格(前引け) | - -##### 前場取引情報 - -| フィールド名 | 日本語説明 | 型 | 備考 | -|------------|----------|-----|------| -| MorningVolume | 前場売買高 | Number | 前場中の総売買株数 | -| MorningTurnoverValue | 前場取引代金 | Number | 前場中の総取引代金 | - -## 東証の取引時間について - -### 前場(午前立会) -- **取引時間**: 9:00~11:30 -- **データ提供**: 前場終了後(11:30以降) -- **取得期限**: 翌日6:00頃まで - -### 後場(午後立会) -- **取引時間**: 12:30~15:00 -- **データ提供**: 後場終了後(15:00以降) - -## 使用上の注意事項 - -1. **データ取得タイミング** - - 前場終了後(11:30以降)にデータが利用可能 - - 当日データは翌日6:00頃まで取得可能 - -2. **取引のない銘柄** - - 売買されていない銘柄は四本値・取引高・売買代金がNull - - ストップ高・ストップ安で売買不成立の場合も同様 - -3. **ヒストリカルデータ** - - 過去の前場データは株価四本値APIを利用 - - 当APIは当日の前場データ専用 - -4. **対象銘柄の制限** - - 東証上場銘柄のみが対象 - - 地方取引所単独上場銘柄は対象外 - -## エラーレスポンス - -### 210 取得可能時間外または存在しない銘柄コード -```json -{ - "message": "No content due to outside the target time or a stock code does not exist." -} -``` - -このエラーは以下の場合に発生します: -- 取得可能時間外(前場終了前または翌日6:00以降) -- 存在しない銘柄コードを指定 -- 対象外銘柄(地方取引所単独上場等)を指定 - -## サンプルレスポンス - -```json -{ - "prices_am": [ - { - "Date": "2023-03-20", - "Code": "39400", - "MorningOpen": 232.0, - "MorningHigh": 244.0, - "MorningLow": 232.0, - "MorningClose": 240.0, - "MorningVolume": 52600.0, - "MorningTurnoverValue": 12518800.0 - } - ], - "pagination_key": "value1.value2." -} -``` - -## 活用例 - -### 特定銘柄の前場パフォーマンス確認 -``` -/prices/prices_am?code=39400 -``` - -### 全銘柄の前場動向を取得 -``` -/prices/prices_am -``` - -### 前場の値幅・出来高分析 -```javascript -// 前場値幅の計算 -const morningRange = response.MorningHigh - response.MorningLow; -const morningChangeFromOpen = response.MorningClose - response.MorningOpen; -const morningChangeRate = (morningChangeFromOpen / response.MorningOpen) * 100; -``` - -### 前場の流動性確認 -```javascript -// 前場の売買代金が一定額以上の銘柄をフィルタ -const activeStocks = response.prices_am.filter(stock => - stock.MorningTurnoverValue > 100000000 // 1億円以上 -); -``` - -### 前場急騰・急落銘柄の検出 -前場の始値と終値の変動率で急激な動きを検出 - -### リアルタイム監視 -前場終了後すぐに前場データを取得し、後場の戦略立案に活用 - -## 関連情報 - -このAPIは前場の株価データを提供するものです。関連する他のAPIについては以下を参照してください: -- 株価四本値:`/prices/daily_quotes`(日中全体の四本値データ、ヒストリカルデータ) -- 上場銘柄一覧:`/listed/info`(銘柄の基本情報) -- 売買内訳データ:`/markets/breakdown`(詳細な売買内訳) -- 取引カレンダー:`/markets/trading_calendar`(営業日情報) \ No newline at end of file diff --git a/docs/v1/short_selling.md b/docs/v1/short_selling.md deleted file mode 100644 index 4013f92..0000000 --- a/docs/v1/short_selling.md +++ /dev/null @@ -1,167 +0,0 @@ -# J-Quants API 業種別空売り比率データ項目概要 - -このドキュメントは、J-Quants APIの業種別空売り比率エンドポイント (`/markets/short_selling`) のレスポンスデータ項目について説明します。 - -## データ型について -- 日付フィールドは `String` 型で返されます(YYYY-MM-DD形式) -- 売買代金データは `Number` 型で返されます -- 金額の単位は円です - -## エンドポイント概要 - -### 業種別空売り比率 (/markets/short_selling) - -#### 概要 -- **エンドポイント**: `https://api.jquants.com/v1/markets/short_selling` -- **HTTPメソッド**: GET -- **説明**: 日々の業種(セクター)別の空売り比率に関する売買代金を取得することができます。 - -#### 公式情報源 -配信データは下記のページで公表している内容と同様です: -- https://www.jpx.co.jp/markets/statistics-equities/short-selling/index.html - -**注意**: Webページでの公表値は百万円単位に丸められていますが、APIでは円単位のデータとなります。 - -#### 本APIの留意点 -- **取引のない日**: 取引高が存在しない(売買されていない)日の日付(date)を指定した場合は、値は空です -- **システム障害日**: 2020/10/1は東京証券取引所の株式売買システムの障害により終日売買停止となった関係で、データが存在しません - -#### リクエストパラメータ - -データの取得では、33業種コード(sector33code)または日付(date)の指定が必須となります。 - -| パラメータ名 | 型 | 必須 | 説明 | 例 | -|------------|-----|------|------|-----| -| sector33code | String | いいえ* | 33業種コード | 0050 or 50 | -| date | String | いいえ* | 日付 | 20210907 or 2021-09-07 | -| from | String | いいえ | 期間の開始日 | 20210901 or 2021-09-01 | -| to | String | いいえ | 期間の終了日 | 20210907 or 2021-09-07 | -| pagination_key | String | いいえ | 検索の先頭を指定する文字列 | 過去の検索で返却されたpagination_key | - -*sector33codeまたはdateのいずれかが必須 - -#### パラメータの組み合わせパターン - -| sector33code | date | from/to | レスポンスの結果 | -|--------------|------|---------|-----------------| -| 指定なし | 指定あり | - | 全業種コードについて指定された日付のデータ | -| 指定あり | 指定なし | 指定なし | 指定された業種コードについて全期間分のデータ | -| 指定あり | 指定なし | 指定あり | 指定された業種コードについて指定された期間分のデータ | -| 指定あり | 指定あり | - | 指定された業種コードについて指定された日付のデータ | - -#### リクエストヘッダー - -| ヘッダー名 | 型 | 必須 | 説明 | -|----------|-----|------|------| -| Authorization | String | はい | アクセスキー | - -#### レスポンスフィールド - -##### 基本情報 - -| フィールド名 | 日本語説明 | 型 | 備考 | -|------------|----------|-----|------| -| Date | 日付 | String | YYYY-MM-DD形式 | -| Sector33Code | 33業種コード | String | 33業種コード及び業種名参照 | - -##### 売買代金データ - -| フィールド名 | 日本語説明 | 型 | 備考 | -|------------|----------|-----|------| -| SellingExcludingShortSellingTurnoverValue | 実注文の売買代金 | Number | 単位:円、空売り以外の通常売り注文 | -| ShortSellingWithRestrictionsTurnoverValue | 価格規制有りの空売り売買代金 | Number | 単位:円、アップティック・ルール等の価格規制下での空売り | -| ShortSellingWithoutRestrictionsTurnoverValue | 価格規制無しの空売り売買代金 | Number | 単位:円、価格規制の適用を受けない空売り | - -## 空売り規制について - -### 価格規制有りの空売り -- **アップティック・ルール**: 直前約定価格より高い価格での空売り -- **適用対象**: 通常の個別銘柄空売りに適用 -- **目的**: 株価の急落を防ぐための規制 - -### 価格規制無しの空売り -- **適用対象**: ETF、REIT、証券会社による裁定取引等 -- **特徴**: アップティック・ルールの適用を受けない -- **理由**: 市場の流動性確保、裁定機能維持 - -## 33業種分類について - -このAPIで使用される33業種コードは、東京証券取引所の33業種分類に基づいています。 -詳細な業種コードとコード対応表については、上場銘柄一覧APIの33業種コード参照資料をご確認ください。 - -主要業種例: -- 0050: 水産・農林業 -- 1050: 鉱業 -- 2050: 建設業 -- 3050: 食料品 -- 3100: 繊維製品 -- 9999: その他 - -## 使用上の注意事項 - -1. **データ精度** - - API提供データは円単位 - - 公式Webサイトは百万円単位で丸め表示 - -2. **取引のない日** - - 祝日、年末年始等は通常データなし - - システム障害日(2020/10/1)等もデータなし - -3. **業種分類の特性** - - 33業種分類による集計 - - 業種変更時は変更後分類で履歴も再整理 - -4. **空売り比率の計算** - - 比率 = 空売り売買代金 ÷ 総売買代金 × 100 - -## サンプルレスポンス - -```json -{ - "short_selling": [ - { - "Date": "2022-10-25", - "Sector33Code": "0050", - "SellingExcludingShortSellingTurnoverValue": 1333126400.0, - "ShortSellingWithRestrictionsTurnoverValue": 787355200.0, - "ShortSellingWithoutRestrictionsTurnoverValue": 149084300.0 - } - ], - "pagination_key": "value1.value2." -} -``` - -## 活用例 - -### 特定業種の空売り比率推移を取得 -``` -/markets/short_selling?sector33code=0050&from=20220101&to=20221231 -``` - -### 特定日の全業種空売り状況を取得 -``` -/markets/short_selling?date=2022-10-25 -``` - -### 空売り比率の計算 -```javascript -// 空売り比率の計算例 -const totalShortSelling = response.ShortSellingWithRestrictionsTurnoverValue + - response.ShortSellingWithoutRestrictionsTurnoverValue; -const totalTurnover = response.SellingExcludingShortSellingTurnoverValue + totalShortSelling; -const shortSellingRatio = (totalShortSelling / totalTurnover) * 100; -``` - -### 価格規制有無別の空売り分析 -規制有り空売り(`ShortSellingWithRestrictionsTurnoverValue`)と規制無し空売り(`ShortSellingWithoutRestrictionsTurnoverValue`)の比率分析 - -### 業種間空売り比率比較 -複数業種の同日データを取得し、業種間の空売り動向を比較分析 - -## 関連情報 - -このAPIは業種別の空売り比率データを提供するものです。関連する他のAPIについては以下を参照してください: -- 空売り残高報告:`/markets/short_selling_positions`(大口の空売り残高) -- 信用取引週末残高:`/markets/weekly_margin_interest`(信用取引残高) -- 売買内訳データ:`/markets/breakdown`(詳細な売買内訳) -- 上場銘柄一覧:`/listed/info`(33業種コード一覧) \ No newline at end of file diff --git a/docs/v1/short_selling_positions.md b/docs/v1/short_selling_positions.md deleted file mode 100644 index 43c9029..0000000 --- a/docs/v1/short_selling_positions.md +++ /dev/null @@ -1,206 +0,0 @@ -# J-Quants API 空売り残高報告データ項目概要 - -このドキュメントは、J-Quants APIの空売り残高報告エンドポイント (`/markets/short_selling_positions`) のレスポンスデータ項目について説明します。 - -## データ型について -- 日付フィールドは `String` 型で返されます(YYYY-MM-DD形式) -- 残高数量・比率データは `Number` 型で返されます -- 文字列フィールドは `String` 型で返されます - -## エンドポイント概要 - -### 空売り残高報告 (/markets/short_selling_positions) - -#### 概要 -- **エンドポイント**: `https://api.jquants.com/v1/markets/short_selling_positions` -- **HTTPメソッド**: GET -- **説明**: 「有価証券の取引等の規制に関する内閣府令」に基づき、取引参加者より報告を受けたもののうち、残高割合が0.5%以上のものについての情報を取得できます。 - -#### 公式情報源 -配信データは下記のページで公表している内容と同一ですが、より長いヒストリカルデータを利用可能です: -- https://www.jpx.co.jp/markets/public/short-selling/index.html - -#### 法的根拠 -有価証券の取引等の規制に関する内閣府令についての詳細は以下を参照: -- https://www.jpx.co.jp/markets/public/short-selling/01.html - -#### 本APIの留意点 -- **報告義務**: 取引参加者から該当する報告が行われなかった日にはデータは提供されません -- **閾値**: 残高割合が0.5%以上の場合のみ報告対象となります -- **報告タイミング**: 法令に基づく報告スケジュールに従います - -#### リクエストパラメータ - -データの取得では、銘柄コード(code)、公表日(disclosed_date)、計算日(calculated_date)のいずれかの指定が必須となります。 - -| パラメータ名 | 型 | 必須 | 説明 | 例 | -|------------|-----|------|------|-----| -| code | String | いいえ* | 4桁もしくは5桁の銘柄コード | 8697 or 86970 | -| disclosed_date | String | いいえ* | 公表日の指定 | 20240301 or 2024-03-01 | -| disclosed_date_from | String | いいえ | 公表日のfrom指定 | 20240301 or 2024-03-01 | -| disclosed_date_to | String | いいえ | 公表日のto指定 | 20240301 or 2024-03-01 | -| calculated_date | String | いいえ* | 計算日の指定 | 20240301 or 2024-03-01 | -| pagination_key | String | いいえ | 検索の先頭を指定する文字列 | 過去の検索で返却されたpagination_key | - -*code、disclosed_date、calculated_dateのいずれかが必須 - -#### 銘柄コード指定時の注意 -4桁の銘柄コードを指定した場合は、普通株式と優先株式の両方が上場している銘柄においては普通株式のデータのみが取得されます。 - -#### パラメータの組み合わせパターン - -| code | disclosed_date | disclosed_date_from/to | calculated_date | レスポンスの結果 | -|------|----------------|------------------------|-----------------|-----------------| -| 指定あり | 指定なし | 指定なし | 指定なし | 指定された銘柄について全期間分のデータ | -| 指定あり | 指定あり | - | 指定なし | 指定された銘柄について指定日(公表日)のデータ | -| 指定あり | 指定なし | 指定あり | 指定なし | 指定された銘柄について指定された期間のデータ | -| 指定あり | 指定なし | 指定なし | 指定あり | 指定された銘柄について指定日(計算日)のデータ | -| 指定なし | 指定あり | - | 指定なし | 指定日(公表日)の全ての銘柄のデータ | -| 指定なし | 指定なし | 指定なし | 指定あり | 指定日(計算日)の全ての銘柄のデータ | - -#### リクエストヘッダー - -| ヘッダー名 | 型 | 必須 | 説明 | -|----------|-----|------|------| -| Authorization | String | はい | アクセスキー | - -#### レスポンスフィールド - -##### 基本情報 - -| フィールド名 | 日本語説明 | 型 | 備考 | -|------------|----------|-----|------| -| DisclosedDate | 日付(公表日) | String | YYYY-MM-DD形式 | -| CalculatedDate | 日付(計算日) | String | YYYY-MM-DD形式 | -| Code | 銘柄コード | String | 5桁コード | - -##### 空売り者情報 - -| フィールド名 | 日本語説明 | 型 | 備考 | -|------------|----------|-----|------| -| ShortSellerName | 商号・名称・氏名 | String | 取引参加者から報告されたものをそのまま記載、日本語名称または英語名称が混在 | -| ShortSellerAddress | 住所・所在地 | String | | - -##### 投資一任契約関連情報 - -| フィールド名 | 日本語説明 | 型 | 備考 | -|------------|----------|-----|------| -| DiscretionaryInvestmentContractorName | 委託者・投資一任契約の相手方の商号・名称・氏名 | String | | -| DiscretionaryInvestmentContractorAddress | 委託者・投資一任契約の相手方の住所・所在地 | String | | -| InvestmentFundName | 信託財産・運用財産の名称 | String | | - -##### 空売り残高情報 - -| フィールド名 | 日本語説明 | 型 | 備考 | -|------------|----------|-----|------| -| ShortPositionsToSharesOutstandingRatio | 空売り残高割合 | Number | 発行済株式総数に対する比率 | -| ShortPositionsInSharesNumber | 空売り残高数量 | Number | 株数 | -| ShortPositionsInTradingUnitsNumber | 空売り残高売買単位数 | Number | 売買単位数 | - -##### 前回報告データ - -| フィールド名 | 日本語説明 | 型 | 備考 | -|------------|----------|-----|------| -| CalculationInPreviousReportingDate | 直近計算年月日 | String | YYYY-MM-DD形式 | -| ShortPositionsInPreviousReportingRatio | 直近空売り残高割合 | Number | 前回報告時の残高割合 | - -##### その他 - -| フィールド名 | 日本語説明 | 型 | 備考 | -|------------|----------|-----|------| -| Notes | 備考 | String | | - -## 法的制度について - -### 空売り残高報告制度 -- **法的根拠**: 有価証券の取引等の規制に関する内閣府令 -- **報告対象**: 残高割合が0.5%以上の大口空売りポジション -- **報告義務者**: 取引参加者(証券会社等) -- **透明性向上**: 市場の透明性向上と適切な価格形成を目的 - -### 報告の種類 -1. **通常報告**: 定期的な残高報告 -2. **変更報告**: 残高に大きな変動があった場合 -3. **終了報告**: 0.5%を下回った場合 - -### 投資一任契約 -- **適用範囲**: 投資一任契約に基づく取引も報告対象 -- **実質投資者**: 契約の相手方(実質的な投資判断者)も併せて開示 - -## 使用上の注意事項 - -1. **報告閾値** - - 0.5%以上の残高のみが報告対象 - - 0.5%未満の空売りは報告されない - -2. **報告タイミング** - - 法令に基づく報告スケジュール - - 報告がない日はデータなし - -3. **名称の取り扱い** - - 報告者の名称は報告されたものをそのまま記載 - - 日本語・英語が混在する場合がある - -4. **計算日と公表日** - - 計算日:残高を算定した基準日 - - 公表日:データが公表された日 - -## サンプルレスポンス - -```json -{ - "short_selling_positions": [ - { - "DisclosedDate": "2024-08-01", - "CalculatedDate": "2024-07-31", - "Code": "13660", - "ShortSellerName": "個人", - "ShortSellerAddress": "", - "DiscretionaryInvestmentContractorName": "", - "DiscretionaryInvestmentContractorAddress": "", - "InvestmentFundName": "", - "ShortPositionsToSharesOutstandingRatio": 0.0053, - "ShortPositionsInSharesNumber": 140000, - "ShortPositionsInTradingUnitsNumber": 140000, - "CalculationInPreviousReportingDate": "2024-07-22", - "ShortPositionsInPreviousReportingRatio": 0.0043, - "Notes": "" - } - ], - "pagination_key": "value1.value2." -} -``` - -## 活用例 - -### 特定銘柄の大口空売り状況を確認 -``` -/markets/short_selling_positions?code=86970&calculated_date=20240801 -``` - -### 特定日の大口空売り全体状況を確認 -``` -/markets/short_selling_positions?disclosed_date=2024-08-01 -``` - -### 特定銘柄の大口空売り推移分析 -``` -/markets/short_selling_positions?code=86970&disclosed_date_from=2024-01-01&disclosed_date_to=2024-12-31 -``` - -### 残高変動の監視 -前回報告時との比較: -- `ShortPositionsToSharesOutstandingRatio` vs `ShortPositionsInPreviousReportingRatio` -- 残高の増減トレンドを把握 - -### 大口投資家の特定 -- `ShortSellerName`から主要な空売り実行者を特定 -- 投資一任契約の場合は実質的な投資判断者を確認 - -## 関連情報 - -このAPIは大口空売り残高の報告データを提供するものです。関連する他のAPIについては以下を参照してください: -- 業種別空売り比率:`/markets/short_selling`(業種別の空売り比率) -- 信用取引週末残高:`/markets/weekly_margin_interest`(信用取引残高) -- 株価四本値:`/prices/daily_quotes`(個別銘柄の株価) -- 売買内訳データ:`/markets/breakdown`(詳細な売買内訳) \ No newline at end of file diff --git a/docs/v1/statements.md b/docs/v1/statements.md deleted file mode 100644 index d198a73..0000000 --- a/docs/v1/statements.md +++ /dev/null @@ -1,332 +0,0 @@ -# J-Quants API 財務諸表データ項目概要 - -このドキュメントは、J-Quants APIの財務諸表エンドポイント (`/fins/statements`) のレスポンスデータ項目について説明します。 - -## APIエンドポイント - -- **URL**: `https://api.jquants.com/v1/fins/statements` -- **メソッド**: GET -- **認証**: Authorization ヘッダーにBearer トークンが必要 - -## リクエストパラメータ - -| パラメータ名 | 型 | 必須 | 説明 | 例 | -|------------|-----|------|------|-----| -| code | String | いずれか必須 | 4桁または5桁の銘柄コード | 86970 or 8697 | -| date | String | いずれか必須 | 開示日 | 2022-01-05 or 20220105 | -| pagination_key | String | いいえ | 検索の先頭を指定する文字列(過去の検索で返却されたpagination_keyを設定) | - | - -※ codeまたはdateのいずれかのパラメータが必須 - -## データ型について -- すべてのフィールドは `String` 型で返されます -- 数値データも文字列として格納されています -- 空文字列 (`""`) は値が存在しないことを示します -- 金額の単位は基本的に円です - -## データ項目一覧 - -### 1. 基本情報 - -| フィールド名 | 日本語説明 | 備考 | -|------------|----------|------| -| DisclosedDate | 開示日 | YYYY-MM-DD形式 | -| DisclosedTime | 開示時刻 | HH:MM:SS形式 | -| LocalCode | 銘柄コード(5桁) | | -| DisclosureNumber | 開示番号 | APIから出力されるjsonは開示番号で昇順に並んでいる | -| TypeOfDocument | 開示書類種別 | 詳細は[開示書類種別一覧](#開示書類種別一覧)を参照 | -| TypeOfCurrentPeriod | 当会計期間の種類 | [1Q, 2Q, 3Q, 4Q, 5Q, FY] | -| CurrentPeriodStartDate | 当会計期間開始日 | | -| CurrentPeriodEndDate | 当会計期間終了日 | | -| CurrentFiscalYearStartDate | 当事業年度開始日 | | -| CurrentFiscalYearEndDate | 当事業年度終了日 | | -| NextFiscalYearStartDate | 翌事業年度開始日 | | -| NextFiscalYearEndDate | 翌事業年度終了日 | | - -### 2. 連結財務数値 - -#### 損益計算書関連 -| フィールド名 | 日本語説明 | 備考 | -|------------|----------|------| -| NetSales | 売上高 | 単位:円 | -| OperatingProfit | 営業利益 | 単位:円 | -| OrdinaryProfit | 経常利益 | 単位:円 | -| Profit | 当期純利益 | 単位:円 | - -#### 貸借対照表関連 -| フィールド名 | 日本語説明 | 備考 | -|------------|----------|------| -| TotalAssets | 総資産 | 単位:円 | -| Equity | 純資産 | 単位:円 | - -#### キャッシュフロー関連 -| フィールド名 | 日本語説明 | 備考 | -|------------|----------|------| -| CashAndEquivalents | 現金及び現金同等物 | 単位:円 | -| CashFlowsFromOperatingActivities | 営業活動によるキャッシュフロー | 単位:円 | -| CashFlowsFromInvestingActivities | 投資活動によるキャッシュフロー | 単位:円 | -| CashFlowsFromFinancingActivities | 財務活動によるキャッシュフロー | 単位:円 | - -### 3. 財務指標 - -| フィールド名 | 日本語説明 | 備考 | -|------------|----------|------| -| EarningsPerShare | 1株当たり当期純利益(EPS) | 単位:円 | -| DilutedEarningsPerShare | 潜在株式調整後1株当たり当期純利益 | 単位:円 | -| BookValuePerShare | 1株当たり純資産(BPS) | 単位:円 | -| EquityToAssetRatio | 自己資本比率 | パーセント | - -### 4. 配当情報 - -#### 配当実績 -| フィールド名 | 日本語説明 | 備考 | -|------------|----------|------| -| ResultDividendPerShare1stQuarter | 第1四半期配当金(実績) | 単位:円 | -| ResultDividendPerShare2ndQuarter | 第2四半期配当金(実績) | 単位:円 | -| ResultDividendPerShare3rdQuarter | 第3四半期配当金(実績) | 単位:円 | -| ResultDividendPerShareFiscalYearEnd | 期末配当金(実績) | 単位:円 | -| ResultDividendPerShareAnnual | 年間配当金(実績) | 単位:円 | -| DistributionsPerUnit(REIT) | 1口当たり分配金 | 単位:円 | -| ResultTotalDividendPaidAnnual | 配当金総額 | 単位:円 | -| ResultPayoutRatioAnnual | 配当性向(実績) | パーセント | - -#### 配当予想 -| フィールド名 | 日本語説明 | 備考 | -|------------|----------|------| -| ForecastDividendPerShare1stQuarter | 第1四半期配当金(予想) | 単位:円 | -| ForecastDividendPerShare2ndQuarter | 第2四半期配当金(予想) | 単位:円 | -| ForecastDividendPerShare3rdQuarter | 第3四半期配当金(予想) | 単位:円 | -| ForecastDividendPerShareFiscalYearEnd | 期末配当金(予想) | 単位:円 | -| ForecastDividendPerShareAnnual | 年間配当金(予想) | 単位:円 | -| ForecastDistributionsPerUnit(REIT) | 分配金(REIT)(予想) | 単位:円 | -| ForecastTotalDividendPaidAnnual | 予想配当金総額 | 単位:円 | -| ForecastPayoutRatioAnnual | 配当性向(予想) | パーセント | - -### 5. 業績予想 - -#### 当期業績予想 -| フィールド名 | 日本語説明 | 備考 | -|------------|----------|------| -| ForecastNetSales | 売上高(予想) | 単位:円 | -| ForecastOperatingProfit | 営業利益(予想) | 単位:円 | -| ForecastOrdinaryProfit | 経常利益(予想) | 単位:円 | -| ForecastProfit | 当期純利益(予想) | 単位:円 | -| ForecastEarningsPerShare | 1株当たり当期純利益(予想) | 単位:円 | - -#### 第2四半期業績予想 -| フィールド名 | 日本語説明 | 備考 | -|------------|----------|------| -| ForecastNetSales2ndQuarter | 第2四半期売上高(予想) | 単位:円 | -| ForecastOperatingProfit2ndQuarter | 第2四半期営業利益(予想) | 単位:円 | -| ForecastOrdinaryProfit2ndQuarter | 第2四半期経常利益(予想) | 単位:円 | -| ForecastProfit2ndQuarter | 第2四半期純利益(予想) | 単位:円 | -| ForecastEarningsPerShare2ndQuarter | 第2四半期1株当たり純利益(予想) | 単位:円 | - -#### 翌期業績予想 -| フィールド名 | 日本語説明 | 備考 | -|------------|----------|------| -| NextYearForecastDividendPerShare1stQuarter | 翌期第1四半期配当金(予想) | 単位:円 | -| NextYearForecastDividendPerShare2ndQuarter | 翌期第2四半期配当金(予想) | 単位:円 | -| NextYearForecastDividendPerShare3rdQuarter | 翌期第3四半期配当金(予想) | 単位:円 | -| NextYearForecastDividendPerShareFiscalYearEnd | 翌期期末配当金(予想) | 単位:円 | -| NextYearForecastDividendPerShareAnnual | 翌期年間配当金(予想) | 単位:円 | -| NextYearForecastDistributionsPerUnit(REIT) | 翌期分配金(REIT)(予想) | 単位:円 | -| NextYearForecastPayoutRatioAnnual | 翌期配当性向(予想) | パーセント | -| NextYearForecastNetSales2ndQuarter | 翌期第2四半期売上高(予想) | 単位:円 | -| NextYearForecastOperatingProfit2ndQuarter | 翌期第2四半期営業利益(予想) | 単位:円 | -| NextYearForecastOrdinaryProfit2ndQuarter | 翌期第2四半期経常利益(予想) | 単位:円 | -| NextYearForecastProfit2ndQuarter | 翌期第2四半期純利益(予想) | 単位:円 | -| NextYearForecastEarningsPerShare2ndQuarter | 翌期第2四半期1株当たり純利益(予想) | 単位:円 | -| NextYearForecastNetSales | 翌期売上高(予想) | 単位:円 | -| NextYearForecastOperatingProfit | 翌期営業利益(予想) | 単位:円 | -| NextYearForecastOrdinaryProfit | 翌期経常利益(予想) | 単位:円 | -| NextYearForecastProfit | 翌期当期純利益(予想) | 単位:円 | -| NextYearForecastEarningsPerShare | 翌期1株当たり当期純利益(予想) | 単位:円 | - -### 6. その他の情報 - -| フィールド名 | 日本語説明 | 備考 | -|------------|----------|------| -| MaterialChangesInSubsidiaries | 重要な子会社の異動 | true/false | -| SignificantChangesInTheScopeOfConsolidation | 連結範囲の重要な変更 | 2024/7/22より追加 ※1 | -| ChangesBasedOnRevisionsOfAccountingStandard | 会計基準等の改正に伴う会計方針の変更 | true/false | -| ChangesOtherThanOnesBasedOnRevisionsOfAccountingStandard | 会計基準改正以外の変更 | true/false | -| ChangesInAccountingEstimates | 会計上の見積りの変更 | true/false | -| RetrospectiveRestatement | 修正再表示 | | -| NumberOfIssuedAndOutstandingSharesAtTheEndOfFiscalYearIncludingTreasuryStock | 期末発行済株式数(自己株式を含む) | | -| NumberOfTreasuryStockAtTheEndOfFiscalYear | 期末自己株式数 | | -| AverageNumberOfShares | 期中平均株式数 | | - -### 7. 単体財務数値 - -単体(NonConsolidated)の財務数値は、連結財務数値と同様の項目が「NonConsolidated」プレフィックス付きで提供されます。 - -例: -- `NonConsolidatedNetSales`: 単体売上高 -- `NonConsolidatedOperatingProfit`: 単体営業利益 -- `NonConsolidatedOrdinaryProfit`: 単体経常利益 -- `NonConsolidatedProfit`: 単体当期純利益 -- など - -## 会計基準について - -APIから出力される各項目名は日本基準(JGAAP)の開示項目が基準となっています。そのため: - -- **IFRS**や**米国基準(USGAAP)**の開示データでは、経常利益(OrdinaryProfit)の概念が存在しないため、データが空欄となります -- 各企業の採用する会計基準は`TypeOfDocument`フィールドで確認できます - -## 四半期開示見直し対応について - -2024/7/22より、決算短信サマリー様式の記載事項変更に伴い、以下の項目が追加されました: - -- **変更前**: 重要な子会社の異動(連結範囲の変更を伴う特定子会社の異動) -- **変更後**: 連結範囲の重要な変更 - -新項目: `SignificantChangesInTheScopeOfConsolidation`(期中における連結範囲の重要な変更) -※1: 2024-07-21以前のデータには値が含まれません - -## 使用上の注意 - -1. **データ型の変換**: すべてのフィールドは文字列型で返されるため、数値計算を行う場合は適切な型変換が必要です。 - -2. **空値の処理**: 該当するデータがない場合は空文字列("")が返されます。 - -3. **配当利回りの計算**: 配当利回りを計算する場合は、別途株価データ(`/prices/daily_quotes`)を取得する必要があります。 - -4. **会計期間の種類**: `TypeOfCurrentPeriod`は四半期(1Q-4Q)または通期(FY)を示します。5Qは特殊な場合に使用されます。 - -5. **開示書類種別**: `TypeOfDocument`は会計基準(IFRS/JGAAP)や連結/単体の区別を含みます。 - -## エラーレスポンス - -### 400 Bad Request -```json -{ - "message": "This API requires at least 1 parameter as follows; 'date','code'." -} -``` - -### 401 Unauthorized -```json -{ - "message": "The incoming token is invalid or expired." -} -``` - -### 500 Internal Server Error -```json -{ - "message": "Unexpected error. Please try again later." -} -``` - -### データサイズエラー -```json -{ - "message": "Response data is too large. Specify parameters to reduce the acquired data range." -} -``` - -## APIコールサンプル - -### cURL -```bash -idToken= && curl https://api.jquants.com/v1/fins/statements?code=86970&date=20230130 -H "Authorization: Bearer $idToken" -``` - -### Python -```python -import requests -import json - -idToken = "YOUR idToken" -headers = {'Authorization': 'Bearer {}'.format(idToken)} -r = requests.get("https://api.jquants.com/v1/fins/statements?code=86970&date=20230130", headers=headers) -r.json() -``` - -## 開示書類種別一覧 - -財務情報APIのTypeOfDocumentフィールドに格納される値の一覧です。 - -### 決算短信(通期) -| 書類種別 | 概要 | -|---------|------| -| FYFinancialStatements_Consolidated_JP | 決算短信(連結・日本基準) | -| FYFinancialStatements_Consolidated_US | 決算短信(連結・米国基準) | -| FYFinancialStatements_NonConsolidated_JP | 決算短信(非連結・日本基準) | -| FYFinancialStatements_Consolidated_JMIS | 決算短信(連結・JMIS) | -| FYFinancialStatements_NonConsolidated_IFRS | 決算短信(非連結・IFRS) | -| FYFinancialStatements_Consolidated_IFRS | 決算短信(連結・IFRS) | -| FYFinancialStatements_NonConsolidated_Foreign | 決算短信(非連結・外国株) | -| FYFinancialStatements_Consolidated_Foreign | 決算短信(連結・外国株) | -| FYFinancialStatements_Consolidated_REIT | 決算短信(REIT) | - -### 四半期決算短信 -#### 第1四半期 -| 書類種別 | 概要 | -|---------|------| -| 1QFinancialStatements_Consolidated_JP | 第1四半期決算短信(連結・日本基準) | -| 1QFinancialStatements_Consolidated_US | 第1四半期決算短信(連結・米国基準) | -| 1QFinancialStatements_NonConsolidated_JP | 第1四半期決算短信(非連結・日本基準) | -| 1QFinancialStatements_Consolidated_JMIS | 第1四半期決算短信(連結・JMIS) | -| 1QFinancialStatements_NonConsolidated_IFRS | 第1四半期決算短信(非連結・IFRS) | -| 1QFinancialStatements_Consolidated_IFRS | 第1四半期決算短信(連結・IFRS) | -| 1QFinancialStatements_NonConsolidated_Foreign | 第1四半期決算短信(非連結・外国株) | -| 1QFinancialStatements_Consolidated_Foreign | 第1四半期決算短信(連結・外国株) | - -#### 第2四半期 -| 書類種別 | 概要 | -|---------|------| -| 2QFinancialStatements_Consolidated_JP | 第2四半期決算短信(連結・日本基準) | -| 2QFinancialStatements_Consolidated_US | 第2四半期決算短信(連結・米国基準) | -| 2QFinancialStatements_NonConsolidated_JP | 第2四半期決算短信(非連結・日本基準) | -| 2QFinancialStatements_Consolidated_JMIS | 第2四半期決算短信(連結・JMIS) | -| 2QFinancialStatements_NonConsolidated_IFRS | 第2四半期決算短信(非連結・IFRS) | -| 2QFinancialStatements_Consolidated_IFRS | 第2四半期決算短信(連結・IFRS) | -| 2QFinancialStatements_NonConsolidated_Foreign | 第2四半期決算短信(非連結・外国株) | -| 2QFinancialStatements_Consolidated_Foreign | 第2四半期決算短信(連結・外国株) | - -#### 第3四半期 -| 書類種別 | 概要 | -|---------|------| -| 3QFinancialStatements_Consolidated_JP | 第3四半期決算短信(連結・日本基準) | -| 3QFinancialStatements_Consolidated_US | 第3四半期決算短信(連結・米国基準) | -| 3QFinancialStatements_NonConsolidated_JP | 第3四半期決算短信(非連結・日本基準) | -| 3QFinancialStatements_Consolidated_JMIS | 第3四半期決算短信(連結・JMIS) | -| 3QFinancialStatements_NonConsolidated_IFRS | 第3四半期決算短信(非連結・IFRS) | -| 3QFinancialStatements_Consolidated_IFRS | 第3四半期決算短信(連結・IFRS) | -| 3QFinancialStatements_NonConsolidated_Foreign | 第3四半期決算短信(非連結・外国株) | -| 3QFinancialStatements_Consolidated_Foreign | 第3四半期決算短信(連結・外国株) | - -#### その他の四半期 -| 書類種別 | 概要 | -|---------|------| -| OtherPeriodFinancialStatements_Consolidated_JP | その他四半期決算短信(連結・日本基準) | -| OtherPeriodFinancialStatements_Consolidated_US | その他四半期決算短信(連結・米国基準) | -| OtherPeriodFinancialStatements_NonConsolidated_JP | その他四半期決算短信(非連結・日本基準) | -| OtherPeriodFinancialStatements_Consolidated_JMIS | その他四半期決算短信(連結・JMIS) | -| OtherPeriodFinancialStatements_NonConsolidated_IFRS | その他四半期決算短信(非連結・IFRS) | -| OtherPeriodFinancialStatements_Consolidated_IFRS | その他四半期決算短信(連結・IFRS) | -| OtherPeriodFinancialStatements_NonConsolidated_Foreign | その他四半期決算短信(非連結・外国株) | -| OtherPeriodFinancialStatements_Consolidated_Foreign | その他四半期決算短信(連結・外国株) | - -### 予想修正 -| 書類種別 | 概要 | -|---------|------| -| DividendForecastRevision | 配当予想の修正 | -| EarnForecastRevision | 業績予想の修正 | -| REITDividendForecastRevision | 分配予想の修正(REIT) | -| REITEarnForecastRevision | 利益予想の修正(REIT) | - -### 注記 -- **JP**: 日本基準(JGAAP) -- **US**: 米国基準(USGAAP) -- **IFRS**: 国際財務報告基準 -- **JMIS**: 修正国際基準 -- **REIT**: 不動産投資信託 -- **Foreign**: 外国株 - -## 関連ドキュメント - -- [J-Quants API 公式ドキュメント](https://jpx.gitbook.io/j-quants-ja/api-reference/statements) \ No newline at end of file diff --git a/docs/v1/topix.md b/docs/v1/topix.md deleted file mode 100644 index 9a1e694..0000000 --- a/docs/v1/topix.md +++ /dev/null @@ -1,105 +0,0 @@ -# J-Quants API TOPIX指数四本値データ項目概要 - -このドキュメントは、J-Quants APIのTOPIX指数四本値エンドポイント (`/indices/topix`) のレスポンスデータ項目について説明します。 - -## データ型について -- フィールドは `String` 型または `Number` 型で返されます -- 日付は `String` 型で YYYY-MM-DD 形式 -- 指数値は `Number` 型 - -## エンドポイント概要 - -### TOPIX指数四本値 (/indices/topix) - -#### 概要 -- **エンドポイント**: `https://api.jquants.com/v1/indices/topix` -- **HTTPメソッド**: GET -- **説明**: TOPIXの日通しの四本値を取得できます。本APIで取得可能な指数データはTOPIX(東証株価指数)のみとなります。 - -#### 特徴 -- TOPIX専用のエンドポイント -- パラメータ指定なしで全期間のデータ取得可能 -- 汎用の指数エンドポイント(`/indices`)より簡便にTOPIXデータを取得可能 - -#### リクエストパラメータ - -日付の範囲(from/to)を指定することができます。なお、指定しない場合は全期間のデータがレスポンスに収録されます。 - -| パラメータ名 | 型 | 必須 | 説明 | 例 | -|------------|-----|------|------|-----| -| from | String | いいえ | 期間の開始日 | 20210901 or 2021-09-01 | -| to | String | いいえ | 期間の終了日 | 20210907 or 2021-09-07 | -| pagination_key | String | いいえ | 検索の先頭を指定する文字列 | 過去の検索で返却されたpagination_key | - -#### リクエストヘッダー - -| ヘッダー名 | 型 | 必須 | 説明 | -|----------|-----|------|------| -| Authorization | String | はい | アクセスキー | - -#### レスポンスフィールド - -| フィールド名 | 日本語説明 | 型 | 備考 | -|------------|----------|-----|------| -| Date | 日付 | String | YYYY-MM-DD形式 | -| Open | 始値 | Number | | -| High | 高値 | Number | | -| Low | 安値 | Number | | -| Close | 終値 | Number | | - -## 使用上の注意事項 - -1. **データの対象** - - TOPIX(東証株価指数)のみ取得可能 - - その他の指数は汎用エンドポイント(`/indices`)を使用 - -2. **パラメータの指定** - - パラメータを指定しない場合、全期間のデータが返却される - - 大量データの場合はpagination_keyを使用して分割取得 - - fromはtoより過去の日付である必要がある - -3. **レスポンスサイズ** - - 全期間のデータ取得時は大量になる可能性があるため注意 - - 必要に応じて期間を絞って取得することを推奨 - -## サンプルレスポンス - -```json -{ - "topix": [ - { - "Date": "2022-06-28", - "Open": 1885.52, - "High": 1907.38, - "Low": 1885.32, - "Close": 1907.38 - } - ], - "pagination_key": "value1.value2." -} -``` - -## エラーレスポンスの例 - -### 日付の順序が不正な場合 -```json -{ - "message": "'from' must be older than 'to'" -} -``` - -## 関連情報 - -このAPIはTOPIX指数の四本値データを専門的に提供するものです。関連する他のAPIについては以下を参照してください: -- 指数四本値(汎用):`/indices`(TOPIX以外の各種指数も取得可能) -- 株価四本値:`/prices/daily_quotes`(個別銘柄) -- 上場銘柄一覧:`/listed/info` - -## 汎用エンドポイントとの違い - -| 項目 | `/indices/topix` | `/indices` | -|-----|-----------------|------------| -| 対象指数 | TOPIXのみ | 複数の指数 | -| 指数コード指定 | 不要 | 必要 | -| レスポンスキー | topix | indices | -| 用途 | TOPIX専用 | 汎用 | \ No newline at end of file diff --git a/docs/v1/trades_spec.md b/docs/v1/trades_spec.md deleted file mode 100644 index 87fc8b5..0000000 --- a/docs/v1/trades_spec.md +++ /dev/null @@ -1,224 +0,0 @@ -# J-Quants API 投資部門別情報データ項目概要 - -このドキュメントは、J-Quants APIの投資部門別情報エンドポイント (`/markets/trades_spec`) のレスポンスデータ項目について説明します。 - -## データ型について -- 日付フィールドは `String` 型で返されます(YYYY-MM-DD形式) -- 金額データは `Number` 型で返されます -- 金額の単位は千円です - -## エンドポイント概要 - -### 投資部門別情報 (/markets/trades_spec) - -#### 概要 -- **エンドポイント**: `https://api.jquants.com/v1/markets/trades_spec` -- **HTTPメソッド**: GET -- **説明**: 投資部門別売買状況(株式・金額)のデータを取得することができます。 - -#### 公式情報源 -配信データは下記のページで公表している内容と同一です: -- https://www.jpx.co.jp/markets/statistics-equities/investor-type/index.html - -#### 本APIの留意点 -- 2022年4月4日に行われた市場区分見直しに伴い、市場区分に応じた内容となっている統計資料は、見直し後の市場区分に変更して掲載しています -- 過誤訂正により過去の投資部門別売買状況データが訂正された場合の対応: - - **2023年4月3日以前の訂正**:訂正前のデータは提供せず、訂正後のデータのみ提供 - - **2023年4月3日以降の訂正**:訂正前と訂正後のデータの両方を提供(公表日で識別可能) -- 過誤訂正により過去のデータが訂正された場合は、過誤訂正が公表された翌営業日にデータが更新されます - -#### リクエストパラメータ - -データの取得では、セクション(section)または日付(from/to)の指定が可能です。 - -| パラメータ名 | 型 | 必須 | 説明 | 例 | -|------------|-----|------|------|-----| -| section | String | いいえ | セクション(市場) | TSEPrime | -| from | String | いいえ | 期間の開始日 | 20210901 or 2021-09-01 | -| to | String | いいえ | 期間の終了日 | 20210907 or 2021-09-07 | -| pagination_key | String | いいえ | 検索の先頭を指定する文字列 | 過去の検索で返却されたpagination_key | - -#### パラメータの組み合わせパターン - -| section | from/to | レスポンスの結果 | -|---------|---------|-----------------| -| 指定あり | 指定あり | 指定したセクションの指定した期間のデータ | -| 指定あり | 指定なし | 指定したセクションの全期間のデータ | -| 指定なし | 指定あり | すべてのセクションの指定した期間のデータ | -| 指定なし | 指定なし | すべてのセクションの全期間のデータ | - -#### リクエストヘッダー - -| ヘッダー名 | 型 | 必須 | 説明 | -|----------|-----|------|------| -| Authorization | String | はい | アクセスキー | - -#### レスポンスフィールド - -##### 基本情報 - -| フィールド名 | 日本語説明 | 型 | 備考 | -|------------|----------|-----|------| -| PublishedDate | 公表日 | String | YYYY-MM-DD形式 | -| StartDate | 開始日 | String | YYYY-MM-DD形式 | -| EndDate | 終了日 | String | YYYY-MM-DD形式 | -| Section | 市場名 | String | 市場名一覧参照 | - -##### 自己取引 - -| フィールド名 | 日本語説明 | 型 | 備考 | -|------------|----------|-----|------| -| ProprietarySales | 自己計_売 | Number | 単位:千円 | -| ProprietaryPurchases | 自己計_買 | Number | 単位:千円 | -| ProprietaryTotal | 自己計_合計 | Number | 単位:千円 | -| ProprietaryBalance | 自己計_差引 | Number | 単位:千円 | - -##### 委託取引 - -| フィールド名 | 日本語説明 | 型 | 備考 | -|------------|----------|-----|------| -| BrokerageSales | 委託計_売 | Number | 単位:千円 | -| BrokeragePurchases | 委託計_買 | Number | 単位:千円 | -| BrokerageTotal | 委託計_合計 | Number | 単位:千円 | -| BrokerageBalance | 委託計_差引 | Number | 単位:千円 | - -##### 総計 - -| フィールド名 | 日本語説明 | 型 | 備考 | -|------------|----------|-----|------| -| TotalSales | 総計_売 | Number | 単位:千円 | -| TotalPurchases | 総計_買 | Number | 単位:千円 | -| TotalTotal | 総計_合計 | Number | 単位:千円 | -| TotalBalance | 総計_差引 | Number | 単位:千円 | - -##### 投資部門別内訳 - -| フィールド名 | 日本語説明 | 型 | 備考 | -|------------|----------|-----|------| -| IndividualsSales | 個人_売 | Number | 単位:千円 | -| IndividualsPurchases | 個人_買 | Number | 単位:千円 | -| IndividualsTotal | 個人_合計 | Number | 単位:千円 | -| IndividualsBalance | 個人_差引 | Number | 単位:千円 | -| ForeignersSales | 海外投資家_売 | Number | 単位:千円 | -| ForeignersPurchases | 海外投資家_買 | Number | 単位:千円 | -| ForeignersTotal | 海外投資家_合計 | Number | 単位:千円 | -| ForeignersBalance | 海外投資家_差引 | Number | 単位:千円 | -| SecuritiesCosSales | 証券会社_売 | Number | 単位:千円 | -| SecuritiesCosPurchases | 証券会社_買 | Number | 単位:千円 | -| SecuritiesCosTotal | 証券会社_合計 | Number | 単位:千円 | -| SecuritiesCosBalance | 証券会社_差引 | Number | 単位:千円 | -| InvestmentTrustsSales | 投資信託_売 | Number | 単位:千円 | -| InvestmentTrustsPurchases | 投資信託_買 | Number | 単位:千円 | -| InvestmentTrustsTotal | 投資信託_合計 | Number | 単位:千円 | -| InvestmentTrustsBalance | 投資信託_差引 | Number | 単位:千円 | -| BusinessCosSales | 事業法人_売 | Number | 単位:千円 | -| BusinessCosPurchases | 事業法人_買 | Number | 単位:千円 | -| BusinessCosTotal | 事業法人_合計 | Number | 単位:千円 | -| BusinessCosBalance | 事業法人_差引 | Number | 単位:千円 | -| OtherCosSales | その他法人_売 | Number | 単位:千円 | -| OtherCosPurchases | その他法人_買 | Number | 単位:千円 | -| OtherCosTotal | その他法人_合計 | Number | 単位:千円 | -| OtherCosBalance | その他法人_差引 | Number | 単位:千円 | -| InsuranceCosSales | 生保・損保_売 | Number | 単位:千円 | -| InsuranceCosPurchases | 生保・損保_買 | Number | 単位:千円 | -| InsuranceCosTotal | 生保・損保_合計 | Number | 単位:千円 | -| InsuranceCosBalance | 生保・損保_差引 | Number | 単位:千円 | -| CityBKsRegionalBKsEtcSales | 都銀・地銀等_売 | Number | 単位:千円 | -| CityBKsRegionalBKsEtcPurchases | 都銀・地銀等_買 | Number | 単位:千円 | -| CityBKsRegionalBKsEtcTotal | 都銀・地銀等_合計 | Number | 単位:千円 | -| CityBKsRegionalBKsEtcBalance | 都銀・地銀等_差引 | Number | 単位:千円 | -| TrustBanksSales | 信託銀行_売 | Number | 単位:千円 | -| TrustBanksPurchases | 信託銀行_買 | Number | 単位:千円 | -| TrustBanksTotal | 信託銀行_合計 | Number | 単位:千円 | -| TrustBanksBalance | 信託銀行_差引 | Number | 単位:千円 | -| OtherFinancialInstitutionsSales | その他金融機関_売 | Number | 単位:千円 | -| OtherFinancialInstitutionsPurchases | その他金融機関_買 | Number | 単位:千円 | -| OtherFinancialInstitutionsTotal | その他金融機関_合計 | Number | 単位:千円 | -| OtherFinancialInstitutionsBalance | その他金融機関_差引 | Number | 単位:千円 | - -## 市場名(Section)一覧 - -| 市場名 | コード | -|--------|--------| -| 市場一部 | TSE1st | -| 市場二部 | TSE2nd | -| マザーズ | TSEMothers | -| JASDAQ | TSEJASDAQ | -| プライム | TSEPrime | -| スタンダード | TSEStandard | -| グロース | TSEGrowth | -| 東証および名証 | TokyoNagoya | - -## 使用上の注意事項 - -1. **データ単位** - - 金額は千円単位で提供 - - 差引=買い-売りで計算 - -2. **市場区分変更の影響** - - 2022年4月4日以降は新市場区分(プライム、スタンダード、グロース)を使用 - - 過去データも新市場区分で再整理済み - -3. **過誤訂正の扱い** - - 2023年4月3日を境に対応方針が変更 - - 公表日が新しいデータが訂正後データ - -4. **投資部門の分類** - - 個人、海外投資家、証券会社、各種金融機関等に分類 - - 自己取引と委託取引を区別 - -## サンプルレスポンス - -```json -{ - "trades_spec": [ - { - "PublishedDate":"2017-01-13", - "StartDate":"2017-01-04", - "EndDate":"2017-01-06", - "Section":"TSE1st", - "ProprietarySales":1311271004, - "ProprietaryPurchases":1453326508, - "ProprietaryTotal":2764597512, - "ProprietaryBalance":142055504, - "BrokerageSales":7165529005, - "BrokeragePurchases":7030019854, - "BrokerageTotal":14195548859, - "BrokerageBalance":-135509151, - "TotalSales":8476800009, - "TotalPurchases":8483346362, - "TotalTotal":16960146371, - "TotalBalance":6546353, - "IndividualsSales":1401711615, - "IndividualsPurchases":1161801155, - "IndividualsTotal":2563512770, - "IndividualsBalance":-239910460, - "ForeignersSales":5094891735, - "ForeignersPurchases":5317151774, - "ForeignersTotal":10412043509, - "ForeignersBalance":222260039 - } - ], - "pagination_key": "value1.value2." -} -``` - -## 活用例 - -### 特定市場の最新データを取得 -``` -/markets/trades_spec?section=TSEPrime&from=20230324&to=20230403 -``` - -### 海外投資家の動向分析 -レスポンスの`ForeignersSales`、`ForeignersPurchases`、`ForeignersBalance`を使用 - -### 個人投資家の動向分析 -レスポンスの`IndividualsSales`、`IndividualsPurchases`、`IndividualsBalance`を使用 - -## 関連情報 - -このAPIは投資部門別の売買状況を提供するものです。関連する他のAPIについては以下を参照してください: -- 売買内訳データ:`/markets/breakdown`(銘柄別の詳細な売買内訳) -- 株価四本値:`/prices/daily_quotes`(個別銘柄の株価) -- 取引カレンダー:`/markets/trading_calendar`(営業日情報) \ No newline at end of file diff --git a/docs/v1/trading_calendar.md b/docs/v1/trading_calendar.md deleted file mode 100644 index 8dc480b..0000000 --- a/docs/v1/trading_calendar.md +++ /dev/null @@ -1,120 +0,0 @@ -# J-Quants API 取引カレンダーデータ項目概要 - -このドキュメントは、J-Quants APIの取引カレンダーエンドポイント (`/markets/trading_calendar`) のレスポンスデータ項目について説明します。 - -## データ型について -- すべてのフィールドは `String` 型で返されます -- 日付は YYYY-MM-DD 形式 - -## エンドポイント概要 - -### 取引カレンダー (/markets/trading_calendar) - -#### 概要 -- **エンドポイント**: `https://api.jquants.com/v1/markets/trading_calendar` -- **HTTPメソッド**: GET -- **説明**: 東証およびOSEにおける営業日、休業日、ならびにOSEにおける祝日取引の有無の情報を取得できます。 - -#### 公式情報源 -配信データは下記のページで公表している内容と同様です: -- 休業日一覧:https://www.jpx.co.jp/corporate/about-jpx/calendar/index.html -- 祝日取引実施日:https://www.jpx.co.jp/derivatives/rules/holidaytrading/index.html - -#### 本APIの留意点 -- 原則として、毎年3月末頃をめどに翌年1年間の営業日および祝日取引実施日(予定)を更新します - -#### リクエストパラメータ - -データの取得では、休日区分(holidaydivision)または日付(from/to)の指定が可能です。 - -| パラメータ名 | 型 | 必須 | 説明 | 例 | -|------------|-----|------|------|-----| -| holidaydivision | String | いいえ | 休日区分 | 1 | -| from | String | いいえ | 期間の開始日 | 20210901 or 2021-09-01 | -| to | String | いいえ | 期間の終了日 | 20210907 or 2021-09-07 | - -#### パラメータの組み合わせパターン - -| holidaydivision | from/to | レスポンスの結果 | -|----------------|---------|-----------------| -| 指定あり | 指定なし | 指定された休日区分について全期間分のデータ | -| 指定あり | 指定あり | 指定された休日区分について指定された期間分のデータ | -| 指定なし | 指定あり | 指定された期間分のデータ | -| 指定なし | 指定なし | 全期間分のデータ | - -#### リクエストヘッダー - -| ヘッダー名 | 型 | 必須 | 説明 | -|----------|-----|------|------| -| Authorization | String | はい | アクセスキー | - -#### レスポンスフィールド - -| フィールド名 | 日本語説明 | 備考 | -|------------|----------|------| -| Date | 日付 | YYYY-MM-DD形式 | -| HolidayDivision | 休日区分 | 下記の休日区分一覧参照 | - -## 休日区分一覧 - -| 区分名 | 値 | 説明 | -|-------|-----|------| -| 非営業日 | 0 | 東証・OSEともに休業 | -| 営業日 | 1 | 通常の営業日 | -| 東証半日立会日 | 2 | 東証が半日のみ取引を行う日 | -| 非営業日(祝日取引あり) | 3 | 東証は休業だがOSEで祝日取引を実施 | - -## 使用上の注意事項 - -1. **データ更新時期** - - 毎年3月末頃に翌年分のデータを更新 - - 最新の情報は公式サイトで確認可能 - -2. **祝日取引について** - - OSE(大阪証券取引所)でのデリバティブ取引が対象 - - 東証の現物取引は祝日取引なし - -3. **半日立会について** - - 通常は大納会(年末最終営業日)などが該当 - - 午前中のみの取引 - -4. **パラメータの活用** - - 特定の休日区分のみを抽出可能 - - 期間指定で必要なデータのみ取得可能 - -## サンプルレスポンス - -```json -{ - "trading_calendar": [ - { - "Date": "2015-04-01", - "HolidayDivision": "1" - } - ] -} -``` - -## 活用例 - -### 営業日のみを取得 -``` -/markets/trading_calendar?holidaydivision=1&from=20220101&to=20221231 -``` - -### 特定期間の全カレンダー情報を取得 -``` -/markets/trading_calendar?from=20220101&to=20221231 -``` - -### 祝日取引実施日のみを取得 -``` -/markets/trading_calendar?holidaydivision=3 -``` - -## 関連情報 - -このAPIは取引所の営業日情報を提供するものです。関連する他のAPIについては以下を参照してください: -- 株価四本値:`/prices/daily_quotes`(営業日のみデータあり) -- 売買内訳データ:`/markets/breakdown`(営業日のみデータあり) -- 指数四本値:`/indices`(営業日のみデータあり) \ No newline at end of file diff --git a/docs/v1/weekly_margin_interest.md b/docs/v1/weekly_margin_interest.md deleted file mode 100644 index 125bb61..0000000 --- a/docs/v1/weekly_margin_interest.md +++ /dev/null @@ -1,156 +0,0 @@ -# J-Quants API 信用取引週末残高データ項目概要 - -このドキュメントは、J-Quants APIの信用取引週末残高エンドポイント (`/markets/weekly_margin_interest`) のレスポンスデータ項目について説明します。 - -## データ型について -- 日付フィールドは `String` 型で返されます(YYYY-MM-DD形式) -- 残高数量データは `Number` 型で返されます -- 残高の単位は株数です - -## エンドポイント概要 - -### 信用取引週末残高 (/markets/weekly_margin_interest) - -#### 概要 -- **エンドポイント**: `https://api.jquants.com/v1/markets/weekly_margin_interest` -- **HTTPメソッド**: GET -- **説明**: 週末時点での、各銘柄についての信用取引残高(株数)を取得することができます。 - -#### 公式情報源 -配信データは下記のページで公表している内容と同一です: -- https://www.jpx.co.jp/markets/statistics-equities/margin/05.html - -#### 本APIの留意点 -- **株数調整なし**: 当該銘柄のコーポレートアクションが発生した場合も、遡及して株数の調整は行われません -- **営業日制限**: 年末年始など、営業日が2日以下の週はデータが提供されません -- **対象銘柄**: 東証上場銘柄でない銘柄(地方取引所単独上場銘柄)についてはデータの収録対象外となっています - -#### リクエストパラメータ - -データの取得では、銘柄コード(code)または日付(date)の指定が必須となります。 - -| パラメータ名 | 型 | 必須 | 説明 | 例 | -|------------|-----|------|------|-----| -| code | String | いいえ* | 銘柄コード | 27800 or 2780 | -| date | String | いいえ* | 申込日付 | 20210907 or 2021-09-07 | -| from | String | いいえ | 期間の開始日 | 20210901 or 2021-09-01 | -| to | String | いいえ | 期間の終了日 | 20210907 or 2021-09-07 | -| pagination_key | String | いいえ | 検索の先頭を指定する文字列 | 過去の検索で返却されたpagination_key | - -*codeまたはdateのいずれかが必須 - -#### パラメータの組み合わせパターン - -| code | date | from/to | レスポンスの結果 | -|------|------|---------|-----------------| -| 指定あり | - | 指定なし | 指定された銘柄について全期間分のデータ | -| 指定あり | - | 指定あり | 指定された銘柄について指定された期間分のデータ | -| 指定なし | 指定あり | - | 全上場銘柄について指定された日付のデータ | - -#### 銘柄コード指定時の注意 -4桁の銘柄コードを指定した場合は、普通株式と優先株式の両方が上場している銘柄においては普通株式のデータのみが取得されます。 - -#### リクエストヘッダー - -| ヘッダー名 | 型 | 必須 | 説明 | -|----------|-----|------|------| -| Authorization | String | はい | アクセスキー | - -#### レスポンスフィールド - -##### 基本情報 - -| フィールド名 | 日本語説明 | 型 | 備考 | -|------------|----------|-----|------| -| Date | 申込日付 | String | YYYY-MM-DD形式、信用取引残高基準となる時点(通常は金曜日付) | -| Code | 銘柄コード | String | | -| IssueType | 銘柄区分 | String | 1: 信用銘柄、2: 貸借銘柄、3: その他 | - -##### 信用取引残高(売建) - -| フィールド名 | 日本語説明 | 型 | 備考 | -|------------|----------|-----|------| -| ShortMarginTradeVolume | 売合計信用取引週末残高 | Number | 売建の総残高 | -| ShortNegotiableMarginTradeVolume | 売一般信用取引週末残高 | Number | 売合計のうち一般信用によるもの | -| ShortStandardizedMarginTradeVolume | 売制度信用取引週末残高 | Number | 売合計のうち制度信用によるもの | - -##### 信用取引残高(買建) - -| フィールド名 | 日本語説明 | 型 | 備考 | -|------------|----------|-----|------| -| LongMarginTradeVolume | 買合計信用取引週末残高 | Number | 買建の総残高 | -| LongNegotiableMarginTradeVolume | 買一般信用取引週末残高 | Number | 買合計のうち一般信用によるもの | -| LongStandardizedMarginTradeVolume | 買制度信用取引週末残高 | Number | 買合計のうち制度信用によるもの | - -## 銘柄区分(IssueType)について - -| 区分値 | 説明 | 備考 | -|-------|------|------| -| 1 | 信用銘柄 | 制度信用取引のみ可能 | -| 2 | 貸借銘柄 | 制度信用取引・貸借取引ともに可能 | -| 3 | その他 | 一般信用取引のみまたは取引不可 | - -## 使用上の注意事項 - -1. **データ基準日** - - 週末(通常は金曜日)時点の残高データ - - 年末年始等で営業日が2日以下の週はデータなし - -2. **株数調整** - - コーポレートアクション発生時も遡及調整は行われない - - 株式分割等の際は注意が必要 - -3. **対象銘柄の制限** - - 東証上場銘柄のみが対象 - - 地方取引所単独上場銘柄は対象外 - -4. **信用取引の種類** - - 制度信用取引:証券金融会社が資金・株券を融通 - - 一般信用取引:証券会社が独自に資金・株券を融通 - -## サンプルレスポンス - -```json -{ - "weekly_margin_interest": [ - { - "Date": "2023-02-17", - "Code": "13010", - "ShortMarginTradeVolume": 4100.0, - "LongMarginTradeVolume": 27600.0, - "ShortNegotiableMarginTradeVolume": 1300.0, - "LongNegotiableMarginTradeVolume": 7600.0, - "ShortStandardizedMarginTradeVolume": 2800.0, - "LongStandardizedMarginTradeVolume": 20000.0, - "IssueType": "2" - } - ], - "pagination_key": "value1.value2." -} -``` - -## 活用例 - -### 特定銘柄の信用残高推移を取得 -``` -/markets/weekly_margin_interest?code=86970&from=20230101&to=20230331 -``` - -### 特定日の全銘柄信用残高を取得 -``` -/markets/weekly_margin_interest?date=20230217 -``` - -### 制度信用と一般信用の残高比較 -レスポンスの制度信用残高フィールド(`*StandardizedMarginTradeVolume`)と一般信用残高フィールド(`*NegotiableMarginTradeVolume`)を比較分析 - -### 売建・買建バランス分析 -売建残高(`Short*`)と買建残高(`Long*`)のバランスから市場心理を分析 - -## 関連情報 - -このAPIは信用取引の週末残高データを提供するものです。関連する他のAPIについては以下を参照してください: -- 株価四本値:`/prices/daily_quotes`(個別銘柄の株価) -- 業種別空売り比率:`/markets/short_selling`(空売りデータ) -- 売買内訳データ:`/markets/breakdown`(詳細な売買内訳) -- 取引カレンダー:`/markets/trading_calendar`(営業日情報) \ No newline at end of file diff --git a/docs/v2/drv-bars-daily-fut-derivative-product-category.md b/docs/v2/drv-bars-daily-fut-derivative-product-category.md deleted file mode 100644 index 90ec559..0000000 --- a/docs/v2/drv-bars-daily-fut-derivative-product-category.md +++ /dev/null @@ -1,34 +0,0 @@ -# Protocol API Reference - J-Quants - -> プロが活用する株価や財務データを、APIで簡単に取得。あなたの投資分析に、確かな情報を。 - -- Dashboard -- Support - -- GuidesJ-Quants APIについてV1 API から V2 API への変更点プランごとに利用可能なAPIとデータ格納期間提供データの更新タイミングクイックスタートMCPサーバー -- Noticesデータ修正履歴・制約事項レスポンスのページングについてレートリミットについてAPIレスポンスのGzip化レスポンスステータス -- Resources上場銘柄一覧(/equities/master)17業種コード及び業種名33業種コード及び業種名市場区分コード及び市場区分名株価四本値(/equities/bars/daily)前場四本値(/equities/bars/daily/am)投資部門別情報(/equities/investor-types)市場名信用取引週末残高(/markets/margin-interest)業種別空売り比率(/markets/short-ratio)空売り残高報告(/markets/short-sale-report)日々公表信用取引残高(/markets/margin-alert)公表の理由東証信用貸借規制区分売買内訳データ(/markets/breakdown)取引カレンダー(/markets/calendar)休日区分指数四本値(/indices/bars/daily)配信対象指数コードTOPIX指数四本値(/indices/bars/daily/topix)財務情報(/fins/summary)開示書類種別財務諸表(BS/PL/CF)(/fins/details)配当金情報(/fins/dividend)リファレンスナンバー決算発表予定日(/equities/earnings-calendar)日経225オプション四本値(/derivatives/bars/daily/options/225)先物四本値(/derivatives/bars/daily/futures)先物商品区分コードオプション四本値(/derivatives/bars/daily/options)オプション商品区分コード -- Sign in - -# 先物商品区分コード - -| コード | 商品区分名称 | データ収録期間 | -|------|------|------| -| TOPIXF | TOPIX先物 | 2008/5/7〜 | -| TOPIXMF | ミニTOPIX先物 | 2008/6/16〜 | -| MOTF | マザーズ先物 | 2016/7/19〜 | -| NKVIF | 日経平均VI先物 | 2012/2/27〜 | -| NKYDF | 日経平均・配当指数先物 | 2010/7/26〜 | -| NK225F | 日経225先物 | 2008/5/7〜 | -| NK225MF | 日経225mini先物 | 2008/5/7〜 | -| JN400F | JPX日経インデックス400先物 | 2014/11/25〜 | -| REITF | 東証REIT指数先物 | 2008/6/16〜 | -| DJIAF | NYダウ先物 | 2012/5/28〜 | -| JGBLF | 長期国債先物 | 2008/5/7〜 | -| NK225MCF | 日経225マイクロ先物 | 2023/5/29〜 | -| TOA3MF | TONA3ヶ月金利先物 | 2023/5/29〜 | - -Was this page helpful? - -© JPX Market Innovation & Research, Inc. All rights reserved. - diff --git a/docs/v2/drv-bars-daily-fut.md b/docs/v2/drv-bars-daily-fut.md deleted file mode 100644 index be95142..0000000 --- a/docs/v2/drv-bars-daily-fut.md +++ /dev/null @@ -1,230 +0,0 @@ -# Protocol API Reference - J-Quants - -> プロが活用する株価や財務データを、APIで簡単に取得。あなたの投資分析に、確かな情報を。 - -- Dashboard -- Support - -- GuidesJ-Quants APIについてV1 API から V2 API への変更点プランごとに利用可能なAPIとデータ格納期間提供データの更新タイミングクイックスタートMCPサーバー -- Noticesデータ修正履歴・制約事項レスポンスのページングについてレートリミットについてAPIレスポンスのGzip化レスポンスステータス -- Resources上場銘柄一覧(/equities/master)17業種コード及び業種名33業種コード及び業種名市場区分コード及び市場区分名株価四本値(/equities/bars/daily)前場四本値(/equities/bars/daily/am)投資部門別情報(/equities/investor-types)市場名信用取引週末残高(/markets/margin-interest)業種別空売り比率(/markets/short-ratio)空売り残高報告(/markets/short-sale-report)日々公表信用取引残高(/markets/margin-alert)公表の理由東証信用貸借規制区分売買内訳データ(/markets/breakdown)取引カレンダー(/markets/calendar)休日区分指数四本値(/indices/bars/daily)配信対象指数コードTOPIX指数四本値(/indices/bars/daily/topix)財務情報(/fins/summary)開示書類種別財務諸表(BS/PL/CF)(/fins/details)配当金情報(/fins/dividend)リファレンスナンバー決算発表予定日(/equities/earnings-calendar)日経225オプション四本値(/derivatives/bars/daily/options/225)先物四本値(/derivatives/bars/daily/futures)先物商品区分コードオプション四本値(/derivatives/bars/daily/options)オプション商品区分コード -- Sign in - -# 先物四本値(/derivatives/bars/daily/futures) - -GET /v2/derivatives/bars/daily/futures - -## APIの概要 - -先物に関する、四本値や清算値段、理論価格に関する情報を取得することができます。 -また、本APIで取得可能なデータについては -先物商品区分コード一覧を参照ください。 - -## 本APIの留意点 - -- 銘柄コードについて - -先物・オプション取引識別コードの付番規則については証券コード関係の関係資料等を参照してください。 -- 取引セッションについて - -2011年2月10日以前は、ナイトセッション、前場、後場で構成されています。 -この期間の前場データは収録されず、後場データが日中場データとして収録されます。なお、日通しデータについては、全立会を含めたデータとなります。 -2011年2月14日以降は、ナイトセッション、日中場で構成されています。 -- 祝日取引について - -祝日取引の取引日については、祝日取引実施日直前の平日に開始するナイト・セッション(祝日前営業日)及び祝日取引実施日直後の平日(祝日翌営業日)のデイ・セッションと同一の取引日として扱います。 -- レスポンスのキー項目について - -緊急取引証拠金が発動した場合は、同一の取引日・銘柄に対して清算価格算出時と緊急取引証拠金算出時のデータが発生します。そのため、Date、Codeに加えてEmMrgnTrgDiv(EmergencyMarginTriggerDivision)を組み合わせることでデータを一意に識別することが可能です。 - -## 日次の先物四本値データ取得 - -GET https://api.jquants.com/v2/derivatives/bars/daily/futures - -データの取得では、日付(date)の指定が必須となります。 - -### Requests - -### Headers - -**x-api-key** (string, required) - APIキー - - -### Query Parameters - -date の指定が必須です。 - -**category** (string, optional) - 商品区分の指定 - -**date** (string, required) - date の指定(e.g. 20210901 or 2021-09-01) - -**contract_flag** (string, optional) - 中心限月フラグの指定 - -**pagination_key** (string, optional) - 検索の先頭を指定する文字列 -過去の検索で返却された pagination_key を設定 - - -### APIコールサンプルコード - -### Request - -``` -curl -G https://api.jquants.com/v2/derivatives/bars/daily/futures --H "x-api-key: {loading}" --d date="20230324" -``` - -### Responses - -### データ項目概要 - -**Code** (string) - 銘柄コード - -**ProdCat** (string) - 先物商品区分 - -**Date** (string) - 取引日(YYYY-MM-DD) - -**O** (number) - 日通し始値 - -**H** (number) - 日通し高値 - -**L** (number) - 日通し安値 - -**C** (number) - 日通し終値 - -**MO** (number | string) - 前場始値 -前後場取引対象銘柄でない場合、空文字を設定。 - -**MH** (number | string) - 前場高値 -前後場取引対象銘柄でない場合、空文字を設定。 - -**ML** (number | string) - 前場安値 -前後場取引対象銘柄でない場合、空文字を設定。 - -**MC** (number | string) - 前場終値 -前後場取引対象銘柄でない場合、空文字を設定。 - -**EO** (number | string) - ナイト・セッション始値 -取引開始日初日の銘柄はナイト・セッションが存在しないため、空文字を設定。 - -**EH** (number | string) - ナイト・セッション高値 -取引開始日初日の銘柄はナイト・セッションが存在しないため、空文字を設定。 - -**EL** (number | string) - ナイト・セッション安値 -取引開始日初日の銘柄はナイト・セッションが存在しないため、空文字を設定。 - -**EC** (number | string) - ナイト・セッション終値 -取引開始日初日の銘柄はナイト・セッションが存在しないため、空文字を設定。 - -**AO** (number) - 日中始値 - -**AH** (number) - 日中高値 - -**AL** (number) - 日中安値 - -**AC** (number) - 日中終値 - -**Vo** (number) - 取引高 - -**OI** (number) - 建玉 - -**Va** (number) - 取引代金 - -**CM** (string) - 限月(YYYY-MM) - -**VoOA** (number) - 立会内取引高(※1) - -**EmMrgnTrgDiv** (string) - 緊急取引証拠金発動区分 -001: 緊急取引証拠金発動時、002: 清算価格算出時。 -"001" は2016年7月19日以降に緊急取引証拠金発動した場合のみ収録。 - -**LTD** (string) - 取引最終年月日(YYYY-MM-DD)(※1) - -**SQD** (string) - SQ日(YYYY-MM-DD)(※1) - -**Settle** (number) - 清算値段(※1) - -**CCMFlag** (string) - 中心限月フラグ(1:中心限月、0:その他)(※1) - - -※1 2016年7月19日以降のみ提供。 - -### レスポンスサンプル - -``` -{ - "data": [ - { - "Code": "169090005", - "ProdCat": "TOPIXF", - "Date": "2024-07-23", - "O": 2825.5, - "H": 2853.0, - "L": 2825.5, - "C": 2829.0, - "MO": "", - "MH": "", - "ML": "", - "MC": "", - "EO": 2825.5, - "EH": 2850.0, - "EL": 2825.5, - "EC": 2845.0, - "AO": 2850.5, - "AH": 2853.0, - "AL": 2826.0, - "AC": 2829.0, - "Vo": 42910.0, - "OI": 479812.0, - "Va": 1217918971856.0, - "CM": "2024-09", - "VoOA": 40405.0, - "EmMrgnTrgDiv": "002", - "LTD": "2024-09-12", - "SQD": "2024-09-13", - "Settle": 2829.0, - "CCMFlag": "1" - } - ], - "pagination_key": "value1.value2." -} -``` - -Was this page helpful? - -© JPX Market Innovation & Research, Inc. All rights reserved. - diff --git a/docs/v2/drv-bars-daily-opt-225.md b/docs/v2/drv-bars-daily-opt-225.md deleted file mode 100644 index fe22b11..0000000 --- a/docs/v2/drv-bars-daily-opt-225.md +++ /dev/null @@ -1,219 +0,0 @@ -# Protocol API Reference - J-Quants - -> プロが活用する株価や財務データを、APIで簡単に取得。あなたの投資分析に、確かな情報を。 - -- Dashboard -- Support - -- GuidesJ-Quants APIについてV1 API から V2 API への変更点プランごとに利用可能なAPIとデータ格納期間提供データの更新タイミングクイックスタートMCPサーバー -- Noticesデータ修正履歴・制約事項レスポンスのページングについてレートリミットについてAPIレスポンスのGzip化レスポンスステータス -- Resources上場銘柄一覧(/equities/master)17業種コード及び業種名33業種コード及び業種名市場区分コード及び市場区分名株価四本値(/equities/bars/daily)前場四本値(/equities/bars/daily/am)投資部門別情報(/equities/investor-types)市場名信用取引週末残高(/markets/margin-interest)業種別空売り比率(/markets/short-ratio)空売り残高報告(/markets/short-sale-report)日々公表信用取引残高(/markets/margin-alert)公表の理由東証信用貸借規制区分売買内訳データ(/markets/breakdown)取引カレンダー(/markets/calendar)休日区分指数四本値(/indices/bars/daily)配信対象指数コードTOPIX指数四本値(/indices/bars/daily/topix)財務情報(/fins/summary)開示書類種別財務諸表(BS/PL/CF)(/fins/details)配当金情報(/fins/dividend)リファレンスナンバー決算発表予定日(/equities/earnings-calendar)日経225オプション四本値(/derivatives/bars/daily/options/225)先物四本値(/derivatives/bars/daily/futures)先物商品区分コードオプション四本値(/derivatives/bars/daily/options)オプション商品区分コード -- Sign in - -# 日経225オプション四本値(/derivatives/bars/daily/options/225) - -GET /v2/derivatives/bars/daily/options/225 - -## APIの概要 - -日経225オプションに関する、四本値や清算値段、理論価格に関する情報を取得することができます。 -また、本APIで取得可能なデータは日経225指数オプション(Weeklyオプション及びフレックスオプションを除く)のみとなります。 - -## 本APIの留意点 - -- 取引セッションについて - -2011年2月10日以前は、ナイトセッション、前場、後場で構成されています。 -この期間の前場データは収録されず、後場データが日中場データとして収録されます。なお、日通しデータについては、全立会を含めたデータとなります。 -2011年2月14日以降は、ナイトセッション、日中場で構成されています。 -- レスポンスのキー項目について - -緊急取引証拠金が発動した場合は、同一の取引日・銘柄に対して清算価格算出時と緊急取引証拠金算出時のデータが発生します。そのため、Date、Codeに加えてEmMrgnTrgDiv(EmergencyMarginTriggerDivision)を組み合わせることでデータを一意に識別することが可能です。 - -## 日次の日経225オプションデータ取得 - -GET https://api.jquants.com/v2/derivatives/bars/daily/options/225 - -日付(date)の指定が必須です。 - -### Requests - -### Headers - -**x-api-key** (string, required) - APIキー - - -### Query Parameters - -date の指定が必須です。 - -**date** (string, required) - date の指定(e.g. 20210901 or 2021-09-01) - -**pagination_key** (string, optional) - 検索の先頭を指定する文字列 -過去の検索で返却された pagination_key を設定 - - -### APIコールサンプルコード - -### Request - -``` -curl -G https://api.jquants.com/v2/derivatives/bars/daily/options/225 --H "x-api-key: {loading}" --d date="20230324" -``` - -### Responses - -### データ項目概要 - -**Date** (string) - 取引日(YYYY-MM-DD) - -**Code** (string) - 銘柄コード - -**O** (number) - 日通し始値 - -**H** (number) - 日通し高値 - -**L** (number) - 日通し安値 - -**C** (number) - 日通し終値 - -**EO** (number | string) - ナイト・セッション始値 -取引開始日初日の銘柄はナイト・セッションが存在しないため、空文字を設定。 - -**EH** (number | string) - ナイト・セッション高値 -取引開始日初日の銘柄はナイト・セッションが存在しないため、空文字を設定。 - -**EL** (number | string) - ナイト・セッション安値 -取引開始日初日の銘柄はナイト・セッションが存在しないため、空文字を設定。 - -**EC** (number | string) - ナイト・セッション終値 -取引開始日初日の銘柄はナイト・セッションが存在しないため、空文字を設定。 - -**AO** (number) - 日中始値 - -**AH** (number) - 日中高値 - -**AL** (number) - 日中安値 - -**AC** (number) - 日中終値 - -**Vo** (number) - 取引高 - -**OI** (number) - 建玉 - -**Va** (number) - 取引代金 - -**CM** (string) - 限月(YYYY-MM) - -**Strike** (number) - 権利行使価格 - -**VoOA** (number) - 立会内取引高(※1) - -**EmMrgnTrgDiv** (string) - 緊急取引証拠金発動区分 -001: 緊急取引証拠金発動時、002: 清算価格算出時。 -"001" は2016年7月19日以降に緊急取引証拠金発動した場合のみ収録。 - -**PCDiv** (string) - プットコール区分 -1: プット、2: コール - -**LTD** (string) - 取引最終年月日(YYYY-MM-DD)(※1) - -**SQD** (string) - SQ日(YYYY-MM-DD)(※1) - -**Settle** (number) - 清算値段(※1) - -**Theo** (number) - 理論価格(※1) - -**BaseVol** (number) - 基準ボラティリティ -アット・ザ・マネープット及びコールそれぞれのインプライドボラティリティの中間値(※1) - -**UnderPx** (number) - 原証券価格(※1) - -**IV** (number) - インプライドボラティリティ(※1) - -**IR** (number) - 理論価格計算用金利(※1) - - -※1 2016年7月19日以降のみ提供。 - -### レスポンスサンプル - -``` -{ - "data": [ - { - "Date": "2023-03-22", - "Code": "130060018", - "O": 0.0, - "H": 0.0, - "L": 0.0, - "C": 0.0, - "EO": 0.0, - "EH": 0.0, - "EL": 0.0, - "EC": 0.0, - "AO": 0.0, - "AH": 0.0, - "AL": 0.0, - "AC": 0.0, - "Vo": 0.0, - "OI": 330.0, - "Va": 0.0, - "CM": "2025-06", - "Strike": 20000.0, - "VoOA": 0.0, - "EmMrgnTrgDiv": "002", - "PCDiv": "1", - "LTD": "2025-06-12", - "SQD": "2025-06-13", - "Settle": 980.0, - "Theo": 974.641, - "BaseVol": 17.93025, - "UnderPx": 27466.61, - "IV": 23.1816, - "IR": 0.2336 - } - ], - "pagination_key": "value1.value2." -} -``` - -Was this page helpful? - -© JPX Market Innovation & Research, Inc. All rights reserved. - diff --git a/docs/v2/drv-bars-daily-opt-derivative-product-category.md b/docs/v2/drv-bars-daily-opt-derivative-product-category.md deleted file mode 100644 index 1f3c771..0000000 --- a/docs/v2/drv-bars-daily-opt-derivative-product-category.md +++ /dev/null @@ -1,26 +0,0 @@ -# Protocol API Reference - J-Quants - -> プロが活用する株価や財務データを、APIで簡単に取得。あなたの投資分析に、確かな情報を。 - -- Dashboard -- Support - -- GuidesJ-Quants APIについてV1 API から V2 API への変更点プランごとに利用可能なAPIとデータ格納期間提供データの更新タイミングクイックスタートMCPサーバー -- Noticesデータ修正履歴・制約事項レスポンスのページングについてレートリミットについてAPIレスポンスのGzip化レスポンスステータス -- Resources上場銘柄一覧(/equities/master)17業種コード及び業種名33業種コード及び業種名市場区分コード及び市場区分名株価四本値(/equities/bars/daily)前場四本値(/equities/bars/daily/am)投資部門別情報(/equities/investor-types)市場名信用取引週末残高(/markets/margin-interest)業種別空売り比率(/markets/short-ratio)空売り残高報告(/markets/short-sale-report)日々公表信用取引残高(/markets/margin-alert)公表の理由東証信用貸借規制区分売買内訳データ(/markets/breakdown)取引カレンダー(/markets/calendar)休日区分指数四本値(/indices/bars/daily)配信対象指数コードTOPIX指数四本値(/indices/bars/daily/topix)財務情報(/fins/summary)開示書類種別財務諸表(BS/PL/CF)(/fins/details)配当金情報(/fins/dividend)リファレンスナンバー決算発表予定日(/equities/earnings-calendar)日経225オプション四本値(/derivatives/bars/daily/options/225)先物四本値(/derivatives/bars/daily/futures)先物商品区分コードオプション四本値(/derivatives/bars/daily/options)オプション商品区分コード -- Sign in - -# オプション商品区分コード - -| 商品区分コード | 商品区分名称 | データ収録期間 | -|------|------|------| -| TOPIXE | TOPIXオプション | 2008/5/7〜 | -| NK225E | 日経225オプション | 2008/5/7〜 | -| JGBLFE | 長期国債先物オプション | 2008/5/7〜 | -| EQOP | 有価証券オプション | 2014/11/17〜 | -| NK225MWE | 日経225miniオプション | 2023/5/29〜 | - -Was this page helpful? - -© JPX Market Innovation & Research, Inc. All rights reserved. - diff --git a/docs/v2/drv-bars-daily-opt.md b/docs/v2/drv-bars-daily-opt.md deleted file mode 100644 index 1a1dae5..0000000 --- a/docs/v2/drv-bars-daily-opt.md +++ /dev/null @@ -1,271 +0,0 @@ -# Protocol API Reference - J-Quants - -> プロが活用する株価や財務データを、APIで簡単に取得。あなたの投資分析に、確かな情報を。 - -- Dashboard -- Support - -- GuidesJ-Quants APIについてV1 API から V2 API への変更点プランごとに利用可能なAPIとデータ格納期間提供データの更新タイミングクイックスタートMCPサーバー -- Noticesデータ修正履歴・制約事項レスポンスのページングについてレートリミットについてAPIレスポンスのGzip化レスポンスステータス -- Resources上場銘柄一覧(/equities/master)17業種コード及び業種名33業種コード及び業種名市場区分コード及び市場区分名株価四本値(/equities/bars/daily)前場四本値(/equities/bars/daily/am)投資部門別情報(/equities/investor-types)市場名信用取引週末残高(/markets/margin-interest)業種別空売り比率(/markets/short-ratio)空売り残高報告(/markets/short-sale-report)日々公表信用取引残高(/markets/margin-alert)公表の理由東証信用貸借規制区分売買内訳データ(/markets/breakdown)取引カレンダー(/markets/calendar)休日区分指数四本値(/indices/bars/daily)配信対象指数コードTOPIX指数四本値(/indices/bars/daily/topix)財務情報(/fins/summary)開示書類種別財務諸表(BS/PL/CF)(/fins/details)配当金情報(/fins/dividend)リファレンスナンバー決算発表予定日(/equities/earnings-calendar)日経225オプション四本値(/derivatives/bars/daily/options/225)先物四本値(/derivatives/bars/daily/futures)先物商品区分コードオプション四本値(/derivatives/bars/daily/options)オプション商品区分コード -- Sign in - -# オプション四本値(/derivatives/bars/daily/options) - -GET /v2/derivatives/bars/daily/options - -オプションデータ(四本値・清算値等)を取得することができます。 - -## APIの概要 - -オプションに関する、四本値や清算値段、理論価格に関する情報を取得することができます。 -また、本APIで取得可能なデータについては -オプション商品区分コード一覧を参照ください。 - -## 本APIの留意点 - -- 銘柄コードについて - -先物・オプション取引識別コードの付番規則については証券コード関係の関係資料等を参照してください。 -- 取引セッションについて - -2011年2月10日以前は、ナイトセッション、前場、後場で構成されています。 -この期間の前場データは収録されず、後場データが日中場データとして収録されます。なお、日通しデータについては、全立会を含めたデータとなります。 -2011年2月14日以降は、ナイトセッション、日中場で構成されています。 -- 祝日取引について - -祝日取引の取引日については、祝日取引実施日直前の平日に開始するナイト・セッション(祝日前営業日)及び祝日取引実施日直後の平日(祝日翌営業日)のデイ・セッションと同一の取引日として扱います。 -- レスポンスのキー項目について - -緊急取引証拠金が発動した場合は、同一の取引日・銘柄に対して清算価格算出時と緊急取引証拠金算出時のデータが発生します。そのため、Date、Codeに加えてEmMrgnTrgDiv(EmergencyMarginTriggerDivision)を組み合わせることでデータを一意に識別することが可能です。 - -## 日次のオプション四本値データ取得 - -GET https://api.jquants.com/v2/derivatives/bars/daily/options - -データの取得では、日付(date)の指定が必須となります。 - -### Requests - -### Headers - -**x-api-key** (string, required) - APIキー - - -### Query Parameters - -date の指定が必須です。 - -**category** (string, optional) - 商品区分の指定 - -**code** (string, optional) - 対象有価証券コード -category で有価証券オプションを指定した場合に設定 - -**date** (string, required) - date の指定(e.g. 20210901 or 2021-09-01) - -**contract_flag** (string, optional) - 中心限月フラグの指定 - -**pagination_key** (string, optional) - 検索の先頭を指定する文字列 -過去の検索で返却された pagination_key を設定 - - -### APIコールサンプルコード - -### Request - -``` -curl -G https://api.jquants.com/v2/derivatives/bars/daily/options --H "x-api-key: {loading}" --d date="20230324" -``` - -### Responses - -### データ項目概要 - -**Code** (string) - 銘柄コード - -**ProdCat** (string) - オプション商品区分 - -**UndSSO** (string) - 有価証券オプション対象銘柄 -有価証券オプション以外の場合は "-" を設定 - -**Date** (string) - 取引日(YYYY-MM-DD) - -**O** (number) - 日通し始値 - -**H** (number) - 日通し高値 - -**L** (number) - 日通し安値 - -**C** (number) - 日通し終値 - -**MO** (number | string) - 前場始値 -前後場取引対象銘柄でない場合、空文字を設定。 - -**MH** (number | string) - 前場高値 -前後場取引対象銘柄でない場合、空文字を設定。 - -**ML** (number | string) - 前場安値 -前後場取引対象銘柄でない場合、空文字を設定。 - -**MC** (number | string) - 前場終値 -前後場取引対象銘柄でない場合、空文字を設定。 - -**EO** (number | string) - ナイト・セッション始値 -取引開始日初日の銘柄はナイト・セッションが存在しないため、空文字を設定。 - -**EH** (number | string) - ナイト・セッション高値 -取引開始日初日の銘柄はナイト・セッションが存在しないため、空文字を設定。 - -**EL** (number | string) - ナイト・セッション安値 -取引開始日初日の銘柄はナイト・セッションが存在しないため、空文字を設定。 - -**EC** (number | string) - ナイト・セッション終値 -取引開始日初日の銘柄はナイト・セッションが存在しないため、空文字を設定。 - -**AO** (number) - 日中始値 - -**AH** (number) - 日中高値 - -**AL** (number) - 日中安値 - -**AC** (number) - 日中終値 - -**Vo** (number) - 取引高 - -**OI** (number) - 建玉 - -**Va** (number) - 取引代金 - -**CM** (string) - 限月(YYYY-MM) -日経225miniオプションの場合、月ではなく週の表記となります(e.g. 2024-51 は 2024 年の 51 週目)。 - -**Strike** (number) - 権利行使価格 - -**VoOA** (number) - 立会内取引高(※1) - -**EmMrgnTrgDiv** (string) - 緊急取引証拠金発動区分 -001: 緊急取引証拠金発動時、002: 清算価格算出時。 -"001" は2016年7月19日以降に緊急取引証拠金発動した場合のみ収録。 - -**PCDiv** (string) - プットコール区分 -1: プット、2: コール - -**LTD** (string) - 取引最終年月日(YYYY-MM-DD)(※1) - -**SQD** (string) - SQ日(YYYY-MM-DD)(※1) - -**Settle** (number) - 清算値段(※1) - -**Theo** (number) - 理論価格(※1) - -**BaseVol** (number) - 基準ボラティリティ(※1) - -**UnderPx** (number) - 原証券価格(※1) - -**IV** (number) - インプライドボラティリティ(※1) - -**IR** (number) - 理論価格計算用金利(※1) - -**CCMFlag** (string) - 中心限月フラグ(1:中心限月、0:その他)(※1) - - -※1 2016年7月19日以降のみ提供。 - -### レスポンスサンプル - -``` -{ - "data": [ - { - "Code": "140014505", - "ProdCat": "TOPIXE", - "UndSSO": "-", - "Date": "2024-07-23", - "O": 0.0, - "H": 0.0, - "L": 0.0, - "C": 0.0, - "MO": "", - "MH": "", - "ML": "", - "MC": "", - "EO": 0.0, - "EH": 0.0, - "EL": 0.0, - "EC": 0.0, - "AO": 0.0, - "AH": 0.0, - "AL": 0.0, - "AC": 0.0, - "Vo": 0.0, - "OI": 0.0, - "Va": 0.0, - "CM": "2025-01", - "Strike": 2450.0, - "VoOA": 0.0, - "EmMrgnTrgDiv": "002", - "PCDiv": "2", - "LTD": "2025-01-09", - "SQD": "2025-01-10", - "Settle": 377.0, - "Theo": 380.3801, - "BaseVol": 18.115, - "UnderPx": 2833.39, - "IV": 17.2955, - "IR": 0.3527, - "CCMFlag": "0" - } - ], - "pagination_key": "value1.value2." -} -``` - -Was this page helpful? - -© JPX Market Innovation & Research, Inc. All rights reserved. - diff --git a/docs/v2/eq-bars-daily-am.md b/docs/v2/eq-bars-daily-am.md deleted file mode 100644 index 1926727..0000000 --- a/docs/v2/eq-bars-daily-am.md +++ /dev/null @@ -1,126 +0,0 @@ -# Protocol API Reference - J-Quants - -> プロが活用する株価や財務データを、APIで簡単に取得。あなたの投資分析に、確かな情報を。 - -- Dashboard -- Support - -- GuidesJ-Quants APIについてV1 API から V2 API への変更点プランごとに利用可能なAPIとデータ格納期間提供データの更新タイミングクイックスタートMCPサーバー -- Noticesデータ修正履歴・制約事項レスポンスのページングについてレートリミットについてAPIレスポンスのGzip化レスポンスステータス -- Resources上場銘柄一覧(/equities/master)17業種コード及び業種名33業種コード及び業種名市場区分コード及び市場区分名株価四本値(/equities/bars/daily)前場四本値(/equities/bars/daily/am)投資部門別情報(/equities/investor-types)市場名信用取引週末残高(/markets/margin-interest)業種別空売り比率(/markets/short-ratio)空売り残高報告(/markets/short-sale-report)日々公表信用取引残高(/markets/margin-alert)公表の理由東証信用貸借規制区分売買内訳データ(/markets/breakdown)取引カレンダー(/markets/calendar)休日区分指数四本値(/indices/bars/daily)配信対象指数コードTOPIX指数四本値(/indices/bars/daily/topix)財務情報(/fins/summary)開示書類種別財務諸表(BS/PL/CF)(/fins/details)配当金情報(/fins/dividend)リファレンスナンバー決算発表予定日(/equities/earnings-calendar)日経225オプション四本値(/derivatives/bars/daily/options/225)先物四本値(/derivatives/bars/daily/futures)先物商品区分コードオプション四本値(/derivatives/bars/daily/options)オプション商品区分コード -- Sign in - -# 前場四本値(/equities/bars/daily/am) - -GET /v2/equities/bars/daily/am - -## APIの概要 - -前場終了時に、前場の株価データを取得することができます。 - -### 本APIの留意点 - -- 前場の取引高が存在しない(売買されていない)銘柄についての四本値、取引高と売買代金は、null が収録されています。 -- 東証上場銘柄でない銘柄(地方取引所単独上場銘柄)についてはデータの収録対象外となっております。 -- なお、当日のデータは翌日6:00頃まで取得可能です。ヒストリカルの前場四本値については -株価四本値(/equities/bars/daily) -をご利用ください。 - -## 前場の株価データを取得します - -GET https://api.jquants.com/v2/equities/bars/daily/am - -データの取得では、銘柄コード(code)が指定できます。 - -### パラメータ及びレスポンス - -データの取得では、銘柄コード(code)の指定が可能です。 -各パラメータの組み合わせとレスポンスの結果については以下のとおりです。 - -| code | レスポンスの結果 | -|------|------| -| ✓ | 指定された銘柄についての前場の株価データ | -| ✗ | 全上場銘柄について前場の株価データ | - -### Requests - -### Headers - -**x-api-key** (string, required) - APIキー - - -### Query Parameters - -**code** (string, optional) - 銘柄コード(e.g. 27800 or 2780) -4桁の銘柄コードを指定した場合は、普通株式と優先株式の両方が上場している銘柄においては普通株式のデータのみが取得されます。 - -**pagination_key** (string, optional) - 検索の先頭を指定する文字列 -過去の検索で返却された pagination_key を設定 - - -### APIコールサンプルコード - -### Request - -``` -curl -G https://api.jquants.com/v2/equities/bars/daily/am --H "x-api-key: {loading}" --d code="39400" -``` - -### Responses - -### データ項目概要 - -**Date** (string) - 日付(YYYY-MM-DD) - -**Code** (string) - 銘柄コード - -**MO** (number) - 前場始値 - -**MH** (number) - 前場高値 - -**ML** (number) - 前場安値 - -**MC** (number) - 前場終値 - -**MVo** (number) - 前場売買高 - -**MVa** (number) - 前場取引代金 - - -### レスポンスサンプル - -``` -{ - "data": [ - { - "Date": "2023-03-20", - "Code": "39400", - "MO": 232.0, - "MH": 244.0, - "ML": 232.0, - "MC": 240.0, - "MVo": 52600.0, - "MVa": 12518800.0 - } - ], - "pagination_key": "value1.value2." -} -``` - -Was this page helpful? - -© JPX Market Innovation & Research, Inc. All rights reserved. - diff --git a/docs/v2/eq-bars-daily.md b/docs/v2/eq-bars-daily.md deleted file mode 100644 index 692c99f..0000000 --- a/docs/v2/eq-bars-daily.md +++ /dev/null @@ -1,278 +0,0 @@ -# Protocol API Reference - J-Quants - -> プロが活用する株価や財務データを、APIで簡単に取得。あなたの投資分析に、確かな情報を。 - -- Dashboard -- Support - -- GuidesJ-Quants APIについてV1 API から V2 API への変更点プランごとに利用可能なAPIとデータ格納期間提供データの更新タイミングクイックスタートMCPサーバー -- Noticesデータ修正履歴・制約事項レスポンスのページングについてレートリミットについてAPIレスポンスのGzip化レスポンスステータス -- Resources上場銘柄一覧(/equities/master)17業種コード及び業種名33業種コード及び業種名市場区分コード及び市場区分名株価四本値(/equities/bars/daily)前場四本値(/equities/bars/daily/am)投資部門別情報(/equities/investor-types)市場名信用取引週末残高(/markets/margin-interest)業種別空売り比率(/markets/short-ratio)空売り残高報告(/markets/short-sale-report)日々公表信用取引残高(/markets/margin-alert)公表の理由東証信用貸借規制区分売買内訳データ(/markets/breakdown)取引カレンダー(/markets/calendar)休日区分指数四本値(/indices/bars/daily)配信対象指数コードTOPIX指数四本値(/indices/bars/daily/topix)財務情報(/fins/summary)開示書類種別財務諸表(BS/PL/CF)(/fins/details)配当金情報(/fins/dividend)リファレンスナンバー決算発表予定日(/equities/earnings-calendar)日経225オプション四本値(/derivatives/bars/daily/options/225)先物四本値(/derivatives/bars/daily/futures)先物商品区分コードオプション四本値(/derivatives/bars/daily/options)オプション商品区分コード -- Sign in - -# 株価四本値(/equities/bars/daily) - -GET /v2/equities/bars/daily - -## APIの概要 - -株価データを取得することができます。 -株価は分割・併合を考慮した調整済み株価(小数点第2位四捨五入)と調整前の株価を取得することができます。 - -### 本APIの留意点 - -- 取引が存在しない日の銘柄についての四本値、取引高と売買代金は、Nullが収録されています。 -- 東証上場銘柄でない銘柄(地方取引所単独上場銘柄)についてはデータの収録対象外となっております。 -- 2020/10/1のデータは東京証券取引所の株式売買システムの障害により終日売買停止となった関係で、四本値、取引高と売買代金はNullが収録されています。 -- 日通しデータについては全プランで取得できますが、前場/後場別のデータについてはPremiumプランのみ取得可能です。 -- 株価調整については株式分割・併合にのみ対応しております。一部コーポレートアクションには対応しておりませんので、ご了承ください。 - -## 日次の株価データを取得します - -GET https://api.jquants.com/v2/equities/bars/daily - -データの取得では、銘柄コード(code)または日付(date)の指定が必須となります。 - -### パラメータ及びレスポンス - -データの取得では、銘柄コード(code)または日付(date)の指定が必須となります。 -各パラメータの組み合わせとレスポンスの結果については以下のとおりです。 - -| code | date | from /to | レスポンスの結果 | -|------|------|------|------| -| ✓ | ✗ | ✗ | 指定された銘柄について全期間分のデータ | -| ✓ | ✓ | ✗ | 指定された銘柄について指定された日付のデータ | -| ✓ | ✗ | ✓ | 指定された銘柄について指定された期間分のデータ | -| ✗ | ✓ | ✗ | 全上場銘柄について指定された日付のデータ | - -### Requests - -### Headers - -**x-api-key** (string, required) - APIキー - - -### Query Parameters - -code または date のいずれか一つの指定が必須です。 - -**code** (string, optional) - 銘柄コード(e.g. 27800 or 2780)4桁の銘柄コードを指定した場合は、普通株式と優先株式等の両方が上場している銘柄においては普通株式のデータのみが取得されます。 - -**date** (string, optional) - from と to を指定しないとき(e.g. 20210907 or 2021-09-07) - -**from** (string, optional) - fromの指定(e.g. 20210901 or 2021-09-01) - -**to** (string, optional) - to の指定(e.g. 20210907 or 2021-09-07) - -**pagination_key** (string, optional) - 検索の先頭を指定する文字列過去の検索で返却された pagination_key を設定 - - -### APIコールサンプルコード - -### Request - -``` -curl -G https://api.jquants.com/v2/equities/bars/daily --H "x-api-key: {loading}" --d code="86970" --d date="20230324" -``` - -### Responses - -### データ項目概要 - -**Date** (string) - 日付(YYYY-MM-DD) - -**Code** (string) - 銘柄コード - -**O** (number) - 始値(調整前) - -**H** (number) - 高値(調整前) - -**L** (number) - 安値(調整前) - -**C** (number) - 終値(調整前) - -**UL** (string) - 日通ストップ高フラグ(0:ストップ高以外, 1:ストップ高) - -**LL** (string) - 日通ストップ安フラグ(0:ストップ安以外, 1:ストップ安) - -**Vo** (number) - 取引高(調整前) - -**Va** (number) - 取引代金 - -**AdjFactor** (number) - 調整係数(株式分割1:2の場合、権利落ち日に 0.5 が入る) - -**AdjO** (number) - 調整済み始値(※1) - -**AdjH** (number) - 調整済み高値(※1) - -**AdjL** (number) - 調整済み安値(※1) - -**AdjC** (number) - 調整済み終値(※1) - -**AdjVo** (number) - 調整済み取引高(※1) - -**MO** (number) - 前場始値(※2) - -**MH** (number) - 前場高値(※2) - -**ML** (number) - 前場安値(※2) - -**MC** (number) - 前場終値(※2) - -**MUL** (string) - 前場ストップ高フラグ(0:ストップ高以外, 1:ストップ高),(※2) - -**MLL** (string) - 前場ストップ安フラグ(0:ストップ安以外, 1:ストップ安),(※2) - -**MVo** (number) - 前場売買高(※2) - -**MVa** (number) - 前場取引代金(※2) - -**MAdjO** (number) - 調整済み前場始値(※1, ※2) - -**MAdjH** (number) - 調整済み前場高値(※1, ※2) - -**MAdjL** (number) - 調整済み前場安値(※1, ※2) - -**MAdjC** (number) - 調整済み前場終値(※1, ※2) - -**MAdjVo** (number) - 調整済み前場売買高(※1, ※2) - -**AO** (number) - 後場始値(※2) - -**AH** (number) - 後場高値(※2) - -**AL** (number) - 後場安値(※2) - -**AC** (number) - 後場終値(※2) - -**AUL** (string) - 後場ストップ高フラグ(0:ストップ高以外, 1:ストップ高),(※2) - -**ALL** (string) - 後場ストップ安フラグ(0:ストップ安以外, 1:ストップ安),(※2) - -**AVo** (number) - 後場売買高(※2) - -**AVa** (number) - 後場取引代金(※2) - -**AAdjO** (number) - 調整済み後場始値(※1, ※2) - -**AAdjH** (number) - 調整済み後場高値(※1, ※2) - -**AAdjL** (number) - 調整済み後場安値(※1, ※2) - -**AAdjC** (number) - 調整済み後場終値(※1, ※2) - -**AAdjVo** (number) - 調整済み後場売買高(※1, ※2) - - -※1 過去の分割等を考慮した調整済みの項目です -※2 Premiumプランのみ取得可能な項目です - -### レスポンスサンプル - -``` -{ - "data": [ - { - "Date": "2023-03-24", - "Code": "86970", - "O": 2047.0, - "H": 2069.0, - "L": 2035.0, - "C": 2045.0, - "UL": "0", - "LL": "0", - "Vo": 2202500.0, - "Va": 4507051850.0, - "AdjFactor": 1.0, - "AdjO": 2047.0, - "AdjH": 2069.0, - "AdjL": 2035.0, - "AdjC": 2045.0, - "AdjVo": 2202500.0, - "MO": 2047.0, - "MH": 2069.0, - "ML": 2040.0, - "MC": 2045.5, - "MUL": "0", - "MLL": "0", - "MVo": 1121200.0, - "MVa": 2297525850.0, - "MAdjO": 2047.0, - "MAdjH": 2069.0, - "MAdjL": 2040.0, - "MAdjC": 2045.5, - "MAdjVo": 1121200.0, - "AO": 2047.0, - "AH": 2047.0, - "AL": 2035.0, - "AC": 2045.0, - "AUL": "0", - "ALL": "0", - "AVo": 1081300.0, - "AVa": 2209526000.0, - "AAdjO": 2047.0, - "AAdjH": 2047.0, - "AAdjL": 2035.0, - "AAdjC": 2045.0, - "AAdjVo": 1081300.0 - } - ], - "pagination_key": "value1.value2." -} -``` - -Was this page helpful? - -© JPX Market Innovation & Research, Inc. All rights reserved. - diff --git a/docs/v2/eq-earnings-cal.md b/docs/v2/eq-earnings-cal.md deleted file mode 100644 index 5455c18..0000000 --- a/docs/v2/eq-earnings-cal.md +++ /dev/null @@ -1,106 +0,0 @@ -# Protocol API Reference - J-Quants - -> プロが活用する株価や財務データを、APIで簡単に取得。あなたの投資分析に、確かな情報を。 - -- Dashboard -- Support - -- GuidesJ-Quants APIについてV1 API から V2 API への変更点プランごとに利用可能なAPIとデータ格納期間提供データの更新タイミングクイックスタートMCPサーバー -- Noticesデータ修正履歴・制約事項レスポンスのページングについてレートリミットについてAPIレスポンスのGzip化レスポンスステータス -- Resources上場銘柄一覧(/equities/master)17業種コード及び業種名33業種コード及び業種名市場区分コード及び市場区分名株価四本値(/equities/bars/daily)前場四本値(/equities/bars/daily/am)投資部門別情報(/equities/investor-types)市場名信用取引週末残高(/markets/margin-interest)業種別空売り比率(/markets/short-ratio)空売り残高報告(/markets/short-sale-report)日々公表信用取引残高(/markets/margin-alert)公表の理由東証信用貸借規制区分売買内訳データ(/markets/breakdown)取引カレンダー(/markets/calendar)休日区分指数四本値(/indices/bars/daily)配信対象指数コードTOPIX指数四本値(/indices/bars/daily/topix)財務情報(/fins/summary)開示書類種別財務諸表(BS/PL/CF)(/fins/details)配当金情報(/fins/dividend)リファレンスナンバー決算発表予定日(/equities/earnings-calendar)日経225オプション四本値(/derivatives/bars/daily/options/225)先物四本値(/derivatives/bars/daily/futures)先物商品区分コードオプション四本値(/derivatives/bars/daily/options)オプション商品区分コード -- Sign in - -# 決算発表予定日(/equities/earnings-calendar) - -GET /v2/equities/earnings-calendar - -## APIの概要 - -3月期・9月期決算の会社の決算発表予定日を取得できます。(その他の決算期の会社は今後対応予定です) - -## 本APIの留意点 - -- 下記のサイトで、3月期・9月期決算会社分に更新があった場合のみ19時ごろに更新されます。3月期・9月期決算会社についての更新がなかった場合は、最終更新日時点のデータを提供します。 -https://www.jpx.co.jp/listing/event-schedules/financial-announcement/index.html -- 本APIは翌営業日に決算発表が行われる銘柄に関する情報を返します。 -- 本APIから得られたデータにおいてDateの項目が翌営業日付であるレコードが存在しない場合は、3月期・9月期決算会社における翌営業日の開示予定はないことを意味します。 -- REITのデータは含まれません。 - -## 決算発表予定日の銘柄コード、年度、 四半期等の照会をします。 - -GET https://api.jquants.com/v2/equities/earnings-calendar - -### Requests - -### Headers - -**x-api-key** (string, required) - APIキー - - -### Query Parameters - -**pagination_key** (string, optional) - 検索の先頭を指定する文字列 -過去の検索で返却された pagination_key を設定 - - -### APIコールサンプルコード - -### Request - -``` -curl -G https://api.jquants.com/v2/equities/earnings-calendar --H "x-api-key: {loading}" -``` - -### Responses - -### データ項目概要 - -**Date** (string) - 日付(YYYY-MM-DD) -決算発表予定日が未定の場合、空文字("")となります。 - -**Code** (string) - 銘柄コード - -**CoName** (string) - 会社名 - -**FY** (string) - 決算期末 - -**SectorNm** (string) - 業種名 - -**FQ** (string) - 決算種別 - -**Section** (string) - 市場区分 - - -### レスポンスサンプル - -``` -{ - "data": [ - { - "Date": "2022-02-14", - "Code": "43760", - "CoName": "くふうカンパニー", - "FY": "9月30日", - "SectorNm": "情報・通信業", - "FQ": "第1四半期", - "Section": "マザーズ" - } - ], - "pagination_key": "value1.value2." -} -``` - -Was this page helpful? - -© JPX Market Innovation & Research, Inc. All rights reserved. - diff --git a/docs/v2/eq-investor-types-section.md b/docs/v2/eq-investor-types-section.md deleted file mode 100644 index 46ae5d2..0000000 --- a/docs/v2/eq-investor-types-section.md +++ /dev/null @@ -1,29 +0,0 @@ -# Protocol API Reference - J-Quants - -> プロが活用する株価や財務データを、APIで簡単に取得。あなたの投資分析に、確かな情報を。 - -- Dashboard -- Support - -- GuidesJ-Quants APIについてV1 API から V2 API への変更点プランごとに利用可能なAPIとデータ格納期間提供データの更新タイミングクイックスタートMCPサーバー -- Noticesデータ修正履歴・制約事項レスポンスのページングについてレートリミットについてAPIレスポンスのGzip化レスポンスステータス -- Resources上場銘柄一覧(/equities/master)17業種コード及び業種名33業種コード及び業種名市場区分コード及び市場区分名株価四本値(/equities/bars/daily)前場四本値(/equities/bars/daily/am)投資部門別情報(/equities/investor-types)市場名信用取引週末残高(/markets/margin-interest)業種別空売り比率(/markets/short-ratio)空売り残高報告(/markets/short-sale-report)日々公表信用取引残高(/markets/margin-alert)公表の理由東証信用貸借規制区分売買内訳データ(/markets/breakdown)取引カレンダー(/markets/calendar)休日区分指数四本値(/indices/bars/daily)配信対象指数コードTOPIX指数四本値(/indices/bars/daily/topix)財務情報(/fins/summary)開示書類種別財務諸表(BS/PL/CF)(/fins/details)配当金情報(/fins/dividend)リファレンスナンバー決算発表予定日(/equities/earnings-calendar)日経225オプション四本値(/derivatives/bars/daily/options/225)先物四本値(/derivatives/bars/daily/futures)先物商品区分コードオプション四本値(/derivatives/bars/daily/options)オプション商品区分コード -- Sign in - -# 市場名 - -| 項目 | 値 | -|------|------| -| 市場一部 | TSE1st | -| 市場二部 | TSE2nd | -| マザーズ | TSEMothers | -| JASDAQ | TSEJASDAQ | -| プライム | TSEPrime | -| スタンダード | TSEStandard | -| グロース | TSEGrowth | -| 東証および名証 | TokyoNagoya | - -Was this page helpful? - -© JPX Market Innovation & Research, Inc. All rights reserved. - diff --git a/docs/v2/eq-investor-types.md b/docs/v2/eq-investor-types.md deleted file mode 100644 index 5a37d7c..0000000 --- a/docs/v2/eq-investor-types.md +++ /dev/null @@ -1,332 +0,0 @@ -# Protocol API Reference - J-Quants - -> プロが活用する株価や財務データを、APIで簡単に取得。あなたの投資分析に、確かな情報を。 - -- Dashboard -- Support - -- GuidesJ-Quants APIについてV1 API から V2 API への変更点プランごとに利用可能なAPIとデータ格納期間提供データの更新タイミングクイックスタートMCPサーバー -- Noticesデータ修正履歴・制約事項レスポンスのページングについてレートリミットについてAPIレスポンスのGzip化レスポンスステータス -- Resources上場銘柄一覧(/equities/master)17業種コード及び業種名33業種コード及び業種名市場区分コード及び市場区分名株価四本値(/equities/bars/daily)前場四本値(/equities/bars/daily/am)投資部門別情報(/equities/investor-types)市場名信用取引週末残高(/markets/margin-interest)業種別空売り比率(/markets/short-ratio)空売り残高報告(/markets/short-sale-report)日々公表信用取引残高(/markets/margin-alert)公表の理由東証信用貸借規制区分売買内訳データ(/markets/breakdown)取引カレンダー(/markets/calendar)休日区分指数四本値(/indices/bars/daily)配信対象指数コードTOPIX指数四本値(/indices/bars/daily/topix)財務情報(/fins/summary)開示書類種別財務諸表(BS/PL/CF)(/fins/details)配当金情報(/fins/dividend)リファレンスナンバー決算発表予定日(/equities/earnings-calendar)日経225オプション四本値(/derivatives/bars/daily/options/225)先物四本値(/derivatives/bars/daily/futures)先物商品区分コードオプション四本値(/derivatives/bars/daily/options)オプション商品区分コード -- Sign in - -# 投資部門別情報(/equities/investor-types) - -GET /v2/equities/investor-types - -## APIの概要 - -投資部門別売買状況(株式・金額)のデータを取得することができます。 -配信データは下記のページで公表している内容と同一です。データの単位は千円です。 -https://www.jpx.co.jp/markets/statistics-equities/investor-type/index.html - -### 本APIの留意点 - -- 2022年4月4日に行われた市場区分見直しに伴い、市場区分に応じた内容となっている統計資料は、見直し後の市場区分に変更して掲載しています。 -- 過誤訂正により過去の投資部門別売買状況データが訂正された場合は、本APIでは以下のとおりデータを提供します。 - -2023年4月3日以前に訂正が公表された過誤訂正:訂正前のデータは提供せず、訂正後のデータのみ提供します。 -2023年4月3日以降に訂正が公表された過誤訂正:訂正前と訂正後のデータのいずれも提供します。訂正が生じた場合には、市場名、開始日および終了日を同一とするレコードが追加され、公表日が新しいデータが訂正後、公表日が古いデータが訂正前のデータと識別することが可能です。 -- 過誤訂正により過去の投資部門別売買状況データが訂正された場合は、過誤訂正が公表された翌営業日にデータが更新されます。 - -## 投資部門別売買状況のデータを取得します - -GET https://api.jquants.com/v2/equities/investor-types - -データの取得では、市場(section)または公表日の日付(from / to)が指定できます。 - -### パラメータ及びレスポンス - -データの取得では、セクション(section)または日付(from / to)の指定が可能です。 -各パラメータの組み合わせとレスポンスの結果については以下のとおりです。 - -| section | from /to | レスポンスの結果 | -|------|------|------| -| ✓ | ✓ | 指定したセクションの指定した期間のデータ | -| ✓ | ✗ | 指定したセクションの全期間のデータ | -| ✗ | ✓ | すべてのセクションの指定した期間のデータ | -| ✗ | ✗ | すべてのセクションの全期間のデータ | - -セクション(section)で指定可能なパラメータについては、以下の「市場名」を参照してください。 - -### Requests - -### Headers - -**x-api-key** (string, required) - APIキー - - -### Query Parameters - -**section** (string, optional) - セクション(e.g. TSEPrime) - -**from** (string, optional) - fromの指定(e.g. 20210901 or 2021-09-01) - -**to** (string, optional) - toの指定(e.g. 20210907 or 2021-09-07) - -**pagination_key** (string, optional) - 検索の先頭を指定する文字列 -過去の検索で返却された pagination_key を設定 - - -### APIコールサンプルコード - -### Request - -``` -curl -G https://api.jquants.com/v2/equities/investor-types --H "x-api-key: {loading}" --d section="TSEPrime" --d from="20230324" --d to="20230403" -``` - -### Responses - -### データ項目概要 - -**PubDate** (string) - 公表日(YYYY-MM-DD) - -**StDate** (string) - 開始日(YYYY-MM-DD) - -**EnDate** (string) - 終了日(YYYY-MM-DD) - -**Section** (string) - 市場名(市場名を参照) - -**PropSell** (number) - 自己計_売 - -**PropBuy** (number) - 自己計_買 - -**PropTot** (number) - 自己計_合計 - -**PropBal** (number) - 自己計_差引 - -**BrkSell** (number) - 委託計_売 - -**BrkBuy** (number) - 委託計_買 - -**BrkTot** (number) - 委託計_合計 - -**BrkBal** (number) - 委託計_差引 - -**TotSell** (number) - 総計_売 - -**TotBuy** (number) - 総計_買 - -**TotTot** (number) - 総計_合計 - -**TotBal** (number) - 総計_差引 - -**IndSell** (number) - 個人_売 - -**IndBuy** (number) - 個人_買 - -**IndTot** (number) - 個人_合計 - -**IndBal** (number) - 個人_差引 - -**FrgnSell** (number) - 海外投資家_売 - -**FrgnBuy** (number) - 海外投資家_買 - -**FrgnTot** (number) - 海外投資家_合計 - -**FrgnBal** (number) - 海外投資家_差引 - -**SecCoSell** (number) - 証券会社_売 - -**SecCoBuy** (number) - 証券会社_買 - -**SecCoTot** (number) - 証券会社_合計 - -**SecCoBal** (number) - 証券会社_差引 - -**InvTrSell** (number) - 投資信託_売 - -**InvTrBuy** (number) - 投資信託_買 - -**InvTrTot** (number) - 投資信託_合計 - -**InvTrBal** (number) - 投資信託_差引 - -**BusCoSell** (number) - 事業法人_売 - -**BusCoBuy** (number) - 事業法人_買 - -**BusCoTot** (number) - 事業法人_合計 - -**BusCoBal** (number) - 事業法人_差引 - -**OthCoSell** (number) - その他法人_売 - -**OthCoBuy** (number) - その他法人_買 - -**OthCoTot** (number) - その他法人_合計 - -**OthCoBal** (number) - その他法人_差引 - -**InsCoSell** (number) - 生保・損保_売 - -**InsCoBuy** (number) - 生保・損保_買 - -**InsCoTot** (number) - 生保・損保_合計 - -**InsCoBal** (number) - 生保・損保_差引 - -**BankSell** (number) - 都銀・地銀等_売 - -**BankBuy** (number) - 都銀・地銀等_買 - -**BankTot** (number) - 都銀・地銀等_合計 - -**BankBal** (number) - 都銀・地銀等_差引 - -**TrstBnkSell** (number) - 信託銀行_売 - -**TrstBnkBuy** (number) - 信託銀行_買 - -**TrstBnkTot** (number) - 信託銀行_合計 - -**TrstBnkBal** (number) - 信託銀行_差引 - -**OthFinSell** (number) - その他金融機関_売 - -**OthFinBuy** (number) - その他金融機関_買 - -**OthFinTot** (number) - その他金融機関_合計 - -**OthFinBal** (number) - その他金融機関_差引 - - -### レスポンスサンプル - -``` -{ - "data": [ - { - "PubDate": "2017-01-13", - "StDate": "2017-01-04", - "EnDate": "2017-01-06", - "Section": "TSE1st", - "PropSell": 1311271004, - "PropBuy": 1453326508, - "PropTot": 2764597512, - "PropBal": 142055504, - "BrkSell": 7165529005, - "BrkBuy": 7030019854, - "BrkTot": 14195548859, - "BrkBal": -135509151, - "TotSell": 8476800009, - "TotBuy": 8483346362, - "TotTot": 16960146371, - "TotBal": 6546353, - "IndSell": 1401711615, - "IndBuy": 1161801155, - "IndTot": 2563512770, - "IndBal": -239910460, - "FrgnSell": 5094891735, - "FrgnBuy": 5317151774, - "FrgnTot": 10412043509, - "FrgnBal": 222260039, - "SecCoSell": 76381455, - "SecCoBuy": 61700100, - "SecCoTot": 138081555, - "SecCoBal": -14681355, - "InvTrSell": 168705109, - "InvTrBuy": 124389642, - "InvTrTot": 293094751, - "InvTrBal": -44315467, - "BusCoSell": 71217959, - "BusCoBuy": 63526641, - "BusCoTot": 134744600, - "BusCoBal": -7691318, - "OthCoSell": 10745152, - "OthCoBuy": 15687836, - "OthCoTot": 26432988, - "OthCoBal": 4942684, - "InsCoSell": 15926202, - "InsCoBuy": 9831555, - "InsCoTot": 25757757, - "InsCoBal": -6094647, - "BankSell": 10606789, - "BankBuy": 8843871, - "BankTot": 19450660, - "BankBal": -1762918, - "TrstBnkSell": 292932297, - "TrstBnkBuy": 245322795, - "TrstBnkTot": 538255092, - "TrstBnkBal": -47609502, - "OthFinSell": 22410692, - "OthFinBuy": 21764485, - "OthFinTot": 44175177, - "OthFinBal": -646207 - } - ], - "pagination_key": "value1.value2." -} -``` - -Was this page helpful? - -© JPX Market Innovation & Research, Inc. All rights reserved. - diff --git a/docs/v2/eq-master-marketcode.md b/docs/v2/eq-master-marketcode.md deleted file mode 100644 index 73b3592..0000000 --- a/docs/v2/eq-master-marketcode.md +++ /dev/null @@ -1,31 +0,0 @@ -# Protocol API Reference - J-Quants - -> プロが活用する株価や財務データを、APIで簡単に取得。あなたの投資分析に、確かな情報を。 - -- Dashboard -- Support - -- GuidesJ-Quants APIについてV1 API から V2 API への変更点プランごとに利用可能なAPIとデータ格納期間提供データの更新タイミングクイックスタートMCPサーバー -- Noticesデータ修正履歴・制約事項レスポンスのページングについてレートリミットについてAPIレスポンスのGzip化レスポンスステータス -- Resources上場銘柄一覧(/equities/master)17業種コード及び業種名33業種コード及び業種名市場区分コード及び市場区分名株価四本値(/equities/bars/daily)前場四本値(/equities/bars/daily/am)投資部門別情報(/equities/investor-types)市場名信用取引週末残高(/markets/margin-interest)業種別空売り比率(/markets/short-ratio)空売り残高報告(/markets/short-sale-report)日々公表信用取引残高(/markets/margin-alert)公表の理由東証信用貸借規制区分売買内訳データ(/markets/breakdown)取引カレンダー(/markets/calendar)休日区分指数四本値(/indices/bars/daily)配信対象指数コードTOPIX指数四本値(/indices/bars/daily/topix)財務情報(/fins/summary)開示書類種別財務諸表(BS/PL/CF)(/fins/details)配当金情報(/fins/dividend)リファレンスナンバー決算発表予定日(/equities/earnings-calendar)日経225オプション四本値(/derivatives/bars/daily/options/225)先物四本値(/derivatives/bars/daily/futures)先物商品区分コードオプション四本値(/derivatives/bars/daily/options)オプション商品区分コード -- Sign in - -# 市場区分コード及び市場区分名 - -| コード | 名称 | -|------|------| -| 0101 | 東証一部 | -| 0102 | 東証二部 | -| 0104 | マザーズ | -| 0105 | TOKYO PRO MARKET | -| 0106 | JASDAQ スタンダード | -| 0107 | JASDAQ グロース | -| 0109 | その他 | -| 0111 | プライム | -| 0112 | スタンダード | -| 0113 | グロース | - -Was this page helpful? - -© JPX Market Innovation & Research, Inc. All rights reserved. - diff --git a/docs/v2/eq-master-sector17code.md b/docs/v2/eq-master-sector17code.md deleted file mode 100644 index 66f60ca..0000000 --- a/docs/v2/eq-master-sector17code.md +++ /dev/null @@ -1,39 +0,0 @@ -# Protocol API Reference - J-Quants - -> プロが活用する株価や財務データを、APIで簡単に取得。あなたの投資分析に、確かな情報を。 - -- Dashboard -- Support - -- GuidesJ-Quants APIについてV1 API から V2 API への変更点プランごとに利用可能なAPIとデータ格納期間提供データの更新タイミングクイックスタートMCPサーバー -- Noticesデータ修正履歴・制約事項レスポンスのページングについてレートリミットについてAPIレスポンスのGzip化レスポンスステータス -- Resources上場銘柄一覧(/equities/master)17業種コード及び業種名33業種コード及び業種名市場区分コード及び市場区分名株価四本値(/equities/bars/daily)前場四本値(/equities/bars/daily/am)投資部門別情報(/equities/investor-types)市場名信用取引週末残高(/markets/margin-interest)業種別空売り比率(/markets/short-ratio)空売り残高報告(/markets/short-sale-report)日々公表信用取引残高(/markets/margin-alert)公表の理由東証信用貸借規制区分売買内訳データ(/markets/breakdown)取引カレンダー(/markets/calendar)休日区分指数四本値(/indices/bars/daily)配信対象指数コードTOPIX指数四本値(/indices/bars/daily/topix)財務情報(/fins/summary)開示書類種別財務諸表(BS/PL/CF)(/fins/details)配当金情報(/fins/dividend)リファレンスナンバー決算発表予定日(/equities/earnings-calendar)日経225オプション四本値(/derivatives/bars/daily/options/225)先物四本値(/derivatives/bars/daily/futures)先物商品区分コードオプション四本値(/derivatives/bars/daily/options)オプション商品区分コード -- Sign in - -# 17業種コード及び業種名 - -| コード | 名称 | -|------|------| -| 1 | 食品 | -| 2 | エネルギー資源 | -| 3 | 建設・資材 | -| 4 | 素材・化学 | -| 5 | 医薬品 | -| 6 | 自動車・輸送機 | -| 7 | 鉄鋼・非鉄 | -| 8 | 機械 | -| 9 | 電機・精密 | -| 10 | 情報通信・サービスその他 | -| 11 | 電気・ガス | -| 12 | 運輸・物流 | -| 13 | 商社・卸売 | -| 14 | 小売 | -| 15 | 銀行 | -| 16 | 金融(除く銀行) | -| 17 | 不動産 | -| 99 | その他 | - -Was this page helpful? - -© JPX Market Innovation & Research, Inc. All rights reserved. - diff --git a/docs/v2/eq-master-sector33code.md b/docs/v2/eq-master-sector33code.md deleted file mode 100644 index 80e6878..0000000 --- a/docs/v2/eq-master-sector33code.md +++ /dev/null @@ -1,55 +0,0 @@ -# Protocol API Reference - J-Quants - -> プロが活用する株価や財務データを、APIで簡単に取得。あなたの投資分析に、確かな情報を。 - -- Dashboard -- Support - -- GuidesJ-Quants APIについてV1 API から V2 API への変更点プランごとに利用可能なAPIとデータ格納期間提供データの更新タイミングクイックスタートMCPサーバー -- Noticesデータ修正履歴・制約事項レスポンスのページングについてレートリミットについてAPIレスポンスのGzip化レスポンスステータス -- Resources上場銘柄一覧(/equities/master)17業種コード及び業種名33業種コード及び業種名市場区分コード及び市場区分名株価四本値(/equities/bars/daily)前場四本値(/equities/bars/daily/am)投資部門別情報(/equities/investor-types)市場名信用取引週末残高(/markets/margin-interest)業種別空売り比率(/markets/short-ratio)空売り残高報告(/markets/short-sale-report)日々公表信用取引残高(/markets/margin-alert)公表の理由東証信用貸借規制区分売買内訳データ(/markets/breakdown)取引カレンダー(/markets/calendar)休日区分指数四本値(/indices/bars/daily)配信対象指数コードTOPIX指数四本値(/indices/bars/daily/topix)財務情報(/fins/summary)開示書類種別財務諸表(BS/PL/CF)(/fins/details)配当金情報(/fins/dividend)リファレンスナンバー決算発表予定日(/equities/earnings-calendar)日経225オプション四本値(/derivatives/bars/daily/options/225)先物四本値(/derivatives/bars/daily/futures)先物商品区分コードオプション四本値(/derivatives/bars/daily/options)オプション商品区分コード -- Sign in - -# 33業種コード及び業種名 - -| コード | 名称 | -|------|------| -| 0050 | 水産・農林業 | -| 1050 | 鉱業 | -| 2050 | 建設業 | -| 3050 | 食料品 | -| 3100 | 繊維製品 | -| 3150 | パルプ・紙 | -| 3200 | 化学 | -| 3250 | 医薬品 | -| 3300 | 石油・石炭製品 | -| 3350 | ゴム製品 | -| 3400 | ガラス・土石製品 | -| 3450 | 鉄鋼 | -| 3500 | 非鉄金属 | -| 3550 | 金属製品 | -| 3600 | 機械 | -| 3650 | 電気機器 | -| 3700 | 輸送用機器 | -| 3750 | 精密機器 | -| 3800 | その他製品 | -| 4050 | 電気・ガス業 | -| 5050 | 陸運業 | -| 5100 | 海運業 | -| 5150 | 空運業 | -| 5200 | 倉庫・運輸関連業 | -| 5250 | 情報・通信業 | -| 6050 | 卸売業 | -| 6100 | 小売業 | -| 7050 | 銀行業 | -| 7100 | 証券・商品先物取引業 | -| 7150 | 保険業 | -| 7200 | その他金融業 | -| 8050 | 不動産業 | -| 9050 | サービス業 | -| 9999 | その他 | - -Was this page helpful? - -© JPX Market Innovation & Research, Inc. All rights reserved. - diff --git a/docs/v2/eq-master.md b/docs/v2/eq-master.md deleted file mode 100644 index c548f1c..0000000 --- a/docs/v2/eq-master.md +++ /dev/null @@ -1,148 +0,0 @@ -# Protocol API Reference - J-Quants - -> プロが活用する株価や財務データを、APIで簡単に取得。あなたの投資分析に、確かな情報を。 - -- Dashboard -- Support - -- GuidesJ-Quants APIについてV1 API から V2 API への変更点プランごとに利用可能なAPIとデータ格納期間提供データの更新タイミングクイックスタートMCPサーバー -- Noticesデータ修正履歴・制約事項レスポンスのページングについてレートリミットについてAPIレスポンスのGzip化レスポンスステータス -- Resources上場銘柄一覧(/equities/master)17業種コード及び業種名33業種コード及び業種名市場区分コード及び市場区分名株価四本値(/equities/bars/daily)前場四本値(/equities/bars/daily/am)投資部門別情報(/equities/investor-types)市場名信用取引週末残高(/markets/margin-interest)業種別空売り比率(/markets/short-ratio)空売り残高報告(/markets/short-sale-report)日々公表信用取引残高(/markets/margin-alert)公表の理由東証信用貸借規制区分売買内訳データ(/markets/breakdown)取引カレンダー(/markets/calendar)休日区分指数四本値(/indices/bars/daily)配信対象指数コードTOPIX指数四本値(/indices/bars/daily/topix)財務情報(/fins/summary)開示書類種別財務諸表(BS/PL/CF)(/fins/details)配当金情報(/fins/dividend)リファレンスナンバー決算発表予定日(/equities/earnings-calendar)日経225オプション四本値(/derivatives/bars/daily/options/225)先物四本値(/derivatives/bars/daily/futures)先物商品区分コードオプション四本値(/derivatives/bars/daily/options)オプション商品区分コード -- Sign in - -# 上場銘柄一覧(/equities/master) - -GET /v2/equities/master - -## APIの概要 - -過去時点での銘柄情報、当日の銘柄情報および翌営業日時点の銘柄情報が取得可能です。 -ただし、翌営業日時点の銘柄情報については17 時半以降に取得可能となります。 - -### 本APIの留意点 - -- 過去日付の指定について、Premiumプランでデータ提供開始日(2008年5月7日)より過去日付を指定した場合であっても、2008年5月7日時点の銘柄情報を返却します。 -- 指定された日付が休業日の場合は、指定日の翌営業日の銘柄情報を返却します。 -- 貸借信用区分および貸借信用区分名については Standard および Premium プランのみ取得可能な項目です。 - -2022年4月の東証市場区分再編により、日本銀行(銘柄コード83010)および信金中央金庫(銘柄コード84210)については、制度上所属する市場区分が存在しなくなりましたが、J-Quants では市場区分をスタンダードとして返却します。 - -## 日次の銘柄情報を取得します - -GET https://api.jquants.com/v2/equities/master - -データの取得では、銘柄コード(code)または日付(date)の指定が可能です。 -各パラメータの組み合わせとレスポンスの結果については以下のとおりです。 - -| code | date | レスポンスの結果 | -|------|------|------| -| ✗ | ✗ | APIを実行した日付時点における全銘柄情報一覧(※1) | -| ✓ | ✗ | APIを実行した日付時点における指定された銘柄情報(※1) | -| ✗ | ✓ | 指定日付時点における全銘柄情報の一覧(※2) | -| ✓ | ✓ | 指定日付時点における指定された銘柄情報(※2) | - -※1 休業日において日付を指定せずにクエリした場合、直近の翌営業日における銘柄情報一覧を返却します。 -※2 未来日付の指定について、Light プラン以上では翌営業日時点のデータが取得可能です。翌営業日より先の未来日付を指定した場合であっても、翌営業日時点の銘柄情報を返却します。 - -### Requests - -### Headers - -**x-api-key** (string, required) - APIキー - - -### Query Parameters - -**code** (string, optional) - 銘柄コード(e.g. 27890 or 2789)4桁の銘柄コードを指定した場合は、普通株式と優先株式の両方が上場している銘柄においては普通株式のデータのみが取得されます。 - -**date** (string, optional) - 基準となる日付の指定(e.g. 20210907 or 2021-09-07) - - -### APIコールサンプルコード - -### Request - -``` -curl -G https://api.jquants.com/v2/equities/master --H "x-api-key: {loading}" --d code="86970" --d date="2022-11-11" -``` - -### Responses - -### データ項目概要 - -**Date** (string) - 情報適用年月日(YYYY-MM-DD) - -**Code** (string) - 銘柄コード - -**CoName** (string) - 会社名 - -**CoNameEn** (string) - 会社名(英語) - -**S17** (string) - 17業種コード(17業種コード及び業種名を参照) - -**S17Nm** (string) - 17業種コード名(17業種コード及び業種名を参照) - -**S33** (string) - 33業種コード(33業種コード及び業種名を参照) - -**S33Nm** (string) - 33業種コード名(33業種コード及び業種名を参照) - -**ScaleCat** (string) - 規模コード - -**Mkt** (string) - 市場区分コード(市場区分コード及び市場区分を参照) - -**MktNm** (string) - 市場区分名(市場区分コード及び市場区分を参照) - -**Mrgn** (string) - 貸借信用区分(1: 信用 / 2: 貸借 / 3: その他)(※1) - -**MrgnNm** (string) - 貸借信用区分名(※1) - - -※1 Standard および Premium プランで取得可能な項目です - -### レスポンスサンプル - -``` -{ - "data": [ - { - "Date": "2022-11-11", - "Code": "86970", - "CoName": "日本取引所グループ", - "CoNameEn": "Japan Exchange Group,Inc.", - "S17": "16", - "S17Nm": "金融(除く銀行)", - "S33": "7200", - "S33Nm": "その他金融業", - "ScaleCat": "TOPIX Large70", - "Mkt": "0111", - "MktNm": "プライム", - "Mrgn": "1", - "MrgnNm": "信用" - } - ] -} -``` - -Was this page helpful? - -© JPX Market Innovation & Research, Inc. All rights reserved. - diff --git a/docs/v2/fin-details.md b/docs/v2/fin-details.md deleted file mode 100644 index ef1ac5c..0000000 --- a/docs/v2/fin-details.md +++ /dev/null @@ -1,226 +0,0 @@ -# Protocol API Reference - J-Quants - -> プロが活用する株価や財務データを、APIで簡単に取得。あなたの投資分析に、確かな情報を。 - -- Dashboard -- Support - -- GuidesJ-Quants APIについてV1 API から V2 API への変更点プランごとに利用可能なAPIとデータ格納期間提供データの更新タイミングクイックスタートMCPサーバー -- Noticesデータ修正履歴・制約事項レスポンスのページングについてレートリミットについてAPIレスポンスのGzip化レスポンスステータス -- Resources上場銘柄一覧(/equities/master)17業種コード及び業種名33業種コード及び業種名市場区分コード及び市場区分名株価四本値(/equities/bars/daily)前場四本値(/equities/bars/daily/am)投資部門別情報(/equities/investor-types)市場名信用取引週末残高(/markets/margin-interest)業種別空売り比率(/markets/short-ratio)空売り残高報告(/markets/short-sale-report)日々公表信用取引残高(/markets/margin-alert)公表の理由東証信用貸借規制区分売買内訳データ(/markets/breakdown)取引カレンダー(/markets/calendar)休日区分指数四本値(/indices/bars/daily)配信対象指数コードTOPIX指数四本値(/indices/bars/daily/topix)財務情報(/fins/summary)開示書類種別財務諸表(BS/PL/CF)(/fins/details)配当金情報(/fins/dividend)リファレンスナンバー決算発表予定日(/equities/earnings-calendar)日経225オプション四本値(/derivatives/bars/daily/options/225)先物四本値(/derivatives/bars/daily/futures)先物商品区分コードオプション四本値(/derivatives/bars/daily/options)オプション商品区分コード -- Sign in - -# 財務諸表(BS/PL/CF)(/fins/details) - -GET /v2/fins/details - -## APIの概要 - -上場企業の四半期毎の財務情報における、貸借対照表、損益計算書、キャッシュ・フロー計算書に記載の項目を取得することができます。 - -## 本APIの留意点 - -- FinancialStatement(財務諸表の各種項目)について - -EDINET XBRLタクソノミ本体(label情報)を用いてコンテンツを作成しています。 -FinancialStatementに含まれる冗長ラベル(英語)については、下記サイトよりご確認ください。 -https://disclosure2dl.edinet-fsa.go.jp/guide/static/disclosure/WZEK0110.html -年度別に公表されているEDINETタクソノミページに、「勘定科目リスト」(会計基準:日本基準)及び「国際会計基準タクソノミ要素リスト」(会計基準:IFRS) が掲載されています。会計基準別に以下のとおりデータを提供しています。 - -会計基準が日本基準の場合、「勘定科目リスト」の各シートのE列「冗長ラベル(英語)」をキーとし、その値とセットで提供しています。 -会計基準がIFRSの場合、「国際会計基準タクソノミ要素リスト」の各シートのD列「冗長ラベル(英語)」をキーとし、その値とセットで提供しています。 -- 提出者別タクソノミについて - -EDINETタクソノミには存在しない提出者別タクソノミで定義される企業独自の項目は、本APIの提供対象外となります。 - -- 三井海洋開発(銘柄コード62690)は、2022年2月以降の決算短信の連結財務諸表及び連結財務諸表注記を米ドルにより表示されています。そのため、本サービスの当該銘柄の対象の財務諸表情報についても米ドルでの提供となります。 - -## 四半期の財務諸表情報を取得することができます - -GET https://api.jquants.com/v2/fins/details - -リクエストパラメータに code(銘柄コード)または date(開示日)を入力する必要があります。 - -### Requests - -### Headers - -**x-api-key** (string, required) - APIキー - - -### Query Parameters - -code または date のいずれか一つの指定が必須です。 - -**code** (string, optional) - 銘柄コード(e.g. 86970 or 8697) -4桁もしくは5桁の銘柄コード - -**date** (string, optional) - 開示日付の指定(e.g. 2022-01-05 or 20220105) - -**pagination_key** (string, optional) - 検索の先頭を指定する文字列 -過去の検索で返却された pagination_key を設定 - - -### APIコールサンプルコード - -### Request - -``` -curl -G https://api.jquants.com/v2/fins/details --H "x-api-key: {loading}" --d code="86970" --d date="20230130" -``` - -### Responses - -### データ項目概要 - -**DiscDate** (string) - 開示日 - -**DiscTime** (string) - 開示時刻 - -**Code** (string) - 銘柄コード(5桁) - -**DiscNo** (string) - 開示番号 -APIから出力されるjsonは開示番号で昇順に並んでいます。 - -**DocType** (string) - 開示書類種別 -開示書類種別一覧 - -**FS** (object) - 財務諸表の各種項目 -冗長ラベル(英語)をキーとし、その値(財務諸表の値)をバリューとして格納したデータです。 -XBRLタグと紐づく冗長ラベル(英語)とその値が収録されます。 - - -### レスポンスサンプル - -``` -{ - "data": [ - { - "DiscDate": "2020-04-30", - "DiscTime": "12:00:00", - "Code": "86970", - "DiscNo": "20200429402226", - "DocType": "FYFinancialStatements_Consolidated_IFRS", - "FS": { - "EDINET code, DEI": "E03814", - "Security code, DEI": "86970", - "Filer name in Japanese, DEI": "株式会社日本取引所グループ", - "Filer name in English, DEI": "Japan Exchange Group, Inc.", - "Document type, DEI": "通期第3号参考様式 [IFRS](連結)", - "Accounting standards, DEI": "IFRS", - "Whether consolidated financial statements are prepared, DEI": "true", - "Industry code when consolidated financial statements are prepared in accordance with industry specific regulations, DEI": "CTE", - "Industry code when financial statements are prepared in accordance with industry specific regulations, DEI": "CTE", - "Current fiscal year start date, DEI": "2019-04-01", - "Current period end date, DEI": "2020-03-31", - "Type of current period, DEI": "FY", - "Current fiscal year end date, DEI": "2020-03-31", - "Previous fiscal year start date, DEI": "2018-04-01", - "Comparative period end date, DEI": "2019-03-31", - "Previous fiscal year end date, DEI": "2019-03-31", - "Amendment flag, DEI": "false", - "Report amendment flag, DEI": "false", - "XBRL amendment flag, DEI": "false", - "Cash and cash equivalents (IFRS)": "71883000000", - "Trade and other receivables - CA (IFRS)": "16686000000", - "Income taxes receivable - CA (IFRS)": "5922000000", - "Other financial assets - CA (IFRS)": "117400000000", - "Other current assets - CA (IFRS)": "1837000000", - "Current assets (IFRS)": "67093263000000", - "Property, plant and equipment (IFRS)": "14798000000", - "Goodwill (IFRS)": "67374000000", - "Intangible assets (IFRS)": "35045000000", - "Retirement benefit asset - NCA (IFRS)": "5642000000", - "Investments accounted for using equity method (IFRS)": "14703000000", - "Other financial assets - NCA (IFRS)": "18156000000", - "Other non-current assets - NCA (IFRS)": "6049000000", - "Deferred tax assets (IFRS)": "3321000000", - "Non-current assets (IFRS)": "193039000000", - "Assets (IFRS)": "67286302000000", - "Trade and other payables - CL (IFRS)": "6643000000", - "Bonds and borrowings - CL (IFRS)": "32500000000", - "Income taxes payable - CL (IFRS)": "10289000000", - "Other current liabilities - CL (IFRS)": "10062000000", - "Current liabilities (IFRS)": "66947278000000", - "Bonds and borrowings - NCL (IFRS)": "19953000000", - "Retirement benefit liability - NCL (IFRS)": "8866000000", - "Other non-current liabilities - NCL (IFRS)": "2162000000", - "Deferred tax liabilities (IFRS)": "2665000000", - "Non-current liabilities (IFRS)": "33648000000", - "Liabilities (IFRS)": "66980926000000", - "Share capital (IFRS)": "11500000000", - "Capital surplus (IFRS)": "39716000000", - "Treasury shares (IFRS)": "-1548000000", - "Other components of equity (IFRS)": "5602000000", - "Retained earnings (IFRS)": "242958000000", - "Equity attributable to owners of parent (IFRS)": "298228000000", - "Non-controlling interests (IFRS)": "7146000000", - "Equity (IFRS)": "305375000000", - "Liabilities and equity (IFRS)": "67286302000000", - "Number of submission, DEI": "1", - "Profit (loss) before tax from continuing operations (IFRS)": "69095000000.0", - "Depreciation and amortization - OpeCF (IFRS)": "16499000000", - "Finance income - OpeCF (IFRS)": "-665000000", - "Finance costs - OpeCF (IFRS)": "96000000", - "Share of loss (profit) of investments accounted for using equity method - OpeCF (IFRS)": "-2457000000", - "Decrease (increase) in trade and other receivables - OpeCF (IFRS)": "-5246000000", - "Increase (decrease) in trade and other payables - OpeCF (IFRS)": "420000000", - "Decrease (increase) in retirement benefit asset - OpeCF (IFRS)": "230000000", - "Increase (decrease) in retirement benefit liability - OpeCF (IFRS)": "12000000", - "Other, Changes in working capital - OpeCF (IFRS)": "-424000000", - "Subtotal - OpeCF (IFRS)": "77560000000", - "Interest and dividends received - OpeCF (IFRS)": "899000000", - "Interest paid - OpeCF (IFRS)": "-96000000", - "Income taxes refund (paid) - OpeCF (IFRS)": "-21482000000", - "Net cash provided by (used in) operating activities (IFRS)": "56881000000", - "Payments into time deposits - InvCF (IFRS)": "-117400000000", - "Proceeds from withdrawal of time deposits - InvCF (IFRS)": "113100000000", - "Purchase of property, plant and equipment - InvCF (IFRS)": "-1199000000", - "Purchase of intangible assets - InvCF (IFRS)": "-12379000000", - "Proceeds from sale of investment securities - InvCF (IFRS)": "11585000000", - "Payments for acquisition of subsidiaries - InvCF (IFRS)": "-3165000000", - "Other - InvCF (IFRS)": "23000000", - "Net cash provided by (used in) investing activities (IFRS)": "-9434000000", - "Repayments of lease liabilities - FinCF (IFRS)": "-3125000000", - "Dividends paid - FinCF (IFRS)": "-35935000000", - "Purchase of treasury shares - FinCF (IFRS)": "-350000000", - "Net cash provided by (used in) financing activities (IFRS)": "-39411000000", - "Net increase (decrease) in cash and cash equivalents before effect of exchange rate changes (IFRS)": "8035000000", - "Effect of exchange rate changes on cash and cash equivalents (IFRS)": "-43000000", - "Other income (IFRS)": "975000000.0", - "Revenue - 2 (IFRS)": "124663000000.0", - "Operating expenses (IFRS)": "58532000000.0", - "Other expenses (IFRS)": "54000000.0", - "Share of profit (loss) of investments accounted for using equity method (IFRS)": "2457000000.0", - "Operating profit (loss) (IFRS)": "68533000000.0", - "Finance income (IFRS)": "665000000.0", - "Finance costs (IFRS)": "103000000.0", - "Income tax expense (IFRS)": "20781000000.0", - "Profit (loss) (IFRS)": "48314000000.0", - "Profit (loss) attributable to owners of parent (IFRS)": "47609000000.0", - "Profit (loss) attributable to non-controlling interests (IFRS)": "705000000.0", - "Basic earnings (loss) per share (IFRS)": "88.91" - } - } - ], - "pagination_key": "value1.value2." -} -``` - -Was this page helpful? - -© JPX Market Innovation & Research, Inc. All rights reserved. - diff --git a/docs/v2/fin-dividend-reference-number.md b/docs/v2/fin-dividend-reference-number.md deleted file mode 100644 index 3d9cbb5..0000000 --- a/docs/v2/fin-dividend-reference-number.md +++ /dev/null @@ -1,42 +0,0 @@ -# Protocol API Reference - J-Quants - -> プロが活用する株価や財務データを、APIで簡単に取得。あなたの投資分析に、確かな情報を。 - -- Dashboard -- Support - -- GuidesJ-Quants APIについてV1 API から V2 API への変更点プランごとに利用可能なAPIとデータ格納期間提供データの更新タイミングクイックスタートMCPサーバー -- Noticesデータ修正履歴・制約事項レスポンスのページングについてレートリミットについてAPIレスポンスのGzip化レスポンスステータス -- Resources上場銘柄一覧(/equities/master)17業種コード及び業種名33業種コード及び業種名市場区分コード及び市場区分名株価四本値(/equities/bars/daily)前場四本値(/equities/bars/daily/am)投資部門別情報(/equities/investor-types)市場名信用取引週末残高(/markets/margin-interest)業種別空売り比率(/markets/short-ratio)空売り残高報告(/markets/short-sale-report)日々公表信用取引残高(/markets/margin-alert)公表の理由東証信用貸借規制区分売買内訳データ(/markets/breakdown)取引カレンダー(/markets/calendar)休日区分指数四本値(/indices/bars/daily)配信対象指数コードTOPIX指数四本値(/indices/bars/daily/topix)財務情報(/fins/summary)開示書類種別財務諸表(BS/PL/CF)(/fins/details)配当金情報(/fins/dividend)リファレンスナンバー決算発表予定日(/equities/earnings-calendar)日経225オプション四本値(/derivatives/bars/daily/options/225)先物四本値(/derivatives/bars/daily/futures)先物商品区分コードオプション四本値(/derivatives/bars/daily/options)オプション商品区分コード -- Sign in - -# リファレンスナンバー - -## リファレンスナンバーについて - -- リファレンスナンバー:配当通知を一意に特定するための番号。 -- CAリファレンスナンバー:訂正・削除の対象となっている配当通知のリファレンスナンバー。新規の場合はリファレンスナンバーと同じ値。 - -## 具体例:以下の通知があった場合に、提供データは下表のとおりになります。 - -- 銘柄:日本取引所グループ(銘柄コード:86970)について - -2023-03-06  配当が新規で通知 -2023-03-07  配当が訂正情報として通知 -2023-03-08  配当が削除された -2023-03-09  配当が新規で通知 - -| PubDate | Code | RefNo | CARefNo | StatCode | -|------|------|------|------|------| -| 2023-03-06 | 86970 | 1 | 1 | 1:新規 | -| 2023-03-07 | 86970 | 2 | 1 | 2:訂正 | -| 2023-03-08 | 86970 | 3 | 1 | 3:削除 | -| 2023-03-09 | 86970 | 4 | 4 | 1:新規 | - -- 一部項目のみを抽出して例示しています。 -- 上記のコード値は例示のため便宜的な記載としており、また実際に発生したデータとは異なります。 - -Was this page helpful? - -© JPX Market Innovation & Research, Inc. All rights reserved. - diff --git a/docs/v2/fin-dividend.md b/docs/v2/fin-dividend.md deleted file mode 100644 index 58a5f55..0000000 --- a/docs/v2/fin-dividend.md +++ /dev/null @@ -1,221 +0,0 @@ -# Protocol API Reference - J-Quants - -> プロが活用する株価や財務データを、APIで簡単に取得。あなたの投資分析に、確かな情報を。 - -- Dashboard -- Support - -- GuidesJ-Quants APIについてV1 API から V2 API への変更点プランごとに利用可能なAPIとデータ格納期間提供データの更新タイミングクイックスタートMCPサーバー -- Noticesデータ修正履歴・制約事項レスポンスのページングについてレートリミットについてAPIレスポンスのGzip化レスポンスステータス -- Resources上場銘柄一覧(/equities/master)17業種コード及び業種名33業種コード及び業種名市場区分コード及び市場区分名株価四本値(/equities/bars/daily)前場四本値(/equities/bars/daily/am)投資部門別情報(/equities/investor-types)市場名信用取引週末残高(/markets/margin-interest)業種別空売り比率(/markets/short-ratio)空売り残高報告(/markets/short-sale-report)日々公表信用取引残高(/markets/margin-alert)公表の理由東証信用貸借規制区分売買内訳データ(/markets/breakdown)取引カレンダー(/markets/calendar)休日区分指数四本値(/indices/bars/daily)配信対象指数コードTOPIX指数四本値(/indices/bars/daily/topix)財務情報(/fins/summary)開示書類種別財務諸表(BS/PL/CF)(/fins/details)配当金情報(/fins/dividend)リファレンスナンバー決算発表予定日(/equities/earnings-calendar)日経225オプション四本値(/derivatives/bars/daily/options/225)先物四本値(/derivatives/bars/daily/futures)先物商品区分コードオプション四本値(/derivatives/bars/daily/options)オプション商品区分コード -- Sign in - -# 配当金情報(/fins/dividend) - -GET /v2/fins/dividend - -## APIの概要 - -上場会社の配当(決定・予想)に関する1株当たり配当金額、基準日、権利落日及び支払開始予定日等の情報を取得できます。 - -## 本APIの留意点 - -- 東証上場銘柄でない銘柄(地方取引所単独上場銘柄)についてはデータの収録対象外となっております。 - -## 配当金データを取得します - -GET https://api.jquants.com/v2/fins/dividend - -データの取得では、銘柄コード(code)または通知日付(date)の指定が必須となります。 - -### パラメータ及びレスポンス - -データの取得では、銘柄コード(code)または通知日付(date)の指定が必須となります。 -各パラメータの組み合わせとレスポンスの結果については以下のとおりです。 - -| code | date | from /to | レスポンスの結果 | -|------|------|------|------| -| ✓ | ✗ | ✗ | 指定された銘柄について取得可能期間の全データ | -| ✓ | ✓ | ✗ | 指定された銘柄について指定された通知日付のデータ | -| ✓ | ✗ | ✓ | 指定された銘柄について指定された期間分のデータ | -| ✗ | ✓ | ✗ | 全上場銘柄について指定された通知日付のデータ | - -### Requests - -### Headers - -**x-api-key** (string, required) - APIキー - - -### Query Parameters - -code または date のいずれか一つの指定が必須です。 - -**code** (string, optional) - 銘柄コード -(e.g. 27800 or 2780) -4桁の銘柄コードを指定した場合は、普通株式と優先株式の両方が上場している銘柄においては普通株式のデータのみが取得されます。 - -**from** (string, optional) - fromの指定(e.g. 20210901 or 2021-09-01) - -**to** (string, optional) - toの指定(e.g. 20210907 or 2021-09-07) - -**date** (string, optional) - *fromとtoを指定しないとき(e.g. 20210907 or 2021-09-07) - -**pagination_key** (string, optional) - 検索の先頭を指定する文字列 -過去の検索で返却された pagination_key を設定 - - -### APIコールサンプルコード - -### Request - -``` -curl -G https://api.jquants.com/v2/fins/dividend --H "x-api-key: {loading}" --d code="86970" --d date="2024-10-25" -``` - -### Responses - -### データ項目概要 - -**PubDate** (string) - 通知日時(YYYY-MM-DD) - -**PubTime** (string) - 通知日時(HH:MM) - -**Code** (string) - 銘柄コード - -**RefNo** (string) - リファレンスナンバー -配当通知を一意に特定するための番号 -詳細はリファレンスナンバーを参照 - -**StatCode** (string) - 更新区分(コード) -1: 新規、2: 訂正、3: 削除 - -**BoardDate** (string) - 取締役会決議日 - -**IFCode** (string) - 配当種類(コード) -1: 中間配当、2: 期末配当 - -**FRCode** (string) - 予想/決定(コード) -1: 決定、2: 予想 - -**IFTerm** (string) - 配当基準日年月 - -**DivRate** (number | string) - 1株当たり配当金額 -未定の場合: - 、非設定の場合: 空文字 - -**RecDate** (string) - 基準日 - -**ExDate** (string) - 権利落日 - -**ActRecDate** (string) - 権利確定日 - -**PayDate** (string) - 支払開始予定日 -未定の場合: - 、非設定の場合: 空文字 - -**CARefNo** (string) - CAリファレンスナンバー -訂正・削除の対象となっている配当通知のリファレンスナンバー。新規の場合はリファレンスナンバーと同じ値を設定 -詳細はリファレンスナンバーを参照 - -**DistAmt** (number | string) - 1株当たりの交付金銭等の額 -未定の場合: - 、非設定の場合: 空文字 が設定されます。 -2014年2月24日以降のみ提供。 - -**RetEarn** (number | string) - 1株当たりの利益剰余金の額 -未定の場合: - 、非設定の場合: 空文字 が設定されます。 -2014年2月24日以降のみ提供。 - -**DeemDiv** (number | string) - 1株当たりのみなし配当の額 -未定の場合: - 、非設定の場合: 空文字 が設定されます。 -2014年2月24日以降のみ提供。 - -**DeemCapGains** (number | string) - 1株当たりのみなし譲渡収入の額 -未定の場合: - 、非設定の場合: 空文字 が設定されます。 -2014年2月24日以降のみ提供。 - -**NetAssetDecRatio** (number | string) - 純資産減少割合 -未定の場合: - 、非設定の場合: 空文字 が設定されます。 -2014年2月24日以降のみ提供。 - -**CommSpecCode** (string) - 記念配当/特別配当コード -1: 記念配当、2: 特別配当、3: 記念・特別配当、0: 通常の配当 - -**CommDivRate** (number | string) - 1株当たり記念配当金額 -未定の場合: - 、非設定の場合: 空文字 -2022年6月6日以降のみ提供。 - -**SpecDivRate** (number | string) - 1株当たり特別配当金額 -未定の場合: - 、非設定の場合: 空文字 -2022年6月6日以降のみ提供。 - - -### レスポンスサンプル - -``` -{ - "data": [ - { - "PubDate": "2014-02-24", - "PubTime": "09:21", - "Code": "15550", - "RefNo": "201402241B00002", - "StatCode": "1", - "BoardDate": "2014-02-24", - "IFCode": "2", - "FRCode": "2", - "IFTerm": "2014-03", - "DivRate": "-", - "RecDate": "2014-03-10", - "ExDate": "2014-03-06", - "ActRecDate": "2014-03-10", - "PayDate": "-", - "CARefNo": "201402241B00002", - "DistAmt": "", - "RetEarn": "", - "DeemDiv": "", - "DeemCapGains": "", - "NetAssetDecRatio": "", - "CommSpecCode": "0", - "CommDivRate": "", - "SpecDivRate": "" - } - ], - "pagination_key": "value1.value2." -} -``` - -Was this page helpful? - -© JPX Market Innovation & Research, Inc. All rights reserved. - diff --git a/docs/v2/fin-summary-typeofdocument.md b/docs/v2/fin-summary-typeofdocument.md deleted file mode 100644 index a767390..0000000 --- a/docs/v2/fin-summary-typeofdocument.md +++ /dev/null @@ -1,70 +0,0 @@ -# Protocol API Reference - J-Quants - -> プロが活用する株価や財務データを、APIで簡単に取得。あなたの投資分析に、確かな情報を。 - -- Dashboard -- Support - -- GuidesJ-Quants APIについてV1 API から V2 API への変更点プランごとに利用可能なAPIとデータ格納期間提供データの更新タイミングクイックスタートMCPサーバー -- Noticesデータ修正履歴・制約事項レスポンスのページングについてレートリミットについてAPIレスポンスのGzip化レスポンスステータス -- Resources上場銘柄一覧(/equities/master)17業種コード及び業種名33業種コード及び業種名市場区分コード及び市場区分名株価四本値(/equities/bars/daily)前場四本値(/equities/bars/daily/am)投資部門別情報(/equities/investor-types)市場名信用取引週末残高(/markets/margin-interest)業種別空売り比率(/markets/short-ratio)空売り残高報告(/markets/short-sale-report)日々公表信用取引残高(/markets/margin-alert)公表の理由東証信用貸借規制区分売買内訳データ(/markets/breakdown)取引カレンダー(/markets/calendar)休日区分指数四本値(/indices/bars/daily)配信対象指数コードTOPIX指数四本値(/indices/bars/daily/topix)財務情報(/fins/summary)開示書類種別財務諸表(BS/PL/CF)(/fins/details)配当金情報(/fins/dividend)リファレンスナンバー決算発表予定日(/equities/earnings-calendar)日経225オプション四本値(/derivatives/bars/daily/options/225)先物四本値(/derivatives/bars/daily/futures)先物商品区分コードオプション四本値(/derivatives/bars/daily/options)オプション商品区分コード -- Sign in - -# 開示書類種別 - -財務情報APIのTypeOfDocumentの項目一覧です。 - -## 書類種別一覧 - -| 書類種別 | 概要 | -|------|------| -| FYFinancialStatements_Consolidated_JP | 決算短信(連結・日本基準) | -| FYFinancialStatements_Consolidated_US | 決算短信(連結・米国基準) | -| FYFinancialStatements_NonConsolidated_JP | 決算短信(非連結・日本基準) | -| 1QFinancialStatements_Consolidated_JP | 第1四半期決算短信(連結・日本基準) | -| 1QFinancialStatements_Consolidated_US | 第1四半期決算短信(連結・米国基準) | -| 1QFinancialStatements_NonConsolidated_JP | 第1四半期決算短信(非連結・日本基準) | -| 2QFinancialStatements_Consolidated_JP | 第2四半期決算短信(連結・日本基準) | -| 2QFinancialStatements_Consolidated_US | 第2四半期決算短信(連結・米国基準) | -| 2QFinancialStatements_NonConsolidated_JP | 第2四半期決算短信(非連結・日本基準) | -| 3QFinancialStatements_Consolidated_JP | 第3四半期決算短信(連結・日本基準) | -| 3QFinancialStatements_Consolidated_US | 第3四半期決算短信(連結・米国基準) | -| 3QFinancialStatements_NonConsolidated_JP | 第3四半期決算短信(非連結・日本基準) | -| OtherPeriodFinancialStatements_Consolidated_JP | その他四半期決算短信(連結・日本基準) | -| OtherPeriodFinancialStatements_Consolidated_US | その他四半期決算短信(連結・米国基準) | -| OtherPeriodFinancialStatements_NonConsolidated_JP | その他四半期決算短信(非連結・日本基準) | -| FYFinancialStatements_Consolidated_JMIS | 決算短信(連結・JMIS) | -| 1QFinancialStatements_Consolidated_JMIS | 第1四半期決算短信(連結・JMIS) | -| 2QFinancialStatements_Consolidated_JMIS | 第2四半期決算短信(連結・JMIS) | -| 3QFinancialStatements_Consolidated_JMIS | 第3四半期決算短信(連結・JMIS) | -| OtherPeriodFinancialStatements_Consolidated_JMIS | その他四半期決算短信(連結・JMIS) | -| FYFinancialStatements_NonConsolidated_IFRS | 決算短信(非連結・IFRS) | -| 1QFinancialStatements_NonConsolidated_IFRS | 第1四半期決算短信(非連結・IFRS) | -| 2QFinancialStatements_NonConsolidated_IFRS | 第2四半期決算短信(非連結・IFRS) | -| 3QFinancialStatements_NonConsolidated_IFRS | 第3四半期決算短信(非連結・IFRS) | -| OtherPeriodFinancialStatements_NonConsolidated_IFRS | その他四半期決算短信(非連結・IFRS) | -| FYFinancialStatements_Consolidated_IFRS | 決算短信(連結・IFRS) | -| 1QFinancialStatements_Consolidated_IFRS | 第1四半期決算短信(連結・IFRS) | -| 2QFinancialStatements_Consolidated_IFRS | 第2四半期決算短信(連結・IFRS) | -| 3QFinancialStatements_Consolidated_IFRS | 第3四半期決算短信(連結・IFRS) | -| OtherPeriodFinancialStatements_Consolidated_IFRS | その他四半期決算短信(連結・IFRS) | -| FYFinancialStatements_NonConsolidated_Foreign | 決算短信(非連結・外国株) | -| 1QFinancialStatements_NonConsolidated_Foreign | 第1四半期決算短信(非連結・外国株) | -| 2QFinancialStatements_NonConsolidated_Foreign | 第2四半期決算短信(非連結・外国株) | -| 3QFinancialStatements_NonConsolidated_Foreign | 第3四半期決算短信(非連結・外国株) | -| OtherPeriodFinancialStatements_NonConsolidated_Foreign | その他四半期決算短信(非連結・外国株) | -| FYFinancialStatements_Consolidated_Foreign | 決算短信(連結・外国株) | -| 1QFinancialStatements_Consolidated_Foreign | 第1四半期決算短信(連結・外国株) | -| 2QFinancialStatements_Consolidated_Foreign | 第2四半期決算短信(連結・外国株) | -| 3QFinancialStatements_Consolidated_Foreign | 第3四半期決算短信(連結・外国株) | -| OtherPeriodFinancialStatements_Consolidated_Foreign | その他四半期決算短信(連結・外国株) | -| FYFinancialStatements_Consolidated_REIT | 決算短信(REIT) | -| DividendForecastRevision | 配当予想の修正 | -| EarnForecastRevision | 業績予想の修正 | -| REITDividendForecastRevision | 分配予想の修正 | -| REITEarnForecastRevision | 利益予想の修正 | - -Was this page helpful? - -© JPX Market Innovation & Research, Inc. All rights reserved. - diff --git a/docs/v2/fin-summary.md b/docs/v2/fin-summary.md deleted file mode 100644 index a24fca7..0000000 --- a/docs/v2/fin-summary.md +++ /dev/null @@ -1,543 +0,0 @@ -# Protocol API Reference - J-Quants - -> プロが活用する株価や財務データを、APIで簡単に取得。あなたの投資分析に、確かな情報を。 - -- Dashboard -- Support - -- GuidesJ-Quants APIについてV1 API から V2 API への変更点プランごとに利用可能なAPIとデータ格納期間提供データの更新タイミングクイックスタートMCPサーバー -- Noticesデータ修正履歴・制約事項レスポンスのページングについてレートリミットについてAPIレスポンスのGzip化レスポンスステータス -- Resources上場銘柄一覧(/equities/master)17業種コード及び業種名33業種コード及び業種名市場区分コード及び市場区分名株価四本値(/equities/bars/daily)前場四本値(/equities/bars/daily/am)投資部門別情報(/equities/investor-types)市場名信用取引週末残高(/markets/margin-interest)業種別空売り比率(/markets/short-ratio)空売り残高報告(/markets/short-sale-report)日々公表信用取引残高(/markets/margin-alert)公表の理由東証信用貸借規制区分売買内訳データ(/markets/breakdown)取引カレンダー(/markets/calendar)休日区分指数四本値(/indices/bars/daily)配信対象指数コードTOPIX指数四本値(/indices/bars/daily/topix)財務情報(/fins/summary)開示書類種別財務諸表(BS/PL/CF)(/fins/details)配当金情報(/fins/dividend)リファレンスナンバー決算発表予定日(/equities/earnings-calendar)日経225オプション四本値(/derivatives/bars/daily/options/225)先物四本値(/derivatives/bars/daily/futures)先物商品区分コードオプション四本値(/derivatives/bars/daily/options)オプション商品区分コード -- Sign in - -# 財務情報(/fins/summary) - -GET /v2/fins/summary - -## APIの概要 - -財務情報の開示日・銘柄コードを指定して、決算短信などの財務情報サマリーを取得できます。 -銘柄コード(code)または日付(date)のいずれか一方、もしくは両方の指定が必要です。 - -## 本APIの留意点 - -- 会計基準について: APIから出力される各項目名は日本基準(JGAAP)の開示項目が基準となっています。そのため、IFRSや米国基準(USGAAP)の開示データにおいては、経常利益の概念がありませんので、データが空欄となっています。 - -- 四半期開示見直し対応に伴うAPI項目の追加について: - -四半期開示見直し対応において、決算短信サマリー様式の記載事項が以下のとおり変更されます。 - -変更前: 重要な⼦会社の異動(連結範囲の変更を伴う特定⼦会社の異動) -変更後: 連結範囲の重要な変更 - - -この対応に伴い、2024/7/22より本APIのレスポンス項目に"SignificantChangesInTheScopeOfConsolidation"(期中における連結範囲の重要な変更)を追加いたします。 -詳細は、データ項目概要欄をご覧ください。 - -## 財務情報データを取得します - -GET https://api.jquants.com/v2/fins/summary - -銘柄コード(code)または日付(date)の指定が必須となります。 - -### パラメータ及びレスポンス - -銘柄コード(code)または日付(date)の指定が必須となります。 -各パラメータの組み合わせとレスポンスの結果については以下のとおりです。 - -| code | date | レスポンスの結果 | -|------|------|------| -| ✓ | ✗ | 指定された銘柄について全期間分の財務情報データ | -| ✓ | ✓ | 指定された銘柄について指定された日付の財務情報データ | -| ✗ | ✓ | 全上場銘柄について指定された日付の財務情報データ | - -### Requests - -### Headers - -**x-api-key** (string, required) - APIキー - - -### Query Parameters - -code または date のいずれか一つの指定が必須です。 - -**code** (string, optional) - 銘柄コード(e.g. 86970 or 8697) -4桁もしくは5桁の銘柄コード - -**date** (string, optional) - 開示日付の指定(e.g. 2022-01-05 or 20220105) - -**pagination_key** (string, optional) - 検索の先頭を指定する文字列 -過去の検索で返却された pagination_key を設定 - - -### APIコールサンプルコード - -### Request - -``` -curl -G https://api.jquants.com/v2/fins/summary --H "x-api-key: {loading}" --d code="86970" --d date="2024-10-25" -``` - -### Responses - -### データ項目概要 - -**DiscDate** (string) - 開示日 - -**DiscTime** (string) - 開示時刻 - -**Code** (string) - 銘柄コード(5桁) - -**DiscNo** (string) - 開示番号 -APIから出力されるjsonは開示番号で昇順に並んでいます。 - -**DocType** (string) - 開示書類種別 -開示書類種別一覧 - -**CurPerType** (string) - 当会計期間の種類 -[1Q, 2Q, 3Q, 4Q, 5Q, FY] - -**CurPerSt** (string) - 当会計期間開始日 - -**CurPerEn** (string) - 当会計期間終了日 - -**CurFYSt** (string) - 当事業年度開始日 - -**CurFYEn** (string) - 当事業年度終了日 - -**NxtFYSt** (string) - 翌事業年度開始日 -開示レコードに翌事業年度の開示情報がない場合空欄になります。 - -**NxtFYEn** (string) - 翌事業年度終了日 -開示レコードに翌事業年度の開示情報がない場合空欄になります。 - -**Sales** (number) - 売上高 - -**OP** (number) - 営業利益 - -**OdP** (number) - 経常利益 - -**NP** (number) - 当期純利益 - -**EPS** (number) - 一株あたり当期純利益 - -**DEPS** (number) - 潜在株式調整後一株あたり当期純利益 - -**TA** (number) - 総資産 - -**Eq** (number) - 純資産 - -**EqAR** (number) - 自己資本比率 - -**BPS** (number) - 一株あたり純資産 - -**CFO** (number) - 営業活動によるキャッシュ・フロー - -**CFI** (number) - 投資活動によるキャッシュ・フロー - -**CFF** (number) - 財務活動によるキャッシュ・フロー - -**CashEq** (number) - 現金及び現金同等物期末残高 - -**Div1Q** (number) - 一株あたり配当実績_第1四半期末 - -**Div2Q** (number) - 一株あたり配当実績_第2四半期末 - -**Div3Q** (number) - 一株あたり配当実績_第3四半期末 - -**DivFY** (number) - 一株あたり配当実績_期末 - -**DivAnn** (number) - 一株あたり配当実績_合計 - -**DivUnit** (number) - 1口当たり分配金 - -**DivTotalAnn** (number) - 配当金総額 - -**PayoutRatioAnn** (number) - 配当性向 - -**FDiv1Q** (number) - 一株あたり配当予想_第1四半期末 - -**FDiv2Q** (number) - 一株あたり配当予想_第2四半期末 - -**FDiv3Q** (number) - 一株あたり配当予想_第3四半期末 - -**FDivFY** (number) - 一株あたり配当予想_期末 - -**FDivAnn** (number) - 一株あたり配当予想_合計 - -**FDivUnit** (number) - 1口当たり予想分配金 - -**FDivTotalAnn** (number) - 予想配当金総額 - -**FPayoutRatioAnn** (number) - 予想配当性向 - -**NxFDiv1Q** (number) - 一株あたり配当予想_翌事業年度第1四半期末 - -**NxFDiv2Q** (number) - 一株あたり配当予想_翌事業年度第2四半期末 - -**NxFDiv3Q** (number) - 一株あたり配当予想_翌事業年度第3四半期末 - -**NxFDivFY** (number) - 一株あたり配当予想_翌事業年度期末 - -**NxFDivAnn** (number) - 一株あたり配当予想_翌事業年度合計 - -**NxFDivUnit** (number) - 1口当たり翌事業年度予想分配金 - -**NxFPayoutRatioAnn** (number) - 翌事業年度予想配当性向 - -**FSales2Q** (number) - 売上高_予想_第2四半期末 - -**FOP2Q** (number) - 営業利益_予想_第2四半期末 - -**FOdP2Q** (number) - 経常利益_予想_第2四半期末 - -**FNP2Q** (number) - 当期純利益_予想_第2四半期末 - -**FEPS2Q** (number) - 一株あたり当期純利益_予想_第2四半期末 - -**NxFSales2Q** (number) - 売上高_予想_翌事業年度第2四半期末 - -**NxFOP2Q** (number) - 営業利益_予想_翌事業年度第2四半期末 - -**NxFOdP2Q** (number) - 経常利益_予想_翌事業年度第2四半期末 - -**NxFNp2Q** (number) - 当期純利益_予想_翌事業年度第2四半期末 - -**NxFEPS2Q** (number) - 一株あたり当期純利益_予想_翌事業年度第2四半期末 - -**FSales** (number) - 売上高_予想_期末 - -**FOP** (number) - 営業利益_予想_期末 - -**FOdP** (number) - 経常利益_予想_期末 - -**FNP** (number) - 当期純利益_予想_期末 - -**FEPS** (number) - 一株あたり当期純利益_予想_期末 - -**NxFSales** (number) - 売上高_予想_翌事業年度期末 - -**NxFOP** (number) - 営業利益_予想_翌事業年度期末 - -**NxFOdP** (number) - 経常利益_予想_翌事業年度期末 - -**NxFNp** (number) - 当期純利益_予想_翌事業年度期末 - -**NxFEPS** (number) - 一株あたり当期純利益_予想_翌事業年度期末 - -**MatChgSub** (string) - 期中における重要な子会社の異動 - -**SigChgInC** (string) - 期中における連結範囲の重要な変更 -*指定されたdateが2024-07-21以前のレスポンスは、当該項目には値が収録されません。 - -**ChgByASRev** (string) - 会計基準等の改正に伴う会計方針の変更 - -**ChgNoASRev** (string) - 会計基準等の改正に伴う変更以外の会計方針の変更 - -**ChgAcEst** (string) - 会計上の見積りの変更 - -**RetroRst** (string) - 修正再表示 - -**ShOutFY** (number) - 期末発行済株式数 - -**TrShFY** (number) - 期末自己株式数 - -**AvgSh** (number) - 期中平均株式数 - -**NCSales** (number) - 売上高_非連結 - -**NCOP** (number) - 営業利益_非連結 - -**NCOdP** (number) - 経常利益_非連結 - -**NCNP** (number) - 当期純利益_非連結 - -**NCEPS** (number) - 一株あたり当期純利益_非連結 - -**NCTA** (number) - 総資産_非連結 - -**NCEq** (number) - 純資産_非連結 - -**NCEqAR** (number) - 自己資本比率_非連結 - -**NCBPS** (number) - 一株あたり純資産_非連結 - -**FNCSales2Q** (number) - 売上高_予想_第2四半期末_非連結 - -**FNCOP2Q** (number) - 営業利益_予想_第2四半期末_非連結 - -**FNCOdP2Q** (number) - 経常利益_予想_第2四半期末_非連結 - -**FNCNP2Q** (number) - 当期純利益_予想_第2四半期末_非連結 - -**FNCEPS2Q** (number) - 一株あたり当期純利益_予想_第2四半期末_非連結 - -**NxFNCSales2Q** (number) - 売上高_予想_翌事業年度第2四半期末_非連結 - -**NxFNCOP2Q** (number) - 営業利益_予想_翌事業年度第2四半期末_非連結 - -**NxFNCOdP2Q** (number) - 経常利益_予想_翌事業年度第2四半期末_非連結 - -**NxFNCNP2Q** (number) - 当期純利益_予想_翌事業年度第2四半期末_非連結 - -**NxFNCEPS2Q** (number) - 一株あたり当期純利益_予想_翌事業年度第2四半期末_非連結 - -**FNCSales** (number) - 売上高_予想_期末_非連結 - -**FNCOP** (number) - 営業利益_予想_期末_非連結 - -**FNCOdP** (number) - 経常利益_予想_期末_非連結 - -**FNCNP** (number) - 当期純利益_予想_期末_非連結 - -**FNCEPS** (number) - 一株あたり当期純利益_予想_期末_非連結 - -**NxFNCSales** (number) - 売上高_予想_翌事業年度期末_非連結 - -**NxFNCOP** (number) - 営業利益_予想_翌事業年度期末_非連結 - -**NxFNCOdP** (number) - 経常利益_予想_翌事業年度期末_非連結 - -**NxFNCNP** (number) - 当期純利益_予想_翌事業年度期末_非連結 - -**NxFNCEPS** (number) - 一株あたり当期純利益_予想_翌事業年度期末_非連結 - - -### レスポンスサンプル - -``` -{ - "data": [ - { - "DiscDate": "2023-01-30", - "DiscTime": "12:00:00", - "Code": "86970", - "DiscNo": "20230127594871", - "DocType": "3QFinancialStatements_Consolidated_IFRS", - "CurPerType": "3Q", - "CurPerSt": "2022-04-01", - "CurPerEn": "2022-12-31", - "CurFYSt": "2022-04-01", - "CurFYEn": "2023-03-31", - "NxtFYSt": "", - "NxtFYEn": "", - "Sales": "100529000000", - "OP": "51765000000", - "OdP": "", - "NP": "35175000000", - "EPS": "66.76", - "DEPS": "", - "TA": "79205861000000", - "Eq": "320021000000", - "EqAR": "0.004", - "BPS": "", - "CFO": "", - "CFI": "", - "CFF": "", - "CashEq": "91135000000", - "Div1Q": "", - "Div2Q": "26.0", - "Div3Q": "", - "DivFY": "", - "DivAnn": "", - "DivUnit": "", - "DivTotalAnn": "", - "PayoutRatioAnn": "", - "FDiv1Q": "", - "FDiv2Q": "", - "FDiv3Q": "", - "FDivFY": "36.0", - "FDivAnn": "62.0", - "FDivUnit": "", - "FDivTotalAnn": "", - "FPayoutRatioAnn": "", - "NxFDiv1Q": "", - "NxFDiv2Q": "", - "NxFDiv3Q": "", - "NxFDivFY": "", - "NxFDivAnn": "", - "NxFDivUnit": "", - "NxFPayoutRatioAnn": "", - "FSales2Q": "", - "FOP2Q": "", - "FOdP2Q": "", - "FNP2Q": "", - "FEPS2Q": "", - "NxFSales2Q": "", - "NxFOP2Q": "", - "NxFOdP2Q": "", - "NxFNp2Q": "", - "NxFEPS2Q": "", - "FSales": "132500000000", - "FOP": "65500000000", - "FOdP": "", - "FNP": "45000000000", - "FEPS": "85.42", - "NxFSales": "", - "NxFOP": "", - "NxFOdP": "", - "NxFNp": "", - "NxFEPS": "", - "MatChgSub": "false", - "SigChgInC": "", - "ChgByASRev": "false", - "ChgNoASRev": "false", - "ChgAcEst": "true", - "RetroRst": "", - "ShOutFY": "528578441", - "TrShFY": "1861043", - "AvgSh": "526874759", - "NCSales": "", - "NCOP": "", - "NCOdP": "", - "NCNP": "", - "NCEPS": "", - "NCTA": "", - "NCEq": "", - "NCEqAR": "", - "NCBPS": "", - "FNCSales2Q": "", - "FNCOP2Q": "", - "FNCOdP2Q": "", - "FNCNP2Q": "", - "FNCEPS2Q": "", - "NxFNCSales2Q": "", - "NxFNCOP2Q": "", - "NxFNCOdP2Q": "", - "NxFNCNP2Q": "", - "NxFNCEPS2Q": "", - "FNCSales": "", - "FNCOP": "", - "FNCOdP": "", - "FNCNP": "", - "FNCEPS": "", - "NxFNCSales": "", - "NxFNCOP": "", - "NxFNCOdP": "", - "NxFNCNP": "", - "NxFNCEPS": "" - } - ], - "pagination_key": "value1.value2." -} -``` - -Was this page helpful? - -© JPX Market Innovation & Research, Inc. All rights reserved. - diff --git a/docs/v2/idx-bars-daily-indexcodes.md b/docs/v2/idx-bars-daily-indexcodes.md deleted file mode 100644 index 6712bf4..0000000 --- a/docs/v2/idx-bars-daily-indexcodes.md +++ /dev/null @@ -1,101 +0,0 @@ -# Protocol API Reference - J-Quants - -> プロが活用する株価や財務データを、APIで簡単に取得。あなたの投資分析に、確かな情報を。 - -- Dashboard -- Support - -- GuidesJ-Quants APIについてV1 API から V2 API への変更点プランごとに利用可能なAPIとデータ格納期間提供データの更新タイミングクイックスタートMCPサーバー -- Noticesデータ修正履歴・制約事項レスポンスのページングについてレートリミットについてAPIレスポンスのGzip化レスポンスステータス -- Resources上場銘柄一覧(/equities/master)17業種コード及び業種名33業種コード及び業種名市場区分コード及び市場区分名株価四本値(/equities/bars/daily)前場四本値(/equities/bars/daily/am)投資部門別情報(/equities/investor-types)市場名信用取引週末残高(/markets/margin-interest)業種別空売り比率(/markets/short-ratio)空売り残高報告(/markets/short-sale-report)日々公表信用取引残高(/markets/margin-alert)公表の理由東証信用貸借規制区分売買内訳データ(/markets/breakdown)取引カレンダー(/markets/calendar)休日区分指数四本値(/indices/bars/daily)配信対象指数コードTOPIX指数四本値(/indices/bars/daily/topix)財務情報(/fins/summary)開示書類種別財務諸表(BS/PL/CF)(/fins/details)配当金情報(/fins/dividend)リファレンスナンバー決算発表予定日(/equities/earnings-calendar)日経225オプション四本値(/derivatives/bars/daily/options/225)先物四本値(/derivatives/bars/daily/futures)先物商品区分コードオプション四本値(/derivatives/bars/daily/options)オプション商品区分コード -- Sign in - -# 配信対象指数コード - -## 各指数の留意点 - -- 2022年4月の東証市場区分再編によりマザーズ市場は廃止されていますが、一定のルールに基づき東証マザーズ指数の構成銘柄の入替を行い、2023年11月6日より指数名称を「東証グロース市場250指数」に変更されています。詳細はこちらをご参照ください。 - -| 指数コード | 指数名称 | データ収録期間 | -|------|------|------| -| 0000 | TOPIX | 2008/5/7〜 | -| 0001 | 東証二部総合指数 | 2008/5/7〜2022/4/1 | -| 0028 | TOPIX Core30 | 2008/5/7〜 | -| 0029 | TOPIX Large 70 | 2008/5/7〜 | -| 002A | TOPIX 100 | 2008/5/7〜 | -| 002B | TOPIX Mid400 | 2008/5/7〜 | -| 002C | TOPIX 500 | 2008/5/7〜 | -| 002D | TOPIX Small | 2008/5/7〜 | -| 002E | TOPIX 1000 | 2008/5/7〜 | -| 002F | TOPIX Small500 | (四本値)2018/10/9〜 (終値のみ)2018/9/3〜 | -| 0040 | 東証業種別 水産・農林業 | 2008/5/7〜 | -| 0041 | 東証業種別 鉱業 | 2008/5/7〜 | -| 0042 | 東証業種別 建設業 | 2008/5/7〜 | -| 0043 | 東証業種別 食料品 | 2008/5/7〜 | -| 0044 | 東証業種別 繊維製品 | 2008/5/7〜 | -| 0045 | 東証業種別 パルプ・紙 | 2008/5/7〜 | -| 0046 | 東証業種別 化学 | 2008/5/7〜 | -| 0047 | 東証業種別 医薬品 | 2008/5/7〜 | -| 0048 | 東証業種別 石油・石炭製品​ | 2008/5/7〜 | -| 0049 | 東証業種別 ゴム製品 | 2008/5/7〜 | -| 004A | 東証業種別 ガラス・土石製品 | 2008/5/7〜 | -| 004B | 東証業種別 鉄鋼 | 2008/5/7〜 | -| 004C | 東証業種別 非鉄金属 | 2008/5/7〜 | -| 004D | 東証業種別 金属製品 | 2008/5/7〜 | -| 004E | 東証業種別 機械 | 2008/5/7〜 | -| 004F | 東証業種別 電気機器 | 2008/5/7〜 | -| 0050 | 東証業種別 輸送用機器 | 2008/5/7〜 | -| 0051 | 東証業種別 精密機器 | 2008/5/7〜 | -| 0052 | 東証業種別 その他製品 | 2008/5/7〜 | -| 0053 | 東証業種別 電気・ガス業 | 2008/5/7〜 | -| 0054 | 東証業種別 陸運業 | 2008/5/7〜 | -| 0055 | 東証業種別 海運業 | 2008/5/7〜 | -| 0056 | 東証業種別 空運業 | 2008/5/7〜 | -| 0057 | 東証業種別 倉庫・運輸関連業​ | 2008/5/7〜 | -| 0058 | 東証業種別 情報・通信業 | 2008/5/7〜 | -| 0059 | 東証業種別 卸売業 | 2008/5/7〜 | -| 005A | 東証業種別 小売業 | 2008/5/7〜 | -| 005B | 東証業種別 銀行業 | 2008/5/7〜 | -| 005C | 東証業種別 証券・商品先物取引業 | 2008/5/7〜 | -| 005D | 東証業種別 保険業 | 2008/5/7〜 | -| 005E | 東証業種別 その他金融業 | 2008/5/7〜 | -| 005F | 東証業種別 不動産業 | 2008/5/7〜 | -| 0060 | 東証業種別 サービス業 | 2008/5/7〜 | -| 0070 | 東証グロース市場250指数 (旧:東証マザーズ指数※) | 2008/5/7〜 | -| 0075 | REIT | 2008/5/7〜 | -| 0080 | TOPIX-17 食品 | 2009/2/2〜 | -| 0081 | TOPIX-17 エネルギー資源 | 2009/2/2〜 | -| 0082 | TOPIX-17 建設・資材 | 2009/2/2〜 | -| 0083 | TOPIX-17 素材・化学 | 2009/2/2〜 | -| 0084 | TOPIX-17 医薬品 | 2009/2/2〜 | -| 0085 | TOPIX-17 自動車・輸送機 | 2009/2/2〜 | -| 0086 | TOPIX-17 鉄鋼・非鉄​ | 2009/2/2〜 | -| 0087 | TOPIX-17 機械 | 2009/2/2〜 | -| 0088 | TOPIX-17 電機・精密 | 2009/2/2〜 | -| 0089 | TOPIX-17 情報通信・サービスその他 | 2009/2/2〜 | -| 008A | TOPIX-17 電力・ガス | 2009/2/2〜 | -| 008B | TOPIX-17 運輸・物流 | 2009/2/2〜 | -| 008C | TOPIX-17 商社・卸売 | 2009/2/2〜 | -| 008D | TOPIX-17 小売 | 2009/2/2〜 | -| 008E | TOPIX-17 銀行 | 2009/2/2〜 | -| 008F | TOPIX-17 金融(除く銀行) | 2009/2/2〜 | -| 0090 | TOPIX-17 不動産 | 2009/2/2〜 | -| 0091 | JASDAQ INDEX | 2008/5/7〜2022/4/1 | -| 0500 | 東証プライム市場指数 | 2022/6/27〜 | -| 0501 | 東証スタンダード市場指数 | 2022/6/27〜 | -| 0502 | 東証グロース市場指数 | 2022/6/27〜 | -| 0503 | JPXプライム150指数 | (四本値)2023/7/3〜 (終値のみ)2023/5/29〜 | -| 8100 | TOPIX バリュー | 2009/2/9〜 | -| 812C | TOPIX500 バリュー | 2009/2/9〜 | -| 812D | TOPIXSmall バリュー | 2009/2/9〜 | -| 8200 | TOPIX グロース | 2009/2/9〜 | -| 822C | TOPIX500 グロース | 2009/2/9〜 | -| 822D | TOPIXSmall グロース | 2009/2/9〜 | -| 8501 | 東証REIT オフィス指数 | (四本値)2010/3/8〜 (終値のみ)2010/3/1〜 | -| 8502 | 東証REIT 住宅指数 | (四本値)2010/3/8〜 (終値のみ)2010/3/1〜 | -| 8503 | 東証REIT 商業・物流等指数 | (四本値)2010/3/8〜 (終値のみ)2010/3/1〜 | - -Was this page helpful? - -© JPX Market Innovation & Research, Inc. All rights reserved. - diff --git a/docs/v2/idx-bars-daily-topix.md b/docs/v2/idx-bars-daily-topix.md deleted file mode 100644 index 6f8b266..0000000 --- a/docs/v2/idx-bars-daily-topix.md +++ /dev/null @@ -1,99 +0,0 @@ -# Protocol API Reference - J-Quants - -> プロが活用する株価や財務データを、APIで簡単に取得。あなたの投資分析に、確かな情報を。 - -- Dashboard -- Support - -- GuidesJ-Quants APIについてV1 API から V2 API への変更点プランごとに利用可能なAPIとデータ格納期間提供データの更新タイミングクイックスタートMCPサーバー -- Noticesデータ修正履歴・制約事項レスポンスのページングについてレートリミットについてAPIレスポンスのGzip化レスポンスステータス -- Resources上場銘柄一覧(/equities/master)17業種コード及び業種名33業種コード及び業種名市場区分コード及び市場区分名株価四本値(/equities/bars/daily)前場四本値(/equities/bars/daily/am)投資部門別情報(/equities/investor-types)市場名信用取引週末残高(/markets/margin-interest)業種別空売り比率(/markets/short-ratio)空売り残高報告(/markets/short-sale-report)日々公表信用取引残高(/markets/margin-alert)公表の理由東証信用貸借規制区分売買内訳データ(/markets/breakdown)取引カレンダー(/markets/calendar)休日区分指数四本値(/indices/bars/daily)配信対象指数コードTOPIX指数四本値(/indices/bars/daily/topix)財務情報(/fins/summary)開示書類種別財務諸表(BS/PL/CF)(/fins/details)配当金情報(/fins/dividend)リファレンスナンバー決算発表予定日(/equities/earnings-calendar)日経225オプション四本値(/derivatives/bars/daily/options/225)先物四本値(/derivatives/bars/daily/futures)先物商品区分コードオプション四本値(/derivatives/bars/daily/options)オプション商品区分コード -- Sign in - -# TOPIX指数四本値(/indices/bars/daily/topix) - -GET /v2/indices/bars/daily/topix - -## APIの概要 - -TOPIXの日通しの四本値を取得できます。 -本APIで取得可能な指数データは TOPIX(東証株価指数)のみとなります。 - -## 日次のTOPIX指数データを取得します - -GET https://api.jquants.com/v2/indices/bars/daily/topix - -日付の範囲(from/to)を指定することができます。なお、指定しない場合は全期間のデータがレスポンスに収録されます。 - -### Requests - -### Headers - -**x-api-key** (string, required) - APIキー - - -### Query Parameters - -**from** (string, optional) - from の指定(e.g. 20210901 or 2021-09-01) - -**to** (string, optional) - to の指定(e.g. 20210907 or 2021-09-07) - -**pagination_key** (string, optional) - 検索の先頭を指定する文字列過去の検索で返却された pagination_key を設定 - - -### APIコールサンプルコード - -### Request - -``` -curl -G https://api.jquants.com/v2/indices/bars/daily/topix --H "x-api-key: {loading}" --d from="20220101" --d to="20221231" -``` - -### Responses - -### データ項目概要 - -**Date** (string) - 日付(YYYY-MM-DD) - -**O** (number) - 始値 - -**H** (number) - 高値 - -**L** (number) - 安値 - -**C** (number) - 終値 - - -### レスポンスサンプル - -``` -{ - "data": [ - { - "Date": "2022-06-28", - "O": 1885.52, - "H": 1907.38, - "L": 1885.32, - "C": 1907.38 - } - ], - "pagination_key": "value1.value2." -} -``` - -Was this page helpful? - -© JPX Market Innovation & Research, Inc. All rights reserved. - diff --git a/docs/v2/idx-bars-daily.md b/docs/v2/idx-bars-daily.md deleted file mode 100644 index a6ee9ae..0000000 --- a/docs/v2/idx-bars-daily.md +++ /dev/null @@ -1,131 +0,0 @@ -# Protocol API Reference - J-Quants - -> プロが活用する株価や財務データを、APIで簡単に取得。あなたの投資分析に、確かな情報を。 - -- Dashboard -- Support - -- GuidesJ-Quants APIについてV1 API から V2 API への変更点プランごとに利用可能なAPIとデータ格納期間提供データの更新タイミングクイックスタートMCPサーバー -- Noticesデータ修正履歴・制約事項レスポンスのページングについてレートリミットについてAPIレスポンスのGzip化レスポンスステータス -- Resources上場銘柄一覧(/equities/master)17業種コード及び業種名33業種コード及び業種名市場区分コード及び市場区分名株価四本値(/equities/bars/daily)前場四本値(/equities/bars/daily/am)投資部門別情報(/equities/investor-types)市場名信用取引週末残高(/markets/margin-interest)業種別空売り比率(/markets/short-ratio)空売り残高報告(/markets/short-sale-report)日々公表信用取引残高(/markets/margin-alert)公表の理由東証信用貸借規制区分売買内訳データ(/markets/breakdown)取引カレンダー(/markets/calendar)休日区分指数四本値(/indices/bars/daily)配信対象指数コードTOPIX指数四本値(/indices/bars/daily/topix)財務情報(/fins/summary)開示書類種別財務諸表(BS/PL/CF)(/fins/details)配当金情報(/fins/dividend)リファレンスナンバー決算発表予定日(/equities/earnings-calendar)日経225オプション四本値(/derivatives/bars/daily/options/225)先物四本値(/derivatives/bars/daily/futures)先物商品区分コードオプション四本値(/derivatives/bars/daily/options)オプション商品区分コード -- Sign in - -# 指数四本値(/indices/bars/daily) - -GET /v2/indices/bars/daily - -## APIの概要 - -各種指数の四本値データを取得することができます。 - -現在配信している指数につきましては、こちらのページを参照ください。 - -### 本APIの留意点 - -- 2022年4月の東証市場区分再編によりマザーズ市場は廃止されていますが、一定のルールに基づき東証マザーズ指数の構成銘柄の入替を行い、2023年11月6日より指数名称を「東証グロース市場250指数」に変更されています。詳細はこちらをご参照ください。 -- 2020年10月1日のデータは東京証券取引所の株式売買システムの障害により終日売買停止となった関係で、四本値は前営業日(2020年10月1日)の終値が収録されています。 - -## 日次の指数四本値データを取得します - -GET https://api.jquants.com/v2/indices/bars/daily - -データの取得では、指数コード(code)または日付(date)の指定が必須となります。 - -### パラメータ及びレスポンス - -データの取得する際には、指数コード(code)または日付(date)の指定が必須となります。 -各パラメータの組み合わせとレスポンスの結果については以下のとおりです。 - -| code | date | from /to | レスポンスの結果 | -|------|------|------|------| -| ✓ | ✗ | ✗ | 指定された銘柄について全期間分のデータ | -| ✓ | ✓ | ✗ | 指定された銘柄について指定された日付のデータ | -| ✓ | ✗ | ✓ | 指定された銘柄について指定された期間分のデータ | -| ✗ | ✓ | ✗ | 配信している指数全てについて指定された日付のデータ | - -### Requests - -### Headers - -**x-api-key** (string, required) - APIキー - - -### Query Parameters - -code または date のいずれか一つの指定が必須です。 - -**code** (string, optional) - 指数コード(e.g. 0000 or 0028) -配信対象の指数コードについては配信対象指数コードを参照してください。 - -**date** (string, optional) - from と to を指定しないとき(e.g. 20210907 or 2021-09-07) - -**from** (string, optional) - from の指定(e.g. 20210901 or 2021-09-01) - -**to** (string, optional) - to の指定(e.g. 20210907 or 2021-09-07) - -**pagination_key** (string, optional) - 検索の先頭を指定する文字列過去の検索で返却された pagination_key を設定 - - -### APIコールサンプルコード - -### Request - -``` -curl -G https://api.jquants.com/v2/indices/bars/daily --H "x-api-key: {loading}" --d code="0028" --d date="20231201" -``` - -### Responses - -### データ項目概要 - -**Date** (string) - 日付(YYYY-MM-DD) - -**Code** (string) - 指数コード -配信対象の指数コードはこちらのページを参照ください。 - -**O** (number) - 始値 - -**H** (number) - 高値 - -**L** (number) - 安値 - -**C** (number) - 終値 - - -### レスポンスサンプル - -``` -{ - "data": [ - { - "Date": "2023-12-01", - "Code": "0028", - "O": 1199.18, - "H": 1202.58, - "L": 1195.01, - "C": 1200.17 - } - ], - "pagination_key": "value1.value2." -} -``` - -Was this page helpful? - -© JPX Market Innovation & Research, Inc. All rights reserved. - diff --git a/docs/v2/migration-v1-v2.md b/docs/v2/migration-v1-v2.md deleted file mode 100644 index 01fd4d8..0000000 --- a/docs/v2/migration-v1-v2.md +++ /dev/null @@ -1,119 +0,0 @@ -# V1 API から V2 API への変更点 - Protocol API Reference - -> J-Quants API V1 から V2 への主な仕様変更点(認証方式、プラン内容、レートリミット、エンドポイント、レスポンス形式)について説明します。 - -- Dashboard -- Support - -- GuidesJ-Quants APIについてV1 API から V2 API への変更点認証認可プラン・データ提供範囲レートリミットエンドポイント・パラメータの変更レスポンス形式プランごとに利用可能なAPIとデータ格納期間提供データの更新タイミングクイックスタートMCPサーバー -- Noticesデータ修正履歴・制約事項レスポンスのページングについてレートリミットについてAPIレスポンスのGzip化レスポンスステータス -- Resources上場銘柄一覧(/equities/master)17業種コード及び業種名33業種コード及び業種名市場区分コード及び市場区分名株価四本値(/equities/bars/daily)前場四本値(/equities/bars/daily/am)投資部門別情報(/equities/investor-types)市場名信用取引週末残高(/markets/margin-interest)業種別空売り比率(/markets/short-ratio)空売り残高報告(/markets/short-sale-report)日々公表信用取引残高(/markets/margin-alert)公表の理由東証信用貸借規制区分売買内訳データ(/markets/breakdown)取引カレンダー(/markets/calendar)休日区分指数四本値(/indices/bars/daily)配信対象指数コードTOPIX指数四本値(/indices/bars/daily/topix)財務情報(/fins/summary)開示書類種別財務諸表(BS/PL/CF)(/fins/details)配当金情報(/fins/dividend)リファレンスナンバー決算発表予定日(/equities/earnings-calendar)日経225オプション四本値(/derivatives/bars/daily/options/225)先物四本値(/derivatives/bars/daily/futures)先物商品区分コードオプション四本値(/derivatives/bars/daily/options)オプション商品区分コード -- Sign in - -# V1 API から V2 API への変更点 - -J-Quants API V2 では、使いやすさの改善等を目的として、認証方式を含むいくつかの重要な仕様変更が行われています。 -V1 API をご利用中のお客様は、以下の変更点をご確認の上、V2 API への移行をお願いいたします。 - -V1仕様書はこちら - -## 認証認可 - -認証方式が「トークン方式」から「APIキー方式」に変更されました。 - -| 項目 | V1 API | V2 API | -|------|------|------| -| API利用方法 | token/auth_user 等で ID Token / Refresh Token を発行して利用 | ダッシュボードから発行した APIキー (x-api-key ヘッダー) を利用 | -| 認可の期限 | ID Token / Refresh Token に有効期限あり | APIキー自体には有効期限なし(再発行・削除は可能) | - -## プラン・データ提供範囲 - -| 項目 | V1 API | V2 API | -|------|------|------| -| Premiumプランの期間制限 | 無制限 | 過去20年分 まで | -| 上場銘柄一覧(貸借信用区分) | Standard, Premium プランのみ取得可能 | 全プラン で取得可能 | - -## レートリミット - -プランごとに API リクエスト数の上限(レートリミット)が設定されました。 - -| プラン | 上限 (リクエスト / 分) | -|------|------| -| Free | 5 | -| Light | 60 | -| Standard | 120 | -| Premium | 500 | - -## エンドポイント・パラメータの変更 - -V1 API から V2 API への移行に伴い、エンドポイントのパスとパラメータを変更しています。 - -### エンドポイントの対応表 - -| データセット | V1 エンドポイント | V2 エンドポイント | -|------|------|------| -| トークン発行 | /v1/token/auth_user | 廃止 (APIキーを使用) | -| トークンリフレッシュ | /v1/token/auth_refresh | 廃止 (APIキーを使用) | -| 株価四本値 | /v1/prices/daily_quotes | /v2/equities/bars/daily | -| 前場四本値 | /v1/prices/prices_am | /v2/equities/bars/daily/am | -| 決算発表予定日 | /v1/fins/announcement | /v2/equities/earnings-calendar | -| 投資部門別情報 | /v1/markets/trades_spec | /v2/equities/investor-types | -| 上場銘柄一覧 | /v1/listed/info | /v2/equities/master | -| 先物四本値 | /v1/derivatives/futures | /v2/derivatives/bars/daily/futures | -| オプション四本値 | /v1/derivatives/options | /v2/derivatives/bars/daily/options | -| 日経225オプション四本値 | /v1/option/index_option | /v2/derivatives/bars/daily/options/225 | -| 売買内訳データ | /v1/markets/breakdown | /v2/markets/breakdown | -| 取引カレンダー | /v1/markets/trading_calendar | /v2/markets/calendar | -| 日々公表信用取引残高 | /v1/markets/daily_margin_interest | /v2/markets/margin-alert | -| 信用取引週末残高 | /v1/markets/weekly_margin_interest | /v2/markets/margin-interest | -| 業種別空売り比率 | /v1/markets/short_selling | /v2/markets/short-ratio | -| 空売り残高報告 | /v1/markets/short_selling_positions | /v2/markets/short-sale-report | -| 指数四本値 | /v1/indices | /v2/indices/bars/daily | -| TOPIX指数四本値 | /v1/indices/topix | /v2/indices/bars/daily/topix | -| 財務諸表(BS/PL/CF) | /v1/fins/fs_details | /v2/fins/details | -| 財務情報 | /v1/fins/statements | /v2/fins/summary | -| 配当金情報 | /v1/fins/dividend | /v2/fins/dividend | - -## レスポンス形式 - -| 項目 | V1 API | V2 API | -|------|------|------| -| レスポンス構造 | APIによって異なる | 原則としてデータを "data" キーの配列として返却 | - -### レスポンス例 - -``` -{ - "data": [ - { ... }, - { ... } - ], - "pagination_key": "..." -} -``` - -### カラム名の変更例(株価四本値) - -V2 API では、レスポンスのカラム名が短縮形に変更されている場合があります。以下は株価四本値の例です。 - -| 項目 | V1 API カラム名 | V2 API カラム名 | -|------|------|------| -| 日付 | Date | Date | -| 銘柄コード | Code | Code | -| 始値 | Open | O | -| 高値 | High | H | -| 安値 | Low | L | -| 終値 | Close | C | -| 出来高 | Volume | Vo | -| 売買代金 | TurnoverValue | Va | -| 調整後始値 | AdjustmentOpen | AdjO | -| 調整後高値 | AdjustmentHigh | AdjH | -| 調整後安値 | AdjustmentLow | AdjL | -| 調整後終値 | AdjustmentClose | AdjC | -| 調整後出来高 | AdjustmentVolume | AdjVo | -| 調整係数 | AdjustmentFactor | AdjFactor | - -Was this page helpful? - -© JPX Market Innovation & Research, Inc. All rights reserved. - diff --git a/docs/v2/mkt-breakdown.md b/docs/v2/mkt-breakdown.md deleted file mode 100644 index f3022eb..0000000 --- a/docs/v2/mkt-breakdown.md +++ /dev/null @@ -1,167 +0,0 @@ -# Protocol API Reference - J-Quants - -> プロが活用する株価や財務データを、APIで簡単に取得。あなたの投資分析に、確かな情報を。 - -- Dashboard -- Support - -- GuidesJ-Quants APIについてV1 API から V2 API への変更点プランごとに利用可能なAPIとデータ格納期間提供データの更新タイミングクイックスタートMCPサーバー -- Noticesデータ修正履歴・制約事項レスポンスのページングについてレートリミットについてAPIレスポンスのGzip化レスポンスステータス -- Resources上場銘柄一覧(/equities/master)17業種コード及び業種名33業種コード及び業種名市場区分コード及び市場区分名株価四本値(/equities/bars/daily)前場四本値(/equities/bars/daily/am)投資部門別情報(/equities/investor-types)市場名信用取引週末残高(/markets/margin-interest)業種別空売り比率(/markets/short-ratio)空売り残高報告(/markets/short-sale-report)日々公表信用取引残高(/markets/margin-alert)公表の理由東証信用貸借規制区分売買内訳データ(/markets/breakdown)取引カレンダー(/markets/calendar)休日区分指数四本値(/indices/bars/daily)配信対象指数コードTOPIX指数四本値(/indices/bars/daily/topix)財務情報(/fins/summary)開示書類種別財務諸表(BS/PL/CF)(/fins/details)配当金情報(/fins/dividend)リファレンスナンバー決算発表予定日(/equities/earnings-calendar)日経225オプション四本値(/derivatives/bars/daily/options/225)先物四本値(/derivatives/bars/daily/futures)先物商品区分コードオプション四本値(/derivatives/bars/daily/options)オプション商品区分コード -- Sign in - -# 売買内訳データ(/markets/breakdown) - -GET /v2/markets/breakdown - -## APIの概要 - -東証上場銘柄の東証市場における銘柄別の日次売買代金・売買高(立会内取引に限る)について、信用取引や空売りの利用に関する発注時のフラグ情報を用いて細分化したデータです。 - -### 本APIの留意点 - -- 当該銘柄のコーポレートアクションが発生した場合も、遡及して約定株数の調整は行われません。 -- 2020/10/1は東京証券取引所の株式売買システムの障害により終日売買停止となった関係で、データが存在しません。 - -## 銘柄別の日次売買代金・売買高のデータを取得します - -GET https://api.jquants.com/v2/markets/breakdown - -データの取得では、銘柄コード(code)または日付(date)の指定が必須となります。 - -### パラメータ及びレスポンス - -データの取得では、銘柄コード(code)または日付(date)の指定が必須となります。 -各パラメータの組み合わせとレスポンスの結果については以下のとおりです。 - -| code | date | from /to | レスポンスの結果 | -|------|------|------|------| -| ✓ | ✗ | ✗ | 指定された銘柄について全期間分のデータ | -| ✓ | ✓ | ✗ | 指定された銘柄について指定された日付のデータ | -| ✓ | ✗ | ✓ | 指定された銘柄について指定された期間分のデータ | -| ✗ | ✓ | ✗ | 全上場銘柄について指定された日付のデータ | - -### Requests - -### Headers - -**x-api-key** (string, required) - APIキー - - -### Query Parameters - -code または date のいずれか一つの指定が必須です。 - -**code** (string, optional) - 銘柄コード(e.g. 27800 or 2780)4桁の銘柄コードを指定した場合は、普通株式と優先株式等の両方が上場している銘柄においては普通株式のデータのみが取得されます。 - -**from** (string, optional) - from の指定(e.g. 20210901 or 2021-09-01) - -**to** (string, optional) - to の指定(e.g. 20210907 or 2021-09-07) - -**date** (string, optional) - from と to を指定しないときの日付(e.g. 20210907 or 2021-09-07) - -**pagination_key** (string, optional) - 検索の先頭を指定する文字列過去の検索で返却された pagination_key を設定 - - -### APIコールサンプルコード - -### Request - -``` -curl -G https://api.jquants.com/v2/markets/breakdown --H "x-api-key: {loading}" --d code="86970" --d date="20230324" -``` - -### Responses - -### データ項目概要 - -**Date** (string) - 売買日(YYYY-MM-DD) - -**Code** (string) - 銘柄コード - -**LongSellVa** (number) - 実売りの約定代金売りの約定代金の内訳 - -**ShrtNoMrgnVa** (number) - 空売り(信用新規売りを除く)の約定代金売りの約定代金の内訳 - -**MrgnSellNewVa** (number) - 信用新規売り(新たな信用売りポジションを作るための売り注文)の約定代金売りの約定代金の内訳 - -**MrgnSellCloseVa** (number) - 信用返済売り(既存の信用買いポジションを閉じるための売り注文)の約定代金売りの約定代金の内訳 - -**LongBuyVa** (number) - 現物買いの約定代金買いの約定代金の内訳 - -**MrgnBuyNewVa** (number) - 信用新規買い(新たな信用買いポジションを作るための買い注文)の約定代金買いの約定代金の内訳 - -**MrgnBuyCloseVa** (number) - 信用返済買い(既存の信用売りポジションを閉じるための買い注文)の約定代金買いの約定代金の内訳 - -**LongSellVo** (number) - 実売りの約定株数売りの約定株数の内訳 - -**ShrtNoMrgnVo** (number) - 空売り(信用新規売りを除く)の約定株数売りの約定株数の内訳 - -**MrgnSellNewVo** (number) - 信用新規売り(新たな信用売りポジションを作るための売り注文)の約定株数売りの約定株数の内訳 - -**MrgnSellCloseVo** (number) - 信用返済売り(既存の信用買いポジションを閉じるための売り注文)の約定株数売りの約定株数の内訳 - -**LongBuyVo** (number) - 現物買いの約定株数買いの約定株数の内訳 - -**MrgnBuyNewVo** (number) - 信用新規買い(新たな信用買いポジションを作るための買い注文)の約定株数買いの約定株数の内訳 - -**MrgnBuyCloseVo** (number) - 信用返済買い(既存の信用売りポジションを閉じるための買い注文)の約定株数買いの約定株数の内訳 - - -### レスポンスサンプル - -``` -{ - "data": [ - { - "Date": "2015-04-01", - "Code": "13010", - "LongSellVa": 115164000.0, - "ShrtNoMrgnVa": 93561000.0, - "MrgnSellNewVa": 6412000.0, - "MrgnSellCloseVa": 23009000.0, - "LongBuyVa": 185114000.0, - "MrgnBuyNewVa": 35568000.0, - "MrgnBuyCloseVa": 17464000.0, - "LongSellVo": 415000.0, - "ShrtNoMrgnVo": 337000.0, - "MrgnSellNewVo": 23000.0, - "MrgnSellCloseVo": 83000.0, - "LongBuyVo": 667000.0, - "MrgnBuyNewVo": 128000.0, - "MrgnBuyCloseVo": 63000.0 - } - ], - "pagination_key": "value1.value2." -} -``` - -Was this page helpful? - -© JPX Market Innovation & Research, Inc. All rights reserved. - diff --git a/docs/v2/mkt-cal-holiday-division.md b/docs/v2/mkt-cal-holiday-division.md deleted file mode 100644 index 66530e6..0000000 --- a/docs/v2/mkt-cal-holiday-division.md +++ /dev/null @@ -1,25 +0,0 @@ -# Protocol API Reference - J-Quants - -> プロが活用する株価や財務データを、APIで簡単に取得。あなたの投資分析に、確かな情報を。 - -- Dashboard -- Support - -- GuidesJ-Quants APIについてV1 API から V2 API への変更点プランごとに利用可能なAPIとデータ格納期間提供データの更新タイミングクイックスタートMCPサーバー -- Noticesデータ修正履歴・制約事項レスポンスのページングについてレートリミットについてAPIレスポンスのGzip化レスポンスステータス -- Resources上場銘柄一覧(/equities/master)17業種コード及び業種名33業種コード及び業種名市場区分コード及び市場区分名株価四本値(/equities/bars/daily)前場四本値(/equities/bars/daily/am)投資部門別情報(/equities/investor-types)市場名信用取引週末残高(/markets/margin-interest)業種別空売り比率(/markets/short-ratio)空売り残高報告(/markets/short-sale-report)日々公表信用取引残高(/markets/margin-alert)公表の理由東証信用貸借規制区分売買内訳データ(/markets/breakdown)取引カレンダー(/markets/calendar)休日区分指数四本値(/indices/bars/daily)配信対象指数コードTOPIX指数四本値(/indices/bars/daily/topix)財務情報(/fins/summary)開示書類種別財務諸表(BS/PL/CF)(/fins/details)配当金情報(/fins/dividend)リファレンスナンバー決算発表予定日(/equities/earnings-calendar)日経225オプション四本値(/derivatives/bars/daily/options/225)先物四本値(/derivatives/bars/daily/futures)先物商品区分コードオプション四本値(/derivatives/bars/daily/options)オプション商品区分コード -- Sign in - -# 休日区分 - -| 項目 | 値 | -|------|------| -| 非営業日 | 0 | -| 営業日 | 1 | -| 東証半日立会日 | 2 | -| 非営業日(祝日取引あり) | 3 | - -Was this page helpful? - -© JPX Market Innovation & Research, Inc. All rights reserved. - diff --git a/docs/v2/mkt-cal.md b/docs/v2/mkt-cal.md deleted file mode 100644 index 81842d7..0000000 --- a/docs/v2/mkt-cal.md +++ /dev/null @@ -1,109 +0,0 @@ -# Protocol API Reference - J-Quants - -> プロが活用する株価や財務データを、APIで簡単に取得。あなたの投資分析に、確かな情報を。 - -- Dashboard -- Support - -- GuidesJ-Quants APIについてV1 API から V2 API への変更点プランごとに利用可能なAPIとデータ格納期間提供データの更新タイミングクイックスタートMCPサーバー -- Noticesデータ修正履歴・制約事項レスポンスのページングについてレートリミットについてAPIレスポンスのGzip化レスポンスステータス -- Resources上場銘柄一覧(/equities/master)17業種コード及び業種名33業種コード及び業種名市場区分コード及び市場区分名株価四本値(/equities/bars/daily)前場四本値(/equities/bars/daily/am)投資部門別情報(/equities/investor-types)市場名信用取引週末残高(/markets/margin-interest)業種別空売り比率(/markets/short-ratio)空売り残高報告(/markets/short-sale-report)日々公表信用取引残高(/markets/margin-alert)公表の理由東証信用貸借規制区分売買内訳データ(/markets/breakdown)取引カレンダー(/markets/calendar)休日区分指数四本値(/indices/bars/daily)配信対象指数コードTOPIX指数四本値(/indices/bars/daily/topix)財務情報(/fins/summary)開示書類種別財務諸表(BS/PL/CF)(/fins/details)配当金情報(/fins/dividend)リファレンスナンバー決算発表予定日(/equities/earnings-calendar)日経225オプション四本値(/derivatives/bars/daily/options/225)先物四本値(/derivatives/bars/daily/futures)先物商品区分コードオプション四本値(/derivatives/bars/daily/options)オプション商品区分コード -- Sign in - -# 取引カレンダー(/markets/calendar) - -GET /v2/markets/calendar - -## APIの概要 - -東証およびOSEにおける営業日、休業日、ならびにOSEにおける祝日取引の有無の情報を取得できます。 -配信データは以下のページで公表している内容と同様です。 - -- 休業日一覧: https://www.jpx.co.jp/corporate/about-jpx/calendar/index.html -- 祝日取引実施日: https://www.jpx.co.jp/derivatives/rules/holidaytrading/index.html - -### 本APIの留意点 - -- 原則として、毎年3月末頃をめどに翌年1年間の営業日および祝日取引実施日(予定)を更新します。 - -## 営業日のデータを取得します - -GET https://api.jquants.com/v2/markets/calendar - -データの取得では、休日区分(hol_div)または日付(from/to)の指定が可能です。 - -### パラメータ及びレスポンス - -データの取得では、休日区分(hol_div)または日付(from/to)の指定が可能です。 -各パラメータの組み合わせとレスポンスの結果については以下のとおりです。 - -| hol_div | from /to | レスポンスの結果 | -|------|------|------| -| ✓ | ✗ | 指定された休日区分について全期間分のデータ | -| ✓ | ✓ | 指定された休日区分について指定された期間分のデータ | -| ✗ | ✓ | 指定された期間分のデータ | -| ✗ | ✗ | 全期間分のデータ | - -休日区分(hol_div)で指定可能なパラメータについては、以下の「休日区分」を参照してください。 - -### Requests - -### Headers - -**x-api-key** (string, required) - APIキー - - -### Query Parameters - -**hol_div** (string, optional) - 休日区分 - -**from** (string, optional) - from の指定(e.g. 20210901 or 2021-09-01) - -**to** (string, optional) - to の指定(e.g. 20210907 or 2021-09-07) - - -### APIコールサンプルコード - -### Request - -``` -curl -G https://api.jquants.com/v2/markets/calendar --H "x-api-key: {loading}" --d hol_div="1" --d from="20220101" --d to="20221231" -``` - -### Responses - -### データ項目概要 - -**Date** (string) - 日付(YYYY-MM-DD) - -**HolDiv** (string) - 休日区分 -休日区分を参照 - - -### レスポンスサンプル - -``` -{ - "data": [ - { - "Date": "2015-04-01", - "HolDiv": "1" - } - ] -} -``` - -Was this page helpful? - -© JPX Market Innovation & Research, Inc. All rights reserved. - diff --git a/docs/v2/mkt-margin-alert-margin-trading-classification.md b/docs/v2/mkt-margin-alert-margin-trading-classification.md deleted file mode 100644 index e22f67e..0000000 --- a/docs/v2/mkt-margin-alert-margin-trading-classification.md +++ /dev/null @@ -1,29 +0,0 @@ -# Protocol API Reference - J-Quants - -> プロが活用する株価や財務データを、APIで簡単に取得。あなたの投資分析に、確かな情報を。 - -- Dashboard -- Support - -- GuidesJ-Quants APIについてV1 API から V2 API への変更点プランごとに利用可能なAPIとデータ格納期間提供データの更新タイミングクイックスタートMCPサーバー -- Noticesデータ修正履歴・制約事項レスポンスのページングについてレートリミットについてAPIレスポンスのGzip化レスポンスステータス -- Resources上場銘柄一覧(/equities/master)17業種コード及び業種名33業種コード及び業種名市場区分コード及び市場区分名株価四本値(/equities/bars/daily)前場四本値(/equities/bars/daily/am)投資部門別情報(/equities/investor-types)市場名信用取引週末残高(/markets/margin-interest)業種別空売り比率(/markets/short-ratio)空売り残高報告(/markets/short-sale-report)日々公表信用取引残高(/markets/margin-alert)公表の理由東証信用貸借規制区分売買内訳データ(/markets/breakdown)取引カレンダー(/markets/calendar)休日区分指数四本値(/indices/bars/daily)配信対象指数コードTOPIX指数四本値(/indices/bars/daily/topix)財務情報(/fins/summary)開示書類種別財務諸表(BS/PL/CF)(/fins/details)配当金情報(/fins/dividend)リファレンスナンバー決算発表予定日(/equities/earnings-calendar)日経225オプション四本値(/derivatives/bars/daily/options/225)先物四本値(/derivatives/bars/daily/futures)先物商品区分コードオプション四本値(/derivatives/bars/daily/options)オプション商品区分コード -- Sign in - -# 東証信用貸借規制区分 - -| コード | 説明 | -|------|------| -| 001 | 日本証券金融が実施する貸株注意喚起銘柄および貸株申込制限措置銘柄 | -| 002 | 東京証券取引所が定める日々公表銘柄 | -| 003 | 東京証券取引所が定める規制銘柄 | -| 004 | 東京証券取引所が定める規制銘柄(2次規制) | -| 005 | 東京証券取引所が定める規制銘柄(3次規制) | -| 006 | 東京証券取引所が定める規制銘柄(4次規制) | -| 101 | 東京証券取引所が定める規制解除銘柄 | -| 102 | 東京証券取引所が定める監理銘柄 | - -Was this page helpful? - -© JPX Market Innovation & Research, Inc. All rights reserved. - diff --git a/docs/v2/mkt-margin-alert-publish-reason.md b/docs/v2/mkt-margin-alert-publish-reason.md deleted file mode 100644 index 4d2cc9f..0000000 --- a/docs/v2/mkt-margin-alert-publish-reason.md +++ /dev/null @@ -1,45 +0,0 @@ -# Protocol API Reference - J-Quants - -> プロが活用する株価や財務データを、APIで簡単に取得。あなたの投資分析に、確かな情報を。 - -- Dashboard -- Support - -- GuidesJ-Quants APIについてV1 API から V2 API への変更点プランごとに利用可能なAPIとデータ格納期間提供データの更新タイミングクイックスタートMCPサーバー -- Noticesデータ修正履歴・制約事項レスポンスのページングについてレートリミットについてAPIレスポンスのGzip化レスポンスステータス -- Resources上場銘柄一覧(/equities/master)17業種コード及び業種名33業種コード及び業種名市場区分コード及び市場区分名株価四本値(/equities/bars/daily)前場四本値(/equities/bars/daily/am)投資部門別情報(/equities/investor-types)市場名信用取引週末残高(/markets/margin-interest)業種別空売り比率(/markets/short-ratio)空売り残高報告(/markets/short-sale-report)日々公表信用取引残高(/markets/margin-alert)公表の理由東証信用貸借規制区分売買内訳データ(/markets/breakdown)取引カレンダー(/markets/calendar)休日区分指数四本値(/indices/bars/daily)配信対象指数コードTOPIX指数四本値(/indices/bars/daily/topix)財務情報(/fins/summary)開示書類種別財務諸表(BS/PL/CF)(/fins/details)配当金情報(/fins/dividend)リファレンスナンバー決算発表予定日(/equities/earnings-calendar)日経225オプション四本値(/derivatives/bars/daily/options/225)先物四本値(/derivatives/bars/daily/futures)先物商品区分コードオプション四本値(/derivatives/bars/daily/options)オプション商品区分コード -- Sign in - -# 公表の理由 - -日々公表銘柄の公開理由の各項目の説明です。 -日々公表銘柄に指定されている理由をフラグを用いて示します。 - -例えば、次のケースでは、東京証券取引所が定める信用取引の規制措置銘柄と、日本証券金融における貸株申込制限措置銘柄に選定されていることを意味します。 - -``` -{ - "Restricted": 1, - "DailyPublication": 0, - "Monitoring": 0, - "RestrictedByJSF": 1, - "PrecautionByJSF": 0, - "UnclearOrSecOnAlert": 0 -} -``` - -## 各項目の説明 - -| 変数名 | 意味 | -|------|------| -| Restricted | 1 の場合、東京証券取引所が定める信用取引の規制措置銘柄に選定されていることを意味します。0 の場合、非該当です。 | -| DailyPublication | 1 の場合、東京証券取引所が定める日々公表銘柄に選定されていることを意味します。0 の場合、非該当です。 | -| Monitoring | 1 の場合、東京証券取引所が定める特別注意銘柄に選定されていることを意味します。0 の場合、非該当です。 | -| RestrictedByJSF | 1 の場合、日本証券金融が定める貸株申込制限措置銘柄に選定されていることを意味します。0 の場合、非該当です。 | -| PrecautionByJSF | 1 の場合、日本証券金融が定める貸株注意喚起銘柄に選定されていることを意味します。0 の場合、非該当です。 | -| UnclearOrSecOnAlert | 1 の場合、東京証券取引所が定める不明確情報等により注意喚起の対象となった銘柄、特別注意銘柄等に選定されていることを意味します。0 の場合、非該当です。 | - -Was this page helpful? - -© JPX Market Innovation & Research, Inc. All rights reserved. - diff --git a/docs/v2/mkt-margin-alert.md b/docs/v2/mkt-margin-alert.md deleted file mode 100644 index 5c82661..0000000 --- a/docs/v2/mkt-margin-alert.md +++ /dev/null @@ -1,198 +0,0 @@ -# Protocol API Reference - J-Quants - -> プロが活用する株価や財務データを、APIで簡単に取得。あなたの投資分析に、確かな情報を。 - -- Dashboard -- Support - -- GuidesJ-Quants APIについてV1 API から V2 API への変更点プランごとに利用可能なAPIとデータ格納期間提供データの更新タイミングクイックスタートMCPサーバー -- Noticesデータ修正履歴・制約事項レスポンスのページングについてレートリミットについてAPIレスポンスのGzip化レスポンスステータス -- Resources上場銘柄一覧(/equities/master)17業種コード及び業種名33業種コード及び業種名市場区分コード及び市場区分名株価四本値(/equities/bars/daily)前場四本値(/equities/bars/daily/am)投資部門別情報(/equities/investor-types)市場名信用取引週末残高(/markets/margin-interest)業種別空売り比率(/markets/short-ratio)空売り残高報告(/markets/short-sale-report)日々公表信用取引残高(/markets/margin-alert)公表の理由東証信用貸借規制区分売買内訳データ(/markets/breakdown)取引カレンダー(/markets/calendar)休日区分指数四本値(/indices/bars/daily)配信対象指数コードTOPIX指数四本値(/indices/bars/daily/topix)財務情報(/fins/summary)開示書類種別財務諸表(BS/PL/CF)(/fins/details)配当金情報(/fins/dividend)リファレンスナンバー決算発表予定日(/equities/earnings-calendar)日経225オプション四本値(/derivatives/bars/daily/options/225)先物四本値(/derivatives/bars/daily/futures)先物商品区分コードオプション四本値(/derivatives/bars/daily/options)オプション商品区分コード -- Sign in - -# 日々公表信用取引残高(/markets/margin-alert) - -GET /v2/markets/margin-alert - -## APIの概要 - -日々公表銘柄に指定された個別銘柄の日々の信用取引残高を取得することができます。 -各銘柄についての信用取引残高(株数)を取得できます。 - -配信データは下記のページで公表している内容と同一です。 -https://www.jpx.co.jp/markets/statistics-equities/margin/index.html - -### 本APIの留意点 - -- 当該銘柄のコーポレートアクションが発生した場合であっても、遡及して約定株数の調整は行われません。 -- 東京証券取引所または日本証券金融が、日次の信用取引残高を公表する必要があると認めた銘柄のみが収録されます。 -- 過誤訂正により過去の日々公表信用取引残高データが訂正された場合は、本APIでは以下のとおりデータを提供します。 - -訂正前と訂正後のデータのいずれも提供します。訂正が生じた場合には、申込日を同一とするレコードが追加されます。公表日が新しいデータが訂正後、公表日が古いデータが訂正前のデータと識別することが可能です。 - -## 日々公表信用取引残高を取得します - -GET https://api.jquants.com/v2/markets/margin-alert - -データの取得では、銘柄コード(code)または公表日(date)の指定が必須となります。 - -### パラメータ及びレスポンス - -データの取得では、銘柄コード(code)または公表日(date)の指定が必須となります。 -各パラメータの組み合わせとレスポンスの結果については以下のとおりです。 - -| code | date | from /to | レスポンスの結果 | -|------|------|------|------| -| ✓ | ✗ | ✗ | 指定された銘柄について全期間分のデータ | -| ✓ | ✓ | ✗ | 指定された銘柄について指定された公表日のデータ | -| ✓ | ✗ | ✓ | 指定された銘柄について指定された期間分のデータ | -| ✗ | ✓ | ✗ | 全上場銘柄について指定された公表日のデータ | - -### Requests - -### Headers - -**x-api-key** (string, required) - APIキー - - -### Query Parameters - -code または date のいずれか一つの指定が必須です。 - -**code** (string, optional) - 銘柄コード(e.g. 27800 or 2780)4桁の銘柄コードを指定した場合は、普通株式と優先株式の両方が上場している銘柄においては普通株式のデータのみが取得されます。 - -**from** (string, optional) - from の指定(e.g. 20210901 or 2021-09-01) - -**to** (string, optional) - to の指定(e.g. 20210907 or 2021-09-07) - -**date** (string, optional) - from と to を指定しないときの公表日(e.g. 20210907 or 2021-09-07) - -**pagination_key** (string, optional) - 検索の先頭を指定する文字列過去の検索で返却された pagination_key を設定 - - -### APIコールサンプルコード - -### Request - -``` -curl -G https://api.jquants.com/v2/markets/margin-alert --H "x-api-key: {loading}" --d code="13260" --d date="20240208" -``` - -### Responses - -### データ項目概要 - -**PubDate** (string) - 公表日 - -**Code** (string) - 銘柄コード - -**AppDate** (string) - 申込日(YYYY-MM-DD)信用取引残高の基準となる時点を表します。 - -**PubReason** - 公表の理由 - -**ShrtOut** (number) - 売合計信用残高 - -**ShrtOutChg** - 前日比 売合計信用残高(単位:株)前日に公表されていない銘柄の場合、「-」を出力します。 - -**ShrtOutRatio** - 上場比 売合計信用残高(単位:%) 売合計信用残高 ÷ 上場株数 × 100ETF の場合、「*」を出力します。 - -**LongOut** (number) - 買合計信用残高 - -**LongOutChg** - 前日比 買合計信用残高(単位:株)前日に公表されていない銘柄の場合、「-」を出力します。 - -**LongOutRatio** - 上場比 買合計信用残高(単位:%) 買合計信用残高 ÷ 上場株数 × 100ETF の場合、「*」を出力します。 - -**SLRatio** (number) - 取組比率(単位:%) 売合計信用残高 ÷ 買合計信用残高 × 100 - -**ShrtNegOut** (number) - 一般信用取引売残高売合計信用残高のうち、一般信用によるものです。 - -**ShrtNegOutChg** - 前日比 一般信用取引売残高(単位:株)前日に公表されていない銘柄の場合、「-」を出力します。 - -**ShrtStdOut** (number) - 制度信用取引売残高売合計信用残高のうち、制度信用によるものです。 - -**ShrtStdOutChg** - 前日比 制度信用取引売残高(単位:株)前日に公表されていない銘柄の場合、「-」を出力します。 - -**LongNegOut** (number) - 一般信用取引買残高買合計信用残高のうち、一般信用によるものです。 - -**LongNegOutChg** - 前日比 一般信用取引買残高(単位:株)前日に公表されていない銘柄の場合、「-」を出力します。 - -**LongStdOut** (number) - 制度信用取引買残高買合計信用残高のうち、制度信用によるものです。 - -**LongStdOutChg** - 前日比 制度信用取引買残高(単位:株)前日に公表されていない銘柄の場合、「-」を出力します。 - -**TSEMrgnRegCls** (string) - 東証信用貸借規制区分 - - -### レスポンスサンプル - -``` -{ - "data": [ - { - "PubDate": "2024-02-08", - "Code": "13260", - "AppDate": "2024-02-07", - "PubReason": - { - "Restricted": "0", - "DailyPublication": "0", - "Monitoring": "0", - "RestrictedByJSF": "0", - "PrecautionByJSF": "1", - "UnclearOrSecOnAlert": "0" - }, - "ShrtOut": 11.0, - "ShrtOutChg": 0.0, - "ShrtOutRatio": "*", - "LongOut": 676.0, - "LongOutChg": -20.0, - "LongOutRatio": "*", - "SLRatio": 1.6, - "ShrtNegOut": 0.0, - "ShrtNegOutChg": 0.0, - "ShrtStdOut": 11.0, - "ShrtStdOutChg": 0.0, - "LongNegOut": 192.0, - "LongNegOutChg": -20.0, - "LongStdOut": 484.0, - "LongStdOutChg": 0.0, - "TSEMrgnRegCls": "001" - } - ], - "pagination_key": "value1.value2." -} -``` - -Was this page helpful? - -© JPX Market Innovation & Research, Inc. All rights reserved. - diff --git a/docs/v2/mkt-margin-int.md b/docs/v2/mkt-margin-int.md deleted file mode 100644 index 91835a4..0000000 --- a/docs/v2/mkt-margin-int.md +++ /dev/null @@ -1,143 +0,0 @@ -# Protocol API Reference - J-Quants - -> プロが活用する株価や財務データを、APIで簡単に取得。あなたの投資分析に、確かな情報を。 - -- Dashboard -- Support - -- GuidesJ-Quants APIについてV1 API から V2 API への変更点プランごとに利用可能なAPIとデータ格納期間提供データの更新タイミングクイックスタートMCPサーバー -- Noticesデータ修正履歴・制約事項レスポンスのページングについてレートリミットについてAPIレスポンスのGzip化レスポンスステータス -- Resources上場銘柄一覧(/equities/master)17業種コード及び業種名33業種コード及び業種名市場区分コード及び市場区分名株価四本値(/equities/bars/daily)前場四本値(/equities/bars/daily/am)投資部門別情報(/equities/investor-types)市場名信用取引週末残高(/markets/margin-interest)業種別空売り比率(/markets/short-ratio)空売り残高報告(/markets/short-sale-report)日々公表信用取引残高(/markets/margin-alert)公表の理由東証信用貸借規制区分売買内訳データ(/markets/breakdown)取引カレンダー(/markets/calendar)休日区分指数四本値(/indices/bars/daily)配信対象指数コードTOPIX指数四本値(/indices/bars/daily/topix)財務情報(/fins/summary)開示書類種別財務諸表(BS/PL/CF)(/fins/details)配当金情報(/fins/dividend)リファレンスナンバー決算発表予定日(/equities/earnings-calendar)日経225オプション四本値(/derivatives/bars/daily/options/225)先物四本値(/derivatives/bars/daily/futures)先物商品区分コードオプション四本値(/derivatives/bars/daily/options)オプション商品区分コード -- Sign in - -# 信用取引週末残高(/markets/margin-interest) - -GET /v2/markets/margin-interest - -## APIの概要 - -週末時点での、各銘柄についての信用取引残高(株数)を取得できます。 - -配信データは下記のページで公表している内容と同一です。 -https://www.jpx.co.jp/markets/statistics-equities/margin/index.html - -### 本APIの留意点 - -- 当該銘柄のコーポレートアクションが発生した場合も、遡及して株数の調整は行われません。 -- 年末年始など、営業日が2日以下の週はデータが提供されません。 -- 東証上場銘柄でない銘柄(地方取引所単独上場銘柄)についてはデータの収録対象外となっております。 - -## 信用取引週末残高を取得します - -GET https://api.jquants.com/v2/markets/margin-interest - -データの取得では、銘柄コード(code)または公表日(date)の指定が必須となります。 - -### パラメータ及びレスポンス - -データの取得では、銘柄コード(code)または公表日(date)の指定が必須となります。 -各パラメータの組み合わせとレスポンスの結果については以下のとおりです。 - -| code | date | from /to | レスポンスの結果 | -|------|------|------|------| -| ✓ | ✗ | ✗ | 指定された銘柄について全期間分のデータ | -| ✓ | ✓ | ✗ | 指定された銘柄について指定された公表日のデータ | -| ✓ | ✗ | ✓ | 指定された銘柄について指定された期間分のデータ | -| ✗ | ✓ | ✗ | 全上場銘柄について指定された公表日のデータ | - -### Requests - -### Headers - -**x-api-key** (string, required) - APIキー - - -### Query Parameters - -code または date のいずれか一つの指定が必須です。 - -**code** (string, optional) - 銘柄コード(e.g. 27800 or 2780)4桁の銘柄コードを指定した場合は、普通株式と優先株式等の両方が上場している銘柄においては普通株式のデータのみが取得されます。 - -**from** (string, optional) - from の指定(e.g. 20210901 or 2021-09-01) - -**to** (string, optional) - to の指定(e.g. 20210907 or 2021-09-07) - -**date** (string, optional) - from と to を指定しないときの公表日(e.g. 20210907 or 2021-09-07) - -**pagination_key** (string, optional) - 検索の先頭を指定する文字列過去の検索で返却された pagination_key を設定 - - -### APIコールサンプルコード - -### Request - -``` -curl -G https://api.jquants.com/v2/markets/margin-interest --H "x-api-key: {loading}" --d code="86970" --d date="20230324" -``` - -### Responses - -### データ項目概要 - -**Date** (string) - 申込日付信用取引残高基準となる時点を表します。(通常は金曜日付)(YYYY-MM-DD) - -**Code** (string) - 銘柄コード - -**ShrtVol** (number) - 売合計信用残高 - -**LongVol** (number) - 買合計信用残高 - -**ShrtNegVol** (number) - 一般信用取引売残高売合計信用残高のうち、一般信用によるものです。 - -**LongNegVol** (number) - 一般信用取引買残高買合計信用残高のうち、一般信用によるものです。 - -**ShrtStdVol** (number) - 制度信用取引売残高売合計信用残高のうち、制度信用によるものです。 - -**LongStdVol** (number) - 制度信用取引買残高買合計信用残高のうち、制度信用によるものです。 - -**IssType** (string) - 銘柄区分1: 信用銘柄、2: 貸借銘柄、3: その他 - - -### レスポンスサンプル - -``` -{ - "data": [ - { - "Date": "2023-03-24", - "Code": "86970", - "ShrtVol": 123456.0, - "LongVol": 234567.0, - "ShrtNegVol": 11111.0, - "LongNegVol": 22222.0, - "ShrtStdVol": 33333.0, - "LongStdVol": 44444.0, - "IssType": "1" - } - ], - "pagination_key": "value1.value2." -} -``` - -Was this page helpful? - -© JPX Market Innovation & Research, Inc. All rights reserved. - diff --git a/docs/v2/mkt-short-ratio.md b/docs/v2/mkt-short-ratio.md deleted file mode 100644 index bf0c916..0000000 --- a/docs/v2/mkt-short-ratio.md +++ /dev/null @@ -1,126 +0,0 @@ -# Protocol API Reference - J-Quants - -> プロが活用する株価や財務データを、APIで簡単に取得。あなたの投資分析に、確かな情報を。 - -- Dashboard -- Support - -- GuidesJ-Quants APIについてV1 API から V2 API への変更点プランごとに利用可能なAPIとデータ格納期間提供データの更新タイミングクイックスタートMCPサーバー -- Noticesデータ修正履歴・制約事項レスポンスのページングについてレートリミットについてAPIレスポンスのGzip化レスポンスステータス -- Resources上場銘柄一覧(/equities/master)17業種コード及び業種名33業種コード及び業種名市場区分コード及び市場区分名株価四本値(/equities/bars/daily)前場四本値(/equities/bars/daily/am)投資部門別情報(/equities/investor-types)市場名信用取引週末残高(/markets/margin-interest)業種別空売り比率(/markets/short-ratio)空売り残高報告(/markets/short-sale-report)日々公表信用取引残高(/markets/margin-alert)公表の理由東証信用貸借規制区分売買内訳データ(/markets/breakdown)取引カレンダー(/markets/calendar)休日区分指数四本値(/indices/bars/daily)配信対象指数コードTOPIX指数四本値(/indices/bars/daily/topix)財務情報(/fins/summary)開示書類種別財務諸表(BS/PL/CF)(/fins/details)配当金情報(/fins/dividend)リファレンスナンバー決算発表予定日(/equities/earnings-calendar)日経225オプション四本値(/derivatives/bars/daily/options/225)先物四本値(/derivatives/bars/daily/futures)先物商品区分コードオプション四本値(/derivatives/bars/daily/options)オプション商品区分コード -- Sign in - -# 業種別空売り比率(/markets/short-ratio) - -GET /v2/markets/short-ratio - -## APIの概要 - -日々の業種(セクター)別の空売り比率に関する売買代金を取得できます。 -配信データは下記のページで公表している内容と同様です。 -https://www.jpx.co.jp/markets/statistics-equities/short-selling/index.html -Webページでの公表値は百万円単位に丸められておりますが、APIでは円単位のデータとなります。 - -### 本APIの留意点 - -- 取引高が存在しない(売買されていない)日の日付(date)を指定した場合は、値は空です。 -- 2020/10/1は東京証券取引所の株式売買システムの障害により終日売買停止となった関係で、データが存在しません。 - -## 日々の業種(セクター)別の空売り比率・売買代金を取得します - -GET https://api.jquants.com/v2/markets/short-ratio - -データの取得では、33業種コード(s33)または日付(date)の指定が必須となります。 - -### パラメータ及びレスポンス - -データの取得では、日付(date)または33業種コード(s33)の指定が必須となります。 -各パラメータの組み合わせとレスポンスの結果については以下のとおりです。 - -| s33 | date | from/to | レスポンスの結果 | -|------|------|------|------| -| ✗ | ✓ | ✗ | 全業種コードについて指定された日付のデータ | -| ✓ | ✗ | ✗ | 指定された業種コードについて、全期間分のデータ | -| ✓ | ✗ | ✓ | 指定された業種コードについて指定された期間分のデータ | -| ✓ | ✓ | ✗ | 指定された業種コードについて指定された日付のデータ | - -### Requests - -### Headers - -**x-api-key** (string, required) - APIキー - - -### Query Parameters - -s33 または date のいずれか一つの指定が必須です。 - -**s33** (string, optional) - 33業種コード(e.g. 0050 or 50) - -**from** (string, optional) - fromの指定(e.g. 20210901 or 2021-09-01) - -**to** (string, optional) - toの指定(e.g. 20210907 or 2021-09-07) - -**date** (string, optional) - *fromとtoを指定しないとき(e.g. 20210907 or 2021-09-07) - -**pagination_key** (string, optional) - 検索の先頭を指定する文字列過去の検索で返却された pagination_key を設定 - - -### APIコールサンプルコード - -### Request - -``` -curl -G https://api.jquants.com/v2/markets/short-ratio --H "x-api-key: {loading}" --d s33="0050" --d date="2022-10-25" -``` - -### Responses - -### データ項目概要 - -**Date** (string) - 日付(YYYY-MM-DD) - -**S33** (string) - 33業種コード(33業種コード及び業種名を参照) - -**SellExShortVa** (number) - 実注文の売買代金 - -**ShrtWithResVa** (number) - 価格規制有りの空売り売買代金 - -**ShrtNoResVa** (number) - 価格規制無しの空売り売買代金 - - -### レスポンスサンプル - -``` -{ - "data": [ - { - "Date": "2022-10-25", - "S33": "0050", - "SellExShortVa": 1333126400.0, - "ShrtWithResVa": 787355200.0, - "ShrtNoResVa": 149084300.0 - } - ], - "pagination_key": "value1.value2." -} -``` - -Was this page helpful? - -© JPX Market Innovation & Research, Inc. All rights reserved. - diff --git a/docs/v2/mkt-short-sale.md b/docs/v2/mkt-short-sale.md deleted file mode 100644 index 1ae57ec..0000000 --- a/docs/v2/mkt-short-sale.md +++ /dev/null @@ -1,169 +0,0 @@ -# Protocol API Reference - J-Quants - -> プロが活用する株価や財務データを、APIで簡単に取得。あなたの投資分析に、確かな情報を。 - -- Dashboard -- Support - -- GuidesJ-Quants APIについてV1 API から V2 API への変更点プランごとに利用可能なAPIとデータ格納期間提供データの更新タイミングクイックスタートMCPサーバー -- Noticesデータ修正履歴・制約事項レスポンスのページングについてレートリミットについてAPIレスポンスのGzip化レスポンスステータス -- Resources上場銘柄一覧(/equities/master)17業種コード及び業種名33業種コード及び業種名市場区分コード及び市場区分名株価四本値(/equities/bars/daily)前場四本値(/equities/bars/daily/am)投資部門別情報(/equities/investor-types)市場名信用取引週末残高(/markets/margin-interest)業種別空売り比率(/markets/short-ratio)空売り残高報告(/markets/short-sale-report)日々公表信用取引残高(/markets/margin-alert)公表の理由東証信用貸借規制区分売買内訳データ(/markets/breakdown)取引カレンダー(/markets/calendar)休日区分指数四本値(/indices/bars/daily)配信対象指数コードTOPIX指数四本値(/indices/bars/daily/topix)財務情報(/fins/summary)開示書類種別財務諸表(BS/PL/CF)(/fins/details)配当金情報(/fins/dividend)リファレンスナンバー決算発表予定日(/equities/earnings-calendar)日経225オプション四本値(/derivatives/bars/daily/options/225)先物四本値(/derivatives/bars/daily/futures)先物商品区分コードオプション四本値(/derivatives/bars/daily/options)オプション商品区分コード -- Sign in - -# 空売り残高報告(/markets/short-sale-report) - -GET /v2/markets/short-sale-report - -## APIの概要 - -「有価証券の取引等の規制に関する内閣府令」に基づき、取引参加者より報告を受けたもののうち、残高割合が0.5%以上のものについての情報を取得できます。 - -配信データは下記のページで公表している内容と同一ですが、より長いヒストリカルデータを利用可能です。 -https://www.jpx.co.jp/markets/public/short-selling/index.html - -### 本APIの留意点 - -- 取引参加者から該当する報告が行われなかった日にはデータは提供されません。 -- 「有価証券の取引等の規制に関する内閣府令について」はこちらをご覧ください。https://www.jpx.co.jp/markets/public/short-selling/01.html - -## 空売り残高報告データを取得します - -GET https://api.jquants.com/v2/markets/short-sale-report - -データの取得では、銘柄コード(code)、公表日(disc_date)、計算日(calc_date)のいずれかの指定が必須となります。 - -### パラメータ及びレスポンス - -データの取得では、銘柄コード(code)、公表日(disc_date)、計算日(calc_date)のいずれかの指定が必須となります。 -各パラメータの組み合わせとレスポンスの結果については以下のとおりです。 - -| code | disc_date | disc_date_from/disc_date_to | calc_date | レスポンスの結果 | -|------|------|------|------|------| -| ✓ | ✗ | ✗ | ✗ | 指定された銘柄について全期間分のデータ | -| ✓ | ✓ | ✗ | ✗ | 指定された銘柄について指定日(公表日)のデータ | -| ✓ | ✗ | ✓ | ✗ | 指定された銘柄について指定された期間のデータ | -| ✓ | ✗ | ✗ | ✓ | 指定された銘柄について指定日(計算日)のデータ | -| ✗ | ✓ | ✗ | ✗ | 指定日(公表日)の全ての銘柄のデータ | -| ✗ | ✗ | ✗ | ✓ | 指定日(計算日)の全ての銘柄のデータ | - -### Requests - -### Headers - -**x-api-key** (string, required) - APIキー - - -### Query Parameters - -code / disc_date / calc_date のいずれか一つ以上の指定が必須です。 - -**code** (string, optional) - 4桁もしくは5桁の銘柄コード(e.g. 8697 or 86970) -4桁の銘柄コードを指定した場合は、普通株式と優先株式の両方が上場している銘柄においては普通株式のデータのみが取得されます。 - -**disc_date** (string, optional) - 公表日の指定(e.g. 20240301 or 2024-03-01) - -**disc_date_from** (string, optional) - 公表日のfromの指定(e.g. 20240301 or 2024-03-01) - -**disc_date_to** (string, optional) - 公表日のtoの指定(e.g. 20240301 or 2024-03-01) - -**calc_date** (string, optional) - 計算日の指定(e.g. 20240301 or 2024-03-01) - -**pagination_key** (string, optional) - 検索の先頭を指定する文字列過去の検索で返却された pagination_key を設定 - - -### APIコールサンプルコード - -### Request - -``` -curl -G https://api.jquants.com/v2/markets/short-sale-report --H "x-api-key: {loading}" --d code="86970" --d calc_date="20240801" -``` - -### Responses - -### データ項目概要 - -**DiscDate** (string) - 日付(公表日, YYYY-MM-DD) - -**CalcDate** (string) - 日付(計算日, YYYY-MM-DD) - -**Code** (string) - 銘柄コード5桁コード - -**SSName** (string) - 商号・名称・氏名 -取引参加者から報告されたものをそのまま記載しているため、日本語名称または英語名称が混在しています。 - -**SSAddr** (string) - 住所・所在地 - -**DICName** (string) - 委託者・投資一任契約の相手方の商号・名称・氏名 - -**DICAddr** (string) - 委託者・投資一任契約の相手方の住所・所在地 - -**FundName** (string) - 信託財産・運用財産の名称 - -**ShrtPosToSO** (number) - 空売り残高割合 - -**ShrtPosShares** (number) - 空売り残高数量 - -**ShrtPosUnits** (number) - 空売り残高売買単位数 - -**PrevRptDate** (string) - 直近計算年月日(YYYY-MM-DD) - -**PrevRptRatio** (number) - 直近空売り残高割合 - -**Notes** (string) - 備考 - - -### レスポンスサンプル - -``` -{ - "data": [ - { - "DiscDate": "2024-08-01", - "CalcDate": "2024-07-31", - "Code": "13660", - "SSName": "個人", - "SSAddr": "", - "DICName": "", - "DICAddr": "", - "FundName": "", - "ShrtPosToSO": 0.0053, - "ShrtPosShares": 140000, - "ShrtPosUnits": 140000, - "PrevRptDate": "2024-07-22", - "PrevRptRatio": 0.0043, - "Notes": "" - } - ], - "pagination_key": "value1.value2." -} -``` - -Was this page helpful? - -© JPX Market Innovation & Research, Inc. All rights reserved. - diff --git a/scripts/sync-docs.sh b/scripts/sync-docs.sh new file mode 100755 index 0000000..f889506 --- /dev/null +++ b/scripts/sync-docs.sh @@ -0,0 +1,38 @@ +#!/usr/bin/env bash +# J-Quants 公式ドキュメント(Markdown配信)を docs/v2/ に同期する。 +# llms.txt に載っているページをシードに、ページ内の /ja/spec/ リンクも辿って取得する。 +# docs/v2/ はローカルキャッシュであり、リポジトリにはコミットしない(.gitignore対象)。 +set -euo pipefail + +BASE="https://jpx-jquants.com" +DEST="$(cd "$(dirname "$0")/.." && pwd)/docs/v2" +TMP="$(mktemp -d)" +trap 'rm -rf "$TMP"' EXIT + +queue="$(curl -fsS "$BASE/llms.txt" | grep -oE '(https://jpx-jquants\.com)?/ja/spec/[a-z0-9/_-]+' | sed "s|^$BASE||" | sort -u)" +seen="" + +while [ -n "$queue" ]; do + next="" + for path in $queue; do + case " $seen " in *" $path "*) continue ;; esac + seen="$seen $path" + out="$TMP/${path#/ja/spec/}.md" + mkdir -p "$(dirname "$out")" + if ! curl -fsS "$BASE$path.md" -o "$out"; then + echo "skip (fetch failed): $path" >&2 + rm -f "$out" + continue + fi + echo "fetched: ${path#/ja/spec/}.md" + links="$(grep -oE '\]\((https://jpx-jquants\.com)?/ja/spec/[a-z0-9/_-]+' "$out" || true)" + next="$next $(printf '%s\n' "$links" | sed -e 's|^](||' -e "s|^$BASE||" | sort -u | tr '\n' ' ')" + done + queue="$(printf '%s\n' $next | sort -u)" +done + +rm -rf "$DEST" +mkdir -p "$(dirname "$DEST")" +mv "$TMP" "$DEST" +trap - EXIT +echo "synced: $(find "$DEST" -name '*.md' | wc -l | tr -d ' ') files -> $DEST"