Header menu logo FSharp.Data.Fred

Series Type

Namespace: FSharp.Data.Fred
Assembly: FSharp.Data.Fred.dll
Base Type: obj

A data series.

Constructors

Constructor Description

Series(key)

Full Usage: Series(key)

Parameters:
    key : string

Returns: Series
key : string
Returns: Series

Instance members

Instance member Description

this.Categories

Full Usage: this.Categories

Parameters:
    id : string - The id for a series. String, required.
    ?realtimeStart : DateTime - The start of the real-time period. For more information, see Real-Time Periods. `DateTime(yyyy,MM,dd)` formatted `DateTime`, optional, default: today's date.
    ?realtimeEnd : DateTime - The start of the real-time period. For more information, see Real-Time Periods. Optional, default: today's date.

Returns: CategoriesResponse A collection of the series categories.

Get the categories for an economic data series.

id : string

The id for a series. String, required.

?realtimeStart : DateTime

The start of the real-time period. For more information, see Real-Time Periods. `DateTime(yyyy,MM,dd)` formatted `DateTime`, optional, default: today's date.

?realtimeEnd : DateTime

The start of the real-time period. For more information, see Real-Time Periods. Optional, default: today's date.

Returns: CategoriesResponse

A collection of the series categories.

this.Info

Full Usage: this.Info

Parameters:
    id : string - The id for a series. String, required.

Returns: InfoResponse The information for an economic data series.

Get the information for an economic data series.

id : string

The id for a series. String, required.

Returns: InfoResponse

The information for an economic data series.

this.Observations

Full Usage: this.Observations

Parameters:
    id : string - The id for a series. String, required.
    ?observationStart : DateTime - The start of the observation period. Optional, default: DateTime(1776,07,04) (earliest available).
    ?observationEnd : DateTime - The end of the observation period. Optional, default: DateTime(9999,12,31) (latest available).
    ?limit : int - The maximum number of results to return. integer between `1` and `1000`, optional, default: `1000`.
    ?sortOrder : SortOrder - Sort results is ascending or descending observation date order. optional, default: asc.
    ?units : Units - A key that indicates a data value transformation. Optional, default: Levels (No transformation). See unit transformation formulas here.
    ?frequency : Frequency - An optional parameter that indicates a lower frequency to aggregate values to. The FRED 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 FRED, 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 here.
    ?aggMethod : AggMethod - A key that indicates the aggregation method used for frequency aggregation. This parameter has no affect if the frequency parameter is not set. Optional, default: AggMethod.Average.
    ?realtimeStart : DateTime - The start of the real-time period, "when facts were true or when information was known until it changed." For more information, see Real-time periods. DateTime(yyyy,MM,dd) formatted DateTime, optional, default: today's date.
    ?realtimeEnd : DateTime - The start of the real-time period, "when facts were true or when information was known until it changed." For more information, see Real-time periods. Optional, default: today's date.

Returns: ObservationsResponse Observations or data values for an economic data series.

Get the observations or data values for an economic data series.

id : string

The id for a series. String, required.

?observationStart : DateTime

The start of the observation period. Optional, default: DateTime(1776,07,04) (earliest available).

?observationEnd : DateTime

The end of the observation period. Optional, default: DateTime(9999,12,31) (latest available).

?limit : int

The maximum number of results to return. integer between `1` and `1000`, optional, default: `1000`.

?sortOrder : SortOrder

Sort results is ascending or descending observation date order. optional, default: asc.

?units : Units

A key that indicates a data value transformation. Optional, default: Levels (No transformation). See unit transformation formulas here.

?frequency : Frequency

An optional parameter that indicates a lower frequency to aggregate values to. The FRED 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 FRED, 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 here.

?aggMethod : AggMethod

A key that indicates the aggregation method used for frequency aggregation. This parameter has no affect if the frequency parameter is not set. Optional, default: AggMethod.Average.

?realtimeStart : DateTime

The start of the real-time period, "when facts were true or when information was known until it changed." For more information, see Real-time periods. DateTime(yyyy,MM,dd) formatted DateTime, optional, default: today's date.

