Get Economic Indicators

curl --request GET \
  --url https://data-tools.prd.arrays.org/api/v1/macro/economic-indicators \
  --header 'X-API-Key: <api-key>'

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://data-tools.prd.arrays.org/api/v1/macro/economic-indicators', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://data-tools.prd.arrays.org/api/v1/macro/economic-indicators",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://data-tools.prd.arrays.org/api/v1/macro/economic-indicators"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://data-tools.prd.arrays.org/api/v1/macro/economic-indicators")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "observations": [
        {
          "date": "2024-01-15",
          "observed_at": 1714041000,
          "release_date": "2024-04-25",
          "value": 28284.498
        }
      ],
      "series": {
        "frequency": "Quarterly",
        "name": "GDP",
        "notes": "<string>",
        "seasonal_adjustment": "Seasonally Adjusted Annual Rate",
        "title": "Gross Domestic Product",
        "units": "Billions of Dollars"
      }
    }
  ],
  "error": {
    "code": "RESOURCE_NOT_FOUND",
    "details": [
      {
        "field": "<string>",
        "got": "<string>",
        "reason": "<string>"
      }
    ],
    "docs_url": "<string>",
    "examples": [
      "<string>"
    ],
    "hint": "<string>",
    "message": "The requested resource was not found.",
    "suggestions": [
      "<string>"
    ]
  },
  "metadata": "<unknown>",
  "pagination": "<unknown>",
  "request_id": "<string>",
  "success": true
}

{
  "data": "<unknown>",
  "error": {
    "code": "RESOURCE_NOT_FOUND",
    "details": [
      {
        "field": "<string>",
        "got": "<string>",
        "reason": "<string>"
      }
    ],
    "docs_url": "<string>",
    "examples": [
      "<string>"
    ],
    "hint": "<string>",
    "message": "The requested resource was not found.",
    "suggestions": [
      "<string>"
    ]
  },
  "metadata": "<unknown>",
  "pagination": "<unknown>",
  "request_id": "<string>",
  "success": true
}

{
  "data": "<unknown>",
  "error": {
    "code": "RESOURCE_NOT_FOUND",
    "details": [
      {
        "field": "<string>",
        "got": "<string>",
        "reason": "<string>"
      }
    ],
    "docs_url": "<string>",
    "examples": [
      "<string>"
    ],
    "hint": "<string>",
    "message": "The requested resource was not found.",
    "suggestions": [
      "<string>"
    ]
  },
  "metadata": "<unknown>",
  "pagination": "<unknown>",
  "request_id": "<string>",
  "success": true
}

{
  "data": "<unknown>",
  "error": {
    "code": "RESOURCE_NOT_FOUND",
    "details": [
      {
        "field": "<string>",
        "got": "<string>",
        "reason": "<string>"
      }
    ],
    "docs_url": "<string>",
    "examples": [
      "<string>"
    ],
    "hint": "<string>",
    "message": "The requested resource was not found.",
    "suggestions": [
      "<string>"
    ]
  },
  "metadata": "<unknown>",
  "pagination": "<unknown>",
  "request_id": "<string>",
  "success": true
}

Macro

Get Economic Indicators

OpenAPI JSON Spec Retrieve economic indicator time series data with series metadata and observations

Overview This endpoint provides economic indicator data from FRED (Federal Reserve Economic Data), including series metadata (seasonal adjustment, frequency, units) and time series observations (date, value, release date).

Key Features

Series Metadata: Returns complete series information including seasonal adjustment type, frequency, and units
Release Dates: Each observation includes its first release date (when the data was initially published)
Flexible Time Filtering: Choose to filter by observed_at (publish timestamp) or calendar date
Point-in-Time Data: Tracks when data was released, supporting historical analysis

Indicator Types Currently supported 34 indicators:

