# FRED Search Series API

> Search Series from FRED. Returns the official FRED API response unchanged.

Source: https://www.sandbase.ai/model/fred/series-search
API reference: https://www.sandbase.ai/model/fred/series-search/docs

## Facts

- Provider: FRED
- Type: Data API
- Endpoint: `POST https://api.sandbase.ai/v1/api/fred/series-search`
- Price: $0 per call
- Free allowance: 100 calls per organization per UTC day, shared across eligible APIs
- Capabilities: api, fred, economic data
- Billing: pay per use from one SandBase balance; no provider account or subscription needed

## Call it

`POST https://api.sandbase.ai/v1/api/fred/series-search` with `Authorization: Bearer $SANDBASE_API_KEY` and the parameters as a JSON body.

| Parameter | Type | Required | Allowed values |
| --- | --- | --- | --- |
| `search_text` | string | yes |  |
| `exclude_tag_names` | string | no |  |
| `file_type` | string | no | json |
| `filter_value` | string | no |  |
| `filter_variable` | string | no | frequency, units, seasonal_adjustment |
| `limit` | integer | no |  |
| `offset` | integer | no |  |
| `order_by` | string | no | search_rank, series_id, title, units, frequency, seasonal_adjustment, realtime_start, realtime_end, last_updated, observation_start, observation_end, popularity, group_popularity |
| `realtime_end` | string | no |  |
| `realtime_start` | string | no |  |
| `search_type` | string | no | full_text, series_id |
| `sort_order` | string | no | asc, desc |
| `tag_names` | string | no |  |

## FAQ

### How do I use the FRED Search Series API?

Send a POST request to https://api.sandbase.ai/v1/api/fred/series-search with your SandBase API key in the Authorization header (Bearer) and the parameters as a JSON body. You can also try it in the Playground on this page without writing code.

### How much does the FRED Search Series API cost?

$0 per call. Every organization gets 100 free calls per UTC day, shared across eligible SandBase APIs including this one; after that each call is billed at this price from your SandBase balance. There is no subscription.

### What parameters does the FRED Search Series API accept?

Required: search_text (string). Optional: exclude_tag_names (string), file_type (one of json), filter_value (string), filter_variable (one of frequency, units, seasonal_adjustment), limit (integer) and offset (integer) and 6 more. The Parameters table and the Playground on this page list every field.

### What does the FRED Search Series API return?

A JSON response returned in the same HTTP request (synchronous).

### Do I need a FRED developer account or API key?

No. FRED Search Series runs through SandBase, so one SandBase API key covers this endpoint and every other API and model in the catalog. You do not need to apply for FRED API access separately.

## README

### FRED Search Series API

Search Series from FRED. Returns the official FRED API response unchanged.

The response is the official FRED API response, unchanged.

#### Request

```bash
curl -X POST "https://api.sandbase.ai/v1/run" \
  -H "Authorization: Bearer $SANDBASE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"model": "fred/series-search", "search_text": "<search_text>"}'
```

#### Parameters

| Name | Type | Required | Description |
|---|---|---|---|
| `exclude_tag_names` | string | No | A semicolon delimited list of tag names that series match none of. String, optional, no filtering by tags by default. Example value: 'discontinued;m1'. Filter r |
| `file_type` | string | No | Response format. Only json is supported. |
| `filter_value` | string | No | The value of the filter_variable attribute to filter results by. String, optional, no filter by default |
| `filter_variable` | string | No | The attribute to filter results by. One of the following strings: 'frequency', 'units', 'seasonal_adjustment'. optional, no filter by default |
| `limit` | integer | No | The maximum number of results to return. integer between 1 and 1000, optional, default: 1000 |
| `offset` | integer | No | non-negative integer, optional, default: 0 |
| `order_by` | string | No | Order results by values of the specified attribute. One of the following strings: 'search_rank', 'series_id', 'title', 'units', 'frequency', 'seasonal_adjustmen |
| `realtime_end` | string | No | The end of the real-time period. For more information, see Real-Time Periods . YYYY-MM-DD formatted string, optional, default: today's date |
| `realtime_start` | string | No | The start of the real-time period. For more information, see Real-Time Periods . YYYY-MM-DD formatted string, optional, default: today's date |
| `search_text` | string | Yes | The words to match against economic data series. |
| `search_type` | string | No | Determines the type of search to perform. One of the following strings: 'full_text', 'series_id'. 'full_text' searches series attributes title, units, frequency |
| `sort_order` | string | No | Sort results is ascending or descending order for attribute values specified by order_by. One of the following strings: 'asc', 'desc'. optional, default: If ord |
| `tag_names` | string | No | A semicolon delimited list of tag names that series match all of. String, optional, no filtering by tags by default Example value: 'usa;m2'. Filter results to s |

#### Pricing

Flat price per call. Failed calls are not charged.