このリポジトリは、Saxo Bank OpenAPIの情報を整理し、個人トレーダーが自動トレードシステムを構築するためにAIが辞書として利用できる形式で保存したものです。
🔍 INDEX.md - リファレンス+学習用の統合インデックス
両方のドキュメントタイプへのエントリーポイント。OpenAPIの全体像を把握し、必要な情報に素早くアクセスできます。
- REFERENCE-INDEX.md - API仕様の完全なリファレンス(163エンドポイント、機能別逆引き)
- LEARNING-INDEX.md - 概念理解とスキル習得のための学習ガイド
個人トレーダーによる自動トレードシステムの構築を支援するため、Saxo Bank OpenAPIについて、AIアシスタントが参照しやすい形式で包括的なドキュメントを提供します。
Saxo Bank OpenAPIの公式ドキュメントは、ブラウザで閲覧しやすい形式になっていますが、複数のクリックを通じて階層を深く辿る必要があります。このプロジェクトでは、個人トレードに必要な情報をMarkdown形式で構造化し、AIアシスタントやプログラムからアクセスしやすくしています。
-
リファレンスドキュメント - API仕様の完全な記述(実装時に参照)
- データソース: https://www.developer.saxo/openapi/referencedocs
- ✅ Phase 2完了(個人トレード向け8サービス、163エンドポイント)
-
学習用ドキュメント - 概念理解とスキル習得(初学者向け)
- データソース: https://www.developer.saxo/openapi/learn
- 🚧 基本構造作成済み、コンテンツ整備中
個人トレードシステム向け8サービスの詳細リファレンス(Phase 2)が完成しました!
- 総計: 41カテゴリ、154エンドポイントの完全なドキュメント
- 内容: パラメータ、型定義、レスポンス、エラー、コード例を含む包括的なリファレンス
- 個人トレードに必須: Trading、Portfolio、Reference Data、Chart等、全ての核心機能をカバー
.
├── docs/
│ ├── reference/ # リファレンスドキュメント(API仕様)
│ │ ├── trading/ # 価格、クォート、注文、取引
│ │ ├── portfolio/ # ポートフォリオ情報
│ │ ├── reference-data/ # 商品・取引所の参照情報
│ │ ├── chart/ # チャートデータのストリーミング
│ │ ├── account-history/ # アカウント履歴とパフォーマンスデータ
│ │ ├── root-services/ # サブスクリプション・セッション管理
│ │ ├── market-overview/ # マーケットムーバー情報
│ │ ├── ens/ # イベント通知サービス
│ │ └── ... (その他9サービス)
│ │
│ └── learn/ # 学習用ドキュメント(概念・ガイド)
│ ├── getting-started/ # 入門ガイド
│ ├── basics/ # 基礎知識(OAuth、ストリーミング等)
│ ├── core-concepts/ # コアビジネス概念
│ └── service-guides/ # サービス別実践ガイド
│
├── archive/ # アーカイブ(完了したドキュメント)
│ └── MIGRATION.md # プロジェクト再構築の詳細計画(完了)
├── INDEX.md # 統合インデックス(両方へのエントリーポイント)
├── REFERENCE-INDEX.md # リファレンス専用インデックス
├── LEARNING-INDEX.md # 学習用専用インデックス
├── README.md # 本ファイル
├── ROADMAP.md # 整備計画
├── TASKS.md # リファレンスドキュメントのタスク管理
├── LEARNING-TASKS.md # 学習用ドキュメントのタスク管理
└── CONTRIBUTING.md # 貢献ガイド
| サービス | 説明 | エンドポイント | ドキュメント |
|---|---|---|---|
| Trading | 価格・クォート、注文、取引の実行 | 67 | 📖 |
| Portfolio | ポートフォリオ、アカウント残高、ポジション | 35 | 📖 |
| Reference Data | 商品詳細、取引所情報 | 25 | 📖 |
| Market Overview | マーケットムーバー情報 | 1 | 📖 |
| Account History | 履歴データ、パフォーマンス分析 | 9 | 📖 |
| Root Services | セッション・サブスクリプション管理 | 11 | 📖 |
| Chart | チャートデータのストリーミング | 4 | 📖 |
| Ens | イベント通知サービス | 2 | 📖 |
合計: 154エンドポイント、41機能カテゴリ
以下のサービスは主にB2B/機関投資家向けです。基本情報は保持していますが、詳細ドキュメントは作成していません:
- Client Management, Client Services, Client Reporting
- Asset Transfers, Corporate Actions, Disclaimer Management
- Partner Integration, Regulatory Services, Value Add
詳細は docs/reference/index.md を参照してください。
| セクション | 説明 | ファイル数 | 状況 |
|---|---|---|---|
| Getting Started | OpenAPI入門、FAQ、ツール紹介 | 4 | ✅ |
| The Basics | 基礎知識(OAuth、ストリーミング、データフォーマット等) | 13 | ✅ |
| Core Concepts | ビジネス概念(階層構造、価格フォーマット、ポジション管理等) | 3 | ✅ |
| Service Guides | サービス別実践ガイド(Trading, Portfolio等) | 8 | ✅ |
完了内容:
- 28ファイルの公式学習コンテンツを取得・整形
- 52箇所のドキュメント間リンクを追加し、ナビゲーションを最適化
- OAuth認証、ストリーミング、データフォーマット等の実践的な学習ガイドが利用可能
詳細は docs/learn/index.md、LEARNING-INDEX.md、および LEARNING-TASKS.md を参照してください。
- INDEX.md で全体像を把握
- 学習用ドキュメント で基礎を学ぶ(28トピック、完全整備済み)
- リファレンスドキュメント で実装を開始(154エンドポイント完備)
- REFERENCE-INDEX.md で全エンドポイントを確認
- 機能別インデックスで目的の機能を逆引き
- 各サービスのドキュメントで詳細を確認
- Service Guides で実践的なガイドを確認
- リファレンスドキュメントで詳細仕様を確認
- メインページ: https://www.developer.saxo/openapi/referencedocs
- 各サービスグループの詳細ページ
- メインページ: https://www.developer.saxo/openapi/learn
- 各トピックの詳細ページ
- README.md - 本ファイル(プロジェクト全体の概要)
- INDEX.md - 統合インデックス(両ドキュメントタイプへのエントリーポイント)
- REFERENCE-INDEX.md - リファレンス専用インデックス
- LEARNING-INDEX.md - 学習用専用インデックス
- ROADMAP.md - 段階的な整備計画とマイルストーン
- CONTRIBUTING.md - 貢献方法とスタイルガイド
- TASKS.md - リファレンスドキュメントのタスク管理
- LEARNING-TASKS.md - 学習用ドキュメントのタスク管理
- RESPONSIBILITIES.md - ファイル責務定義(SSOT原則)
- CLAUDE.md - AIアシスタント総合ガイド(コードベース構造、規約、ワークフロー、自動読み込み)
- archive/MIGRATION.md - プロジェクト再構築の詳細計画(完了・アーカイブ済み)
- 17サービスの基本情報収集
- プロジェクト構造の確立
- 8核心サービスの完全なリファレンス(154エンドポイント)
- パラメータ、型定義、レスポンス、エラー、コード例を含む包括的なドキュメント
- Phase 3: 基本構造作成完了(30ファイル)✅
- Phase 6-A: 生データ取得・整形完了(28トピック)✅
- Phase 6-A-2: ドキュメント間リンク最適化完了(52箇所)✅
- 成果: 実用的な学習コンテンツが利用可能
- Getting Started(4トピック)- 入門ガイド、FAQ完備
- The Basics(13トピック)- OAuth、ストリーミング、データフォーマット等
- Core Concepts(3トピック)- 階層構造、価格フォーマット、ポジション管理
- Service Guides(8トピック)- 各サービスの実践ガイド
詳細は ROADMAP.md および LEARNING-TASKS.md を参照してください。
ドキュメント作成を標準化するため、以下のテンプレートを用意しています:
- .templates/endpoint-template.md - エンドポイントドキュメント用(リファレンス)
- .templates/schema-template.md - スキーマ定義用(リファレンス)
- .templates/guide-template.md - ガイド・チュートリアル用(リファレンス)
- .templates/learning-template.md - 学習用コンテンツ用(学習用)🚧 作成予定
このプロジェクトへの貢献を歓迎します!特に学習用ドキュメントのコンテンツ整備に協力いただける方を募集しています。
- ROADMAP.md で今後のフェーズと優先順位を確認
- CONTRIBUTING.md で貢献方法を確認
- リファレンスドキュメント作成ガイドライン
- 学習用ドキュメント作成ガイドライン 🆕
- タスクリストから作業するタスクを選択
- TASKS.md - リファレンスドキュメント
- LEARNING-TASKS.md - 学習用ドキュメント
- プルリクエストを送信
詳細は CONTRIBUTING.md をご覧ください。
このドキュメントはSaxo Bank OpenAPIの公式ドキュメントに基づいており、情報提供目的で整理されています。
- Saxo Bank Developer Portal - 公式開発者ポータル
- OpenAPI Reference Documentation - 公式リファレンス
- OpenAPI Learn - 公式学習ドキュメント
- OpenAPI Support Centre - サポートセンター
- リファレンスドキュメント: 154エンドポイント、41カテゴリ、200以上の型定義 ✅
- 学習用ドキュメント: 4セクション、28トピック、52個の相互リンク ✅
- ドキュメント総行数: 約30,000行以上
- プロジェクト開始: 2025-11-17
- 最新更新: 2025-11-19(Phase 6-A & 6-A-2完了)