# 搜尋財務報表

**API:** Data API

**Endpoint:** `POST /v1/beta/financial/financials/search/screener`

**Tags:** Financial Data

尋找符合數值條件的 ticker。請求本文接收 `filters`——每項包含 `field`、`operator` 與 `value`——以及 `limit`。傳回 `results`，包含 `ticker`、`currency`、`sector`、`industry` 以及所符合的篩選欄位。這是此處唯一無需事先知道 ticker 即可使用的工具；其他工具都需要輸入 ticker。可篩選欄位即 `get_financial_financial_metrics` 傳回的指標名稱。可用它建立候選清單，再用報表或指標工具逐一取得詳情。

### 計費參考

- 計量方式：以成功請求為固定成本基礎。
- 參考請求估算：0.02 美元。
- 參考客戶倍率：1.0。不得對已結算的客戶金額再次應用。

僅供參考的中繼資料，並非帳戶報價、保證價格或消費上限。資源額度並非 Felo 額度。最終費用依 Felo 計費記錄為準。

## Base URL

- `https://openapi.felo.ai`

## Authentication

- `FeloBearerAuth` (http bearer, bearer format Felo API Key)
- `FeloApiKey` (apiKey in header `X-API-Key`)

## Request body

Required: **yes**

### application/json

Schema:

```json
{
  "type": "object",
  "required": [
    "filters"
  ],
  "properties": {
    "limit": {
      "type": "integer",
      "minimum": 1,
      "default": 10,
      "description": "要傳回的結果數量上限。"
    },
    "filters": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "field",
          "operator",
          "value"
        ],
        "properties": {
          "field": {
            "type": "string",
            "description": "篩選條件。對於財務指標欄位，請使用 'gt'、'lt'、'gte'、'lte'、'eq' 運算子。對於 'ticker' 與 'cik' 欄位，請使用 'in' 運算子對多個值進行篩選。"
          },
          "operator": {
            "type": "string",
            "enum": [
              "gt",
              "lt",
              "gte",
              "lte",
              "eq",
              "in"
            ],
            "description": "比較運算子。'in' 運算子只能用於欄位值為 'ticker' 或 'cik' 的情況，可對多個值進行篩選。"
          },
          "value": {
            "oneOf": [
              {
                "type": "number",
                "description": "單值運算子（gt、lt、gte、lte、eq）的比較值"
              },
              {
                "type": "array",
                "items": {
                  "type": "string"
                },
                "description": "使用 'in' 運算子時要比較的 ticker 或 cik 值陣列"
              }
            ]
          }
        }
      },
      "minItems": 1,
      "description": "要套用到搜尋的篩選條件物件陣列。"
    }
  }
}
```

## Responses

### 200 — 搜尋成功回應

Headers:
- `X-Request-Id` (string) — 聯絡 Felo 支援時需提供的請求識別碼。

**application/json**

Schema: `ResponseE40Feb4D3D6B_FinancialsSearchResponse` (`#/components/schemas/ResponseE40Feb4D3D6B_FinancialsSearchResponse`)

### 400 — 無法處理該要求。請檢查請求參數。

### 401 — 需要有效的 Felo API 金鑰。

### 402 — 由於未符合計費要求，要求無法繼續。

### 403 — 該帳戶無權執行此操作。

### 429 — 已達到要求或支出上限。

### 502 — 服務無法完成該要求。

### 503 — API 或計費服務暫時無法使用。

### 504 — 服務在處理要求時逾時。

### default — 錯誤回應；上游透傳回應可能採用供應商格式

**application/json**

Schema:

```json
{}
```

## Schema definitions

### ResponseE40Feb4D3D6B_FinancialsSearchResponse

`#/components/schemas/ResponseE40Feb4D3D6B_FinancialsSearchResponse`

```json
{
  "type": "object",
  "properties": {
    "search_results": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "ticker": {
            "type": "string",
            "description": "公司的 ticker 代碼。"
          },
          "report_period": {
            "type": "string",
            "format": "date",
            "description": "財務資料的報告期間。"
          },
          "period": {
            "type": "string",
            "enum": [
              "annual",
              "quarterly",
              "ttm"
            ],
            "description": "財務資料的時間期間。"
          },
          "currency": {
            "type": "string",
            "description": "財務資料的貨幣。"
          }
        },
        "additionalProperties": {
          "type": "string",
          "description": "依搜尋條件的其他財務指標。"
        }
      }
    }
  }
}
```