tradermade-sdk-nodejs 1.0.0

package/README.md

@@ -0,0 +1,113 @@
+# TraderMade Node.js SDK
+
+Official Node.js client library for the TraderMade Data API.
+
+## 🚀 Installation
+
+Install the package via npm:
+
+```bash
+npm install tradermade-sdk-nodejs
+
+```
+
+## 🔑 Getting Started
+
+First, import the library and initialize the client with your API key.
+
+```javascript
+import TraderMade from 'tradermade-sdk-nodejs';
+
+const tm = new TraderMade();
+tm.setRestApiKey(process.env.TRADERMADE_API_KEY);
+
+```
+
+---
+
+## 📚 Usage Examples
+
+After creating the client, making calls to the TraderMade API is easy. Below are examples for fetching different types of market data.
+
+### 1. Get Historical Tick Data
+
+Fetch raw tick data for a specific currency pair and time range.
+
+```javascript
+import TraderMade from 'tradermade-nodejs-sdk';
+
+const tm = new TraderMade();
+tm.setRestApiKey(process.env.TRADERMADE_API_KEY);
+
+async function example_GetHistoricalTickData() {
+    try {
+        const data = await tm.getHistoricalTickData(
+            "GBPUSD",
+            "2026-01-12 15:00",
+            "2026-01-12 15:30"
+        );
+        console.log(data);
+    } catch (error) {
+        console.error(error);
+    }
+}
+
+example_GetHistoricalTickData();
+
+```
+
+### 2. Get Minute Historical Data
+
+Retrieve OHLC (Open, High, Low, Close) data for a specific minute.
+
+```javascript
+import TraderMade from 'tradermade-nodejs-sdk';
+
+const tm = new TraderMade();
+tm.setRestApiKey(process.env.TRADERMADE_API_KEY);
+
+async function example_GetMinuteHistoricalData() {
+    try {
+        const data = await tm.getMinuteHistoricalData(
+            "2019-10-10-13:24",
+            "EURUSD"
+        );
+        console.log(data);
+    } catch (error) {
+        console.error(error);
+    }
+}
+
+example_GetMinuteHistoricalData();
+
+```
+
+### 3. Get Time Series Data
+
+Fetch daily time series data for analysis.
+
+```javascript
+import TraderMade from 'tradermade-nodejs-sdk';
+
+const tm = new TraderMade();
+tm.setRestApiKey(process.env.TRADERMADE_API_KEY);
+
+async function example_GetTimeSeriesData() {
+    try {
+        const data = await tm.getTimeSeriesData(
+            "EURUSD",
+            "2026-01-08",
+            "2026-01-10",
+            "daily",
+            "1",
+            "records"
+        );
+        console.log(data);
+    } catch (error) {
+        console.error(error);
+    }
+}
+
+example_GetTimeSeriesData();
+
+```

package/index.js

