Robinhood Mcp Server

Robinhood MCP サーバー - ユーザーガイド

概要

Robinhood MCP サーバーは、Robinhood Crypto API への包括的なインターフェースを提供します。このサーバーは、REST API と WebSocket インターフェースの両方を通じて、認証、アカウント管理、市場データの取得、取引操作を処理します。

目次

• 機能
• 前提条件
• インストール
• 設定
• サーバーの起動
• API ドキュメント
• テスト
• 開発
• セキュリティ
• トラブルシューティング
• ライセンス
• 免責事項

機能

• アカウント管理と取引操作のための REST API
• リアルタイムの市場データと注文更新のための WebSocket サポート
• 包括的なエラーハンドリングとログ記録
• レート制限とセキュリティのベストプラクティス
• 環境変数による簡単な設定

前提条件

• Python 3.8 以上
• pip（Python パッケージマネージャー）
• Robinhood API の認証情報

インストール

1. リポジトリをクローンします:

   git clone https://github.com/rohitsingh-iitd/robinhood-mcp-server
   cd robinhood-mcp-server
   

2. 仮想環境をセットアップします（推奨）:

   # Create a virtual environment
   python -m venv venv
   
   # Activate the virtual environment
   # On macOS/Linux:
   source venv/bin/activate
   # On Windows:
   # .\venv\Scripts\activate
   

3. 依存関係をインストールします:

   pip install -r requirements.txt
   

設定

1. プロジェクトのルートに .env ファイルを作成します。内容は以下のとおりです:

   # Required
   ROBINHOOD_API_KEY=your_api_key_here
   ROBINHOOD_PRIVATE_KEY=your_base64_encoded_private_key_here
   
   # Optional (with defaults)
   HOST=0.0.0.0
   PORT=8000
   WEBSOCKET_PORT=8001
   DEBUG=False
   LOG_LEVEL=INFO
   LOG_FILE=robinhood_mcp_server.log
   RATE_LIMIT_ENABLED=True
   RATE_LIMIT_REQUESTS=100
   RATE_LIMIT_PERIOD=60
   

2. プレースホルダーの値を、実際の Robinhood API 認証情報に置き換えます。

サーバーの起動

次のコマンドでサーバーを起動します:

python -m src.main

これにより以下が起動します:

• http://localhost:8000 で REST API サーバー
• ws://localhost:8001 で WebSocket サーバー

本番環境での実行

本番環境で使用する場合は、Gunicorn と組み合わせた Uvicorn のような本番グレードの ASGI サーバーの使用を検討してください:

pip install gunicorn uvicorn[standard]
gunicorn src.main:app --worker-class uvicorn.workers.UvicornWorker --bind 0.0.0.0:8000

サーバーの起動

次のコマンドでサーバーを起動します:

python -m src.main

これにより、REST API サーバー（デフォルトポート 8000）と WebSocket サーバー（デフォルトポート 8001）の両方が起動します。

REST API エンドポイント

認証

• GET /auth/status - 認証ステータスを確認します

アカウント

• GET /account - アカウント情報を取得します
• GET /account/holdings - アカウントの保有資産を取得します（オプションのクエリパラメータ: asset_code）

市場データ

• GET /market/best-price - 最良の買値/売値を取得します（オプションのクエリパラメータ: symbol）
• GET /market/estimated-price - 数量に対する推定価格を取得します（必須のクエリパラメータ: symbol、side、quantity）

取引

• GET /trading/pairs - 利用可能な取引ペアを取得します（オプションのクエリパラメータ: symbol）
• GET /trading/orders - 注文履歴を取得します（オプションのクエリパラメータ: status）
• GET /trading/orders/{id} - 注文の詳細を取得します
• POST /trading/orders - 新規注文を出します
  • 必須フィールド: symbol、side、quantity
  • オプションのフィールド: type、price、time_in_force、stop_price
• DELETE /trading/orders/{id} - 注文をキャンセルします

WebSocket API

WebSocket サーバーは、市場データと注文ステータスのリアルタイム更新を提供します。

接続

次の WebSocket サーバーに接続します:

ws://localhost:8001

市場データの購読

市場データの更新を購読します:

{
  "type": "market_data",
  "action": "subscribe",
  "symbols": ["BTC-USD", "ETH-USD"]
}

市場データの更新の購読を解除します:

{
  "type": "market_data",
  "action": "unsubscribe",
  "symbols": ["BTC-USD", "ETH-USD"]
}

注文更新の購読

注文更新を購読します:

{
  "type": "orders",
  "action": "subscribe"
}

注文更新の購読を解除します:

{
  "type": "orders",
  "action": "unsubscribe"
}

Ping/Pong

接続を維持するために ping を送信します:

{
  "type": "ping"
}

サーバーは次のように応答します:

{
  "type": "pong"
}

テスト

サーバーが正しく動作していることを確認するために、検証テストを実行します:

python -m tests.test_server

設定オプション

以下の環境変数は .env ファイルで設定できます:

• ROBINHOOD_API_KEY - Robinhood API キー
• ROBINHOOD_PRIVATE_KEY - base64 でエンコードされた秘密鍵
• HOST - サーバーホスト (デフォルト: 0.0.0.0)
• PORT - REST API サーバーポート (デフォルト: 8000)
• DEBUG - デバッグモードを有効化 (デフォルト: False)
• LOG_LEVEL - ログレベル (デフォルト: INFO)
• LOG_FILE - ログファイルのパス (デフォルト: robinhood_mcp_server.log)
• RATE_LIMIT_ENABLED - レート制限を有効化 (デフォルト: True)
• RATE_LIMIT_REQUESTS - 期間あたりの最大リクエスト数 (デフォルト: 100)
• RATE_LIMIT_PERIOD - レート制限の期間 (秒) (デフォルト: 60)

セキュリティに関する考慮事項

• API キーとシークレットは環境変数に保存され、コードには決して含まれません
• すべての機密データは適切に処理されます
• すべての API エンドポイントに対して入力検証が実装されています
• 悪用を防ぐためにレート制限が適用されます
• 機密情報の漏洩を避けるための適切なエラーハンドリング

トラブルシューティング

問題が発生した場合:

1. 詳細なエラーメッセージについてはログファイルを確認してください
2. API 認証情報が正しいことを確認してください
3. 適切なネットワーク接続があることを確認してください
4. Robinhood API が利用可能であることを確認してください

ライセンス

このプロジェクトは MIT ライセンスの下でライセンスされています - 詳細は LICENSE ファイルを参照してください。

免責事項

作者は、このプロジェクトの使用の結果として生じる可能性のあるいかなる損失や損害についても責任を負いません。