@ganaka/sdk 1.6.0 → 1.7.0

package/dist/index.mjs

@@ -8631,6 +8631,150 @@ async function runMinuteLoop({
     nextBoundaryDayJS = nextBoundaryDayJS.add(intervalMinutes, "minute");
   }
 }
+class GanakaClient {
+  constructor(config2) {
+    this.developerToken = config2?.developerToken || process.env.DEVELOPER_KEY || "";
+    this.apiDomain = config2?.apiDomain || process.env.API_DOMAIN || "https://api.ganaka.live";
+    if (!this.developerToken) {
+      throw new Error(
+        "Developer token not found. Please provide developerToken in constructor or set DEVELOPER_KEY environment variable."
+      );
+    }
+  }
+  /**
+   * Fetch historical candles for a symbol.
+   *
+   * @param params - Query parameters for fetching candles
+   * @param params.symbol - The symbol to fetch candles for
+   * @param params.interval - The interval for candles (e.g., "1minute", "5minute", "1day")
+   * @param params.start_datetime - Start datetime in IST string format (YYYY-MM-DDTHH:mm:ss)
+   * @param params.end_datetime - End datetime in IST string format (YYYY-MM-DDTHH:mm:ss)
+   * @returns Promise resolving to candle data
+   */
+  async fetchCandles(params) {
+    const callback = fetchCandles({
+      developerToken: this.developerToken,
+      apiDomain: this.apiDomain,
+      runId: null,
+      currentTimestamp: "",
+      currentTimezone: "Asia/Kolkata"
+    });
+    return callback(params);
+  }
+  /**
+   * Fetch quote for a symbol at a specific datetime.
+   *
+   * @param params - Query parameters for fetching quote
+   * @param params.symbol - The symbol to fetch quote for
+   * @param params.datetime - Datetime in IST string format (YYYY-MM-DDTHH:mm:ss)
+   * @returns Promise resolving to quote data or null
+   */
+  async fetchQuote(params) {
+    const callback = fetchQuote({
+      developerToken: this.developerToken,
+      apiDomain: this.apiDomain,
+      runId: null,
+      currentTimestamp: "",
+      currentTimezone: "Asia/Kolkata"
+    });
+    return callback(params);
+  }
+  /**
+   * Fetch quote timeline for a symbol.
+   * Given a symbol and an end_datetime, returns the quote timeline for the given date.
+   *
+   * @param symbol - The symbol to fetch quote timeline for
+   * @param end_datetime - End datetime in IST string format (YYYY-MM-DDTHH:mm:ss)
+   * @returns Promise resolving to quote timeline data
+   */
+  async fetchQuoteTimeline(symbol, end_datetime) {
+    const callback = fetchQuoteTimeline({
+      developerToken: this.developerToken,
+      apiDomain: this.apiDomain,
+      runId: null,
+      currentTimestamp: "",
+      currentTimezone: "Asia/Kolkata"
+    });
+    return callback(symbol, end_datetime);
+  }
+  /**
+   * Fetch NIFTY quote at a specific datetime.
+   *
+   * @param params - Query parameters for fetching NIFTY quote
+   * @param params.datetime - Datetime in IST string format (YYYY-MM-DDTHH:mm:ss)
+   * @returns Promise resolving to NIFTY quote data or null
+   */
+  async fetchNiftyQuote(params) {
+    const callback = fetchNiftyQuote({
+      developerToken: this.developerToken,
+      apiDomain: this.apiDomain,
+      runId: null,
+      currentTimestamp: "",
+      currentTimezone: "Asia/Kolkata"
+    });
+    return callback(params);
+  }
+  /**
+   * Fetch NIFTY quote timeline.
+   * Given an end_datetime, returns the NIFTY quote timeline for the given date.
+   *
+   * @param end_datetime - End datetime in IST string format (YYYY-MM-DDTHH:mm:ss)
+   * @returns Promise resolving to NIFTY quote timeline data
+   */
+  async fetchNiftyQuoteTimeline(end_datetime) {
+    const callback = fetchNiftyQuoteTimeline({
+      developerToken: this.developerToken,
+      apiDomain: this.apiDomain,
+      runId: null,
+      currentTimestamp: "",
+      currentTimezone: "Asia/Kolkata"
+    });
+    return callback(end_datetime);
+  }
+  /**
+   * Fetch shortlist for a specific type and datetime.
+   *
+   * @param queryParams - Query parameters for fetching shortlist
+   * @param queryParams.type - The type of shortlist (e.g., "top-gainers", "top-losers")
+   * @param queryParams.datetime - Datetime in IST string format (YYYY-MM-DDTHH:mm:ss)
+   * @returns Promise resolving to shortlist data or null
+   */
+  async fetchShortlist(queryParams) {
+    const callback = fetchShortlist({
+      developerToken: this.developerToken,
+      apiDomain: this.apiDomain,
+      runId: null,
+      currentTimestamp: "",
+      currentTimezone: "Asia/Kolkata"
+    });
+    return callback(queryParams);
+  }
+  /**
+   * Fetch shortlist persistence.
+   * Given a shortlist type and a start and end datetime,
+   * returns the list of instruments that appeared in the shortlist during the time range
+   * in descending order of appearance count.
+   *
+   * This helps identify the stocks that have been consistently appearing in the shortlist
+   * over a given period of time.
+   *
+   * @param queryParams - Query parameters for fetching shortlist persistence
+   * @param queryParams.type - The type of shortlist (e.g., "top-gainers", "top-losers")
+   * @param queryParams.start_datetime - Start datetime in IST string format (YYYY-MM-DDTHH:mm:ss)
+   * @param queryParams.end_datetime - End datetime in IST string format (YYYY-MM-DDTHH:mm:ss)
+   * @returns Promise resolving to shortlist persistence data or null
+   */
+  async fetchShortlistPersistence(queryParams) {
+    const callback = fetchShortlistPersistence({
+      developerToken: this.developerToken,
+      apiDomain: this.apiDomain,
+      runId: null,
+      currentTimestamp: "",
+      currentTimezone: "Asia/Kolkata"
+    });
+    return callback(queryParams);
+  }
+}
 dotenv.config();
 dayjs.extend(utc);
 dayjs.extend(timezone);
@@ -8767,6 +8911,7 @@ async function ganaka({
   }
 }
 export {
+  GanakaClient,
   ganaka,
   S as growwQuotePayloadSchema,
   a as growwQuoteSchema