# FRED Get Category Related Tags API

> Get Category Related Tags from FRED. Returns the official FRED API response unchanged.

Source: https://www.sandbase.ai/model/fred/category-related-tags
API reference: https://www.sandbase.ai/model/fred/category-related-tags/docs

## Facts

- Provider: FRED
- Type: Data API
- Endpoint: `POST https://api.sandbase.ai/v1/api/fred/category-related-tags`
- 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/category-related-tags` with `Authorization: Bearer $SANDBASE_API_KEY` and the parameters as a JSON body.

| Parameter | Type | Required | Allowed values |
| --- | --- | --- | --- |
| `category_id` | integer | yes |  |
| `tag_names` | string | yes |  |
| `exclude_tag_names` | string | no |  |
| `file_type` | string | no | json |
| `limit` | integer | no |  |
| `offset` | integer | no |  |
| `order_by` | string | no | series_count, popularity, created, name, group_id |
| `realtime_end` | string | no |  |
| `realtime_start` | string | no |  |
| `search_text` | string | no |  |
| `sort_order` | string | no | asc, desc |
| `tag_group_id` | string | no |  |

## FAQ

### How do I use the FRED Get Category Related Tags API?

Send a POST request to https://api.sandbase.ai/v1/api/fred/category-related-tags 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 Get Category Related Tags 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 Get Category Related Tags API accept?

Required: category_id (integer) and tag_names (string). Optional: exclude_tag_names (string), file_type (one of json), limit (integer), offset (integer), order_by (one of series_count, popularity, created, name, group_id) and realtime_end (string) and 4 more. The Parameters table and the Playground on this page list every field.

### What does the FRED Get Category Related Tags API return?

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

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

No. FRED Get Category Related Tags 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 Get Category Related Tags API

Get Category Related Tags 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/category-related-tags", "category_id": "<category_id>", "tag_names": "<tag_names>"}'
```

#### Parameters

| Name | Type | Required | Description |
|---|---|---|---|
| `category_id` | integer | Yes | The id for a category. integer, required |
| `exclude_tag_names` | string | No | A semicolon delimited list of tag names that series match none of. String, optional, no default value. Example value: 'goods;sa'. Find the related tags for seri |
| `file_type` | string | No | Response format. Only json is supported. |
| `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: 'series_count', 'popularity', 'created', 'name', 'group_id'. optional, default |
| `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 | No | The words to find matching tags with. String, optional, no filtering by search words by default. |
| `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: asc |
| `tag_group_id` | string | No | 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' |
| `tag_names` | string | Yes | A semicolon delimited list of tag names that series match all of. See the related request fred/category/tags . String, required, no default value. Example value |

#### Pricing

Flat price per call. Failed calls are not charged.