GDP: Gross Domestic Product
REAL_GDP: Real Gross Domestic Product (GDPC1)
REAL_GDP_PER_CAPITA: Real GDP Per Capita (A939RX0Q048SBEA)
INITIAL_CLAIMS: Initial Jobless Claims (ICSA)
UNEMPLOYMENT_RATE: Unemployment Rate (UNRATE)
TOTAL_NONFARM_PAYROLL: Total Nonfarm Payroll (PAYEMS)
FEDERAL_FUNDS: Federal Funds Effective Rate (FEDFUNDS)
CPI: Consumer Price Index (CPIAUCSL)
INFLATION_RATE_YOY: Inflation Rate YoY (FPCPITOTLZGUSA)
CORE_PPI: Core PPI - Final Demand Less Foods and Energy (PPIFES)
PPI_FINAL_DEMAND: PPI Final Demand (PPIFIS)
CONSUMER_SENTIMENT: Consumer Sentiment Index (UMCSENT)
CONSUMER_INFLATION_EXPECTATIONS: Consumer Inflation Expectations (MICH)
RETAIL_SALES: Retail Sales (RSXFS)
DURABLE_GOODS: Durable Goods Orders (DGORDER)
INDUSTRIAL_PRODUCTION: Industrial Production Index (INDPRO)
SMOOTHED_RECESSION_PROBABILITIES: Smoothed Recession Probabilities (RECPROUSM156N)
CORE_CPI: Core CPI - All Items Less Food and Energy (CPILFESL)
TIPS_5_YEAR: 5-Year Treasury Inflation-Indexed Security (DFII5)
TIPS_10_YEAR: 10-Year Treasury Inflation-Indexed Security (DFII10)
TIPS_20_YEAR: 20-Year Treasury Inflation-Indexed Security (DFII20)
TIPS_30_YEAR: 30-Year Treasury Inflation-Indexed Security (DFII30)
VIX: CBOE Volatility Index (VIXCLS)
TREASURY_YIELD_1_MONTH: 1-Month Treasury Constant Maturity Rate (DGS1MO)
TREASURY_YIELD_3_MONTH: 3-Month Treasury Constant Maturity Rate (DGS3MO)
TREASURY_YIELD_6_MONTH: 6-Month Treasury Constant Maturity Rate (DGS6MO)
TREASURY_YIELD_2_YEAR: 2-Year Treasury Constant Maturity Rate (DGS2)
TREASURY_YIELD_5_YEAR: 5-Year Treasury Constant Maturity Rate (DGS5)
TREASURY_YIELD_10_YEAR: 10-Year Treasury Constant Maturity Rate (DGS10)
TREASURY_YIELD_20_YEAR: 20-Year Treasury Constant Maturity Rate (DGS20)
TREASURY_YIELD_30_YEAR: 30-Year Treasury Constant Maturity Rate (DGS30)
GOLD_VIX: CBOE Gold ETF Volatility Index (GVZCLS)
CRUDE_OIL_VIX: CBOE Crude Oil ETF Volatility Index (OVXCLS)
RUSSELL_2000_VIX: CBOE Russell 2000 Volatility Index (RVXCLS)

Time Filter Types

OBSERVED_AT: Filter by observation publish timestamp (when data was released to FRED)
CALENDAR_START_DATE: Filter by the calendar date that the observation represents (e.g., 2024-01-01 for Q1 2024)
RELEASE_DATE: Filter by release/vintage date (when the data revision was published by FRED)

Response Structure The response contains two parts:

series: Metadata about the indicator (name, title, seasonal adjustment (e.g., “Seasonally Adjusted Annual Rate”, “Seasonally Adjusted”, “Not Seasonally Adjusted”), frequency, units, notes)
observations: Array of data points, each containing:
date: Calendar date of the observation (ISO 8601 format, e.g., “2024-01-01”)
value: Indicator value (double precision)
releaseDate: First release date in ISO 8601 format (e.g., “2024-04-25”)
observedAt: Observation publish timestamp (Unix timestamp in seconds, e.g., 1714041000)

Usage Examples

Get GDP data by observed_at (publish time): ?indicator_type=GDP&time_type=OBSERVED_AT&start_time=1704067200&end_time=1735689600
Get GDP data by calendar date: ?indicator_type=GDP&time_type=CALENDAR_START_DATE&start_time=1704067200&end_time=1735689600

Important Notes

All parameters are required (indicator_type, time_type, start_time, end_time)
Timestamps are Unix timestamps in seconds (UTC)
CALENDAR_START_DATE filter is recommended for most use cases
OBSERVED_AT filter is useful for tracking when data was published/updated
Release dates indicate when data first appeared (initial release, not revisions)
Seasonal adjustment info helps interpret the data correctly

GET

macro

economic-indicators

Get Economic Indicators