?realtimeEnd : DateTime

The start of the real-time period, "when facts were true or when information was known until it changed." For more information, see Real-time periods. Optional, default: today's date.

Returns: ObservationsResponse

Observations or data values for an economic data series.

this.Release

Full Usage: this.Release

Parameters:
    id : string - The id for a series. String, required.
    ?realtimeStart : DateTime - The start of the real-time period. For more information, see Real-Time Periods. Optional, default: today's date.
    ?realtimeEnd : DateTime - The start of the real-time period. For more information, see Real-Time Periods. Optional, default: today's date.

Returns: ReleaseResponse A collection of fields describing the series release.

Get the release for an economic data series.

id : string

The id for a series. String, required.

?realtimeStart : DateTime

The start of the real-time period. For more information, see Real-Time Periods. Optional, default: today's date.

?realtimeEnd : DateTime

The start of the real-time period. For more information, see Real-Time Periods. Optional, default: today's date.

Returns: ReleaseResponse

A collection of fields describing the series release.

this.Search

Full Usage: this.Search

Parameters:
    searchText : string - The words to match against economic data series.
    ?searchType : SearchType - Determines the type of search to perform. Default is FullText
    ?realtimeStart : DateTime - The start of the real-time period. For more information, see Real-Time Periods. Optional, default: today's date.
    ?realtimeEnd : DateTime - The start of the real-time period. For more information, see Real-Time Periods. Optional, default: today's date.
    ?limit : int - The maximum number of results to return. integer between `1` and `1000`, optional, default: `1000`.
    ?orderBy : SearchOrder - Order results by values of the specified attribute. Optional, default: If the search type is FullText then the default order is SearchRank. If the value of search type is SeriesIdOrder.
    ?sortOrder : SortOrder - Sort results is ascending or descending order for attribute values. Optional, default: If order by is SearchRank or Popularity then the default descending, otherwise the default is ascending.

Returns: Search A collection of economic data series that match the parameters.

Get economic data series that match search text.

searchText : string

The words to match against economic data series.

?searchType : SearchType

Determines the type of search to perform. Default is FullText

?realtimeStart : DateTime

The start of the real-time period. For more information, see Real-Time Periods. Optional, default: today's date.

?realtimeEnd : DateTime

The start of the real-time period. For more information, see Real-Time Periods. Optional, default: today's date.

?limit : int

The maximum number of results to return. integer between `1` and `1000`, optional, default: `1000`.

?orderBy : SearchOrder

Order results by values of the specified attribute. Optional, default: If the search type is FullText then the default order is SearchRank. If the value of search type is SeriesIdOrder.

?sortOrder : SortOrder

Sort results is ascending or descending order for attribute values. Optional, default: If order by is SearchRank or Popularity then the default descending, otherwise the default is ascending.

Returns: Search

A collection of economic data series that match the parameters.

this.Tags

Full Usage: this.Tags

Parameters:
    id : string - The id for a series. String, required.
    ?realtimeStart : DateTime - The start of the real-time period. For more information, see Real-Time Periods. Optional, default: today's date.
    ?realtimeEnd : DateTime - The end of the real-time period. For more information, see Real-Time Periods. Optional, default: today's date.
    ?orderBy : OrderByTags - Order results by values of the specified attribute. Optional, default: SeriesCount.
    ?sortOrder : SortOrder - Sort results is ascending or descending order. Optional, default is ascending.

Returns: TagsResponse

Get the FRED tags for a series.

id : string

The id for a series. String, required.

?realtimeStart : DateTime

The start of the real-time period. For more information, see Real-Time Periods. Optional, default: today's date.

?realtimeEnd : DateTime

The end of the real-time period. For more information, see Real-Time Periods. Optional, default: today's date.

?orderBy : OrderByTags

Order results by values of the specified attribute. Optional, default: SeriesCount.

?sortOrder : SortOrder

Sort results is ascending or descending order. Optional, default is ascending.

Returns: TagsResponse

Type something to start searching.