@ganaka/sdk 1.10.2 → 1.11.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.ts CHANGED
@@ -35,6 +35,24 @@ declare interface ApiClientConfig {
35
35
  apiDomain: string;
36
36
  }
37
37
 
38
+ declare const candlesSchema: z.ZodObject<{
39
+ status: z.ZodEnum<{
40
+ SUCCESS: "SUCCESS";
41
+ FAILURE: "FAILURE";
42
+ }>;
43
+ payload: z.ZodObject<{
44
+ candles: z.ZodArray<z.ZodArray<z.ZodNullable<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>>>>;
45
+ source: z.ZodEnum<{
46
+ db: "db";
47
+ broker: "broker";
48
+ }>;
49
+ closing_price: z.ZodNullable<z.ZodNumber>;
50
+ start_time: z.ZodNullable<z.ZodString>;
51
+ end_time: z.ZodNullable<z.ZodString>;
52
+ interval_in_minutes: z.ZodNullable<z.ZodNumber>;
53
+ }, z.core.$strip>;
54
+ }, z.core.$strip>;
55
+
38
56
  declare const checkHoliday: {
39
57
  query: z.ZodObject<{
40
58
  date: z.ZodString;
@@ -218,7 +236,7 @@ declare const fetchCandles_2: ({ developerToken, apiDomain, runId, currentTimest
218
236
  runId: string | null;
219
237
  currentTimestamp: string;
220
238
  currentTimezone?: string;
221
- }) => (params: default_2.infer<typeof v1_candles_schemas.getGrowwHistoricalCandles.query>) => Promise<default_2.infer<typeof v1_candles_schemas.getGrowwHistoricalCandles.response>["data"]>;
239
+ }) => (params: default_2.infer<typeof v1_candles_schemas.getDeveloperCandles.query>) => Promise<default_2.infer<typeof v1_candles_schemas.getDeveloperCandles.response>["data"]>;
222
240
 
223
241
  export declare type FetchCandlesResponse = Awaited<ReturnType<ReturnType<typeof fetchCandles_2>>>;
224
242
 
@@ -264,7 +282,7 @@ declare const fetchShortlist_2: ({ developerToken, apiDomain, runId, currentTime
264
282
  runId: string | null;
265
283
  currentTimestamp: string;
266
284
  currentTimezone?: string;
267
- }) => (queryParams: default_2.infer<typeof v1_lists_schemas.getLists.query>) => Promise<default_2.infer<typeof v1_lists_schemas.getLists.response>["data"] | null>;
285
+ }) => (queryParams: default_2.infer<typeof v1_shortlists_schemas.getShortlists.query>) => Promise<default_2.infer<typeof v1_shortlists_schemas.getShortlists.response>["data"] | null>;
268
286
 
269
287
  export declare type fetchShortlistPersistence = ReturnType<typeof fetchShortlistPersistence_2>;
270
288
 
@@ -274,7 +292,7 @@ declare const fetchShortlistPersistence_2: ({ developerToken, apiDomain, runId,
274
292
  runId: string | null;
275
293
  currentTimestamp: string;
276
294
  currentTimezone?: string;
277
- }) => (queryParams: default_2.infer<typeof v1_lists_schemas.getShortlistPersistence.query>) => Promise<default_2.infer<typeof v1_lists_schemas.getShortlistPersistence.response>["data"] | null>;
295
+ }) => (queryParams: default_2.infer<typeof v1_shortlists_schemas.getShortlistPersistence.query>) => Promise<default_2.infer<typeof v1_shortlists_schemas.getShortlistPersistence.response>["data"] | null>;
278
296
 
279
297
  export declare type FetchShortlistResponse = Awaited<ReturnType<ReturnType<typeof fetchShortlist_2>>>;
280
298
 
