# Search financial statements

**API:** Data API

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

**Tags:** Financial Data

Find tickers that match numeric conditions. Body takes `filters` — each a `field`, an `operator` and a `value` — plus `limit`. Returns `results` with `ticker`, `currency`, `sector`, `industry` and whichever filtered field was matched. This is the only tool here that works without knowing a ticker in advance; everything else takes one as input. Filterable fields are the metric names `get_financial_financial_metrics` returns. Use it to build a candidate list, then pull detail on each name with the statement or metric tools.

### Pricing reference

- Metering: Fixed successful-request cost basis.
- Reference request estimate: USD 0.02.
- Reference customer multiplier: 1.0. Do not apply it again to a settled customer amount.

Reference metadata only, not an account quote, a guaranteed price or a spending cap. Resource credits are not Felo credits. Final charges follow Felo billing records.

## 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": "The maximum number of results to return."
    },
    "filters": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "field",
          "operator",
          "value"
        ],
        "properties": {
          "field": {
            "type": "string",
            "description": "The criteria to filter on.  For financial metric fields, use 'gt', 'lt', 'gte', 'lte', 'eq' operators.  For 'ticker' and 'cik' fields, use the 'in' operator to filter against multiple values."
          },
          "operator": {
            "type": "string",
            "enum": [
              "gt",
              "lt",
              "gte",
              "lte",
              "eq",
              "in"
            ],
            "description": "The comparison operator. The 'in' operator can only be used with a field value of 'ticker' or 'cik' and lets you filter against multiple values."
          },
          "value": {
            "oneOf": [
              {
                "type": "number",
                "description": "The value to compare against for single-value operators (gt, lt, gte, lte, eq)"
              },
              {
                "type": "array",
                "items": {
                  "type": "string"
                },
                "description": "Array of ticker or cik values to compare against when using the 'in' operator"
              }
            ]
          }
        }
      },
      "minItems": 1,
      "description": "An array of filter objects to apply to the search."
    }
  }
}
```

## Responses

### 200 — Successful search response

Headers:
- `X-Request-Id` (string) — Request identifier to include when contacting Felo support.

**application/json**

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

### 400 — The request could not be processed. Check the request parameters.

### 401 — A valid Felo API key is required.

### 402 — The request cannot proceed because a billing requirement is not met.

### 403 — The account is not permitted to perform this operation.

### 429 — A request or spending limit has been reached.

### 502 — The service could not complete the request.

### 503 — The API or billing service is temporarily unavailable.

### 504 — The service timed out while processing the request.

### default — Error response; upstream passthrough responses may use provider formats

**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": "The ticker symbol of the company."
          },
          "report_period": {
            "type": "string",
            "format": "date",
            "description": "The reporting period of the financial data."
          },
          "period": {
            "type": "string",
            "enum": [
              "annual",
              "quarterly",
              "ttm"
            ],
            "description": "The time period of the financial data."
          },
          "currency": {
            "type": "string",
            "description": "The currency of the financial data."
          }
        },
        "additionalProperties": {
          "type": "string",
          "description": "Additional financial metrics based on the search criteria."
        }
      }
    }
  }
}
```
