Skip to content

FredSeriesSearchOptions ​

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

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

Extends ​

Properties ​

apiKey ​

readonly apiKey: string

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

Inherited from ​

FredRequestOptions.apiKey


excludeTagNames? ​

readonly optional excludeTagNames?: string | readonly string[]

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


fetch? ​

readonly optional fetch?: SourceFetch

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

Inherited from ​

SourceFetchOptions.fetch


filterValue? ​

readonly optional filterValue?: string

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


filterVariable? ​

readonly optional filterVariable?: FredSeriesFilterVariable

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


limit? ​

readonly optional limit?: number

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


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


offset? ​

readonly optional offset?: number

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


orderBy? ​

readonly optional orderBy?: FredSeriesSearchOrderBy

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


realtimeEnd? ​

readonly optional realtimeEnd?: FredDate

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


realtimeStart? ​

readonly optional realtimeStart?: FredDate

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


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


searchType? ​

readonly optional searchType?: FredSeriesSearchType

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


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:21)


tagNames? ​

readonly optional tagNames?: string | readonly string[]

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


timeoutMs? ​

readonly optional timeoutMs?: number

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

Inherited from ​

SourceFetchOptions.timeoutMs


userAgent? ​

readonly optional userAgent?: string

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

Inherited from ​

SourceFetchOptions.userAgent

Last updated:

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