> ## Documentation Index
> Fetch the complete documentation index at: https://docs.benzinga.com/llms.txt
> Use this file to discover all available pages before exploring further.

# 概要

> 各種識別子を使用して企業、ファンド、暗号資産のロゴを検索・取得するための包括的ガイド

<div id="introduction">
  ## はじめに
</div>

Benzinga Logos API は、企業、ファンド、暗号資産の高品質なロゴ画像へのアクセスを提供しています。シンボル、CIK 番号、ISIN コード、CUSIP、FIGI など、複数種類の識別子を使ってロゴを検索できます。

<div id="available-endpoints">
  ## 利用可能なエンドポイント
</div>

<div id="logossearch">
  ### `/logos/search`
</div>

各種識別子でロゴを検索します。ロゴのURL、証券の詳細、およびメタデータを返します。

<div id="logossync">
  ### `/logos/sync`
</div>

ページネーション対応の複数ロゴ一括取得用同期エンドポイント。

<div id="search-filters">
  ## 検索フィルター
</div>

API は、次の 2 つの主なパラメーターによる柔軟な検索をサポートしています。

* `search_keys` - 検索対象とする識別子の値
* `search_keys_type` - 識別子の種類（オプション。省略時は `symbol` が使用されます）

<div id="1-filter-by-symbol">
  ### 1. シンボルでフィルタリング
</div>

株式tickerシンボルを使用してロゴを検索します。

**パラメータ:**

* `search_keys`: シンボル（例: `AAPL`, `TSLA`, `MSFT`）
* `search_keys_type`: `symbol`（任意、省略時はこれがデフォルト）

**例:**

```
GET /api/v2/logos/search?search_keys=AAPL&search_keys_type=symbol&fields=logo_light,logo_dark
```

<div id="2-filter-by-cik">
  ### 2. CIK でフィルターする
</div>

SEC の Central Index Key（CIK）を使用して検索します。ゼロ埋めあり／なしの値の両方をサポートします。

**パラメータ:**

* `search_keys`: CIK 番号（例: `320193` または `0000320193`）
* `search_keys_type`: `cik`

**例:**

```
GET /api/v2/logos/search?search_keys=320193&search_keys_type=cik&fields=logo_light,logo_dark
```

**ゼロ埋めCIKの例:**

```
GET /api/v2/logos/search?search_keys=0000320193&search_keys_type=cik&fields=logo_light,logo_dark
```

<div id="3-filter-by-isin">
  ### 3. ISIN でフィルタリング
</div>

ISIN（国際証券識別番号）を指定して検索します。

**パラメータ:**

* `search_keys`: ISIN コード（例: `US0378331005`）
* `search_keys_type`: `isin`

**例:**

```
GET /api/v2/logos/search?search_keys=US0378331005&search_keys_type=isin&fields=logo_light,logo_dark
```

<div id="4-filter-by-figi-share-class">
  ### 4. FIGIシェアクラスでフィルタリング
</div>

Bloomberg の Financial Instrument Global Identifier（FIGI）を使用してシェアクラスを検索します。

**パラメータ:**

* `search_keys`: FIGIシェアクラスID（例: `BBG001SQKGD7`）
* `search_keys_type`: `figi_share_class`

**例:**

```
GET /api/v2/logos/search?search_keys=BBG001SQKGD7&search_keys_type=figi_share_class&fields=logo_light,logo_dark
```

<div id="5-filter-by-cusip">
  ### 5. CUSIP で絞り込み
</div>

Committee on Uniform Securities Identification Procedures（CUSIP）の番号を使って検索します。

**パラメータ:**

* `search_keys`: CUSIP 番号（例: `88160R101`）
* `search_keys_type`: `cusip`

**例:**

```
GET /api/v2/logos/search?search_keys=88160R101&search_keys_type=cusip&fields=logo_light,logo_dark
```

<div id="6-filter-by-symbol-with-currency-country">
  ### 6. シンボルを通貨・国コードでフィルタリングする
</div>

