API reference · FRED

fred/series-search

Integrate this model through SandBase's unified API, with production-ready schemas and examples.

APISynchronousOpen model

Production endpoint

Send your first request

OpenAI-compatible endpoint with unified authentication and usage tracking.

POSThttps://api.sandbase.ai/v1/api/fred/series-search

Model IDfred/series-search

Input Schema

13 parameters · 1 required · 12 optional

Parameter	Type	Required	Description
`search_text`	string	Required	The words to match against economic data series.
`limit`	integer	Optional	The maximum number of results to return. integer between 1 and 1000, optional, default: 1000 · Min: 1 · Max: 1000 · Default: 1000
`offset`	integer	Optional	non-negative integer, optional, default: 0 · Min: 0 · Default: 0
`order_by`	string	Optional	Order results by values of the specified attribute. One of the following strings: 'search_rank', 'series_id', 'title', 'units', 'frequency', 'seasonal_adjustment', 'realtime_start', 'realtime_end', 'last_updated', 'observation_start', 'observation_end', 'popularity', 'group_popularity'. optional, de · Options: search_rank, series_id, title, units, frequency, seasonal_adjustment, realtime_start, realtime_end, last_updated, observation_start, observation_end, popularity, group_popularity search_rankseries_idtitleunitsfrequencyseasonal_adjustmentrealtime_startrealtime_endlast_updatedobservation_startobservation_endpopularitygroup_popularity
`file_type`	string	Optional	Response format. Only json is supported. · Options: json · Default: "json" json
`tag_names`	string	Optional	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 series having both tags 'usa' and 'm2'. See the related request fred/tags .
`sort_order`	string	Optional	Sort results is ascending or descending order for attribute values specified by order_by. One of the following strings: 'asc', 'desc'. optional, default: If order_by is equal to 'search_rank' or 'popularity', then the default value of sort_order is 'desc'. Otherwise, the default sort order is 'asc'. · Options: asc, desc ascdesc
`search_type`	string	Optional	Determines the type of search to perform. One of the following strings: 'full_text', 'series_id'. 'full_text' searches series attributes title, units, frequency, and tags by parsing words into stems. This makes it possible for searches like 'Industry' to match series containing related words such as · Options: full_text, series_id · Default: "full_text" full_textseries_id
`filter_value`	string	Optional	The value of the filter_variable attribute to filter results by. String, optional, no filter by default
`realtime_end`	string	Optional	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	Optional	The start of the real-time period. For more information, see Real-Time Periods . YYYY-MM-DD formatted string, optional, default: today's date
`filter_variable`	string	Optional	The attribute to filter results by. One of the following strings: 'frequency', 'units', 'seasonal_adjustment'. optional, no filter by default · Options: frequency, units, seasonal_adjustment frequencyunitsseasonal_adjustment
`exclude_tag_names`	string	Optional	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 results to series having neither tag 'discontinued' nor tag 'm1'. Parameter exclude_tag_names requires that parameter tag_names also be set t

Output Schema

Field	Type	Description
`id`	string	Unique identifier for the generation task
`status`	string	Task status: pending, running, completed, failed, timeout
`model`	string	Model used for the generation
`outputs`	array	Array of output items
`outputs[].url`	string	URL of the generated artifact
`outputs[].content_type`	string	MIME type (e.g. image/png, video/mp4)
`error`	object \| null	Error details if failed, null on success
`error.type`	string	Machine-readable error type code
`error.message`	string	Human-readable error description

Code Examples

Ready-to-run snippets

const apiKey = process.env.SANDBASE_API_KEY;
const response = await fetch("https://api.sandbase.ai/v1/api/fred/series-search", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${apiKey}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "limit": 1000,
    "offset": 0,
    "file_type": "json",
    "search_type": "full_text"
  }),
});

if (!response.ok) throw new Error(await response.text());
console.log(await response.json());

← Back to FRED Search Series