curl --request GET \
  --url https://data-tools.prd.arrays.org/api/v1/macro/economic-indicators \
  --header 'X-API-Key: <api-key>'

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://data-tools.prd.arrays.org/api/v1/macro/economic-indicators', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://data-tools.prd.arrays.org/api/v1/macro/economic-indicators",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://data-tools.prd.arrays.org/api/v1/macro/economic-indicators"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://data-tools.prd.arrays.org/api/v1/macro/economic-indicators")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "observations": [
        {
          "date": "2024-01-15",
          "observed_at": 1714041000,
          "release_date": "2024-04-25",
          "value": 28284.498
        }
      ],
      "series": {
        "frequency": "Quarterly",
        "name": "GDP",
        "notes": "<string>",
        "seasonal_adjustment": "Seasonally Adjusted Annual Rate",
        "title": "Gross Domestic Product",
        "units": "Billions of Dollars"
      }
    }
  ],
  "error": {
    "code": "RESOURCE_NOT_FOUND",
    "details": [
      {
        "field": "<string>",
        "got": "<string>",
        "reason": "<string>"
      }
    ],
    "docs_url": "<string>",
    "examples": [
      "<string>"
    ],
    "hint": "<string>",
    "message": "The requested resource was not found.",
    "suggestions": [
      "<string>"
    ]
  },
  "metadata": "<unknown>",
  "pagination": "<unknown>",
  "request_id": "<string>",
  "success": true
}

{
  "data": "<unknown>",
  "error": {
    "code": "RESOURCE_NOT_FOUND",
    "details": [
      {
        "field": "<string>",
        "got": "<string>",
        "reason": "<string>"
      }
    ],
    "docs_url": "<string>",
    "examples": [
      "<string>"
    ],
    "hint": "<string>",
    "message": "The requested resource was not found.",
    "suggestions": [
      "<string>"
    ]
  },
  "metadata": "<unknown>",
  "pagination": "<unknown>",
  "request_id": "<string>",
  "success": true
}

{
  "data": "<unknown>",
  "error": {
    "code": "RESOURCE_NOT_FOUND",
    "details": [
      {
        "field": "<string>",
        "got": "<string>",
        "reason": "<string>"
      }
    ],
    "docs_url": "<string>",
    "examples": [
      "<string>"
    ],
    "hint": "<string>",
    "message": "The requested resource was not found.",
    "suggestions": [
      "<string>"
    ]
  },
  "metadata": "<unknown>",
  "pagination": "<unknown>",
  "request_id": "<string>",
  "success": true
}

{
  "data": "<unknown>",
  "error": {
    "code": "RESOURCE_NOT_FOUND",
    "details": [
      {
        "field": "<string>",
        "got": "<string>",
        "reason": "<string>"
      }
    ],
    "docs_url": "<string>",
    "examples": [
      "<string>"
    ],
    "hint": "<string>",
    "message": "The requested resource was not found.",
    "suggestions": [
      "<string>"
    ]
  },
  "metadata": "<unknown>",
  "pagination": "<unknown>",
  "request_id": "<string>",
  "success": true
}

Authorizations

X-API-Key

string

header

required

API Key authentication. Example: "your-api-key-here"

Query Parameters

indicator_type

enum<string>

required

Indicator type (enum, required)

Available options:

GDP,

REAL_GDP,

REAL_GDP_PER_CAPITA,

INITIAL_CLAIMS,

UNEMPLOYMENT_RATE,

TOTAL_NONFARM_PAYROLL,

FEDERAL_FUNDS,

CPI,

INFLATION_RATE_YOY,

CORE_PPI,

PPI_FINAL_DEMAND,

CONSUMER_SENTIMENT,

CONSUMER_INFLATION_EXPECTATIONS,

RETAIL_SALES,

DURABLE_GOODS,

INDUSTRIAL_PRODUCTION,

SMOOTHED_RECESSION_PROBABILITIES,

CORE_CPI,

TIPS_5_YEAR,

TIPS_10_YEAR,

TIPS_20_YEAR,

TIPS_30_YEAR,

VIX,

TREASURY_YIELD_1_MONTH,

TREASURY_YIELD_3_MONTH,

TREASURY_YIELD_6_MONTH,

TREASURY_YIELD_2_YEAR,

TREASURY_YIELD_5_YEAR,

TREASURY_YIELD_10_YEAR,

TREASURY_YIELD_20_YEAR,

TREASURY_YIELD_30_YEAR,

GOLD_VIX,

CRUDE_OIL_VIX,

RUSSELL_2000_VIX

time_type

enum<string>

required

Time filter type (enum, required)

Available options:

OBSERVED_AT,

CALENDAR_START_DATE,

RELEASE_DATE

start_time

integer<int64>

required

Start time (Unix timestamp in seconds)

end_time

integer<int64>

required

End time (Unix timestamp in seconds)

Response

Successfully retrieved economic indicators

data

object[]

Show child attributes

error

object

Show child attributes

metadata

any

pagination

any

request_id

string

success

boolean