@@ -0,0 +1,218 @@
+import "dotenv/config";
+import { Client } from "./src/client.js";
+import {
+  TIME_SERIES_FORMAT,
+  TIME_SERIES_INTERVAL,
+  TIME_SERIES_PERIOD,
+  DATA_EXPORTS_PANDAS_DF_FIELDS,
+  DATA_EXPORTS_PANDAS_DF_FORMAT,
+} from "./src/constants.js";
+
+class TraderMade {
+  constructor() {
+    this.apiKey = null;
+    this.client = null;
+  }
+
+  _validateApiKey(apiKey) {
+    if (typeof apiKey !== "string" || apiKey.trim() === "") {
+      throw new Error("Api key must be a non empty string.");
+    }
+  }
+
+  //Set Rest api key
+  setRestApiKey(apiKey) {
+    this._validateApiKey(apiKey);
+    this.apiKey = apiKey;
+    this.client = new Client(apiKey);
+  }
+
+  //Get Rest api key
+  getRestApiKey() {
+    return this.apiKey;
+  }
+
+  //Get Live Exchange Rates​
+  async getLiveExchangeRates() {
+    const data = await this.client.get("/live");
+    return data;
+  }
+
+  //Get List of Live Currencies​
+  async getLiveCurrencyList() {
+    const data = await this.client.get("/live_currencies_list");
+    return data;
+  }
+
+  //Get List of Streaming Instruments​
+  async getStreamCurrencyList() {
+    const data = await this.client.get("/streaming_currencies_list");
+    return data;
+  }
+
+  //Get List of Live Cryptocurrencies​
+  async getCryptoList() {
+    const data = await this.client.get("/live_crypto_list");
+    return data;
+  }
+
+  //Get List of Historical Currencies​
+  async getHistoricalCurrencyList() {
+    const data = await this.client.get("/historical_currencies_list");
+    return data;
+  }
+
+  //Get List of Available CFDs​
+  async getCfdList() {
+    const data = await this.client.get("/cfd_list");
+    return data;
+  }
+
+  //Get Historical Exchange Rates​
+  async getHistoricalExchangeRates(date, currency) {
+    if (!date || !currency) {
+      throw new Error("date_time,currency are required.");
+    }
+
+    const data = await this.client.get("/historical", {
+      currency,
+      date,
+    });
+    return data;
+  }
+
+  //Get Hourly Historical Data​
+  async getHourlyHistoricalData(date_time, currency) {
+    if (!date_time || !currency) {
+      throw new Error("date_time,currency are required.");
+    }
+
+    const data = await this.client.get("/hour_historical", {
+      date_time,
+      currency,
+    });
+    return data;
+  }
+
+  //Get Minute Historical Data​
+  async getMinuteHistoricalData(date_time, currency) {
+    if (!date_time || !currency) {
+      throw new Error("date_time,currency are required.");
+    }
+    const data = await this.client.get("/minute_historical", {
+      date_time,
+      currency,
+    });
+    return data;
+  }
+
+  //Get Historical Tick Data​
+  async getHistoricalTickData(symbol, startDate, endDate) {
+    if (!symbol || !startDate || !endDate) {
+      throw new Error("symbol, startDate and endDate are required.");
+    }
+    const start = encodeURIComponent(startDate);
+    const end = encodeURIComponent(endDate);
+    const data = await this.client.get(
+      `/tick_historical/${symbol}/${start}/${end}`,
+      { format: "json" }
+    );
+    return data;
+  }
+
+  async getHistoricalTickDataSample(symbol, startDate, endDate) {
+    if (!symbol || !startDate || !endDate) {
+      throw new Error("Symbol,startDateTime and endDateTime are required.");
+    }
+    const startDateAndTime = encodeURIComponent(startDate);
+    const endDateAndTime = encodeURIComponent(endDate);
+    const data = await this.client.get(
+      `/tick_historical_sample/${symbol}/${startDateAndTime}/${endDateAndTime}`,
+      { format: "json" }
+    );
+    return data;
+  }
+
+  //Get Time Series Data
+  async getTimeSeriesData(
+    currency,
+    startDate,
+    endDate,
+    interval,
+    period,
+    format
+  ) {
+    if (!TIME_SERIES_FORMAT.includes(format)) {
+      throw new Error(
+        `Invalid format.Please use one of : ${TIME_SERIES_FORMAT}`
+      );
+    }
+    if (!TIME_SERIES_INTERVAL.includes(interval)) {
+      throw new Error(
+        `Invalid interval.Please use one of : ${TIME_SERIES_INTERVAL}`
+      );
+    }
+    const periodNum = Number(period);
+    if (!TIME_SERIES_PERIOD[interval]?.includes(periodNum)) {
+      throw new Error(
+        `Invalid period.Please use one of : ${TIME_SERIES_PERIOD[interval].join(
+          ", "
+        )} `
+      );
+    }
+    const data = await this.client.get("/timeseries", {
+      currency,
+      start_date: startDate,
+      end_date: endDate,
+      interval,
+      period: periodNum,
+      format,
+    });
+    return data;
+  }
+
+  //Get Market Open Status
+  async getOpenMarketStatus() {
+    const data = await this.client.get("/market_open_status");
+    return data;
+  }
+
+  //Get Market Opening Times
+  async getMarketOpenTiming() {
+    const data = await this.client.get("/market_opening_times");
+    return data;
+  }
+
+  //Convert Currency Amount
+  async getConvertCurrencyAmount(from, to, amount) {
+    const data = await this.client.get("/convert", {
+      from,
+      to,
+      amount,
+    });
+    return data;
+  }
+
+  //Get Data as Pandas DataFrame
+  async getDataAsPandasDataFrame(currency, startDate, endDate, format, fields) {
+    if (!DATA_EXPORTS_PANDAS_DF_FORMAT.includes(format)) {
+      throw new Error(
+        `Invalid format.Please use one of : ${DATA_EXPORTS_PANDAS_DF_FORMAT}`
+      );
+    }
+    if (!DATA_EXPORTS_PANDAS_DF_FIELDS.includes(fields)) {
+      throw new Error(
+        `Invalid format.Please use one of : ${DATA_EXPORTS_PANDAS_DF_FIELDS}`
+      );
+    }
+    const data = await this.client.get("/pandasDF", {
+      currency,
+      start_date: startDate,
+      end_date: endDate,
+      format,
+      fields,
+    });
+    return data;
+  }
+}
+export default TraderMade;

