Class ImfClient

constructor

• new ImfClient(config?: ImfClientConfig): ImfClient

  Parameters

  • config: ImfClientConfig = {}

  Returns ImfClient

ReadonlydatamapperBaseURL

ReadonlysdmxBaseURL

Readonlytimeout

ReadonlymaxRetries

ReadonlyweoVintage

ReadonlyuserAgent

ReadonlysdmxSubscriptionKey

getWeoIndicator

• getWeoIndicator(
      iso3: string,
      weoCode: string,
      years?: number,
  ): Promise<ImfDataPoint[]>

  Fetch a WEO time series for one country via the Datamapper.

  Parameters

  • iso3: string

    ISO-3 alpha-3 country code (Datamapper native format)

  • weoCode: string

    WEO indicator code (see IMF_WEO_INDICATORS)

  • years: number = 10

    How many most-recent years to return (default 10)

  Returns Promise<ImfDataPoint[]>

listDatamapperIndicators

• listDatamapperIndicators(): Promise<Map<string, ImfDatamapperIndicatorMeta>>

  Fetch the IMF Datamapper indicator catalog (~132 entries). Use to discover any of the Datamapper-addressable indicators at runtime. Codes outside the catalog require sdmxFetch.

  Returns Promise<Map<string, ImfDatamapperIndicatorMeta>>

getWeoIndicatorsBatch

• getWeoIndicatorsBatch(
      iso3: string,
      weoCodes: readonly string[],
      years?: number,
  ): Promise<Map<string, readonly ImfDataPoint[]>>

  Fetch several WEO indicators for the same country sequentially. Failures on individual indicators map to an empty array so a single flaky series does not poison the whole batch.

  Parameters

  • iso3: string
  • weoCodes: readonly string[]
  • years: number = 10

  Returns Promise<Map<string, readonly ImfDataPoint[]>>

getLatestWeoIndicator

• getLatestWeoIndicator(iso3: string, weoCode: string): Promise<ImfDataPoint>

  Fetch the latest available data point for one country. Returns the most recent historical value when available, otherwise the most recent projection.

  Parameters

  • iso3: string
  • weoCode: string

  Returns Promise<ImfDataPoint>

compareCountriesWeo

• compareCountriesWeo(
      iso3Codes: readonly string[],
      weoCode: string,
  ): Promise<Map<string, ImfDataPoint>>

  Compare an indicator across multiple countries. Fetches sequentially to respect IMF rate limits. Unknown / failed countries map to null.

  Parameters

  • iso3Codes: readonly string[]
  • weoCode: string

  Returns Promise<Map<string, ImfDataPoint>>

sdmxFetch

• sdmxFetch(pathWithQuery: string): Promise<unknown>

  Low-level SDMX 3.0 passthrough. Returns the raw JSON envelope. Includes the Ocp-Apim-Subscription-Key header iff sdmxSubscriptionKey is set.

  Parameters

  • pathWithQuery: string

  Returns Promise<unknown>