reportify-sdk 0.3.1 → 0.3.2

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.
Files changed (5) hide show
  1. package/dist/index.d.mts +1 -45
  2. package/dist/index.d.ts +1 -45
  3. package/dist/index.js +2 -47
  4. package/dist/index.mjs +2 -47
  5. package/package.json +1 -1
package/dist/index.d.mts CHANGED
@@ -744,19 +744,6 @@ interface OHLCVData {
744
744
  volume: number;
745
745
  [key: string]: unknown;
746
746
  }
747
- type FinancialType = 'income' | 'cashflow' | 'balancesheet' | 'equity';
748
- interface FinancialsParams {
749
- financialType: FinancialType;
750
- symbol: string;
751
- market?: StockMarket;
752
- startYear?: number;
753
- endYear?: number;
754
- }
755
- interface FinancialData {
756
- symbol: string;
757
- report_period: string;
758
- [key: string]: unknown;
759
- }
760
747
  interface BacktestParams {
761
748
  startDate: string;
762
749
  endDate: string;
@@ -938,37 +925,6 @@ declare class QuantModule {
938
925
  * ```
939
926
  */
940
927
  ohlcvBatch(params: BatchOHLCVParams): Promise<OHLCVData[]>;
941
- /**
942
- * Get historical financial statement data for a single symbol
943
- *
944
- * @param params - Financials parameters
945
- * @returns Array of financial data sorted by report period
946
- *
947
- * @example
948
- * ```typescript
949
- * // Get income statement
950
- * const data = await client.quant.financials({
951
- * financialType: 'income',
952
- * symbol: '000001'
953
- * });
954
- *
955
- * // Get balance sheet for specific years
956
- * const data = await client.quant.financials({
957
- * financialType: 'balancesheet',
958
- * symbol: '600519',
959
- * startYear: 2020,
960
- * endYear: 2024
961
- * });
962
- *
963
- * // Get cash flow statement for HK stock
964
- * const data = await client.quant.financials({
965
- * financialType: 'cashflow',
966
- * symbol: '00700',
967
- * market: 'hk'
968
- * });
969
- * ```
970
- */
971
- financials(params: FinancialsParams): Promise<FinancialData[]>;
972
928
  /**
973
929
  * Execute strategy backtest
974
930
  *
@@ -1548,4 +1504,4 @@ declare class Reportify {
1548
1504
  getBytes(path: string): Promise<ArrayBuffer>;
1549
1505
  }
1550
1506
 
1551
- export { APIError, type AgentConversation, type AgentMessage, AgentModule, AuthenticationError, type BacktestParams, type BacktestResult, type BatchOHLCVParams, type Calendar, type Channel, ChannelsModule, type ChatCompletionOptions, type ChatCompletionResponse, type ChatMode, ChatModule, type Chunk, type ChunkSearchOptions, type CompanyInfo, type CompanyOverview, type Concept, type ConceptDoc, type ConceptEvent, type ConceptFeed, type ConceptStock, ConceptsModule, type DocsListOptions, DocsModule, type Document, type DocumentInput, type EarningsEvent, type EarningsSearchOptions, type FactorComputeParams, type FactorMeta, type FinancialData, type FinancialStatement, type FinancialType, type FinancialsParams, type FollowedCompany, type IPOEvent, type IPOStatus, type IndexConstituent, type IndexFund, type IndicatorComputeParams, type IndicatorData, type IndicatorMeta, type IndustryConstituent, KBModule, type KBSearchOptions, type Market, NotFoundError, type OHLCVData, type OHLCVParams, type PaginatedResponse, type Period, type PriceData, QuantModule, type Quote, RateLimitError, Reportify, type ReportifyConfig, ReportifyError, type ScreenParams, type ScreenedStock, SearchModule, type SearchOptions, type Shareholder, type ShareholderType, type StockInfo, type StockMarket, StockModule, TimelineModule, type TimelineOptions, type UploadDocRequest, UserModule };
1507
+ export { APIError, type AgentConversation, type AgentMessage, AgentModule, AuthenticationError, type BacktestParams, type BacktestResult, type BatchOHLCVParams, type Calendar, type Channel, ChannelsModule, type ChatCompletionOptions, type ChatCompletionResponse, type ChatMode, ChatModule, type Chunk, type ChunkSearchOptions, type CompanyInfo, type CompanyOverview, type Concept, type ConceptDoc, type ConceptEvent, type ConceptFeed, type ConceptStock, ConceptsModule, type DocsListOptions, DocsModule, type Document, type DocumentInput, type EarningsEvent, type EarningsSearchOptions, type FactorComputeParams, type FactorMeta, type FinancialStatement, type FollowedCompany, type IPOEvent, type IPOStatus, type IndexConstituent, type IndexFund, type IndicatorComputeParams, type IndicatorData, type IndicatorMeta, type IndustryConstituent, KBModule, type KBSearchOptions, type Market, NotFoundError, type OHLCVData, type OHLCVParams, type PaginatedResponse, type Period, type PriceData, QuantModule, type Quote, RateLimitError, Reportify, type ReportifyConfig, ReportifyError, type ScreenParams, type ScreenedStock, SearchModule, type SearchOptions, type Shareholder, type ShareholderType, type StockInfo, type StockMarket, StockModule, TimelineModule, type TimelineOptions, type UploadDocRequest, UserModule };
package/dist/index.d.ts CHANGED
@@ -744,19 +744,6 @@ interface OHLCVData {
744
744
  volume: number;
745
745
  [key: string]: unknown;
746
746
  }
747
- type FinancialType = 'income' | 'cashflow' | 'balancesheet' | 'equity';
748
- interface FinancialsParams {
749
- financialType: FinancialType;
750
- symbol: string;
751
- market?: StockMarket;
752
- startYear?: number;
753
- endYear?: number;
754
- }
755
- interface FinancialData {
756
- symbol: string;
757
- report_period: string;
758
- [key: string]: unknown;
759
- }
760
747
  interface BacktestParams {
761
748
  startDate: string;
762
749
  endDate: string;
@@ -938,37 +925,6 @@ declare class QuantModule {
938
925
  * ```
939
926
  */
940
927
  ohlcvBatch(params: BatchOHLCVParams): Promise<OHLCVData[]>;
941
- /**
942
- * Get historical financial statement data for a single symbol
943
- *
944
- * @param params - Financials parameters
945
- * @returns Array of financial data sorted by report period
946
- *
947
- * @example
948
- * ```typescript
949
- * // Get income statement
950
- * const data = await client.quant.financials({
951
- * financialType: 'income',
952
- * symbol: '000001'
953
- * });
954
- *
955
- * // Get balance sheet for specific years
956
- * const data = await client.quant.financials({
957
- * financialType: 'balancesheet',
958
- * symbol: '600519',
959
- * startYear: 2020,
960
- * endYear: 2024
961
- * });
962
- *
963
- * // Get cash flow statement for HK stock
964
- * const data = await client.quant.financials({
965
- * financialType: 'cashflow',
966
- * symbol: '00700',
967
- * market: 'hk'
968
- * });
969
- * ```
970
- */
971
- financials(params: FinancialsParams): Promise<FinancialData[]>;
972
928
  /**
973
929
  * Execute strategy backtest
974
930
  *
@@ -1548,4 +1504,4 @@ declare class Reportify {
1548
1504
  getBytes(path: string): Promise<ArrayBuffer>;
1549
1505
  }
1550
1506
 
1551
- export { APIError, type AgentConversation, type AgentMessage, AgentModule, AuthenticationError, type BacktestParams, type BacktestResult, type BatchOHLCVParams, type Calendar, type Channel, ChannelsModule, type ChatCompletionOptions, type ChatCompletionResponse, type ChatMode, ChatModule, type Chunk, type ChunkSearchOptions, type CompanyInfo, type CompanyOverview, type Concept, type ConceptDoc, type ConceptEvent, type ConceptFeed, type ConceptStock, ConceptsModule, type DocsListOptions, DocsModule, type Document, type DocumentInput, type EarningsEvent, type EarningsSearchOptions, type FactorComputeParams, type FactorMeta, type FinancialData, type FinancialStatement, type FinancialType, type FinancialsParams, type FollowedCompany, type IPOEvent, type IPOStatus, type IndexConstituent, type IndexFund, type IndicatorComputeParams, type IndicatorData, type IndicatorMeta, type IndustryConstituent, KBModule, type KBSearchOptions, type Market, NotFoundError, type OHLCVData, type OHLCVParams, type PaginatedResponse, type Period, type PriceData, QuantModule, type Quote, RateLimitError, Reportify, type ReportifyConfig, ReportifyError, type ScreenParams, type ScreenedStock, SearchModule, type SearchOptions, type Shareholder, type ShareholderType, type StockInfo, type StockMarket, StockModule, TimelineModule, type TimelineOptions, type UploadDocRequest, UserModule };
1507
+ export { APIError, type AgentConversation, type AgentMessage, AgentModule, AuthenticationError, type BacktestParams, type BacktestResult, type BatchOHLCVParams, type Calendar, type Channel, ChannelsModule, type ChatCompletionOptions, type ChatCompletionResponse, type ChatMode, ChatModule, type Chunk, type ChunkSearchOptions, type CompanyInfo, type CompanyOverview, type Concept, type ConceptDoc, type ConceptEvent, type ConceptFeed, type ConceptStock, ConceptsModule, type DocsListOptions, DocsModule, type Document, type DocumentInput, type EarningsEvent, type EarningsSearchOptions, type FactorComputeParams, type FactorMeta, type FinancialStatement, type FollowedCompany, type IPOEvent, type IPOStatus, type IndexConstituent, type IndexFund, type IndicatorComputeParams, type IndicatorData, type IndicatorMeta, type IndustryConstituent, KBModule, type KBSearchOptions, type Market, NotFoundError, type OHLCVData, type OHLCVParams, type PaginatedResponse, type Period, type PriceData, QuantModule, type Quote, RateLimitError, Reportify, type ReportifyConfig, ReportifyError, type ScreenParams, type ScreenedStock, SearchModule, type SearchOptions, type Shareholder, type ShareholderType, type StockInfo, type StockMarket, StockModule, TimelineModule, type TimelineOptions, type UploadDocRequest, UserModule };
package/dist/index.js CHANGED
@@ -841,51 +841,6 @@ var QuantModule = class {
841
841
  return response.datas || [];
842
842
  }
843
843
  // ===========================================================================
844
- // Financials
845
- // ===========================================================================
846
- /**
847
- * Get historical financial statement data for a single symbol
848
- *
849
- * @param params - Financials parameters
850
- * @returns Array of financial data sorted by report period
851
- *
852
- * @example
853
- * ```typescript
854
- * // Get income statement
855
- * const data = await client.quant.financials({
856
- * financialType: 'income',
857
- * symbol: '000001'
858
- * });
859
- *
860
- * // Get balance sheet for specific years
861
- * const data = await client.quant.financials({
862
- * financialType: 'balancesheet',
863
- * symbol: '600519',
864
- * startYear: 2020,
865
- * endYear: 2024
866
- * });
867
- *
868
- * // Get cash flow statement for HK stock
869
- * const data = await client.quant.financials({
870
- * financialType: 'cashflow',
871
- * symbol: '00700',
872
- * market: 'hk'
873
- * });
874
- * ```
875
- */
876
- async financials(params) {
877
- const response = await this.client.get(
878
- `/v1/quant/financials/${params.financialType}`,
879
- {
880
- symbol: params.symbol,
881
- market: params.market || "cn",
882
- start_year: params.startYear,
883
- end_year: params.endYear
884
- }
885
- );
886
- return response.datas || [];
887
- }
888
- // ===========================================================================
889
844
  // Backtest
890
845
  // ===========================================================================
891
846
  /**
@@ -1709,7 +1664,7 @@ var Reportify = class {
1709
1664
  headers: {
1710
1665
  Authorization: `Bearer ${this.apiKey}`,
1711
1666
  "Content-Type": "application/json",
1712
- "User-Agent": "reportify-sdk-js/0.3.1"
1667
+ "User-Agent": "reportify-sdk-js/0.3.2"
1713
1668
  },
1714
1669
  body: options.body ? JSON.stringify(options.body) : void 0,
1715
1670
  signal: controller.signal
@@ -1770,7 +1725,7 @@ var Reportify = class {
1770
1725
  headers: {
1771
1726
  Authorization: `Bearer ${this.apiKey}`,
1772
1727
  "Content-Type": "application/json",
1773
- "User-Agent": "reportify-sdk-typescript/0.3.1"
1728
+ "User-Agent": "reportify-sdk-typescript/0.3.2"
1774
1729
  }
1775
1730
  });
1776
1731
  if (!response.ok) {
package/dist/index.mjs CHANGED
@@ -799,51 +799,6 @@ var QuantModule = class {
799
799
  return response.datas || [];
800
800
  }
801
801
  // ===========================================================================
802
- // Financials
803
- // ===========================================================================
804
- /**
805
- * Get historical financial statement data for a single symbol
806
- *
807
- * @param params - Financials parameters
808
- * @returns Array of financial data sorted by report period
809
- *
810
- * @example
811
- * ```typescript
812
- * // Get income statement
813
- * const data = await client.quant.financials({
814
- * financialType: 'income',
815
- * symbol: '000001'
816
- * });
817
- *
818
- * // Get balance sheet for specific years
819
- * const data = await client.quant.financials({
820
- * financialType: 'balancesheet',
821
- * symbol: '600519',
822
- * startYear: 2020,
823
- * endYear: 2024
824
- * });
825
- *
826
- * // Get cash flow statement for HK stock
827
- * const data = await client.quant.financials({
828
- * financialType: 'cashflow',
829
- * symbol: '00700',
830
- * market: 'hk'
831
- * });
832
- * ```
833
- */
834
- async financials(params) {
835
- const response = await this.client.get(
836
- `/v1/quant/financials/${params.financialType}`,
837
- {
838
- symbol: params.symbol,
839
- market: params.market || "cn",
840
- start_year: params.startYear,
841
- end_year: params.endYear
842
- }
843
- );
844
- return response.datas || [];
845
- }
846
- // ===========================================================================
847
802
  // Backtest
848
803
  // ===========================================================================
849
804
  /**
@@ -1667,7 +1622,7 @@ var Reportify = class {
1667
1622
  headers: {
1668
1623
  Authorization: `Bearer ${this.apiKey}`,
1669
1624
  "Content-Type": "application/json",
1670
- "User-Agent": "reportify-sdk-js/0.3.1"
1625
+ "User-Agent": "reportify-sdk-js/0.3.2"
1671
1626
  },
1672
1627
  body: options.body ? JSON.stringify(options.body) : void 0,
1673
1628
  signal: controller.signal
@@ -1728,7 +1683,7 @@ var Reportify = class {
1728
1683
  headers: {
1729
1684
  Authorization: `Bearer ${this.apiKey}`,
1730
1685
  "Content-Type": "application/json",
1731
- "User-Agent": "reportify-sdk-typescript/0.3.1"
1686
+ "User-Agent": "reportify-sdk-typescript/0.3.2"
1732
1687
  }
1733
1688
  });
1734
1689
  if (!response.ok) {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "reportify-sdk",
3
- "version": "0.3.1",
3
+ "version": "0.3.2",
4
4
  "description": "TypeScript SDK for Reportify API - Financial data and document search",
5
5
  "main": "dist/index.js",
6
6
  "module": "dist/index.mjs",