@@ -330,9 +348,10 @@ export declare class GanakaClient {
330
348
  * @param params.interval - The interval for candles (e.g., "1minute", "5minute", "1day")
331
349
  * @param params.start_datetime - Start datetime in IST string format (YYYY-MM-DDTHH:mm:ss)
332
350
  * @param params.end_datetime - End datetime in IST string format (YYYY-MM-DDTHH:mm:ss)
351
+ * @param params.ignoreDb - Optional boolean to force fetching from broker instead of database
333
352
  * @returns Promise resolving to candle data
334
353
  */
335
- fetchCandles(params: z.infer<typeof v1_candles_schemas.getGrowwHistoricalCandles.query>): Promise<z.infer<typeof v1_candles_schemas.getGrowwHistoricalCandles.response>["data"]>;
354
+ fetchCandles(params: z.infer<typeof v1_candles_schemas.getDeveloperCandles.query>): Promise<z.infer<typeof v1_candles_schemas.getDeveloperCandles.response>["data"]>;
336
355
  /**
337
356
  * Fetch quote for a symbol at a specific datetime.
338
357
  *
@@ -350,7 +369,7 @@ export declare class GanakaClient {
350
369
  * @param queryParams.datetime - Datetime in IST string format (YYYY-MM-DDTHH:mm:ss)
351
370
  * @returns Promise resolving to shortlist data or null
352
371
  */
353
- fetchShortlist(queryParams: z.infer<typeof v1_lists_schemas.getLists.query>): Promise<z.infer<typeof v1_lists_schemas.getLists.response>["data"] | null>;
372
+ fetchShortlist(queryParams: z.infer<typeof v1_shortlists_schemas.getShortlists.query>): Promise<z.infer<typeof v1_shortlists_schemas.getShortlists.response>["data"] | null>;
354
373
  /**
355
374
  * Fetch shortlist persistence.
356
375
  * Given a shortlist type and a start and end datetime,
@@ -366,7 +385,7 @@ export declare class GanakaClient {
366
385
  * @param queryParams.end_datetime - End datetime in IST string format (YYYY-MM-DDTHH:mm:ss)
367
386
  * @returns Promise resolving to shortlist persistence data or null
368
387
  */
369
- fetchShortlistPersistence(queryParams: z.infer<typeof v1_lists_schemas.getShortlistPersistence.query>): Promise<z.infer<typeof v1_lists_schemas.getShortlistPersistence.response>["data"] | null>;
388
+ fetchShortlistPersistence(queryParams: z.infer<typeof v1_shortlists_schemas.getShortlistPersistence.query>): Promise<z.infer<typeof v1_shortlists_schemas.getShortlistPersistence.response>["data"] | null>;
370
389
  /**
371
390
  * Fetch dates with data.
372
391
  * Returns which dates have data available, grouped by date with all timestamps for each date.
@@ -397,10 +416,11 @@ export declare interface GanakaClientConfig {
397
416
  apiDomain?: string;
398
417
  }
399
418
 
400
- declare const getCandles: {
419
+ declare const getDashboardCandles: {
401
420
  query: z.ZodObject<{
402
421
  symbol: z.ZodString;
403
422
  date: z.ZodString;
423
+ ignoreDb: z.ZodOptional<z.ZodCoercedBoolean<unknown>>;
404
424
  interval: z.ZodOptional<z.ZodEnum<{
405
425
  "1minute": "1minute";
406
426
  "2minute": "2minute";
@@ -427,6 +447,10 @@ declare const getCandles: {
427
447
  low: z.ZodNumber;
428
448
  close: z.ZodNumber;
429
449
  }, z.core.$strip>>;
450
+ source: z.ZodEnum<{
451
+ db: "db";
452
+ broker: "broker";
453
+ }>;
430
454
  start_time: z.ZodNullable<z.ZodString>;
431
455
  end_time: z.ZodNullable<z.ZodString>;
432
456
  interval_in_minutes: z.ZodNumber;
@@ -462,7 +486,7 @@ declare const getDatesAdmin: {
462
486
  }, z.core.$strip>;
463
487
  };
464
488
 
465
- declare const getGrowwHistoricalCandles: {
489
+ declare const getDeveloperCandles: {
466
490
  query: z.ZodObject<{
467
491
  symbol: z.ZodString;
468
492
  interval: z.ZodEnum<{
@@ -481,6 +505,7 @@ declare const getGrowwHistoricalCandles: {
481
505
  }>;
482
506
  start_datetime: z.ZodString;
483
507
  end_datetime: z.ZodString;
508
+ ignoreDb: z.ZodOptional<z.ZodCoercedBoolean<unknown>>;
484
509
  timezone: z.ZodOptional<z.ZodString>;
485
510
  }, z.core.$strip>;
486
511
  response: z.ZodObject<{
@@ -493,10 +518,14 @@ declare const getGrowwHistoricalCandles: {
493
518
  }>;
494
519
  payload: z.ZodObject<{
495
520
  candles: z.ZodArray<z.ZodArray<z.ZodNullable<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>>>>;
521
+ source: z.ZodEnum<{
522
+ db: "db";
523
+ broker: "broker";
524
+ }>;
496
525
  closing_price: z.ZodNullable<z.ZodNumber>;
497
- start_time: z.ZodString;
498
- end_time: z.ZodString;
499
- interval_in_minutes: z.ZodNumber;
526
+ start_time: z.ZodNullable<z.ZodString>;
527
+ end_time: z.ZodNullable<z.ZodString>;
528
+ interval_in_minutes: z.ZodNullable<z.ZodNumber>;
500
529
  }, z.core.$strip>;
501
530
  }, z.core.$strip>;
502
531
  }, z.core.$strip>;
@@ -583,30 +612,6 @@ declare const getHolidays: {
583
612
  }, z.core.$strip>;
584
613
  };
585
614
 
586
- declare const getLists: {
587
- query: z.ZodObject<{
588
- type: z.ZodEnum<{
589
- TOP_GAINERS: "TOP_GAINERS";
590
- VOLUME_SHOCKERS: "VOLUME_SHOCKERS";
591
- }>;
592
- datetime: z.ZodOptional<z.ZodString>;
593
- timezone: z.ZodOptional<z.ZodString>;
594
- scope: z.ZodOptional<z.ZodEnum<{
595
- FULL: "FULL";
596
- TOP_5: "TOP_5";
597
- }>>;
598
- }, z.core.$strip>;
599
- response: z.ZodObject<{
600
- statusCode: z.ZodNumber;
601
- message: z.ZodString;
602
- data: z.ZodNullable<z.ZodArray<z.ZodObject<{
603
- name: z.ZodString;
604
- price: z.ZodNumber;
605
- nseSymbol: z.ZodString;
606
- }, z.core.$strip>>>;
607
- }, z.core.$strip>;
608
- };
609
-
610
615
  declare const getListsScrap: {
611
616
  query: z.ZodObject<{
612
617
  type: z.ZodEnum<{
@@ -718,111 +723,28 @@ declare const getShortlistPersistence: {
718
723
 
719
724
  declare const getShortlists: {
720
725
  query: z.ZodObject<{
721
- datetime: z.ZodString;
722
- timezone: z.ZodOptional<z.ZodString>;
723
726
  type: z.ZodEnum<{
724
727
  TOP_GAINERS: "TOP_GAINERS";
725
728
  VOLUME_SHOCKERS: "VOLUME_SHOCKERS";
726
729
  }>;
730
+ datetime: z.ZodString;
731
+ timezone: z.ZodOptional<z.ZodString>;
727
732
  scope: z.ZodOptional<z.ZodEnum<{
728
733
  FULL: "FULL";
729
734
  TOP_5: "TOP_5";
730
735
  }>>;
731
- takeProfitPercentage: z.ZodDefault<z.ZodOptional<z.ZodCoercedNumber<unknown>>>;
732
- stopLossPercentage: z.ZodDefault<z.ZodOptional<z.ZodCoercedNumber<unknown>>>;
733
736
  }, z.core.$strip>;
734
737
  response: z.ZodObject<{
735
738
  statusCode: z.ZodNumber;
736
739
  message: z.ZodString;
737
- data: z.ZodObject<{
738
- shortlist: z.ZodNullable<z.ZodObject<{
739
- id: z.ZodString;
740
- timestamp: z.ZodString;
741
- shortlistType: z.ZodEnum<{
742
- TOP_GAINERS: "TOP_GAINERS";
743
- VOLUME_SHOCKERS: "VOLUME_SHOCKERS";
744
- }>;
745
- entries: z.ZodArray<z.ZodObject<{
746
- nseSymbol: z.ZodString;
747
- name: z.ZodString;
748
- price: z.ZodNumber;
749
- quoteData: z.ZodOptional<z.ZodNullable<z.ZodObject<{
750
- status: z.ZodEnum<{
751
- SUCCESS: "SUCCESS";
752
- FAILURE: "FAILURE";
753
- }>;
754
- payload: z.ZodObject<{
755
- average_price: z.ZodNullable<z.ZodNumber>;
756
- bid_quantity: z.ZodNullable<z.ZodNumber>;
757
- bid_price: z.ZodNullable<z.ZodNumber>;
758
- day_change: z.ZodNullable<z.ZodNumber>;
759
- day_change_perc: z.ZodNullable<z.ZodNumber>;
760
- upper_circuit_limit: z.ZodNullable<z.ZodNumber>;
761
- lower_circuit_limit: z.ZodNullable<z.ZodNumber>;
762
- ohlc: z.ZodNullable<z.ZodObject<{
763
- open: z.ZodNullable<z.ZodNumber>;
764
- high: z.ZodNullable<z.ZodNumber>;
765
- low: z.ZodNullable<z.ZodNumber>;
766
- close: z.ZodNullable<z.ZodNumber>;
767
- }, z.core.$strip>>;
768
- depth: z.ZodNullable<z.ZodObject<{
769
- buy: z.ZodArray<z.ZodObject<{
770
- price: z.ZodNullable<z.ZodNumber>;
771
- quantity: z.ZodNullable<z.ZodNumber>;
772
- }, z.core.$strip>>;
773
- sell: z.ZodArray<z.ZodObject<{
774
- price: z.ZodNullable<z.ZodNumber>;
775
- quantity: z.ZodNullable<z.ZodNumber>;
776
- }, z.core.$strip>>;
777
- }, z.core.$strip>>;
778
- high_trade_range: z.ZodNullable<z.ZodNull>;
779
- implied_volatility: z.ZodNullable<z.ZodNull>;
780
- last_trade_quantity: z.ZodNullable<z.ZodNumber>;
781
- last_trade_time: z.ZodNullable<z.ZodNumber>;
782
- low_trade_range: z.ZodNullable<z.ZodNull>;
783
- last_price: z.ZodNullable<z.ZodNumber>;
784
- market_cap: z.ZodNullable<z.ZodNumber>;
785
- offer_price: z.ZodNullable<z.ZodNumber>;
786
- offer_quantity: z.ZodNullable<z.ZodNumber>;
787
- oi_day_change: z.ZodNullable<z.ZodNumber>;
788
- oi_day_change_percentage: z.ZodNullable<z.ZodNumber>;
789
- open_interest: z.ZodNullable<z.ZodNumber>;
790
- previous_open_interest: z.ZodNullable<z.ZodNull>;
791
- total_buy_quantity: z.ZodNullable<z.ZodNumber>;
792
- total_sell_quantity: z.ZodNullable<z.ZodNumber>;
793
- volume: z.ZodNullable<z.ZodNumber>;
794
- week_52_high: z.ZodNullable<z.ZodNumber>;
795
- week_52_low: z.ZodNullable<z.ZodNumber>;
796
- }, z.core.$strip>;
797
- }, z.core.$strip>>>;
798
- targetPrice: z.ZodOptional<z.ZodNumber>;
799
- stopLossPrice: z.ZodOptional<z.ZodNumber>;
800
- targetAchieved: z.ZodOptional<z.ZodBoolean>;
801
- stopLossHit: z.ZodOptional<z.ZodBoolean>;
802
- timeToTargetMinutes: z.ZodOptional<z.ZodNumber>;
803
- timeToStopLossMinutes: z.ZodOptional<z.ZodNumber>;
804
- targetTimestamp: z.ZodOptional<z.ZodString>;
805
- stopLossTimestamp: z.ZodOptional<z.ZodString>;
806
- }, z.core.$strip>>;
807
- }, z.core.$strip>>;
808
- }, z.core.$strip>;
740
+ data: z.ZodNullable<z.ZodArray<z.ZodObject<{
741
+ name: z.ZodString;
742
+ price: z.ZodNumber;
743
+ nseSymbol: z.ZodString;
744
+ }, z.core.$strip>>>;
809
745
  }, z.core.$strip>;
810
746
  };
811
747
 
812
- declare const growwHistoricalCandlesSchema: z.ZodObject<{
813
- status: z.ZodEnum<{
814
- SUCCESS: "SUCCESS";
815
- FAILURE: "FAILURE";
816
- }>;
817
- payload: z.ZodObject<{
818
- candles: z.ZodArray<z.ZodArray<z.ZodNullable<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>>>>;
819
- closing_price: z.ZodNullable<z.ZodNumber>;
820
- start_time: z.ZodString;
821
- end_time: z.ZodString;
822
- interval_in_minutes: z.ZodNumber;
823
- }, z.core.$strip>;
824
- }, z.core.$strip>;
825
-
826
748
  export declare const growwQuotePayloadSchema: z.ZodObject<{
827
749
  average_price: z.ZodNullable<z.ZodNumber>;
828
750
  bid_quantity: z.ZodNullable<z.ZodNumber>;
@@ -917,12 +839,6 @@ export declare const growwQuoteSchema: z.ZodObject<{
917
839
  }, z.core.$strip>;
918
840
  }, z.core.$strip>;
919
841
 
920
- declare const listSchema: z.ZodObject<{
921
- name: z.ZodString;
922
- price: z.ZodNumber;
923
- nseSymbol: z.ZodString;
924
- }, z.core.$strip>;
925
-
926
842
  declare const placeOrder: ({ runId, apiClient }: {
927
843
  runId: string | null;
928
844
  apiClient: ApiClient;
@@ -979,69 +895,6 @@ export declare interface RunContext {
979
895
  currentTimestamp: string;
980
896
  }
981
897
 
982
- declare const shortlistEntryWithMetricsSchema: z.ZodObject<{
983
- nseSymbol: z.ZodString;
984
- name: z.ZodString;
985
- price: z.ZodNumber;
986
- quoteData: z.ZodOptional<z.ZodNullable<z.ZodObject<{
987
- status: z.ZodEnum<{
988
- SUCCESS: "SUCCESS";
989
- FAILURE: "FAILURE";
990
- }>;
991
- payload: z.ZodObject<{
992
- average_price: z.ZodNullable<z.ZodNumber>;
993
- bid_quantity: z.ZodNullable<z.ZodNumber>;
994
- bid_price: z.ZodNullable<z.ZodNumber>;
995
- day_change: z.ZodNullable<z.ZodNumber>;
996
- day_change_perc: z.ZodNullable<z.ZodNumber>;
997
- upper_circuit_limit: z.ZodNullable<z.ZodNumber>;
998
- lower_circuit_limit: z.ZodNullable<z.ZodNumber>;
999
- ohlc: z.ZodNullable<z.ZodObject<{
1000
- open: z.ZodNullable<z.ZodNumber>;
1001
- high: z.ZodNullable<z.ZodNumber>;
1002
- low: z.ZodNullable<z.ZodNumber>;
1003
- close: z.ZodNullable<z.ZodNumber>;
1004
- }, z.core.$strip>>;
1005
- depth: z.ZodNullable<z.ZodObject<{
1006
- buy: z.ZodArray<z.ZodObject<{
1007
- price: z.ZodNullable<z.ZodNumber>;
1008
- quantity: z.ZodNullable<z.ZodNumber>;
1009
- }, z.core.$strip>>;
1010
- sell: z.ZodArray<z.ZodObject<{
1011
- price: z.ZodNullable<z.ZodNumber>;
1012
- quantity: z.ZodNullable<z.ZodNumber>;
1013
- }, z.core.$strip>>;
1014
- }, z.core.$strip>>;
1015
- high_trade_range: z.ZodNullable<z.ZodNull>;
1016
- implied_volatility: z.ZodNullable<z.ZodNull>;
1017
- last_trade_quantity: z.ZodNullable<z.ZodNumber>;
1018
- last_trade_time: z.ZodNullable<z.ZodNumber>;
1019
- low_trade_range: z.ZodNullable<z.ZodNull>;
1020
- last_price: z.ZodNullable<z.ZodNumber>;
1021
- market_cap: z.ZodNullable<z.ZodNumber>;
1022
- offer_price: z.ZodNullable<z.ZodNumber>;
1023
- offer_quantity: z.ZodNullable<z.ZodNumber>;
1024
- oi_day_change: z.ZodNullable<z.ZodNumber>;
1025
- oi_day_change_percentage: z.ZodNullable<z.ZodNumber>;
1026
- open_interest: z.ZodNullable<z.ZodNumber>;
1027
- previous_open_interest: z.ZodNullable<z.ZodNull>;
1028
- total_buy_quantity: z.ZodNullable<z.ZodNumber>;
1029
- total_sell_quantity: z.ZodNullable<z.ZodNumber>;
1030
- volume: z.ZodNullable<z.ZodNumber>;
1031
- week_52_high: z.ZodNullable<z.ZodNumber>;
1032
- week_52_low: z.ZodNullable<z.ZodNumber>;
1033
- }, z.core.$strip>;
1034
- }, z.core.$strip>>>;
1035
- targetPrice: z.ZodOptional<z.ZodNumber>;
1036
- stopLossPrice: z.ZodOptional<z.ZodNumber>;
1037
- targetAchieved: z.ZodOptional<z.ZodBoolean>;
1038
- stopLossHit: z.ZodOptional<z.ZodBoolean>;
1039
- timeToTargetMinutes: z.ZodOptional<z.ZodNumber>;
1040
- timeToStopLossMinutes: z.ZodOptional<z.ZodNumber>;
1041
- targetTimestamp: z.ZodOptional<z.ZodString>;
1042
- stopLossTimestamp: z.ZodOptional<z.ZodString>;
1043
- }, z.core.$strip>;
1044
-
1045
898
  declare const shortlistTypeSchema: z.ZodEnum<{
1046
899
  TOP_GAINERS: "TOP_GAINERS";
1047
900
  VOLUME_SHOCKERS: "VOLUME_SHOCKERS";
@@ -1072,9 +925,9 @@ declare const updateRun: {
1072
925
 
1073
926
  declare namespace v1_candles_schemas {
1074
927
  export {
1075
- growwHistoricalCandlesSchema,
1076
- getCandles,
1077
- getGrowwHistoricalCandles
928
+ candlesSchema,
929
+ getDashboardCandles,
930
+ getDeveloperCandles
1078
931
  }
1079
932
  }
1080
933
 
@@ -1095,19 +948,6 @@ declare namespace v1_holidays_schemas {
1095
948
  }
1096
949
  }
1097
950
 
1098
- declare namespace v1_lists_schemas {
1099
- export {
1100
- shortlistTypeSchema,
1101
- shortlistEntryWithMetricsSchema,
1102
- listSchema,
1103
- getShortlists,
1104
- getLists,
1105
- createShortlistSnapshot,
1106
- getListsScrap,
1107
- getShortlistPersistence
1108
- }
1109
- }
1110
-
1111
951
  declare namespace v1_quote_schemas {
1112
952
  export {
1113
953
  getGrowwQuote
@@ -1126,4 +966,14 @@ declare namespace v1_runs_schemas {
1126
966
  }
1127
967
  }
1128
968
 
969
+ declare namespace v1_shortlists_schemas {
970
+ export {
971
+ shortlistTypeSchema,
972
+ getShortlists,
973
+ createShortlistSnapshot,
974
+ getListsScrap,
975
+ getShortlistPersistence
976
+ }
977
+ }
978
+
1129
979
  export { }