# FRED GeoFRED Regional Data API

> GeoFRED Regional Data from FRED. Returns the official FRED API response unchanged.

Source: https://www.sandbase.ai/model/fred/geo-regional-data
API reference: https://www.sandbase.ai/model/fred/geo-regional-data/docs

## Facts

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

| Parameter | Type | Required | Allowed values |
| --- | --- | --- | --- |
| `date` | string | yes |  |
| `frequency` | string | yes | d, w, bw, m, q, sa, a, wef, weth, wew, wetu, wem, wesu, wesa, bwew, bwem |
| `region_type` | string | yes | bea, msa, frb, necta, state, country, county, censusregion |
| `season` | string | yes |  |
| `series_group` | string | yes |  |
| `units` | string | yes |  |
| `aggregation_method` | string | no | avg, sum, eop |
| `file_type` | string | no | json |
| `start_date` | string | no |  |
| `transformation` | string | no | lin, chg, ch1, pch, pc1, pca, cch, cca, log |

## FAQ

### How do I use the FRED GeoFRED Regional Data API?

Send a POST request to https://api.sandbase.ai/v1/api/fred/geo-regional-data 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 GeoFRED Regional Data 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 GeoFRED Regional Data API accept?

Required: date (string), frequency (one of d, w, bw, m, q, sa, a, wef, weth, wew, wetu, wem, wesu, wesa, bwew, bwem), region_type (one of bea, msa, frb, necta, state, country, county, censusregion), season (string), series_group (string) and units (string). Optional: aggregation_method (one of avg, sum, eop), file_type (one of json), start_date (string) and transformation (one of lin, chg, ch1, pch, pc1, pca, cch, cca, log). The Parameters table and the Playground on this page list every field.

### What does the FRED GeoFRED Regional Data API return?

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

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

No. FRED GeoFRED Regional Data 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 GeoFRED Regional Data API

GeoFRED Regional Data 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/geo-regional-data", "date": "<date>", "frequency": "<frequency>", "region_type": "<region_type>", "season": "<season>", "series_group": "<series_group>", "units": "<units>"}'
```

#### Parameters

| Name | Type | Required | Description |
|---|---|---|---|
| `aggregation_method` | string | No | string, optional, default: avg One of the following values: 'avg', 'sum', 'eop' avg = Average sum = Sum eop = End of Period avg = Average sum = Sum eop = End of |
| `date` | string | Yes | The date you want to pull a series group data from. YYYY-MM-DD formatted string, required |
| `file_type` | string | No | Response format. Only json is supported. |
| `frequency` | string | Yes | Frequency automatically assigns the default frequency of the map when using the Request Wizard above. The parameter can be used as a frequency aggregation featu |
| `region_type` | string | Yes | The region you want to pull data for. string, required One of the following values: bea msa frb necta state country county censusregion bea msa frb necta state  |
| `season` | string | Yes | The seasonality of the series group. string, required, five possible SA (Seasonally Adjusted), NSA (Not Seasonally Adjusted), SSA (Smoothed Seasonally Adjusted) |
| `series_group` | string | Yes | The ID for a group of series found in FRED. string, required |
| `start_date` | string | No | The start date you want to request series group data from. This allows you to pull a range of data YYYY-MM-DD formatted string, optional |
| `transformation` | string | No | A key that indicates a data value transformation. string, optional, default: lin (No transformation) One of the following values: 'lin', 'chg', 'ch1', 'pch', 'p |
| `units` | string | Yes | The units of the series you want to pull. string, required |

#### Pricing

Flat price per call. Failed calls are not charged.