FRED — Get Regional Economic Data
Retrieve Regional Economic Data with the FRED API. Supply a file type, a series group and a region type and optionally set a start date. Build a market research view or track changes over time. The GET request schema also lists file_type, series_group, region_type.
- Selected price
- $0 / callPublished pricing
- Sellers / implementations
- 1 / 1
- Requests · 30d
- —Loading...
- Success rate · 30d
- —Loading...
| Seller | Pricing | Requests · 30d | Performance | Access |
|---|---|---|---|---|
fredCurrent FRED — Get Regional Economic Data · GET | $0 / call | — | —successP50— |
Run sends a real API request. Charges follow the published API contract.
Response structure
2013 Per Capita Personal Income by State (Dollars)object2013object[]codestringregionstringseries_idstringvaluestring
// Inferred from response examples. Fields are optional and other fields may be returned.
export type ApiResponse = {
"2013 Per Capita Personal Income by State (Dollars)"?: {
"2013"?: Array<{
code?: string;
region?: string;
series_id?: string;
value?: string;
}>;
};
};- Method
- GET
- Endpoint
https://api.openany.si/v1/agent-apis/fred/geofred/regional/data- Content type
- application/json
- Authentication
Authorization: Bearer $OPENANY_API_KEY
curl \
'https://api.openany.si/v1/agent-apis/fred/geofred/regional/data?date=2013-01-01&file_type=json&frequency=a®ion_type=state&season=NSA&series_group=882&units=Dollars' \
-X GET \
-H "Authorization: Bearer $OPENANY_API_KEY" \
-H 'Content-Type: application/json'Input parameters
Fields in this listing; additional options and input encoding can vary by provider.
| Parameter | Location | Type | Required | Description |
|---|---|---|---|---|
file_type | URL query parametersquery | string | Yes | A key or file extension that indicates the type of file to send.
One of the following values: 'xml', 'json'
xml = Extensible Markup Language. The HTTP Content-Type is text/xml (xml is not available for county data).
json = JavaScript Object Notation. The HTTP Content-Type is application/json.
OpenAny import profile requires json explicitly; original XML/download formats remain in official documentation. enum: "json" |
series_group | URL query parametersquery | string | Yes | The ID for a group of series found in FRED. string, required |
region_type | URL query parametersquery | 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 enum: "bea", "msa", "frb", "necta", "state", "country", "county", "censusregion" |
date | URL query parametersquery | string | Yes | The date you want to pull a series group data from. YYYY-MM-DD formatted string, required |
start_date | URL query parametersquery | 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 |
season | URL query parametersquery | string | Yes | The seasonality of the series group.
string, required, five possible SA (Seasonally Adjusted), NSA (Not Seasonally Adjusted), SSA (Smoothed Seasonally Adjusted), SAAR (Seasonally Adjusted Annual Rate), or NSAAR (Not Seasonally Adjusted Annual Rate) enum: "SA", "NSA", "SSA", "SAAR", "NSAAR" |
units | URL query parametersquery | string | Yes | The units of the series you want to pull. string, required |
transformation | URL query parametersquery | 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', 'pc1', 'pca', 'cch', 'cca', 'log'
lin = Levels (No transformation)
chg = Change
ch1 = Change from Year Ago
pch = Percent Change
pc1 = Percent Change from Year Ago
pca = Compounded Annual Rate of Change
cch = Continuously Compounded Rate of Change
cca = Continuously Compounded Annual Rate of Change
log = Natural Log
For unit transformation formulas, see:
https://alfred.stlouisfed.org/help#growth_formulas enum: "lin", "chg", "ch1", "pch", "pc1", "pca", "cch", "cca", "log" |
frequency | URL query parametersquery | string | No | Frequency automatically assigns the default frequency of the map when using the Request Wizard above. The parameter can be used as a frequency aggregation feature.
The maps frequency aggregation feature converts higher frequency data series into lower frequency data series (e.g. converts a monthly data series into an annual data series).
In maps, the highest frequency data is daily, and the lowest frequency data is annual.
There are 3 aggregation methods available- average, sum, and end of period.
See the aggregation_method parameter.
string
One of the following values: 'd', 'w', 'bw', 'm', 'q', 'sa', 'a', 'wef', 'weth', 'wew', 'wetu', 'wem', 'wesu', 'wesa', 'bwew', 'bwem'
Frequencies without period descriptions:
d = Daily
w = Weekly
bw = Biweekly
m = Monthly
q = Quarterly
sa = Semiannual
a = Annual
Frequencies with period descriptions:
wef = Weekly, Ending Friday
weth = Weekly, Ending Thursday
wew = Weekly, Ending Wednesday
wetu = Weekly, Ending Tuesday
wem = Weekly, Ending Monday
wesu = Weekly, Ending Sunday
wesa = Weekly, Ending Saturday
bwew = Biweekly, Ending Wednesday
bwem = Biweekly, Ending Monday enum: "d", "w", "bw", "m", "q", "sa", "a", "wef", "weth", "wew", "wetu", "wem", "wesu", "wesa", "bwew", "bwem" |
aggregation_method | URL query parametersquery | string | No | string, optional, default: avg
One of the following values: 'avg', 'sum', 'eop'
avg = Average
sum = Sum
eop = End of Period enum: "avg", "sum", "eop" |
Required markers inside a nested object or variant apply when that object or variant is used.
Sample response
Sample response · Configured HTTP 200; actual status is unverified. Example from the provider's documentation. Field values in your results will differ.
{
"2013 Per Capita Personal Income by State (Dollars)": {
"2013": [
{
"code": "01",
"region": "Alabama",
"series_id": "ALPCPI",
"value": "36481"
},
{
"code": "02",
"region": "Alaska",
"series_id": "AKPCPI",
"value": "50150"
},
{
"code": "04",
"region": "Arizona",
"series_id": "AZPCPI",
"value": "36983"
},
{
"code": "05",
"region": "Arkansas",
"series_id": "ARPCPI",
"value": "36698"
},
{
"code": "06",
"region": "California",
"series_id": "CAPCPI",
"value": "48434"
},
{
"code": "08",
"region": "Colorado",
"series_id": "COPCPI",
"value": "46897"
},
{
"code": "09",
"region": "Connecticut",
"series_id": "CTPCPI",
"value": "60658"
},
{
"code": "10",
"region": "Delaware",
"series_id": "DEPCPI",
"value": "44815"
},
{
"code": "11",
"region": "District of Columbia",
"series_id": "DCPCPI",
"value": "75329"
},
{
"code": "12",
"region": "Florida",
"series_id": "FLPCPI",
"value": "41497"
},
{
"code": "13",
"region": "Georgia",
"series_id": "GAPCPI",
"value": "37845"
},
{
"code": "15",
"region": "Hawaii",
"series_id": "HIPCPI",
"value": "45204"
},
{
"code": "16",
"region": "Idaho",
"series_id": "IDPCPI",
"value": "36146"
},
{
"code": "17",
"region": "Illinois",
"series_id": "ILPCPI",
"value": "46980"
},
{
"code": "18",
"region": "Indiana",
"series_id": "INPCPI",
"value": "38622"
},
{
"code": "19",
"region": "Iowa",
"series_id": "IAPCPI",
"value": "44763"
},
{
"code": "20",
"region": "Kansas",
"series_id": "KSPCPI",
"value": "44417"
},
{
"code": "21",
"region": "Kentucky",
"series_id": "KYPCPI",
"value": "36214"
},
{
"code": "22",
"region": "Louisiana",
"series_id": "LAPCPI",
"value": "41204"
},
{
"code": "23",
"region": "Maine",
"series_id": "MEPCPI",
"value": "40924"
},
{
"code": "24",
"region": "Maryland",
"series_id": "MDPCPI",
"value": "53826"
},
{
"code": "25",
"region": "Massachusetts",
"series_id": "MAPCPI",
"value": "57248"
},
{
"code": "26",
"region": "Michigan",
"series_id": "MIPCPI",
"value": "39055"
},
{
"code": "27",
"region": "Minnesota",
"series_id": "MNPCPI",
"value": "47500"
},
{
"code": "28",
"region": "Mississippi",
"series_id": "MSPCPI",
"value": "33913"
},
{
"code": "29",
"region": "Missouri",
"series_id": "MOPCPI",
"value": "40663"
},
{
"code": "30",
"region": "Montana",
"series_id": "MTPCPI",
"value": "39366"
},
{
"code": "31",
"region": "Nebraska",
"series_id": "NEPCPI",
"value": "47157"
},
{
"code": "32",
"region": "Nevada",
"series_id": "NVPCPI",
"value": "39235"
},
{
"code": "33",
"region": "New Hampshire",
"series_id": "NHPCPI",
"value": "51013"
},
{
"code": "34",
"region": "New Jersey",
"series_id": "NJPCPI",
"value": "55386"
},
{
"code": "35",
"region": "New Mexico",
"series_id": "NMPCPI",
"value": "35965"
},
{
"code": "36",
"region": "New York",
"series_id": "NYPCPI",
"value": "54462"
},
{
"code": "37",
"region": "North Carolina",
"series_id": "NCPCPI",
"value": "38683"
},
{
"code": "38",
"region": "North Dakota",
"series_id": "NDPCPI",
"value": "53182"
},
{
"code": "39",
"region": "Ohio",
"series_id": "OHPCPI",
"value": "41049"
},
{
"code": "40",
"region": "Oklahoma",
"series_id": "OKPCPI",
"value": "41861"
},
{
"code": "41",
"region": "Oregon",
"series_id": "ORPCPI",
"value": "39848"
},
{
"code": "42",
"region": "Pennsylvania",
"series_id": "PAPCPI",
"value": "46202"
},
{
"code": "44",
"region": "Rhode Island",
"series_id": "RIPCPI",
"value": "46989"
},
{
"code": "45",
"region": "South Carolina",
"series_id": "SCPCPI",
"value": "35831"
},
{
"code": "46",
"region": "South Dakota",
"series_id": "SDPCPI",
"value": "46039"
},
{
"code": "47",
"region": "Tennessee",
"series_id": "TNPCPI",
"value": "39558"
},
{
"code": "48",
"region": "Texas",
"series_id": "TXPCPI",
"value": "43862"
},
{
"code": "49",
"region": "Utah",
"series_id": "UTPCPI",
"value": "36640"
},
{
"code": "50",
"region": "Vermont",
"series_id": "VTPCPI",
"value": "45483"
},
{
"code": "51",
"region": "Virginia",
"series_id": "VAPCPI",
"value": "48838"
},
{
"code": "53",
"region": "Washington",
"series_id": "WAPCPI",
"value": "47717"
},
{
"code": "54",
"region": "West Virginia",
"series_id": "WVPCPI",
"value": "35533"
},
{
"code": "55",
"region": "Wisconsin",
"series_id": "WIPCPI",
"value": "43244"
},
{
"code": "56",
"region": "Wyoming",
"series_id": "WYPCPI",
"value": "52826"
}
]
}
}Agent integration
Copy the resource contract without sharing an API key.
View API Markdown
# FRED — Get Regional Economic Data
Retrieve Regional Economic Data with the FRED API. Supply a file type, a series group and a region type and optionally set a start date. Build a market research view or track changes over time. The GET request schema also lists file_type, series_group, region_type.
## Available implementations
fred · FRED — Get Regional Economic Data: https://openany.si/markets/apis/capabilities/fred-get-regional-economic-data?offering=09a329ce-d558-4d9a-af57-d0da3b8a8318 · $0 / call
## Selected API contract
Documentation: https://openany.si/markets/apis/capabilities/fred-get-regional-economic-data
Method: GET
Endpoint: https://api.openany.si/v1/agent-apis/fred/geofred/regional/data
Price: $0 / call
Provider: fred
Contract revision: 3
Price source: OpenAny public API contract and documented provider unit rates. Price update time: not supplied.
Use OPENANY_API_KEY from the environment. API Key calls use your shared balance.
## Prepared request
```bash
curl \
'https://api.openany.si/v1/agent-apis/fred/geofred/regional/data?date=2013-01-01&file_type=json&frequency=a®ion_type=state&season=NSA&series_group=882&units=Dollars' \
-X GET \
-H "Authorization: Bearer $OPENANY_API_KEY" \
-H 'Content-Type: application/json'
```
## API contract
```json
{
"resource_type": "api",
"name": "FRED — Get Regional Economic Data",
"endpoint": "https://api.openany.si/v1/agent-apis/fred/geofred/regional/data",
"method": "GET",
"content_type": "none",
"execution_mode": "sync",
"authentication": {
"type": "bearer",
"environment_variable": "OPENANY_API_KEY"
},
"inputs": [
{
"description": "A key or file extension that indicates the type of file to send.\n\nOne of the following values: 'xml', 'json'\n\n xml = Extensible Markup Language. The HTTP Content-Type is text/xml (xml is not available for county data).\n\n json = JavaScript Object Notation. The HTTP Content-Type is application/json.\nOpenAny import profile requires json explicitly; original XML/download formats remain in official documentation.",
"enum_values": [
"json"
],
"location": "query",
"name": "file_type",
"nullable": false,
"required": true,
"type": "string"
},
{
"description": "The ID for a group of series found in FRED.\n\nstring, required",
"location": "query",
"name": "series_group",
"nullable": false,
"required": true,
"type": "string"
},
{
"description": "The region you want to pull data for.\n\nstring, required\n\nOne of the following values:\n\nbea\n\nmsa\n\nfrb\n\nnecta\n\nstate\n\ncountry\n\ncounty\n\ncensusregion",
"enum_values": [
"bea",
"msa",
"frb",
"necta",
"state",
"country",
"county",
"censusregion"
],
"location": "query",
"name": "region_type",
"nullable": false,
"required": true,
"type": "string"
},
{
"description": "The date you want to pull a series group data from.\n\nYYYY-MM-DD formatted string, required",
"location": "query",
"name": "date",
"nullable": false,
"required": true,
"type": "string"
},
{
"description": "The start date you want to request series group data from. This allows you to pull a range of data\n\nYYYY-MM-DD formatted string, optional",
"location": "query",
"name": "start_date",
"nullable": false,
"required": false,
"type": "string"
},
{
"description": "The seasonality of the series group.\n\nstring, required, five possible SA (Seasonally Adjusted), NSA (Not Seasonally Adjusted), SSA (Smoothed Seasonally Adjusted), SAAR (Seasonally Adjusted Annual Rate), or NSAAR (Not Seasonally Adjusted Annual Rate)",
"enum_values": [
"SA",
"NSA",
"SSA",
"SAAR",
"NSAAR"
],
"location": "query",
"name": "season",
"nullable": false,
"required": true,
"type": "string"
},
{
"description": "The units of the series you want to pull.\n\nstring, required",
"location": "query",
"name": "units",
"nullable": false,
"required": true,
"type": "string"
},
{
"description": "A key that indicates a data value transformation.\n\nstring, optional, default: lin (No transformation)\n\nOne of the following values: 'lin', 'chg', 'ch1', 'pch', 'pc1', 'pca', 'cch', 'cca', 'log'\n\nlin = Levels (No transformation)\n\n chg = Change\n\n ch1 = Change from Year Ago\n\n pch = Percent Change\n\n pc1 = Percent Change from Year Ago\n\n pca = Compounded Annual Rate of Change\n\n cch = Continuously Compounded Rate of Change\n\n cca = Continuously Compounded Annual Rate of Change\n\n log = Natural Log\n\nFor unit transformation formulas, see:\n https://alfred.stlouisfed.org/help#growth_formulas",
"enum_values": [
"lin",
"chg",
"ch1",
"pch",
"pc1",
"pca",
"cch",
"cca",
"log"
],
"location": "query",
"name": "transformation",
"nullable": false,
"required": false,
"type": "string"
},
{
"description": "Frequency automatically assigns the default frequency of the map when using the Request Wizard above. The parameter can be used as a frequency aggregation feature.\n The maps frequency aggregation feature converts higher frequency data series into lower frequency data series (e.g. converts a monthly data series into an annual data series). \n In maps, the highest frequency data is daily, and the lowest frequency data is annual. \n There are 3 aggregation methods available- average, sum, and end of period. \n See the aggregation_method parameter. \n\nstring\n\nOne of the following values: 'd', 'w', 'bw', 'm', 'q', 'sa', 'a', 'wef', 'weth', 'wew', 'wetu', 'wem', 'wesu', 'wesa', 'bwew', 'bwem'\n\nFrequencies without period descriptions:\n\n d = Daily\n\n w = Weekly\n\n bw = Biweekly\n\n m = Monthly\n\n q = Quarterly\n\n sa = Semiannual\n\n a = Annual\n\nFrequencies with period descriptions:\n\n wef = Weekly, Ending Friday\n\n weth = Weekly, Ending Thursday\n\n wew = Weekly, Ending Wednesday\n\n wetu = Weekly, Ending Tuesday\n\n wem = Weekly, Ending Monday\n\n wesu = Weekly, Ending Sunday\n\n wesa = Weekly, Ending Saturday\n\n bwew = Biweekly, Ending Wednesday\n\n bwem = Biweekly, Ending Monday",
"enum_values": [
"d",
"w",
"bw",
"m",
"q",
"sa",
"a",
"wef",
"weth",
"wew",
"wetu",
"wem",
"wesu",
"wesa",
"bwew",
"bwem"
],
"location": "query",
"name": "frequency",
"nullable": false,
"required": false,
"type": "string"
},
{
"description": "string, optional, default: avg\n\nOne of the following values: 'avg', 'sum', 'eop'\n\n avg = Average\n\n sum = Sum\n\n eop = End of Period",
"enum_values": [
"avg",
"sum",
"eop"
],
"location": "query",
"name": "aggregation_method",
"nullable": false,
"required": false,
"type": "string"
}
],
"billing": {
"currency": "USD",
"mode": "fixed",
"priceMicroUsd": "0",
"rounding": null,
"unit": "call",
"unitQuantity": null
},
"examples": [
{
"http_status": 200,
"name": "Official example · Official example (not executed) (HTTP assumed",
"request": {
"body": null,
"headers": {},
"path": {},
"query": {
"date": "2013-01-01",
"file_type": "json",
"frequency": "a",
"region_type": "state",
"season": "NSA",
"series_group": "882",
"units": "Dollars"
}
},
"response_body": {
"2013 Per Capita Personal Income by State (Dollars)": {
"2013": [
{
"code": "01",
"region": "Alabama",
"series_id": "ALPCPI",
"value": "36481"
},
{
"code": "02",
"region": "Alaska",
"series_id": "AKPCPI",
"value": "50150"
},
{
"code": "04",
"region": "Arizona",
"series_id": "AZPCPI",
"value": "36983"
},
{
"code": "05",
"region": "Arkansas",
"series_id": "ARPCPI",
"value": "36698"
},
{
"code": "06",
"region": "California",
"series_id": "CAPCPI",
"value": "48434"
},
{
"code": "08",
"region": "Colorado",
"series_id": "COPCPI",
"value": "46897"
},
{
"code": "09",
"region": "Connecticut",
"series_id": "CTPCPI",
"value": "60658"
},
{
"code": "10",
"region": "Delaware",
"series_id": "DEPCPI",
"value": "44815"
},
{
"code": "11",
"region": "District of Columbia",
"series_id": "DCPCPI",
"value": "75329"
},
{
"code": "12",
"region": "Florida",
"series_id": "FLPCPI",
"value": "41497"
},
{
"code": "13",
"region": "Georgia",
"series_id": "GAPCPI",
"value": "37845"
},
{
"code": "15",
"region": "Hawaii",
"series_id": "HIPCPI",
"value": "45204"
},
{
"code": "16",
"region": "Idaho",
"series_id": "IDPCPI",
"value": "36146"
},
{
"code": "17",
"region": "Illinois",
"series_id": "ILPCPI",
"value": "46980"
},
{
"code": "18",
"region": "Indiana",
"series_id": "INPCPI",
"value": "38622"
},
{
"code": "19",
"region": "Iowa",
"series_id": "IAPCPI",
"value": "44763"
},
{
"code": "20",
"region": "Kansas",
"series_id": "KSPCPI",
"value": "44417"
},
{
"code": "21",
"region": "Kentucky",
"series_id": "KYPCPI",
"value": "36214"
},
{
"code": "22",
"region": "Louisiana",
"series_id": "LAPCPI",
"value": "41204"
},
{
"code": "23",
"region": "Maine",
"series_id": "MEPCPI",
"value": "40924"
},
{
"code": "24",
"region": "Maryland",
"series_id": "MDPCPI",
"value": "53826"
},
{
"code": "25",
"region": "Massachusetts",
"series_id": "MAPCPI",
"value": "57248"
},
{
"code": "26",
"region": "Michigan",
"series_id": "MIPCPI",
"value": "39055"
},
{
"code": "27",
"region": "Minnesota",
"series_id": "MNPCPI",
"value": "47500"
},
{
"code": "28",
"region": "Mississippi",
"series_id": "MSPCPI",
"value": "33913"
},
{
"code": "29",
"region": "Missouri",
"series_id": "MOPCPI",
"value": "40663"
},
{
"code": "30",
"region": "Montana",
"series_id": "MTPCPI",
"value": "39366"
},
{
"code": "31",
"region": "Nebraska",
"series_id": "NEPCPI",
"value": "47157"
},
{
"code": "32",
"region": "Nevada",
"series_id": "NVPCPI",
"value": "39235"
},
{
"code": "33",
"region": "New Hampshire",
"series_id": "NHPCPI",
"value": "51013"
},
{
"code": "34",
"region": "New Jersey",
"series_id": "NJPCPI",
"value": "55386"
},
{
"code": "35",
"region": "New Mexico",
"series_id": "NMPCPI",
"value": "35965"
},
{
"code": "36",
"region": "New York",
"series_id": "NYPCPI",
"value": "54462"
},
{
"code": "37",
"region": "North Carolina",
"series_id": "NCPCPI",
"value": "38683"
},
{
"code": "38",
"region": "North Dakota",
"series_id": "NDPCPI",
"value": "53182"
},
{
"code": "39",
"region": "Ohio",
"series_id": "OHPCPI",
"value": "41049"
},
{
"code": "40",
"region": "Oklahoma",
"series_id": "OKPCPI",
"value": "41861"
},
{
"code": "41",
"region": "Oregon",
"series_id": "ORPCPI",
"value": "39848"
},
{
"code": "42",
"region": "Pennsylvania",
"series_id": "PAPCPI",
"value": "46202"
},
{
"code": "44",
"region": "Rhode Island",
"series_id": "RIPCPI",
"value": "46989"
},
{
"code": "45",
"region": "South Carolina",
"series_id": "SCPCPI",
"value": "35831"
},
{
"code": "46",
"region": "South Dakota",
"series_id": "SDPCPI",
"value": "46039"
},
{
"code": "47",
"region": "Tennessee",
"series_id": "TNPCPI",
"value": "39558"
},
{
"code": "48",
"region": "Texas",
"series_id": "TXPCPI",
"value": "43862"
},
{
"code": "49",
"region": "Utah",
"series_id": "UTPCPI",
"value": "36640"
},
{
"code": "50",
"region": "Vermont",
"series_id": "VTPCPI",
"value": "45483"
},
{
"code": "51",
"region": "Virginia",
"series_id": "VAPCPI",
"value": "48838"
},
{
"code": "53",
"region": "Washington",
"series_id": "WAPCPI",
"value": "47717"
},
{
"code": "54",
"region": "West Virginia",
"series_id": "WVPCPI",
"value": "35533"
},
{
"code": "55",
"region": "Wisconsin",
"series_id": "WIPCPI",
"value": "43244"
},
{
"code": "56",
"region": "Wyoming",
"series_id": "WYPCPI",
"value": "52826"
}
]
}
}
}
]
}
```Error handling
| Status | Next step |
|---|---|
400 | Check the offering and request fields. |
401 / 403 | Verify your credentials and access permissions. |
402 | Inspect the selected access mode and returned payment requirements. |
429 | Respect the returned rate limit and retry guidance. |
5xx | Inspect the error and usage record before retrying a paid operation. |
Official example · Official example (not executed) (HTTP assumed
Example from the provider's documentation. Field values in your results will differ.
Prepare your environment
Use a terminal with cURL installed.
Use an OpenAny API key with shared-balance access. Confirm availability and price before running; a call may charge your balance.
Set the key in your terminal using the hidden prompt below. Keep its value out of source files and logs.
Terminal · macOS / Linuxprintf 'OpenAny API key: ' read -r -s OPENANY_API_KEY export OPENANY_API_KEY printf '\n'Run the request
Paste the complete command below into your terminal.
Values to replace before running 10
Review these request fields before running. Keep the published provider and request method unchanged.
file_type- A key or file extension that indicates the type of file to send. One of the following values: 'xml', 'json' xml = Extensible Markup Language. The HTTP Content-Type is text/xml (xml is not available for county data). json = JavaScript Object Notation. The HTTP Content-Type is application/json. OpenAny import profile requires json explicitly; original XML/download formats remain in official documentation.
series_group- The ID for a group of series found in FRED. string, required
region_type- The region you want to pull data for. string, required One of the following values: bea msa frb necta state country county censusregion
date- The date you want to pull a series group data from. YYYY-MM-DD formatted string, required
start_date- 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
season- The seasonality of the series group. string, required, five possible SA (Seasonally Adjusted), NSA (Not Seasonally Adjusted), SSA (Smoothed Seasonally Adjusted), SAAR (Seasonally Adjusted Annual Rate), or NSAAR (Not Seasonally Adjusted Annual Rate)
units- The units of the series you want to pull. string, required
transformation- A key that indicates a data value transformation. string, optional, default: lin (No transformation) One of the following values: 'lin', 'chg', 'ch1', 'pch', 'pc1', 'pca', 'cch', 'cca', 'log' lin = Levels (No transformation) chg = Change ch1 = Change from Year Ago pch = Percent Change pc1 = Percent Change from Year Ago pca = Compounded Annual Rate of Change cch = Continuously Compounded Rate of Change cca = Continuously Compounded Annual Rate of Change log = Natural Log For unit transformation formulas, see: https://alfred.stlouisfed.org/help#growth_formulas
frequency- Frequency automatically assigns the default frequency of the map when using the Request Wizard above. The parameter can be used as a frequency aggregation feature. The maps frequency aggregation feature converts higher frequency data series into lower frequency data series (e.g. converts a monthly data series into an annual data series). In maps, the highest frequency data is daily, and the lowest frequency data is annual. There are 3 aggregation methods available- average, sum, and end of period. See the aggregation_method parameter. string One of the following values: 'd', 'w', 'bw', 'm', 'q', 'sa', 'a', 'wef', 'weth', 'wew', 'wetu', 'wem', 'wesu', 'wesa', 'bwew', 'bwem' Frequencies without period descriptions: d = Daily w = Weekly bw = Biweekly m = Monthly q = Quarterly sa = Semiannual a = Annual Frequencies with period descriptions: wef = Weekly, Ending Friday weth = Weekly, Ending Thursday wew = Weekly, Ending Wednesday wetu = Weekly, Ending Tuesday wem = Weekly, Ending Monday wesu = Weekly, Ending Sunday wesa = Weekly, Ending Saturday bwew = Biweekly, Ending Wednesday bwem = Biweekly, Ending Monday
aggregation_method- string, optional, default: avg One of the following values: 'avg', 'sum', 'eop' avg = Average sum = Sum eop = End of Period
Terminal · cURLcurl \ 'https://api.openany.si/v1/agent-apis/fred/geofred/regional/data?date=2013-01-01&file_type=json&frequency=a®ion_type=state&season=NSA&series_group=882&units=Dollars' \ -X GET \ -H "Authorization: Bearer $OPENANY_API_KEY" \ -H 'Content-Type: application/json'Check the response
Sample response · Configured HTTP 200; actual status is unverified.
Sample response{ "2013 Per Capita Personal Income by State (Dollars)": { "2013": [ { "code": "01", "region": "Alabama", "series_id": "ALPCPI", "value": "36481" }, { "code": "02", "region": "Alaska", "series_id": "AKPCPI", "value": "50150" }, { "code": "04", "region": "Arizona", "series_id": "AZPCPI", "value": "36983" }, { "code": "05", "region": "Arkansas", "series_id": "ARPCPI", "value": "36698" }, { "code": "06", "region": "California", "series_id": "CAPCPI", "value": "48434" }, { "code": "08", "region": "Colorado", "series_id": "COPCPI", "value": "46897" }, { "code": "09", "region": "Connecticut", "series_id": "CTPCPI", "value": "60658" }, { "code": "10", "region": "Delaware", "series_id": "DEPCPI", "value": "44815" }, { "code": "11", "region": "District of Columbia", "series_id": "DCPCPI", "value": "75329" }, { "code": "12", "region": "Florida", "series_id": "FLPCPI", "value": "41497" }, { "code": "13", "region": "Georgia", "series_id": "GAPCPI", "value": "37845" }, { "code": "15", "region": "Hawaii", "series_id": "HIPCPI", "value": "45204" }, { "code": "16", "region": "Idaho", "series_id": "IDPCPI", "value": "36146" }, { "code": "17", "region": "Illinois", "series_id": "ILPCPI", "value": "46980" }, { "code": "18", "region": "Indiana", "series_id": "INPCPI", "value": "38622" }, { "code": "19", "region": "Iowa", "series_id": "IAPCPI", "value": "44763" }, { "code": "20", "region": "Kansas", "series_id": "KSPCPI", "value": "44417" }, { "code": "21", "region": "Kentucky", "series_id": "KYPCPI", "value": "36214" }, { "code": "22", "region": "Louisiana", "series_id": "LAPCPI", "value": "41204" }, { "code": "23", "region": "Maine", "series_id": "MEPCPI", "value": "40924" }, { "code": "24", "region": "Maryland", "series_id": "MDPCPI", "value": "53826" }, { "code": "25", "region": "Massachusetts", "series_id": "MAPCPI", "value": "57248" }, { "code": "26", "region": "Michigan", "series_id": "MIPCPI", "value": "39055" }, { "code": "27", "region": "Minnesota", "series_id": "MNPCPI", "value": "47500" }, { "code": "28", "region": "Mississippi", "series_id": "MSPCPI", "value": "33913" }, { "code": "29", "region": "Missouri", "series_id": "MOPCPI", "value": "40663" }, { "code": "30", "region": "Montana", "series_id": "MTPCPI", "value": "39366" }, { "code": "31", "region": "Nebraska", "series_id": "NEPCPI", "value": "47157" }, { "code": "32", "region": "Nevada", "series_id": "NVPCPI", "value": "39235" }, { "code": "33", "region": "New Hampshire", "series_id": "NHPCPI", "value": "51013" }, { "code": "34", "region": "New Jersey", "series_id": "NJPCPI", "value": "55386" }, { "code": "35", "region": "New Mexico", "series_id": "NMPCPI", "value": "35965" }, { "code": "36", "region": "New York", "series_id": "NYPCPI", "value": "54462" }, { "code": "37", "region": "North Carolina", "series_id": "NCPCPI", "value": "38683" }, { "code": "38", "region": "North Dakota", "series_id": "NDPCPI", "value": "53182" }, { "code": "39", "region": "Ohio", "series_id": "OHPCPI", "value": "41049" }, { "code": "40", "region": "Oklahoma", "series_id": "OKPCPI", "value": "41861" }, { "code": "41", "region": "Oregon", "series_id": "ORPCPI", "value": "39848" }, { "code": "42", "region": "Pennsylvania", "series_id": "PAPCPI", "value": "46202" }, { "code": "44", "region": "Rhode Island", "series_id": "RIPCPI", "value": "46989" }, { "code": "45", "region": "South Carolina", "series_id": "SCPCPI", "value": "35831" }, { "code": "46", "region": "South Dakota", "series_id": "SDPCPI", "value": "46039" }, { "code": "47", "region": "Tennessee", "series_id": "TNPCPI", "value": "39558" }, { "code": "48", "region": "Texas", "series_id": "TXPCPI", "value": "43862" }, { "code": "49", "region": "Utah", "series_id": "UTPCPI", "value": "36640" }, { "code": "50", "region": "Vermont", "series_id": "VTPCPI", "value": "45483" }, { "code": "51", "region": "Virginia", "series_id": "VAPCPI", "value": "48838" }, { "code": "53", "region": "Washington", "series_id": "WAPCPI", "value": "47717" }, { "code": "54", "region": "West Virginia", "series_id": "WVPCPI", "value": "35533" }, { "code": "55", "region": "Wisconsin", "series_id": "WIPCPI", "value": "43244" }, { "code": "56", "region": "Wyoming", "series_id": "WYPCPI", "value": "52826" } ] } }
Common questions
Do I need a separate key for every provider?
Use your OpenAny API key for standard API access. Read it from OPENANY_API_KEY in your environment and keep it out of prompts, source code and logs.
Are these providers interchangeable?
No. Each offering has its own inputs, pricing and response contract. Selecting a catalog offering does not establish automatic routing or fallback. Confirm the service contract before calling.
How is this API billed?
API-key calls use your shared balance at the selected implementation's published rate. Check the billing unit and request-specific pricing rules before making a paid call. Recorded usage determines the final charge under that contract.
Where do the price and contract come from?
The selected implementation publishes its provider, request contract, revision and billing rules through OpenAny's public API catalog. A revision number identifies a contract version, not a price update date. A price update timestamp is not supplied; do not treat a page date as one.
How do OpenAny Balance and x402 differ?
OpenAny Balance uses an API key and one shared balance. Card, USDC and x402 top-ups, card auto top-up and USDC subscriptions fund that balance; available routes appear on the Credits page. Direct x402 is a separate pay-per-request flow, available only on listings that show it and requiring an authorized payment client.
Does Playground send a paid request?
Yes. After you sign in, Run sends a real API request using an active OpenAny API key. Charges follow the published API contract and use your shared balance. Selecting an implementation, editing inputs and viewing sample responses do not send requests.
Use FRED — Get Regional Economic Data with your agent
Inspect endpoint contracts and confirm availability and pricing before a paid call.