シンボルに国コードまたは通貨コードを、コロン（`:`）またはピリオド（`.`）を区切り文字として付けて指定します。

**パラメータ:**

* `search_keys`: 修飾子付きシンボル（例: `AAPL:US`, `AAPL:USD`, `AAPL.US`）
* `search_keys_type`: `symbol`

**例:**

```
GET /api/v2/logos/search?search_keys=AAPL:US&search_keys_type=symbol&fields=logo_light,logo_dark
GET /api/v2/logos/search?search_keys=AAPL:USD&search_keys_type=symbol&fields=logo_light,logo_dark
GET /api/v2/logos/search?search_keys=AAPL.US&search_keys_type=symbol&fields=logo_light,logo_dark
```

<div id="7-filter-by-exchange-and-symbol">
  ### 7. 取引所とシンボルでフィルタリング
</div>

取引所コードとシンボルを組み合わせて検索します。Bloomberg 形式（レガシー）と LSEG 形式の両方をサポートします。

**Bloomberg 形式のマッピング（レガシー）：**

* `search_keys`: 取引所とシンボル（例: `NASDAQ:AAPL`）
* `search_keys_type`: `symbol`

**LSEG 3文字コード（現行）：**

* `search_keys`: 取引所コードとシンボル（例: `NSQ:AAPL`）
* `search_keys_type`: `symbol`

**例:**

```
GET /api/v2/logos/search?search_keys=NASDAQ:AAPL&search_keys_type=symbol&fields=logo_light,logo_dark
GET /api/v2/logos/search?search_keys=NSQ:AAPL&search_keys_type=symbol&fields=logo_light,logo_dark
```

<div id="8-filter-by-iso-mic-and-symbol">
  ### 8. ISO MIC とシンボルによるフィルタ
</div>

ISO Market Identifier Code とシンボルを組み合わせて検索します。

**パラメータ:**

* `search_keys`: MIC コードとシンボル（例: `XYNS:AAPL`）
* `search_keys_type`: `symbol`

**例:**

```
GET /api/v2/logos/search?search_keys=XYNS:AAPL&search_keys_type=symbol&fields=logo_light,logo_dark
```

<div id="9-crypto-logo-filters">
  ### 9. 暗号資産ロゴフィルター
</div>

さまざまな形式を使用して暗号資産のロゴを検索します。`search_keys_type` を指定しなくても、API は暗号資産の形式を自動的に認識します。

**サポートされる形式:**

* `CRYPTO:BTC`
* `CRYPTO/BTC`
* `$BTC`
* `BTC/USD`

**例:**

```
GET /api/v2/logos/search?search_keys=CRYPTO:BTC&fields=logo_light,logo_dark
GET /api/v2/logos/search?search_keys=CRYPTO/BTC&fields=logo_light,logo_dark
GET /api/v2/logos/search?search_keys=$BTC&fields=logo_light,logo_dark
GET /api/v2/logos/search?search_keys=BTC/USD&fields=logo_light,logo_dark
```

<div id="available-fields">
  ## 利用可能なフィールド
</div>

