finra-py

finra-pyは、FINRA API Platformを包み込む非公式・オープンソースのPythonクライアントライブラリです。意図的に薄いレイヤーとして設計されており、リクエストがFINRA APIにマッピングされ、生のhttpx.Responseオブジェクトが呼び出し元に返されます。独自のレスポンスやデータモデルは課されません。 dedicated FINRAクライアントの利便性を提供しつつ、直接HTTPリクエストを行う制御力を手放さないことが目的です。 認証は本ライブラリがユーザーに代わって処理する主な箇所です。FINRA APIはOAuth 2.0を採用しており、finra-pyはトークンの取得とライフサイクルを管理します。資格情報を自システムで保持するアプリケーション向けに、カスタマイズ可能なトークンストレージもサポートしています。 READMEに記載されている対応API領域は以下の3つです： - Query APIデータセット：Equity、Fixed Income、FINRA、Firm、Registration、TRACE Report Cardを含む。 - Notification APIデータセット：FINRA通知イベント用。 - Submission APIワークフロー：Form U4、Form U5、Form BR、Create Individual、Non-Registered Fingerprintなど、作成・検証・送信・更新・取得を含む規制届出及其他他対応フロー。 追加機能として、すべての資格情報タイプ対応、Mockデータセット、QAテスト環境API、サーバー側の非同期リクエスト、およびクライアント側のasyncio対応が文書されています。 インストールにはPython 3.11以上が必要で、`python -m pip install finra-py`により実行できます。パッケージは`import finra`としてインポートされます。完全なドキュメントは別途ホストされ、Getting Startedガイド、ADRノート、チェンジログがREADMEからリンクされています。 制限事項は明確に記載されています。ライブラリは文書済みデータセットの全面対応を目指していますが、一部のFINRAデータセットやサービスはAPIを通じて公開されていない場合があり、fileX APIはこの時点では明示的にサポートされていません。 開発はGitHub Issues経由で行われ、バグ報告や機能要望は歓迎されますが、現在プルリクエストは受け付けていません。著者はまた、FINRA API統合、Web EFT移行、コンプライアンス関連ワークフロー、マーケットデータシステムに関するコンサルティングサービスを提供しています。プロジェクトはCIとカバレッジバッジを備え、Windows、macOS、Linux acrossテストカバ覆済です。 READMEには、本ライブラリが非公式でありFINRAにより承認・提携・スポンサーされていないこと、金融助言や取引戦略を提供しないこと、およびユーザーは基盤となるAPIの利用規約遵守の責任を負うことの免責事項が記載されています。ライセンスファイルの下で保証なしに配布されています。 ディレクトリ分類としては、バックエンド/APIクライアントライブラリとしてdeveloper-toolsが最適で、規制・市場データセットを他のシステムに取り込む実用的な用途からdata-integrationが二次的なフィットとなります。