A Step By Step TM3 Client File Store (CFS) File API using Data Library for TypeScript

• version: 1.0.0
• Last update: August 2025
• Environment: NodeJS version 22+

Example Code Disclaimer: ALL EXAMPLE CODE IS PROVIDED ON AN “AS IS” AND “AS AVAILABLE” BASIS FOR ILLUSTRATIVE PURPOSES ONLY. LSEG MAKES NO REPRESENTATIONS OR WARRANTIES OF ANY KIND, EXPRESS OR IMPLIED, AS TO THE OPERATION OF THE EXAMPLE CODE, OR THE INFORMATION, CONTENT, OR MATERIALS USED IN CONNECTION WITH THE EXAMPLE CODE. YOU EXPRESSLY AGREE THAT YOUR USE OF THE EXAMPLE CODE IS AT YOUR SOLE RISK.

Introduction

This example demonstrates how to use TypeScript with LSEG Data Library for TypeScript Delivery Layer to retrieve the Municipal Market Monitor (TM3) bulk file via the Delivery Platform—also known as the Data Platform or RDP.

This is just a basic examples for my personal learning on LSEG Data Library for TypeScript.

Please note that this code is intended for demonstration purposes only and is not optimized for production use.

Prerequisite

This example requires the following dependencies.

1. Node.js version 22+.
2. RDP access credential.
3. Internet connection.

Please contact your LSEG representative to help you to access the RDP account.

How to run the demo application

The first step is to unzip or download the example project folder into a directory of your choice, then set up the environment by the steps below.

Run the demo Console application

1. Create a file name .env inside a folder with the following content

   MACHINE_ID=<RDP Username>
   PASSWORD=<RDP Password>
   APP_KEY=<RDP App Key>
   PACKAGE_ID=<Your Bulk Package ID>

2. Run the following node command to set up a project

   npm install

3. Once the project set up process is succeed, run the following command to build the code

   npm run build

4. Then run the following command to start an application

   npm run start

5. The TM3 bulk file will be downloaded to \dist folder.