はじめに
利用可能なエンドポイント
/logos/search
/logos/sync
検索フィルター
search_keys- 検索対象とする識別子の値search_keys_type- 識別子の種類(オプション。省略時はsymbolが使用されます)
1. シンボルでフィルタリング
search_keys: シンボル(例:AAPL,TSLA,MSFT)search_keys_type:symbol(任意、省略時はこれがデフォルト)
2. CIK でフィルターする
search_keys: CIK 番号(例:320193または0000320193)search_keys_type:cik
3. ISIN でフィルタリング
search_keys: ISIN コード(例:US0378331005)search_keys_type:isin
search_keys: FIGIシェアクラスID(例:BBG001SQKGD7)search_keys_type:figi_share_class
5. CUSIP で絞り込み
search_keys: CUSIP 番号(例:88160R101)search_keys_type:cusip
6. シンボルを通貨・国コードでフィルタリングする
:)またはピリオド(.)を区切り文字として付けて指定します。
パラメータ:
search_keys: 修飾子付きシンボル(例:AAPL:US,AAPL:USD,AAPL.US)search_keys_type:symbol
7. 取引所とシンボルでフィルタリング
search_keys: 取引所とシンボル(例:NASDAQ:AAPL)search_keys_type:symbol
search_keys: 取引所コードとシンボル(例:NSQ:AAPL)search_keys_type:symbol
8. ISO MIC とシンボルによるフィルタ
search_keys: MIC コードとシンボル(例:XYNS:AAPL)search_keys_type:symbol
9. 暗号資産ロゴフィルター
search_keys_type を指定しなくても、API は暗号資産の形式を自動的に認識します。
サポートされる形式:
CRYPTO:BTCCRYPTO/BTC$BTCBTC/USD
利用可能なフィールド
fields パラメータを使用して、取得するロゴの種類を指定できます。利用可能なフィールドは次のとおりです。
logo_light- ライトテーマのロゴ (PNG)logo_dark- ダークテーマのロゴ (PNG)logo_vector_light- ライトテーマのベクター形式ロゴ (SVG)logo_vector_dark- ダークテーマのベクター形式ロゴ (SVG)mark_light- ライトテーマのマーク/アイコン (PNG)mark_dark- ダークテーマのマーク/アイコン (PNG)mark_vector_light- ライトテーマのベクター形式マーク (SVG)mark_vector_dark- ダークテーマのベクター形式マーク (SVG)mark_composite_light- ライトテーマの複合マーク (PNG)mark_composite_dark- ダークテーマの複合マーク (PNG)mark_vector_composite_light- ライトテーマのベクター形式複合マーク (SVG)mark_vector_composite_dark- ダークテーマのベクター形式複合マーク (SVG)
追加パラメータ
画像カスタマイズ
scale- 画像サイズ(例:100x100、300x300)max_width- 返される画像の最大幅composite_radius- 合成画像のボーダーの角丸半径(整数、範囲0-50)composite_auto- 合成画像を自動生成するかどうかを指定(真偽値)
ページネーション(バルク同期時のみ)
page- ページ番号(整数)pagesize- 1ページあたりの結果数(整数)updated_since- 更新タイムスタンプによるフィルタ(ISO 8601 形式)
証券の詳細
securities- レスポンスに詳細な証券情報を含める(ブール値)
レスポンス例
200 成功時のレスポンス
404 Not Found レスポンス
500 Internal Server Error のレスポンス
認証
ベストプラクティス
- search_keys_type を指定する - API のデフォルトは
symbolですが、種類を明示的に指定することで可読性とパフォーマンスが向上します - 必要なフィールドのみをリクエストする - 必要なロゴタイプだけをリクエストして、レスポンスサイズを最小化し、パフォーマンスを向上させます
- 大規模データセットには bulk-sync を使用する - 複数のロゴを取得する場合は、ページネーション付きの
/logos/bulk-syncエンドポイントを使用します - レスポンスをキャッシュする - ロゴの URL には有効期限のタイムスタンプが含まれているため、適切にキャッシュして API コールを削減します
- エラーを適切に処理する - レスポンス内の
okフィールドを常に確認し、エラーケースを適切に処理してください