`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)

**複数フィールドを指定する例:**

```
GET /api/v2/logos/search?search_keys=TSLA&fields=logo_light,logo_dark,mark_vector_composite_light
```

<div id="additional-parameters">
  ## 追加パラメータ
</div>

<div id="image-customization">
  ### 画像カスタマイズ
</div>

* `scale` - 画像サイズ（例: `100x100`、`300x300`）
* `max_width` - 返される画像の最大幅
* `composite_radius` - 合成画像のボーダーの角丸半径（整数、範囲 `0-50`）
* `composite_auto` - 合成画像を自動生成するかどうかを指定（真偽値）

<div id="pagination-bulk-sync-only">
  ### ページネーション（バルク同期時のみ）
</div>

* `page` - ページ番号（整数）
* `pagesize` - 1ページあたりの結果数（整数）
* `updated_since` - 更新タイムスタンプによるフィルタ（ISO 8601 形式）

<div id="security-details">
  ### 証券の詳細
</div>

* `securities` - レスポンスに詳細な証券情報を含める（ブール値）

<div id="response-examples">
  ## レスポンス例
</div>

<div id="200-success-response">
  ### 200 成功時のレスポンス
</div>

```json theme={null}
{
  "ok": true,
  "data": [
    {
      "id": "efc3943a-ddac-4f59-a2cc-47a67583068b",
      "search_key": "TSLA",
      "securities": [
        {
          "symbol": "TSLA",
          "name": "TESLA INC",
          "cik": "1318605",
          "exchange": "NASDAQ",
          "mic_code": "XNAS",
          "exchange_name": "NASDAQ Global Select Consolidated",
          "cusip": "88160R101",
          "isin": "US88160R1014",
          "country": "US",
          "figi_share_class": "BBG001SQKGD7",
          "figi": "BBG000N9MNX3",
          "security_type": "Common Stock"
        }
      ],
      "files": {
        "logo_dark": "https://image-util.benzinga.com/api/v2/logos/file/image/1318605/logo_dark__53646042d4c8b507c7eddb70110ee334.png?x-bz-cred=...",
        "logo_light": "https://image-util.benzinga.com/api/v2/logos/file/image/1318605/logo_light__6895726d0ff148e46c238f91d033e72a.png?x-bz-cred=..."
      },
      "created_at": "2022-05-18T05:19:45.008547Z",
      "updated_at": "2025-02-05T09:43:14.303261Z"
    }
  ]
}
```

<div id="401-unauthorized-response">
  ### 401 Unauthorized レスポンス
</div>

```json theme={null}
{
  "ok": false,
  "errors": [
    {
      "code": "auth_failed",
      "id": "unauthorized",
      "value": "Invalid or missing authentication token"
    }
  ]
}
```

<div id="404-not-found-response">
  ### 404 Not Found レスポンス
</div>

```json theme={null}
{
  "ok": false,
  "errors": [
    {
      "code": "no_data_found",
      "id": "not_found",
      "value": "指定された検索キーのロゴが見つかりませんでした"
    }
  ]
}
```

<div id="500-internal-server-error-response">
  ### 500 Internal Server Error のレスポンス
</div>

```json theme={null}
{
  "ok": false,
  "errors": [
    {
      "code": "internal_server_error",
      "id": "server_error",
      "value": "リクエストの処理中に予期しないエラーが発生しました"
    }
  ]
}
```

<div id="authentication">
  ## 認証
</div>

Logos API の全エンドポイントでは、API キーによる認証が必要です。トークンをクエリパラメータとして指定してください。

```
?token=YOUR_API_KEY
```

<div id="best-practices">
  ## ベストプラクティス
</div>

1. **search\_keys\_type を指定する** - API のデフォルトは `symbol` ですが、種類を明示的に指定することで可読性とパフォーマンスが向上します
2. **必要なフィールドのみをリクエストする** - 必要なロゴタイプだけをリクエストして、レスポンスサイズを最小化し、パフォーマンスを向上させます
3. **大規模データセットには bulk-sync を使用する** - 複数のロゴを取得する場合は、ページネーション付きの `/logos/bulk-sync` エンドポイントを使用します
4. **レスポンスをキャッシュする** - ロゴの URL には有効期限のタイムスタンプが含まれているため、適切にキャッシュして API コールを削減します
5. **エラーを適切に処理する** - レスポンス内の `ok` フィールドを常に確認し、エラーケースを適切に処理してください

<div id="rate-limits">
  ## レート制限
</div>

レート制限の詳細については、ご契約の API サブスクリプションプランをご確認ください。アプリケーションでより高いレート制限が必要な場合は、サポートまでご連絡ください。

<div id="support">
  ## サポート
</div>

Logos API の利用に関してさらにサポートが必要な場合やご不明点がある場合は、Benzinga API サポートまでお問い合わせいただくか、各エンドポイントの詳細なドキュメントを参照してください。