package/lib/tradermade.js

@@ -0,0 +1,6 @@
+import TraderMade from "../index.js";
+
+const tm = new TraderMade();
+tm.setRestApiKey(process.env.TRADERMADE_API_KEY || "api_key");
+
+export default tm;

package/package.json

@@ -0,0 +1,36 @@
+{
+  "name": "tradermade-sdk-nodejs",
+  "version": "1.0.0",
+  "description": "Official TRADERMADE Node.js SDK",
+  "main": "index.js",
+  "scripts": {
+    "start": "node index.js",
+    "test": "node tests/test.js"
+  },
+  "repository": {
+    "type": "",
+    "url": ""
+  },
+  "keywords": [
+    "tardermade.com",
+    "forex api",
+    "crypto api",
+    "api",
+    "sdk"
+  ],
+  "contributors": [
+    {
+      "name": "TraderMade Support",
+      "email": "support@tradermade.com"
+    }
+  ],
+  "author": "",
+  "license": "MIT",
+  "type": "module",
+  "homepage": "",
+  "dependencies": {
+    "axios": "^1.13.2",
+    "dotenv": "^17.2.3",
+    "tradermade-nodejs-sdk": "^1.0.0"
+  }
+}

package/src/client.js

@@ -0,0 +1,34 @@
+import axios from "axios";
+import {  DEFAULT_BASE_URL } from "./constants.js"
+
+export class Client{
+    constructor(apiKey)
+    {
+        this.apiKey = apiKey;
+        this.api = axios.create({
+            baseURL: DEFAULT_BASE_URL,
+            params:{ api_key : apiKey}
+        });
+    }
+
+    async get(endpoint, queryParams={})
+    {
+        try {
+            const response = await this.api.get(endpoint,{params:queryParams});
+            return response.data
+        } catch (error) {
+            this._handleError(error)
+        }
+    }
+
+    _handleError(error) {
+        if (error.response) {
+            const message = error.response.data?.message || error.response.statusText;
+            throw new Error(`API Error ${error.response.status}: ${message}`);
+        } else if (error.request) {
+            throw new Error("Network Error: No response received from server. Please check your internet connection.");
+        } else {
+            throw new Error(`Request Setup Error: ${error.message}`);
+        }
+    }
+}

package/src/constants.js

@@ -0,0 +1,15 @@
+//Base url https://marketdata.tradermade.com/api/v1
+export const DEFAULT_BASE_URL = "https://marketdata.tradermade.com/api/v1";
+
+export const TIME_SERIES_FORMAT = ["records","csv","index","columns","split"];
+export const TIME_SERIES_INTERVAL = ["daily","hourly","minute"];
+export const TIME_SERIES_PERIOD = {
+    "daily": [1],
+    "hourly":[1,2,4,6,8,24],
+    "minute":[1,5,10,15,30]
+};
+export const DATA_EXPORTS_PANDAS_DF_FIELDS = ["close","ohlc"];
+export const DATA_EXPORTS_PANDAS_DF_FORMAT = ["records","columns","index","split"];
+
+
+