Skip to content

EarningsTranscriptQueryOptions ​

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

Defined in: src/sources/hftranscripts.urls.ts (declaration: sources/hftranscripts.urls.d.ts:27)

Options for one earnings-transcript query against datasets-server.

Extends ​

Properties ​

allowCrossOriginRedirects? ​

readonly optional allowCrossOriginRedirects?: boolean

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

Allows a redirect to leave the requested origin even when a caller User-Agent, sensitive query parameter, request body, or extra header would otherwise refuse it. File downloads need this: catalogs mint a short-lived token on their own host and redirect to a CDN. A redirect into a private network address is still refused.

Inherited from ​

SourceFetchOptions.allowCrossOriginRedirects


dataset? ​

readonly optional dataset?: HfDatasetRef

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

Override the queried dataset with a schema-compatible mirror.


fetch? ​

readonly optional fetch?: SourceFetch

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

Inherited from ​

SourceFetchOptions.fetch


limit? ​

readonly optional limit?: number

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

Inherited from ​

SourceFetchOptions.limit


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


msrbAcceptTermsOfUse? ​

readonly optional msrbAcceptTermsOfUse?: boolean

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

MSRB EMMA gates data behind a Terms-of-Use acceptance cookie. Accepting those terms (https://emma.msrb.org) is the caller's act: without this flag, EMMA requests fail closed with a config error instead of the library accepting on the caller's behalf.

Inherited from ​

SourceFetchOptions.msrbAcceptTermsOfUse


offset? ​

readonly optional offset?: number

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

Row offset for paging beyond the first limit transcripts.


quarter? ​

readonly optional quarter?: number

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

Fiscal quarter 1-4 as labeled by the dataset.


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


secUserAgent? ​

readonly optional secUserAgent?: string

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

Inherited from ​

SourceFetchOptions.secUserAgent


signal? ​

readonly optional signal?: AbortSignal

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

Inherited from ​

SourceFetchOptions.signal


since? ​

readonly optional since?: string | Date

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

Inherited from ​

SourceFetchOptions.since


timeoutMs? ​

readonly optional timeoutMs?: number

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

Inherited from ​

SourceFetchOptions.timeoutMs


until? ​

readonly optional until?: string | Date

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

Inherited from ​

SourceFetchOptions.until


userAgent? ​

readonly optional userAgent?: string

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

Inherited from ​

SourceFetchOptions.userAgent


year? ​

readonly optional year?: number

Defined in: src/sources/hftranscripts.urls.ts (declaration: sources/hftranscripts.urls.d.ts:29)

Fiscal year as labeled by the dataset, e.g. 2024.

Last updated:

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