Release v30.2.0 (from 889635ab5e3bd31aa685c07ac870cfe4d0f7caca)

charting_library/datafeed-api.d.ts

@@ -306,6 +306,19 @@ export interface IDatafeedChartApi {
 	 * @param searchSource The source of the search ({@link SearchInitiationPoint}).
 	 */
 	searchSymbols(userInput: string, exchange: string, symbolType: string, onResult: SearchSymbolsCallback, searchSource?: SearchInitiationPoint): void;
+	/**
+	 * Provides a list of symbols that match the user's search query.
+	 *
+	 * Optional. If defined, the library uses this method instead of the non-paginated `searchSymbols`.
+	 *
+	 * Use the `start` property from `options` to determine which "page" of results to return.
+	 * For example, if the first call returns 50 results with 10 remaining, the second call will have `start` set to `50`.
+	 * When no more results are available on the server, set the `symbolsRemaining` parameter of the callback to `0`.
+	 *
+	 * @param options Object containing the user input, exchange, symbol type, and search source ({@link SearchInitiationPoint}).
+	 * @param onResult Callback function that returns an array of results ({@link SearchSymbolResultItem}) or an empty array if no symbols are found.
+	 */
+	searchSymbolsPaginated?(options: SymbolSearchPaginatedOptions, onResult: SearchSymbolsPaginatedCallback): void;
 	/**
 	 * The library will call this function when it needs to get SymbolInfo by symbol name.
 	 *
@@ -948,7 +961,7 @@ export interface QuoteOkData extends QuoteDataResponse {
 }
 /**
  * [Symbol Search](https://www.tradingview.com/charting-library-docs/latest/ui_elements/Symbol-Search) result item.
- * Pass the resulting array of symbols as a parameter to {@link SearchSymbolsCallback} of the [`searchSymbols`](https://www.tradingview.com/charting-library-docs/latest/connecting_data/datafeed-api/required-methods#searchsymbols) method.
+ * Pass the resulting array to the callback for [`searchSymbols`](https://www.tradingview.com/charting-library-docs/latest/connecting_data/datafeed-api/required-methods#searchsymbols) or [`searchSymbolsPaginated`](https://www.tradingview.com/charting-library-docs/latest/connecting_data/datafeed-api/additional-methods#searchsymbolspaginated).
  *
  * @example
  * ```
@@ -1043,6 +1056,31 @@ export interface SymbolResolveExtension {
 	 */
 	session?: string;
 }
+/**
+ * Options that define paginated [Symbol Search](https://www.tradingview.com/charting-library-docs/latest/ui_elements/Symbol-Search) requests.
+ */
+export interface SymbolSearchPaginatedOptions {
+	/**
+	 * The requested exchange. An empty value means no filter is specified.
+	 */
+	exchange: string;
+	/**
+	 * Text entered by the user in the Symbol Search field.
+	 */
+	userInput: string;
+	/**
+	 * The number of results to skip, representing how many have already been returned for the same input.
+	 */
+	start?: number;
+	/**
+	 * Type of symbol. An empty value means no filter is specified.
+	 */
+	symbolType: string;
+	/**
+	 * The source of the search ({@link SearchInitiationPoint}).
+	 */
+	searchSource?: SearchInitiationPoint;
+}
 export interface TimescaleMark {
 	/** ID of the timescale mark */
 	id: string | number;
@@ -1131,6 +1169,7 @@ export type QuotesErrorCallback = (reason: string) => void;
 export type ResolutionString = Nominal<string, "ResolutionString">;
 export type ResolveCallback = (symbolInfo: LibrarySymbolInfo) => void;
 export type SearchSymbolsCallback = (items: SearchSymbolResultItem[]) => void;
+export type SearchSymbolsPaginatedCallback = (items: SearchSymbolResultItem[], symbolsRemaining: number) => void;
 export type SeriesFormat = "price" | "volume";
 export type ServerTimeCallback = (serverTime: number) => void;
 export type SubscribeBarsCallback = (bar: Bar) => void;