fred/category/series

Description
Example
- Request
- Response
Parameters
- api_key
- category_id
- realtime_start
- realtime_end
- limit
- offset
- order_by
- sort_order
- filter_variable
- filter_value

Description

Get the series in a category.

Example

Request (HTTP GET)

http://api.stlouisfed.org/fred/category/series?category_id=125&api_key=abcdefghijklmnopqrstuvwxyz123456

Note that API key 'abcdefghijklmnopqrstuvwxyz123456' is for demonstration purposes only. Use a registered API key instead.

Response

<?xml version="1.0" encoding="utf-8" ?>
<seriess realtime_start="2008-07-21" realtime_end="2008-07-21" order_by="series_id" sort_order="asc" count="9" offset="0" limit="1000">
  <series id="BOPBCA" realtime_start="2008-07-21" realtime_end="2008-07-21" title="Balance on Current Account" observation_start="1960-01-01" observation_end="2007-10-01" frequency="Quarterly" frequency_short="Q" units="Billions of Dollars" units_short="Bil. of $" seasonal_adjustment="Seasonally Adjusted" seasonal_adjustment_short="SA" last_updated="2008-03-17 10:02:13-05"/>
  <series id="BOPBGS" realtime_start="2008-07-21" realtime_end="2008-07-21" title="Balance on Goods and Services" observation_start="1960-01-01" observation_end="2007-10-01" frequency="Quarterly" frequency_short="Q" units="Billions of Dollars" units_short="Bil. of $" seasonal_adjustment="Seasonally Adjusted" seasonal_adjustment_short="SA" last_updated="2008-03-17 10:03:35-05"/>
  <series id="BOPBII" realtime_start="2008-07-21" realtime_end="2008-07-21" title="Balance on Investment Income" observation_start="1960-01-01" observation_end="2007-10-01" frequency="Quarterly" frequency_short="Q" units="Billions of Dollars" units_short="Bil. of $" seasonal_adjustment="Seasonally Adjusted" seasonal_adjustment_short="SA" last_updated="2008-03-17 10:01:34-05"/>
  <series id="BOPBM" realtime_start="2008-07-21" realtime_end="2008-07-21" title="Balance on Merchandise Trade" observation_start="1960-01-01" observation_end="2007-10-01" frequency="Quarterly" frequency_short="Q" units="Billions of Dollars" units_short="Bil. of $" seasonal_adjustment="Seasonally Adjusted" seasonal_adjustment_short="SA" last_updated="2008-03-17 10:02:35-05"/>
  <series id="BOPBSV" realtime_start="2008-07-21" realtime_end="2008-07-21" title="Balance on Services" observation_start="1960-01-01" observation_end="2007-10-01" frequency="Quarterly" frequency_short="Q" units="Billions of Dollars" units_short="Bil. of $" seasonal_adjustment="Seasonally Adjusted" seasonal_adjustment_short="SA" last_updated="2008-03-17 10:03:41-05"/>
  <series id="BOPG" realtime_start="2008-07-21" realtime_end="2008-07-21" title="Unilateral Transfers, Net" observation_start="1960-01-01" observation_end="2007-10-01" frequency="Quarterly" frequency_short="Q" units="Billions of Dollars" units_short="Bil. of $" seasonal_adjustment="Seasonally Adjusted" seasonal_adjustment_short="SA" last_updated="2008-03-17 10:01:32-05"/>
  <series id="BOPGSTB" realtime_start="2008-07-21" realtime_end="2008-07-21" title="Trade Balance: Goods and Services, Balance of Payments Basis" observation_start="1992-01-01" observation_end="2008-02-01" frequency="Monthly" frequency_short="M" units="Millions of Dollars" units_short="Mil. of $" seasonal_adjustment="Seasonally Adjusted" seasonal_adjustment_short="SA" last_updated="2008-04-10 11:47:54-05"/>
  <series id="BOPGTB" realtime_start="2008-07-21" realtime_end="2008-07-21" title="Trade Balance: Goods, Balance of Payments Basis" observation_start="1992-01-01" observation_end="2008-02-01" frequency="Monthly" frequency_short="M" units="Millions of Dollars" units_short="Mil. of $" seasonal_adjustment="Seasonally Adjusted" seasonal_adjustment_short="SA" last_updated="2008-04-10 11:50:40-05"/>
  <series id="BOPSTB" realtime_start="2008-07-21" realtime_end="2008-07-21" title="Trade Balance: Services, Balance of Payments Basis" observation_start="1992-01-01" observation_end="2008-02-01" frequency="Monthly" frequency_short="M" units="Millions of Dollars" units_short="Mil. of $" seasonal_adjustment="Seasonally Adjusted" seasonal_adjustment_short="SA" last_updated="2008-04-10 11:47:58-05"/>
</seriess>

The series tag's notes attribute is optional.

Parameters

api_key

Read API Keys for more information.

32 character alpha-numeric lowercase string, required

category_id

The id for a category.

integer, required

realtime_start

The start of the real-time period. For more information, see Real-Time Periods.

YYYY-MM-DD formatted string, optional, default: today's date

realtime_end

The end of the real-time period. For more information, see Real-Time Periods.

YYYY-MM-DD formatted string, optional, default: today's date

limit

The maximum number of results to return.

integer between 1 and 1000, optional, default: 1000

offset

non-negative integer, optional, default: 0

order_by

Order results by values of the specified attribute.

One of the following strings: 'series_id', 'title', 'units', 'frequency', 'seasonal_adjustment', 'realtime_start', 'realtime_end', 'last_updated', 'observation_start', 'observation_end'.
optional, default: series_id

sort_order

Sort results is ascending or descending order for attribute values specified by order_by.

One of the following strings: 'asc', 'desc'.
optional, default: asc

filter_variable

The attribute to filter results by.

On of the following strings: 'frequency', 'units', 'seasonal_adjustment'.
optional, no filter by default

filter_value

The value of the filter_variable attribute to filter results by.

String, optional, no filter by default