API reference · FRED
fred/series-search-related-tags
Integrate this model through SandBase's unified API, with production-ready schemas and examples.
Production endpoint
Send your first request
OpenAI-compatible endpoint with unified authentication and usage tracking.
POST
https://api.sandbase.ai/v1/api/fred/series-search-related-tagsModel ID
fred/series-search-related-tags01
Input Schema
12 parameters · 2 required · 10 optional
| Parameter | Type | Required | Description |
|---|---|---|---|
tag_names | string | Required | A semicolon delimited list of tag names that series match all of. See the related request fred/series/search/tags . String, required, no default value. Example value: '30-year;frb'. Find the related tags for series having both tags '30-year' and 'frb'. |
series_search_text | string | Required | The words to match against economic data series. string, required |
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: 'series_count', 'popularity', 'created', 'name', 'group_id'. optional, default: series_count · Options: series_count, popularity, created, name, group_id · Default: "series_count" series_countpopularitycreatednamegroup_id |
file_type | string | Optional | Response format. Only json is supported. · Options: json · Default: "json" json |
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: asc · Options: asc, desc · Default: "asc" ascdesc |
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 |
tag_group_id | string | Optional | A tag group id to filter tags by type. String, optional, no filtering by tag group by default. One of the following: 'freq', 'gen', 'geo', 'geot', 'rls', 'seas', 'src'. freq = Frequency gen = General or Concept geo = Geography geot = Geography Type rls = Release seas = Seasonal Adjustment src = Sour |
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 |
tag_search_text | string | Optional | The words to find matching tags with. String, optional, no filtering by search words by default. |
exclude_tag_names | string | Optional | A semicolon delimited list of tag names that series match none of. String, optional, no default value. Example value: 'discontinued;monthly'. Find the related tags for series having neither tag 'discontinued' nor tag 'monthly'. |
02
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 |
03
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-related-tags", {
method: "POST",
headers: {
Authorization: `Bearer ${apiKey}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"limit": 1000,
"offset": 0,
"order_by": "series_count",
"file_type": "json",
"sort_order": "asc"
}),
});
if (!response.ok) throw new Error(await response.text());
console.log(await response.json());