Skip to content

FredObservationsOptions ​

Import from: @xbbg/xnews, @xbbg/xnews/catalog

Defined in: src/sources/fred.urls.ts (declaration: sources/fred.urls.d.ts:31)

Extends ​

Properties ​

aggregationMethod? ​

readonly optional aggregationMethod?: FredAggregationMethod

Defined in: src/sources/fred.urls.ts (declaration: sources/fred.urls.d.ts:41)


apiKey ​

readonly apiKey: string

Defined in: src/sources/fred.urls.ts (declaration: sources/fred.urls.d.ts:12)

Inherited from ​

FredRequestOptions.apiKey


fetch? ​

readonly optional fetch?: SourceFetch

Defined in: src/types.ts (declaration: types.d.ts:88)

Inherited from ​

SourceFetchOptions.fetch


frequency? ​

readonly optional frequency?: FredFrequency

Defined in: src/sources/fred.urls.ts (declaration: sources/fred.urls.d.ts:40)


limit? ​

readonly optional limit?: number

Defined in: src/sources/fred.urls.ts (declaration: sources/fred.urls.d.ts:34)


maxResponseBytes? ​

readonly optional maxResponseBytes?: number

Defined in: src/types.ts (declaration: types.d.ts:92)

Maximum response body size in bytes; defaults to 32 MiB.

Inherited from ​

SourceFetchOptions.maxResponseBytes


observationEnd? ​

readonly optional observationEnd?: FredDate

Defined in: src/sources/fred.urls.ts (declaration: sources/fred.urls.d.ts:38)


observationStart? ​

readonly optional observationStart?: FredDate

Defined in: src/sources/fred.urls.ts (declaration: sources/fred.urls.d.ts:37)


offset? ​

readonly optional offset?: number

Defined in: src/sources/fred.urls.ts (declaration: sources/fred.urls.d.ts:35)


realtimeEnd? ​

readonly optional realtimeEnd?: FredDate

Defined in: src/sources/fred.urls.ts (declaration: sources/fred.urls.d.ts:33)


realtimeStart? ​

readonly optional realtimeStart?: FredDate

Defined in: src/sources/fred.urls.ts (declaration: sources/fred.urls.d.ts:32)


redirect? ​

readonly optional redirect?: RequestRedirect

Defined in: src/types.ts (declaration: types.d.ts:97)

Redirect semantics enforced by xnews. "follow" (default) revalidates policy on at most ten hops; the injected fetch receives "manual".

Inherited from ​

SourceFetchOptions.redirect


signal? ​

readonly optional signal?: AbortSignal

Defined in: src/types.ts (declaration: types.d.ts:89)

Inherited from ​

SourceFetchOptions.signal


sortOrder? ​

readonly optional sortOrder?: FredSortOrder

Defined in: src/sources/fred.urls.ts (declaration: sources/fred.urls.d.ts:36)


timeoutMs? ​

readonly optional timeoutMs?: number

Defined in: src/types.ts (declaration: types.d.ts:90)

Inherited from ​

SourceFetchOptions.timeoutMs


units? ​

readonly optional units?: FredUnits

Defined in: src/sources/fred.urls.ts (declaration: sources/fred.urls.d.ts:39)


userAgent? ​

readonly optional userAgent?: string

Defined in: src/types.ts (declaration: types.d.ts:106)

Inherited from ​

SourceFetchOptions.userAgent


vintageDates? ​

readonly optional vintageDates?: string | readonly FredDate[]

Defined in: src/sources/fred.urls.ts (declaration: sources/fred.urls.d.ts:42)

Last updated:

xbbg is independent open-source software and is not affiliated with, endorsed by, sponsored by, or approved by Bloomberg Finance L.P.