DtccFetchOptions

Import from: @xbbg/xnews

Defined in: src/sources/dtcc.ts (declaration: sources/dtcc.d.ts:48)

Transport options for one data-release fetch. ifNewerThan is a skip hint, not a filter: a source MAY resolve undefined without dialing its heavy endpoints when it can cheaply determine the current release is not strictly newer than this ISO date. createDataReleaseWatcher passes the last yielded asOf here so multi-megabyte sources (e.g. FFIEC bulk zips) are not re-downloaded every poll. Sources are free to ignore it.

Extends

• DataFetchOptions
• DtccUrlOptions

Properties

afterSequence?

readonly optional afterSequence?: number

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

Exclusive lower bound for sequenced datasets: return the earliest release whose sequence is strictly greater, or undefined when the consumer is caught up. Without it a sequenced source returns its latest release. createDataReleaseWatcher passes the last yielded sequence here so a backlog is consumed in order and without gaps. Sources that publish one release per asOf ignore it.

Inherited from

DataFetchOptions.afterSequence

---

agency?

readonly optional agency?: "cftc" | "sec"

Defined in: src/sources/dtcc.ts (declaration: sources/dtcc.d.ts:50)

Reporting regime; defaults to "cftc".

---

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

DataFetchOptions.allowCrossOriginRedirects

---

assetClass?

readonly optional assetClass?: "credits" | "rates" | "equities" | "forex" | "commodities"

Defined in: src/sources/dtcc.ts (declaration: sources/dtcc.d.ts:52)

Asset class; defaults to "credits".

---

dataBaseUrl?

readonly optional dataBaseUrl?: string

Defined in: src/sources/dtcc.urls.ts (declaration: sources/dtcc.urls.d.ts:46)

Overrides DTCC_DATA_BASE_URL (no trailing slash).

Inherited from

DtccUrlOptions.dataBaseUrl

---

fetch?

readonly optional fetch?: SourceFetch

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

Inherited from

DataFetchOptions.fetch

---

ifNewerThan?

readonly optional ifNewerThan?: string

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

Inherited from

DataFetchOptions.ifNewerThan

---

limit?

readonly optional limit?: number

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

Inherited from

DataFetchOptions.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

DataFetchOptions.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

DataFetchOptions.msrbAcceptTermsOfUse

---

ppdApiBaseUrl?

readonly optional ppdApiBaseUrl?: string

Defined in: src/sources/dtcc.urls.ts (declaration: sources/dtcc.urls.d.ts:44)

Overrides DTCC_PPD_API_BASE_URL (no trailing slash).

Inherited from

DtccUrlOptions.ppdApiBaseUrl

---

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

DataFetchOptions.redirect

---

secUserAgent?

readonly optional secUserAgent?: string

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

Inherited from

DataFetchOptions.secUserAgent

---

signal?

readonly optional signal?: AbortSignal

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

Inherited from

DataFetchOptions.signal

---

since?

readonly optional since?: string | Date

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

Inherited from

DataFetchOptions.since

---

timeoutMs?

readonly optional timeoutMs?: number

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

Inherited from

DataFetchOptions.timeoutMs

---

until?

readonly optional until?: string | Date

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

Inherited from

DataFetchOptions.until

---

userAgent?

readonly optional userAgent?: string

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

Inherited from

DataFetchOptions.userAgent