UNPKG

extra-fyers/index.d.ts

Version:
106 kBTypeScriptView Raw
1/// <reference types="ws" />
2import { WebSocket } from 'ws';
3
4/** HTTP(s) header keys and values. */
5interface HttpHeaders {
  [key: string]: string;
7}
8/** HTTP(s) request options. */
9interface HttpRequestOptions {
  /** Full URL, inluding protocol and query. */
  url: string;
  /** HTTP(s) method (GET). */
  method?: string;
  /** Body of request (JSON). */
  body?: object | null;
  /** Request headers. */
  headers?: HttpHeaders;
  /** What if we don't get a response? */
  timeout?: number;
20}
21
22/** Root URL for API requests. */
23declare const API_URL: string;
24/** Root URL for Data API requests. */
25declare const DATA_URL: string;
26/** Root URL for Symbol master files. */
27declare const SYMBOLS_URL: string;
28/** Common response format. */
29interface Response {
  /** ok / error. */
  s: string;
  /** This is the code to identify specific responses. */
  code?: number;
  /** This is the message to identify the specific error responses. */
  message?: string;
36}
37/** HTTP data of multi-response. */
38interface ProxyResponse<Body> {
  /** HTTP status code. */
  statusCode: number;
  /** The actual place order reponse. */
  body: Body;
  /** HTTP status description. */
  statusDescription: string;
45}
46/** Attributes required for authorization of all requests. */
47interface Authorization$1 {
  /** This is the app_id which you have received after creating the app. */
  app_id: string;
  /** This value will be used for all the requests. */
  access_token: string;
52}
53/** Login step 1 request. */
54interface LoginStep1Request$1 {
  /** This is the app_id which you have received after creating the app. */
  client_id: string;
  /** This is where the user will be redirected after successful login. */
  redirect_uri: string;
  /** This value must always be “code”. */
  response_type: string;
  /** The same value will be returned after successful login to the redirect uri. */
  state: string;
63}
64/** Login step 1 response. */
65interface LoginStep1Response$1 extends Response {
  /** String value which will be used to generate the access_token. */
  auth_code: string;
  /** This value is returned as is from the first request. */
  state: string;
70}
71/** Login step 2 request. */
72interface LoginStep2Request$1 {
  /** This value must always be “authorization_code”. */
  grant_type: string;
  /** SHA-256 of `api_id:app_secret` in hex. */
  appIdHash: string;
  /** This is the auth_code which is received from the first step. */
  code: string;
79}
80/** Login step 2 response. */
81interface LoginStep2Response$1 extends Response {
  /** This value will be used for all the subsequent requests. */
  access_token: string;
84}
85/** Basic details of the client. */
86interface Profile$1 {
  /** The client id of the fyers user. */
  fy_id: string;
  /** Email address of the client. */
  email_id: string;
  /** Name of the client. */
  name: string;
  /** Display name, if any, provided by the client. */
  display_name: string;
  /** URL link to the user’s profile picture, if any. */
  image: string;
  /** PAN of the client. */
  PAN: string;
  /** Last PIN changed date. */
  pin_change_date: string;
  /** Last password changed date. */
  pwd_change_date: string;
  /** Number of days until the current password expires. */
  pwd_to_expire: number;
105}
106/** Get profile response. */
107interface GetProfileResponse extends Response {
  /** Basic details of the client. */
  data: Profile$1;
110}
111/** Limit details for particular fund. */
112interface FundLimit {
  /** Unique identity for particular fund. */
  id: number;
  /** Each title represents a heading of the ledger. */
  title: string;
  /** The amount in the capital ledger for the above-mentioned title. */
  equityAmount: number;
  /** The amount in the commodity ledger for the above-mentioned title. */
  commodityAmount: number;
121}
122/** Get funds response. */
123interface GetFundsResponse extends Response {
  /** Balance available for the user for capital as well as the commodity market. */
  fund_limit: FundLimit[];
126}
127/** Details of each equity or mutual fund holding. */
128interface Holding$1 {
  /** An identifier for this holding. */
  id: number;
  /** Fytoken is a unique identifier for every symbol. */
  fytoken: string;
  /** 12-digit International Securities Identification Number. */
  isin: string;
  /** Eg: NSE:RCOM-EQ. */
  symbol: string;
  /** The exchange in which order is placed. */
  exchange: number;
  /** Identify the type of holding. */
  holdingType: string;
  /** The quantity of the symbol which the user has at the beginning of the day. */
  quantity: number;
  /** This reflects the quantity - the quantity sold during the day. */
  remainingQuantity: number;
  /** The original buy price of the holding. */
  costPrice: number;
  /** The Market value of the current holding. */
  marketVal: number;
  /** LTP is the price from which the next sale of the stocks happens. */
  ltp: number;
  /** Profit and loss made. */
  pl: number;
153}
154/** Overall status of equity and mutual fund holdings in this demat account. */
155interface HoldingsOverall$1 {
  /** Total number of holdings present. */
  count_total: number;
  /** Invested amount for the current holdings. */
  total_investment: number;
  /** The present value of the holdings. */
  total_current_value: number;
  /** Total profit and loss made. */
  total_pl: number;
  /** Percentage value of the total pnl. */
  pnl_perc: number;
166}
167/** Equity and mutual fund holdings which the user has in this demat account. */
168interface GetHoldingsResponse extends Response {
  /** Details of each holding. */
  holdings: Holding$1[];
  /** Overall status of holdings in this demat account. */
  overall: HoldingsOverall$1;
173}
174/** Order placed by the user in the current trading day. */
175interface Order$1 {
  /** The unique order id assigned for each order. */
  id: string;
  /** The order id provided by the exchange. */
  exchOrdId: string;
  /** The symbol for which order is placed. */
  symbol: string;
  /** Fytoken is a unique identifier for every symbol. */
  fytoken: string;
  /** Short name for the symbol Eg: “SBIN-EQ”. */
  ex_sym: string;
  /** Description of symbol for which order is placed. */
  description: string;
  /** The segment this order is placed in. */
  segment: number;
  /** Exchange instrument type. */
  instrument: number;
  /** The exchange in which order is placed. */
  exchange: number;
  /** The type of order. */
  type: number;
  /** The order is buy or sell. */
  side: number;
  /** The product type. */
  productType: string;
  /** Source from where the order was placed. */
  source: string;
  /** The status of the order. */
  status: number;
  /** The order number and status of the order. */
  orderNumStatus: number;
  /** True when placing AMO order. */
  offlineOrder: string;
  /** The original order qty. */
  qty: number;
  /** The remaining qty. */
  remainingQuantity: number;
  /** The filled qty after partial trades. */
  filledQty: number;
  /** The limit price for the order. */
  limitPrice: number;
  /** The stop price for the order. */
  stopPrice: number;
  /** Disclosed quantity. */
  discloseQty: number;
  /** Remaining disclosed quantity. */
  dqQtyRem: number;
  /** Day or IOC. */
  orderValidity: string;
  /** The order time as per DD-MMM-YYYY hh:mm:ss in IST. */
  orderDateTime: string;
  /** The parent order id will be provided only for applicable orders. */
  parentId?: string;
  /** Price change from previous trading day. */
  ch: number;
  /** Percent price change from previous trading day. */
  chp: number;
  /** Last price of symbol. */
  lp: number;
  /** The average traded price for the order. */
  tradedPrice: number;
  /** This is used to sort the orders based on the time. */
  slNo: number;
  /** The error messages are shown here. */
  message: string;
  /** PAN of the client. */
  pan: string;
  /** The client id of the fyers user. */
  clientId: string;
244}
245/** Get order request. */
246interface GetOrderRequest {
  /** The unique order id assigned for each order. */
  id: string;
249}
250/** Get orders response. */
251interface GetOrdersResponse extends Response {
  /** List of all orders places during the day. */
  orderBook: Order$1[];
254}
255/** Current open/closed position for the current trading day. */
256interface Position$1 {
  /** The unique value for each position. */
  id: string;
  /** Fytoken is a unique identifier for every symbol. */
  fytoken: string;
  /** Eg: NSE:SBIN-EQ. */
  symbol: string;
  /** The segment in which the position is taken. */
  segment: number;
  /** The product type of the position. */
  productType: string;
  /** The side shows whether the position is long / short. */
  side: number;
  /** Absolute value of net qty. */
  qty: number;
  /** Incase of commodity positions, this multiplier is required for p&l calculation. */
  qtyMulti_com: number;
  /** Average buy price. */
  buyAvg: number;
  /** Total buy qty. */
  buyQty: number;
  /** Total buy value. */
  buyVal: number;
  /** Average sell price. */
  sellAvg: number;
  /** Total sell qty. */
  sellQty: number;
  /** Total sell value. */
  sellVal: number;
  /** Net average price. */
  netAvg: number;
  /** Net qty. */
  netQty: number;
  /** Average price (netAvg). */
  avgPrice: number;
  /** The total p&l of the position. */
  pl: number;
  /** The realized p&l of the position. */
  realized_profit: number;
  /** The unrealized p&l of the open position. */
  unrealized_profit: number;
  /** Is it a cross currency position? */
  crossCurrency: string;
  /** Incase of cross currency position, the rbi reference rate will be required to calculate the p&l. */
  rbiRefRate: number;
  /** LTP is the price from which the next sale of the stocks happens. */
  ltp: number;
  /** This is used for sorting of positions. */
  slNo: number;
305}
306/** Overall status of positions for the current trading day. */
307interface PositionsOverall$1 {
  /** Total number of positions present. */
  count_total: number;
  /** Total number of positions opened. */
  count_open: number;
  /** Total profit and losses. */
  pl_total: number;
  /** Profit and losses when the owned product is sold. */
  pl_realized: number;
  /** Profit and loses when the product is owned, but is not sold. */
  pl_unrealized: number;
318}
319/** Get postions response. */
320interface GetPositionsResponse extends Response {
  /** List of all positions for the current trading day. */
  netPositions: Position$1[];
  /** Overall status of positions for the current trading day. */
  overall: PositionsOverall$1;
325}
326/** Trade in the current trading day. */
327interface Trade$1 {
  /** The unique id to sort the trades. */
  id: string;
  /** The order id for which the trade occurred. */
  orderNumber: string;
  /** The order number provided by the exchange. */
  exchangeOrderNo: string;
  /** The trade number generated by the exchange. */
  tradeNumber: string;
  /** Fytoken is a unique identifier for every symbol. */
  fyToken: string;
  /** Eg: NSE:SBIN-EQ. */
  symbol: string;
  /** The segment in which order is placed. */
  segment: number;
  /** The exchange in which order is placed. */
  exchange: number;
  /** The trade is buy or sell. */
  transactionType: number;
  /** The product in which the order was placed. */
  productType: string;
  /** The type of order. */
  orderType: number;
  /** The time when the trade occured in “DD-MM-YYYY hh:mm:ss” format in IST. */
  orderDateTime: string;
  /** The traded price. */
  tradePrice: number;
  /** The total traded qty. */
  tradedQty: number;
  /** The total traded value. */
  tradeValue: number;
  /** Client id. */
  clientId: string;
  /** ? */
  row: number;
362}
363/** Get trades response. */
364interface GetTradesResponse extends Response {
  /** List of all trades for the current trading day. */
  tradeBook: Trade$1[];
367}
368/** Place order request to an exchange via Fyers. */
369interface PlaceOrderRequest {
  /** Eg: NSE:SBIN-EQ. */
  symbol: string;
  /** The quantity should be in multiples of lot size for derivatives. */
  qty: number;
  /** The type of order. */
  type: number;
  /** The order is buy or sell. */
  side: number;
  /** The product in which the order was placed. */
  productType: string;
  /** Provide valid price for Limit and Stoplimit orders. */
  limitPrice?: number;
  /** Provide valid price for Stop and Stoplimit orders. */
  stopPrice?: number;
  /** Allowed only for Equity. */
  disclosedQty?: number;
  /** Day or IOC. */
  validity: string;
  /** True when placing AMO order. */
  offlineOrder: string;
  /** Provide valid price for CO and BO orders. */
  stopLoss?: number;
  /** Provide valid price for BO orders. */
  takeProfit?: number;
394}
395/** Place/modify/cancel order reponse. */
396interface OrderResponse extends Response {
  /** The order number of the placed/modified/cancelled order. */
  id: string;
399}
400/** Place order reponse. */
401declare type PlaceOrderResponse = OrderResponse;
402/** Place orders response. */
403interface PlaceOrdersResponse extends Response {
  /** List of HTTP data for each order. */
  data: ProxyResponse<PlaceOrderResponse>[];
406}
407/** Modify order request to Fyers. */
408interface ModifyOrderRequest {
  /** The unique order id assigned for each order. */
  id: string;
  /** The type of order. */
  type: number;
  /** The original order qty. */
  qty?: number;
  /** Disclosed quantity. */
  disclosedQty?: number;
  /** The limit price for the order. */
  limitPrice?: number;
  /** The stop price for the order. */
  stopPrice?: number;
421}
422/** Modify order response. */
423declare type ModifyOrderResponse = OrderResponse;
424/** Modify orders response. */
425interface ModifyOrdersResponse extends Response {
  /** List of HTTP data for each order. */
  data: ProxyResponse<ModifyOrderResponse>[];
428}
429/** Cancel order request to any exchange via Fyers. */
430interface CancelOrderRequest {
  /** The order number of the placed order. */
  id: string;
433}
434/** Cancel order response. */
435declare type CancelOrderResponse = OrderResponse;
436/** Cancel orders response. */
437interface CancelOrdersResponse extends Response {
  /** List of HTTP data for each order. */
  data: ProxyResponse<CancelOrderResponse>[];
440}
441/** Exit position request to Fyers. */
442interface ExitPositionRequest {
  /** Mandatory. Eg: NSE:FCONSUMER-EQ-INTRADAY. */
  id: string;
445}
446/** Exit all positions response. */
447interface ExitAllPositionsResponse extends Response {
448}
449/** Exit position response. */
450interface ExitPositionResponse extends Response {
451}
452/** Convert position request to Fyers. */
453interface ConvertPositionRequest {
  /** Mandatory. Eg: 119031547242. */
  symbol: string;
  /** The side shows whether the position is long / short. */
  positionSide: number;
  /** Quantity to be converted. Has to be in multiples of lot size for derivatives. */
  convertQty: number;
  /** Existing productType (CNC positions cannot be converted). */
  convertFrom: string;
  /** The new product type. */
  convertTo: string;
464}
465/** Convert position response. */
466interface ConvertPositionResponse extends Response {
  /** Unknown. */
  positionDetails?: number;
469}
470/** Current market status of an exchange's segment. */
471interface MarketStatus$1 {
  /** The exchange in which the position is taken. */
  exchange: number;
  /** The segment in which the position is taken. */
  segment: number;
  /** The type of market: NL, MS, ES, ... */
  market_type: string;
  /** Market status: OPEN, CLOSE. */
  status: string;
480}
481/** Market status response for all the exchanges and their segments. */
482interface GetMarketStatusResponse extends Response {
  /** List of statuses of various markets. */
  marketStatus: MarketStatus$1[];
485}
486/** Market history request for a symbol. */
487interface GetMarketHistoryRequest {
  /** Eg: NSE:RCOM-EQ. */
  symbol: string;
  /** The candle resolution in minutes. */
  resolution: string;
  /** 0 to enter the epoch value. 1 to enter the date format as yyyy-mm-dd. */
  date_format: number;
  /** Indicating the start date of records (epoch, yyyy-mm-dd). */
  range_from: string;
  /** Indicating the end date of records. */
  range_to: string;
  /** Set cont flag 1 for continues data and future options. */
  cont_flag: string;
500}
501/** Short candle used with market history [time, open, high, low, close, volume]. */
502declare type ShortCandle = [number, number, number, number, number, number];
503/** Market history of a particular stock response. */
504interface GetMarketHistoryResponse extends Response {
  /** List of short candles. */
  candles: ShortCandle[];
507}
508/** Market quotes request for one or more symbols. */
509interface GetMarketQuotesRequest {
  /** Eg: NSE:RCOM-EQ, ... */
  symbols: string;
512}
513/** Candle in market quotes (1 minute). */
514interface Candle$1 {
  /** UNIX expoch time. */
  t: number;
  /** Open price (1 minute). */
  o: number;
  /** High price (1 minute). */
  h: number;
  /** Low price (1 minute). */
  l: number;
  /** Close price (1 minute). */
  c: number;
  /** Volume (1 minute). */
  v: number;
  /** Time, formatted. */
  tf: string;
529}
530/** Quote details of a particular symbol. */
531interface MarketQuoteDetails {
  /** Change value. */
  ch: number;
  /** Percentage of change between the current value and the previous day's market close. */
  chp: number;
  /** Last traded price. */
  lp: number;
  /** Difference between lowest asking and highest bidding price. */
  spread: number;
  /** Asking price for the symbol. */
  ask: number;
  /** Bidding price for the symbol. */
  bid: number;
  /** Price at market opening time. */
  open_price: number;
  /** Highest price for the day. */
  high_price: number;
  /** Lowest price for the day. */
  low_price: number;
  /** Close price of the previous trading day. */
  prev_close_price: number;
  /** Volume traded. */
  volume: number;
  /** Short name for the symbol Eg: “SBIN-EQ”. */
  short_name: string;
  /** Name of the exchange. Eg: “NSE” or “BSE”. */
  exchange: string;
  /** Description of the symbol. */
  description: string;
  /** Original name of the symbol name provided by the use. */
  original_name: string;
  /** Symbol name provided by the user. */
  symbol: string;
  /** Fytoken is a unique identifier for every symbol. */
  fyToken: string;
  /** Today’s time. */
  tt: number;
  /** Current time, open, high, low price and volume with HH:MM timestamp. */
  cmd: Candle$1;
570}
571/** Market quote for a particular symbol. */
572interface MarketQuote$1 {
  /** Name of symbol. */
  n: string;
  /** Status (ok). */
  s: string;
  /** Market quote details. */
  v: MarketQuoteDetails;
579}
580/** Market quotes response. */
581interface GetMarketQuotesResponse extends Response {
  /** List of all market quotes. */
  d: MarketQuote$1[];
584}
585/** Market depth details request. */
586interface GetMarketDepthRequest {
  /** Eg: NSE:RCOM-EQ. */
  symbol: string;
  /** Set the ohlcv_flag to 1 to get open, high, low, closing and volume quantity. */
  ohlcv_flag: number;
591}
592/** Open buy/sell orders at a particular price. */
593interface MarketOffer$1 {
  /** Bid/ask price. */
  price: number;
  /** Bid/ask volume. */
  volume: number;
  /** Number of orders. */
  ord: number;
600}
601/** A measure of the supply and demand for a symbol. */
602interface MarketDepth$1 {
  /** Total buying quantity. */
  totalbuyqty: number;
  /** Total selling quantity. */
  totalsellqty: number;
  /** Bidding price along with volume and total number of orders. */
  bids: MarketOffer$1[];
  /** Offer price with volume and total number of orders. */
  ask: MarketOffer$1[];
  /** Price at market opening time. */
  o?: number;
  /** Highest price for the day. */
  h?: number;
  /** Lowest price for the day. */
  l?: number;
  /** Price at the of market closing. */
  c?: number;
  /** Volume traded. */
  v?: number;
  /** Percentage of change between the current value and the previous day's market close. */
  chp: number;
  /** Change value. */
  ch: number;
  /** Last traded quantity. */
  ltq: number;
  /** Last traded time. */
  ltt: number;
  /** Last traded price. */
  ltp: number;
  /** Average traded price. */
  atp: number;
  /** Lower circuit price. */
  lower_ckt: number;
  /** Upper circuit price. */
  upper_ckt: number;
  /** Expiry date. */
  expiry: string;
  /** Open interest. */
  oi: number;
  /** Boolean flag for OI data, true or false. */
  oiflag: false;
  /** Previous day open interest. */
  pdoi: number;
  /** Change in open Interest percentage. */
  oipercent: number;
647}
648/** Market depth details response. */
649interface GetMarketDepthResponse extends Response {
  /** Dictionary of all market depth details. */
  d: {
      [symbol: string]: MarketDepth$1;
  };
654}
655/** Symbol category of master file request. */
656interface GetSymbolMasterRequest {
  /** Name of the exchange (NSE, BSE, MCX). */
  exchange: string;
  /** The segment whose symbols are needed (CM, FO, CD, COM). */
  segment: string;
661}
662/** e-DIS TPIN generation reponse. */
663interface GenerateEdisTpinResponse extends Response {
  /** Unknown, seen to be empty. */
  data: string;
666}
667/** Details of an e-DIS transaction. */
668interface EdisTransaction$1 {
  /** Transaction id. */
  transactionId: string;
  /** Internal transaction id. */
  internalTxnId: string;
  /** DP transaction id. */
  dpTxnId: string;
  /** ISIN code of stock. */
  isin: string;
  /** Quantity to transact. */
  qty: number;
  /** Quantity already transacted? */
  qtyUtlize: number;
  /** Transaction create date-time/ */
  entryDate: string;
  /** Transaction processing start date? */
  startDate: string;
  /** Transaction processing end date? */
  endDate: string;
  /** No. of days since transaction create date? */
  noOfDays: number;
  /** Source of transaction. */
  source: string;
  /** SUCCESS, FAILURE? */
  status: string;
  /** Unique client code? */
  clientId: string;
  /** Error code (NA). */
  errCode: string;
  /** Error count (0). */
  errorCount: string;
  /** Message. */
  reason: string;
701}
702/** e-DIS transaction details response. */
703interface GetEdisTransactionsResponse extends Response {
  /** List of e-DIS transactions. */
  data: EdisTransaction$1[] | string;
706}
707/** e-DIS securities held in a demat account. */
708interface EdisHolding$1 {
  /** 12-digit alphanumeric code of specific symbol. */
  isin_code: string;
  /** Quantity of securities held. */
  qty: number;
713}
714/** e-DIS holdings submission request. */
715interface SubmitEdisHoldingsRequest {
  /** Records of holdings of the user. */
  recordLst: EdisHolding$1[];
718}
719/** e-DIS transactions status inquiry request. */
720interface InquireEdisTransactionRequest {
  /** Transaction id. */
  transactionId: string;
723}
724/** e-DIS transaction status counts. */
725interface EdisTransactionStatus {
  /** Failure count. */
  FAILED_CNT: number;
  /** Success count. */
  SUCEESS_CNT: number;
730}
731/** e-DIS transaction status inquiry response. */
732interface InquireEdisTransactionResponse extends Response {
  /** Depository status data. */
  data: EdisTransactionStatus;
735}
736/**
* Get request step 1 for authorization (browser only).
* @param options authorization step 1 details \{client_id, redirect_uri, response_type, state\}
* @returns HTTP(s) request options for authorization step 1 (manual)
*/
741declare function loginStep1$1(options: LoginStep1Request$1): HttpRequestOptions;
742/**
* Get request step 2 for authorization (browser, server).
* @param options authorization step 2 details \{graph_type, appIdHash, code\}
* @returns HTTP(s) request options for authorization step 2 (manual)
*/
747declare function loginStep2$1(options: LoginStep2Request$1): HttpRequestOptions;
748/**
* Get basic details of the client.
* @param auth authorization \{app_id, access_token\}
* @returns details of user's profile \{fy_id, email_id, name, ...\}
*/
753declare function getProfile$1(auth: Authorization$1): Promise<GetProfileResponse>;
754/**
* Get balance available for the user for capital as well as the commodity market.
* @param auth authorization \{app_id, access_token\}
* @returns details of user's funds \{fund_limit: [\{id, title, equityAmount, commodityAmount\}]\}
*/
759declare function getFunds$1(auth: Authorization$1): Promise<GetFundsResponse>;
760/**
* Get the equity and mutual fund holdings which the user has in this demat account.
* @param auth authorization \{app_id, access_token\}
* @returns details of user's holdings \{holdings: \{id, ...\}, overall: \{count_total, ...\}\}
*/
765declare function getHoldings$1(auth: Authorization$1): Promise<GetHoldingsResponse>;
766/**
* Get details of an order placed in the current trading day.
* @param auth authorization \{app_id, access_token\}
* @param options order query \{id\}
* @returns details of an order \{orderBook: [\{id, exchOrdId, symbol, ...\}]\}
*/
772declare function getOrder$1(auth: Authorization$1, options: GetOrderRequest): Promise<GetOrdersResponse>;
773/**
* Get details of all the orders placed in the current trading day.
* @param auth authorization \{app_id, access_token\}
* @returns details of orders \{orderBook: [\{id, exchOrdId, symbol, ...\}]\}
*/
778declare function getOrders$1(auth: Authorization$1): Promise<GetOrdersResponse>;
779/**
* Get details of all the positions in the current trading day.
* @param auth authorization \{app_id, access_token\}
* @returns details of positions \{netPositions: \{id, ...\}, overall: \{count_total, ...\}\}
*/
784declare function getPositions$1(auth: Authorization$1): Promise<GetPositionsResponse>;
785/**
* Get details of all the trades in the current trading day.
* @param auth authorization \{app_id, access_token\}
* @returns details of trades \{tradeBook: [\{id, orderNumber, exchangeOrderNo, ...\}]\}
*/
790declare function getTrades$1(auth: Authorization$1): Promise<GetTradesResponse>;
791/**
* Place an order to any exchange via Fyers.
* @param auth authorization \{app_id, access_token\}
* @param options details of an order \{symbol, qty, type, side, ...\}
* @returns place status \{id\}
*/
797declare function placeOrder$1(auth: Authorization$1, options: PlaceOrderRequest): Promise<PlaceOrderResponse>;
798/**
* Place multiple orders to any exchange via Fyers.
* @param auth authorization \{app_id, access_token\}
* @param options details of multiple orders [\{symbol, qty, type, side, ...\}]
* @returns place status \{data: [\{statusCode, body: \{id\}, statusDescription\}]\}
*/
804declare function placeOrders$1(auth: Authorization$1, options: PlaceOrderRequest[]): Promise<PlaceOrdersResponse>;
805/**
* Modify an order placed on any exchange via Fyers.
* @param auth authorization \{app_id, access_token\}
* @param options details of order \{id, qty, type, side, ...\}
* @returns modify status \{id\}
*/
811declare function modifyOrder$1(auth: Authorization$1, options: ModifyOrderRequest): Promise<ModifyOrderResponse>;
812/**
* Modify orders placed on any exchange via Fyers.
* @param auth authorization \{app_id, access_token\}
* @param options details of orders [\{id, qty, type, side, ...\}]
* @returns modify status \{data: [\{statusCode, body: \{id\}, statusDescription\}]\}
*/
818declare function modifyOrders$1(auth: Authorization$1, options: ModifyOrderRequest[]): Promise<ModifyOrdersResponse>;
819/**
* Cancel an order placed on any exchange via Fyers.
* @param auth authorization \{app_id, access_token\}
* @param options details of order \{id\}
* @returns cancel status \{id\}
*/
825declare function cancelOrder$1(auth: Authorization$1, options: CancelOrderRequest): Promise<CancelOrderResponse>;
826/**
* Cancel orders placed on any exchange via Fyers.
* @param auth authorization \{app_id, access_token\}
* @param options details of orders [\{id\}]
* @returns cancel status \{data: [\{statusCode, body: \{id\}, statusDescription\}]\}
*/
832declare function cancelOrders$1(auth: Authorization$1, options: CancelOrderRequest[]): Promise<CancelOrdersResponse>;
833/**
* Exit a position on the current trading day.
* @param auth authorization \{app_id, access_token\}
* @param options details of position \{id\}
* @returns exit status \{\}
*/
839declare function exitPosition$1(auth: Authorization$1, options: ExitPositionRequest): Promise<ExitPositionResponse>;
840/**
* Exit all positions on the current trading day.
* @param auth authorization \{app_id, access_token\}
* @returns exit status \{\}
*/
845declare function exitAllPositions$1(auth: Authorization$1): Promise<ExitAllPositionsResponse>;
846/**
* Convert a position on the current trading day.
* @param auth authorization \{app_id, access_token\}
* @param options details of position \{symbol, positionSide, convertQty, ...\}
* @returns conversion status \{positionDetails\}
*/
852declare function convertPosition$1(auth: Authorization$1, options: ConvertPositionRequest): Promise<ConvertPositionResponse>;
853/**
* Get the current market status of all the exchanges and their segments.
* @param auth authorization \{app_id, access_token\}
* @returns market status \{marketStatus: [\{exchange, segment, market_type, status\}]\}
*/
858declare function getMarketStatus$1(auth: Authorization$1): Promise<GetMarketStatusResponse>;
859/**
* Get the current market history for a particular symbol.
* @param auth authorization \{app_id, access_token\}
* @param options market details \{symbol, resolution, date_format, ...\}
* @returns market history \{candles: \[\[time, open, high, low, close, volume\]\]\}
*/
865declare function getMarketHistory$1(auth: Authorization$1, options: GetMarketHistoryRequest): Promise<GetMarketHistoryResponse>;
866/**
* Get the current market quotes for a set of symbols.
* @param auth authorization \{app_id, access_token\}
* @param options market details \{symbols\}
* @returns market quotes \{d: [\{n, s, v: \{ch, chp, lp, spread, ...\}\}]\}
*/
872declare function getMarketQuotes$1(auth: Authorization$1, options: GetMarketQuotesRequest): Promise<GetMarketQuotesResponse>;
873/**
* Get the current market depth for a particular symbol.
* @param auth authorization \{app_id, access_token\}
* @param options market details \{symbol, ohlcv_flag\}
* @returns market depth \{d: \{<symbol>: \{totalbuyqty, totalsellqty, bids\}\}\}
*/
879declare function getMarketDepth$1(auth: Authorization$1, options: GetMarketDepthRequest): Promise<GetMarketDepthResponse>;
880/**
* Get all the latest symbols of all the exchanges from the symbol master files.
* @param auth authorization (unused)
* @param options details of symbol category \{exchange, segment\}
* @returns symbol master file
*/
886declare function getSymbolMaster$1(auth: null, options: GetSymbolMasterRequest): Promise<string>;
887/**
* Generate e-DIS TPIN for validating/authorising transaction.
* @param auth authorization \{app_id, access_token\}
* @returns optional data \{data\}
*/
892declare function generateEdisTpin$1(auth: Authorization$1): Promise<GenerateEdisTpinResponse>;
893/**
* Get the necessary information regarding the holdings you have on your and also the Status of the holdings. If the “sell” for the particular holdings is a success or not.
* @param auth authorization \{app_id, access_token\}
* @returns list of e-DIS transactions \{data: [\{transactionId, internalTxnId, ...\}]\}
*/
898declare function getEdisTransactions$1(auth: Authorization$1): Promise<GetEdisTransactionsResponse>;
899/**
* Redirect to CDSL page for login where you can submit your Holdings information and accordingly you can provide the same to exchange to Sell your holdings (browser only).
* @param auth authorization \{app_id, access_token\}
* @param options holding details \{recordLst: [\{isin_code, qty\}]\}
* @returns HTTP(s) request options (manual)
*/
905declare function submitEdisHoldingsStep$1(auth: Authorization$1, options: SubmitEdisHoldingsRequest): HttpRequestOptions;
906/**
* Inquire the information/status of the provided transaction Id for the respective holdings you have on your end.
* @param auth authorization \{app_id, access_token\}
* @param options transaction details \{transactionId\}
* @returns edis status \{FAILED_CNT, SUCEESS_CNT\}
*/
912declare function inquireEdisTransaction$1(auth: Authorization$1, options: InquireEdisTransactionRequest): Promise<InquireEdisTransactionResponse>;
913
914declare const http_d_API_URL: typeof API_URL;
915declare const http_d_DATA_URL: typeof DATA_URL;
916declare const http_d_SYMBOLS_URL: typeof SYMBOLS_URL;
917type http_d_Response = Response;
918type http_d_ProxyResponse<Body> = ProxyResponse<Body>;
919type http_d_GetProfileResponse = GetProfileResponse;
920type http_d_FundLimit = FundLimit;
921type http_d_GetFundsResponse = GetFundsResponse;
922type http_d_GetHoldingsResponse = GetHoldingsResponse;
923type http_d_GetOrderRequest = GetOrderRequest;
924type http_d_GetOrdersResponse = GetOrdersResponse;
925type http_d_GetPositionsResponse = GetPositionsResponse;
926type http_d_GetTradesResponse = GetTradesResponse;
927type http_d_PlaceOrderRequest = PlaceOrderRequest;
928type http_d_OrderResponse = OrderResponse;
929type http_d_PlaceOrderResponse = PlaceOrderResponse;
930type http_d_PlaceOrdersResponse = PlaceOrdersResponse;
931type http_d_ModifyOrderRequest = ModifyOrderRequest;
932type http_d_ModifyOrderResponse = ModifyOrderResponse;
933type http_d_ModifyOrdersResponse = ModifyOrdersResponse;
934type http_d_CancelOrderRequest = CancelOrderRequest;
935type http_d_CancelOrderResponse = CancelOrderResponse;
936type http_d_CancelOrdersResponse = CancelOrdersResponse;
937type http_d_ExitPositionRequest = ExitPositionRequest;
938type http_d_ExitAllPositionsResponse = ExitAllPositionsResponse;
939type http_d_ExitPositionResponse = ExitPositionResponse;
940type http_d_ConvertPositionRequest = ConvertPositionRequest;
941type http_d_ConvertPositionResponse = ConvertPositionResponse;
942type http_d_GetMarketStatusResponse = GetMarketStatusResponse;
943type http_d_GetMarketHistoryRequest = GetMarketHistoryRequest;
944type http_d_ShortCandle = ShortCandle;
945type http_d_GetMarketHistoryResponse = GetMarketHistoryResponse;
946type http_d_GetMarketQuotesRequest = GetMarketQuotesRequest;
947type http_d_MarketQuoteDetails = MarketQuoteDetails;
948type http_d_GetMarketQuotesResponse = GetMarketQuotesResponse;
949type http_d_GetMarketDepthRequest = GetMarketDepthRequest;
950type http_d_GetMarketDepthResponse = GetMarketDepthResponse;
951type http_d_GetSymbolMasterRequest = GetSymbolMasterRequest;
952type http_d_GenerateEdisTpinResponse = GenerateEdisTpinResponse;
953type http_d_GetEdisTransactionsResponse = GetEdisTransactionsResponse;
954type http_d_SubmitEdisHoldingsRequest = SubmitEdisHoldingsRequest;
955type http_d_InquireEdisTransactionRequest = InquireEdisTransactionRequest;
956type http_d_EdisTransactionStatus = EdisTransactionStatus;
957type http_d_InquireEdisTransactionResponse = InquireEdisTransactionResponse;
958declare namespace http_d {
export {
  http_d_API_URL as API_URL,
  http_d_DATA_URL as DATA_URL,
  http_d_SYMBOLS_URL as SYMBOLS_URL,
  http_d_Response as Response,
  http_d_ProxyResponse as ProxyResponse,
  Authorization$1 as Authorization,
  LoginStep1Request$1 as LoginStep1Request,
  LoginStep1Response$1 as LoginStep1Response,
  LoginStep2Request$1 as LoginStep2Request,
  LoginStep2Response$1 as LoginStep2Response,
  Profile$1 as Profile,
  http_d_GetProfileResponse as GetProfileResponse,
  http_d_FundLimit as FundLimit,
  http_d_GetFundsResponse as GetFundsResponse,
  Holding$1 as Holding,
  HoldingsOverall$1 as HoldingsOverall,
  http_d_GetHoldingsResponse as GetHoldingsResponse,
  Order$1 as Order,
  http_d_GetOrderRequest as GetOrderRequest,
  http_d_GetOrdersResponse as GetOrdersResponse,
  Position$1 as Position,
  PositionsOverall$1 as PositionsOverall,
  http_d_GetPositionsResponse as GetPositionsResponse,
  Trade$1 as Trade,
  http_d_GetTradesResponse as GetTradesResponse,
  http_d_PlaceOrderRequest as PlaceOrderRequest,
  http_d_OrderResponse as OrderResponse,
  http_d_PlaceOrderResponse as PlaceOrderResponse,
  http_d_PlaceOrdersResponse as PlaceOrdersResponse,
  http_d_ModifyOrderRequest as ModifyOrderRequest,
  http_d_ModifyOrderResponse as ModifyOrderResponse,
  http_d_ModifyOrdersResponse as ModifyOrdersResponse,
  http_d_CancelOrderRequest as CancelOrderRequest,
  http_d_CancelOrderResponse as CancelOrderResponse,
  http_d_CancelOrdersResponse as CancelOrdersResponse,
  http_d_ExitPositionRequest as ExitPositionRequest,
  http_d_ExitAllPositionsResponse as ExitAllPositionsResponse,
  http_d_ExitPositionResponse as ExitPositionResponse,
  http_d_ConvertPositionRequest as ConvertPositionRequest,
  http_d_ConvertPositionResponse as ConvertPositionResponse,
  MarketStatus$1 as MarketStatus,
  http_d_GetMarketStatusResponse as GetMarketStatusResponse,
  http_d_GetMarketHistoryRequest as GetMarketHistoryRequest,
  http_d_ShortCandle as ShortCandle,
  http_d_GetMarketHistoryResponse as GetMarketHistoryResponse,
  http_d_GetMarketQuotesRequest as GetMarketQuotesRequest,
  Candle$1 as Candle,
  http_d_MarketQuoteDetails as MarketQuoteDetails,
  MarketQuote$1 as MarketQuote,
  http_d_GetMarketQuotesResponse as GetMarketQuotesResponse,
  http_d_GetMarketDepthRequest as GetMarketDepthRequest,
  MarketOffer$1 as MarketOffer,
  MarketDepth$1 as MarketDepth,
  http_d_GetMarketDepthResponse as GetMarketDepthResponse,
  http_d_GetSymbolMasterRequest as GetSymbolMasterRequest,
  http_d_GenerateEdisTpinResponse as GenerateEdisTpinResponse,
  EdisTransaction$1 as EdisTransaction,
  http_d_GetEdisTransactionsResponse as GetEdisTransactionsResponse,
  EdisHolding$1 as EdisHolding,
  http_d_SubmitEdisHoldingsRequest as SubmitEdisHoldingsRequest,
  http_d_InquireEdisTransactionRequest as InquireEdisTransactionRequest,
  http_d_EdisTransactionStatus as EdisTransactionStatus,
  http_d_InquireEdisTransactionResponse as InquireEdisTransactionResponse,
  loginStep1$1 as loginStep1,
  loginStep2$1 as loginStep2,
  getProfile$1 as getProfile,
  getFunds$1 as getFunds,
  getHoldings$1 as getHoldings,
  getOrder$1 as getOrder,
  getOrders$1 as getOrders,
  getPositions$1 as getPositions,
  getTrades$1 as getTrades,
  placeOrder$1 as placeOrder,
  placeOrders$1 as placeOrders,
  modifyOrder$1 as modifyOrder,
  modifyOrders$1 as modifyOrders,
  cancelOrder$1 as cancelOrder,
  cancelOrders$1 as cancelOrders,
  exitPosition$1 as exitPosition,
  exitAllPositions$1 as exitAllPositions,
  convertPosition$1 as convertPosition,
  getMarketStatus$1 as getMarketStatus,
  getMarketHistory$1 as getMarketHistory,
  getMarketQuotes$1 as getMarketQuotes,
  getMarketDepth$1 as getMarketDepth,
  getSymbolMaster$1 as getSymbolMaster,
  generateEdisTpin$1 as generateEdisTpin,
  getEdisTransactions$1 as getEdisTransactions,
  submitEdisHoldingsStep$1 as submitEdisHoldingsStep,
  inquireEdisTransaction$1 as inquireEdisTransaction,
};
1051}
1052
1053/** Root URL for Market data notifications. */
1054declare const MARKET_DATA_URL: string;
1055/** Root URL for Order update notifications. */
1056declare const ORDER_UPDATE_URL: string;
1057/** Common notification format. */
1058declare type Notification = Response;
1059/** Update for order placed by the user in the current trading day. */
1060interface OrderUpdate {
  /** The unique order id assigned for each order. */
  id: string;
  /** The order id provided by the exchange. */
  exchOrdId: string;
  /** The symbol for which order is placed. */
  symbol: string;
  /** Fytoken is a unique identifier for every symbol. */
  fyToken: string;
  /** The segment this order is placed in. */
  segment: string;
  /** Exchange instrument type. */
  instrument: string;
  /** The type of order. */
  type: number;
  /** The order is buy or sell. */
  side: number;
  /** The product type. */
  productType: string;
  /** The status of the order. */
  status: number;
  /** The order number and status of the order. */
  orderNumStatus: string;
  /** True when placing AMO order. */
  offlineOrder: boolean;
  /** The original order qty. */
  qty: number;
  /** The remaining qty. */
  remainingQuantity: number;
  /** The filled qty after partial trades. */
  filledQty: number;
  /** The limit price for the order. */
  limitPrice: number;
  /** The stop price for the order. */
  stopPrice: number;
  /** Disclosed quantity. */
  discloseQty: number;
  /** Remaining disclosed quantity. */
  dqQtyRem: number;
  /** Day or IOC. */
  orderValidity: string;
  /** The order time as per DD-MMM-YYYY hh:mm:ss in IST. */
  orderDateTime: string;
  /** The parent order id will be provided only for applicable orders. */
  parentId?: string;
  /** The average traded price for the order. */
  tradedPrice: number;
  /** This is used to sort the orders based on the time. */
  slNo: number;
  /** The error messages are shown here. */
  message: string;
1111}
1112/** String notification on order update. */
1113interface OrderUpdateNotification$1 extends Notification {
  /** Websocket type [1]. */
  ws_type?: number;
  /** Data for the notification. */
  d?: OrderUpdate;
1118}
1119/** Header for each binary message. */
1120interface Header {
  /** Fytoken is a unique identifier for every symbol. */
  token: BigInt;
  /** Timestamp sent by exchange (UNIX epoch). */
  tt: number;
  /** 7202: OI data (NSE FO/CD, MCX), 7207/7208: NSE, BSE (indices/data), 31038: MCX. */
  fyCode: number;
  /** Market status flag? */
  marketStat: number;
  /** Packet length, including header? */
  pktlen: number;
  /** Has L2 data (market depth)? */
  L2: number;
1133}
1134/** Open interest data (fyCode === 7202). */
1135interface OiData {
  /** Open interest. */
  oi: number;
  /** Previous day open interest. */
  pdoi: number;
1140}
1141/** Common data (fyCode !== 7202). */
1142interface CommonData {
  /** Price conversion, divisor for all prices. */
  price_conv: number;
  /** LTP is the price from which the next sale of the stocks happens. */
  ltp: number;
  /** Price at market opening time. */
  open_price: number;
  /** Highest price for the day. */
  high_price: number;
  /** Lowest price for the day. */
  low_price: number;
  /** Close price of the previous trading day. */
  prev_close_price: number;
  /** Open price (1 minute). */
  o: number;
  /** High price (1 minute). */
  h: number;
  /** Low price (1 minute). */
  l: number;
  /** Close price (1 minute). */
  c: number;
  /** Volume (1 minute). */
  v: BigInt;
  /** Open interest. */
  oi: BigInt;
  /** Previous day open interest. */
  pdoi: BigInt;
1169}
1170/** Additional data (fyCode === 7208, 31038). */
1171interface L1Data {
  /** Last traded quantity. */
  LTQ: number;
  /** Last traded time (UNIX epoch). */
  L2_LTT: number;
  /** Average traded price. */
  ATP: number;
  /** Today's volume. */
  volume: number;
  /** Total buy quantity. */
  tot_buy: BigInt;
  /** Total sell quantity. */
  tot_sell: BigInt;
  /** Highest bid price. */
  bid: number;
  /** Lowest ask price. */
  ask: number;
1188}
1189/** Open buy/sell orders at a particular price (L2 === 1). */
1190interface L2MarketOffer {
  /** Bid/ask price. */
  price: number;
  /** Bid/ask volume. */
  volume: number;
  /** Number of orders. */
  ord: number;
1197}
1198/** Market depth data, 5 rows (L2 === 1). */
1199interface L2Data {
  /** Bidding price along with volume and total number of orders. */
  bids: L2MarketOffer[];
  /** Offer price with volume and total number of orders. */
  asks: L2MarketOffer[];
1204}
1205/** Market data (oi/quote/depth) for symbols subscribed by the user. */
1206interface MarketData extends Header, CommonData, L1Data, L2Data {
1207}
1208/** Binary notification on Market data. */
1209interface MarketDataNotification$1 extends Notification {
  /** Data for the notification. */
  d?: MarketData;
1212}
1213/**
* Notified function.
* @param notification notification
*/
1217declare type OnNotification = (notification: Notification) => void;
1218/**
* Order update notified function.
* @param notification notification
*/
1222declare type OnOrderUpdateNotification$1 = (notification: OrderUpdateNotification$1) => void;
1223/**
* Market data notified function.
* @param notification notification
*/
1227declare type OnMarketDataNotification$1 = (notification: MarketDataNotification$1) => void;
1228/** Handler for reciever which has passed (resolved). */
1229declare type OnResolve = (response: Response) => void;
1230/** Handler for reciever which has failed (rejected). */
1231declare type OnReject = (error: Error) => void;
1232/** Recieve response to a request, which can pass or fail. */
1233interface Reciever {
  /** Pass (resolve) handler for reciever. */
  resolve: OnResolve;
  /** Fail (reject) handler for reciever. */
  reject: OnReject;
1238}
1239/**
* Provides the API for creating and managing a WebSocket connection to
* a server, as well as for sending and receiving data on the connection.
*/
1243declare class Connection extends WebSocket {
  /** To recieve response to a request. */
  recievers: Reciever[];
1246}
1247/**
* Connect to Order update URL with WebSocket.
* @param auth authorization \{app_id, access_token\}
* @param fn notified function
* @returns WebSocket connection
*/
1253declare function connectOrderUpdate$1(auth: Authorization$1, fn: OnOrderUpdateNotification$1): Promise<Connection>;
1254/**
* Subscribe to order update.
* @param conn websocket connection
*/
1258declare function subscribeOrderUpdate$1(conn: Connection): Promise<Response>;
1259/**
* Unsubscribe to order update.
* @param conn websocket connection
*/
1263declare function unsubscribeOrderUpdate$1(conn: Connection): Promise<Response>;
1264/**
* Connect to Market data URL with WebSocket.
* @param auth authorization \{app_id, access_token\}
* @param fn notified function
* @returns WebSocket connection
*/
1270declare function connectMarketData$1(auth: Authorization$1, fn: OnMarketDataNotification$1): Promise<Connection>;
1271/**
* Subscribe to market quote.
* @param conn websocket connection
* @param symbols list of symbols
*/
1276declare function subscribeMarketQuote$1(conn: Connection, symbols: string[]): Promise<Response>;
1277/**
* Subscribe to market depth.
* @param conn websocket connection
* @param symbols list of symbols
*/
1282declare function subscribeMarketDepth$1(conn: Connection, symbols: string[]): Promise<Response>;
1283/**
* Unsubscribe to market quote.
* @param conn websocket connection
* @param symbols list of symbols
*/
1288declare function unsubscribeMarketQuote$1(conn: Connection, symbols: string[]): Promise<Response>;
1289/**
* Unsubscribe to market depth.
* @param conn websocket connection
* @param symbols list of symbols
*/
1294declare function unsubscribeMarketDepth$1(conn: Connection, symbols: string[]): Promise<Response>;
1295
1296declare const websocket_d_MARKET_DATA_URL: typeof MARKET_DATA_URL;
1297declare const websocket_d_ORDER_UPDATE_URL: typeof ORDER_UPDATE_URL;
1298type websocket_d_Notification = Notification;
1299type websocket_d_OrderUpdate = OrderUpdate;
1300type websocket_d_Header = Header;
1301type websocket_d_OiData = OiData;
1302type websocket_d_CommonData = CommonData;
1303type websocket_d_L1Data = L1Data;
1304type websocket_d_L2MarketOffer = L2MarketOffer;
1305type websocket_d_L2Data = L2Data;
1306type websocket_d_MarketData = MarketData;
1307type websocket_d_OnNotification = OnNotification;
1308type websocket_d_OnResolve = OnResolve;
1309type websocket_d_OnReject = OnReject;
1310type websocket_d_Reciever = Reciever;
1311type websocket_d_Connection = Connection;
1312declare const websocket_d_Connection: typeof Connection;
1313type websocket_d_Response = Response;
1314declare namespace websocket_d {
export {
  websocket_d_MARKET_DATA_URL as MARKET_DATA_URL,
  websocket_d_ORDER_UPDATE_URL as ORDER_UPDATE_URL,
  websocket_d_Notification as Notification,
  websocket_d_OrderUpdate as OrderUpdate,
  OrderUpdateNotification$1 as OrderUpdateNotification,
  websocket_d_Header as Header,
  websocket_d_OiData as OiData,
  websocket_d_CommonData as CommonData,
  websocket_d_L1Data as L1Data,
  websocket_d_L2MarketOffer as L2MarketOffer,
  websocket_d_L2Data as L2Data,
  websocket_d_MarketData as MarketData,
  MarketDataNotification$1 as MarketDataNotification,
  websocket_d_OnNotification as OnNotification,
  OnOrderUpdateNotification$1 as OnOrderUpdateNotification,
  OnMarketDataNotification$1 as OnMarketDataNotification,
  websocket_d_OnResolve as OnResolve,
  websocket_d_OnReject as OnReject,
  websocket_d_Reciever as Reciever,
  websocket_d_Connection as Connection,
  connectOrderUpdate$1 as connectOrderUpdate,
  subscribeOrderUpdate$1 as subscribeOrderUpdate,
  unsubscribeOrderUpdate$1 as unsubscribeOrderUpdate,
  connectMarketData$1 as connectMarketData,
  subscribeMarketQuote$1 as subscribeMarketQuote,
  subscribeMarketDepth$1 as subscribeMarketDepth,
  unsubscribeMarketQuote$1 as unsubscribeMarketQuote,
  unsubscribeMarketDepth$1 as unsubscribeMarketDepth,
  websocket_d_Response as Response,
  Authorization$1 as Authorization,
};
1347}
1348
1349/** Exchange code. */
1350declare type Exchange = "NSE" | "MCX" | "BSE";
1351/**
* Get exchange description.
* @param code exchange code (NSE, MCX, BSE)
* @returns exchange description
*/
1356declare function exchangeDescription(code: Exchange): string;
1357/**
* Get exchange code.
* @param desc exchange description
* @returns exchange code (NSE, MCX, BSE)
*/
1362declare function exchange(desc: string): Exchange;
1363/** Segment code. */
1364declare type Segment = "CM" | "FO" | "CD" | "COM";
1365/**
* Get segment description.
* @param code segment code (CM, FO, CD, COM)
* @returns segment description
*/
1370declare function segmentDescription(code: Segment): string;
1371/**
* Get segment code.
* @param desc segment description
* @returns segment code (CM, FO, CD, COM)
*/
1376declare function segment(desc: string): Segment;
1377/** Position side code. */
1378declare type PositionSide = "LONG" | "SHORT" | "CLOSED";
1379/**
* Get position side description.
* @param code position side code (LONG, SHORT, CLOSED)
* @returns position side description
*/
1384declare function positionSideDescription(code: PositionSide): string;
1385/**
* Get position side code.
* @param desc position side description
* @returns position side code (LONG, SHORT, CLOSED)
*/
1390declare function positionSide(desc: string): PositionSide;
1391/** Order side code. */
1392declare type OrderSide = "BUY" | "SELL";
1393/**
* Get order side description.
* @param code order side code (BUY, SELL)
* @returns order side description
*/
1398declare function orderSideDescription(code: OrderSide): string;
1399/**
* Get order side code.
* @param desc order side description
* @returns order side code (BUY, SELL)
*/
1404declare function orderSide(desc: string): OrderSide;
1405/** Order source code. */
1406declare type OrderSource = "MOBILE" | "WEB" | "ONE" | "ADMIN" | "API";
1407/**
* Get order source description.
* @param code order source code (MOBILE, WEB, ONE, ADMIN, API)
* @returns order source description
*/
1412declare function orderSourceDescription(code: OrderSource): string;
1413/**
* Get order source code.
* @param desc order source description
* @returns order source code (MOBILE, WEB, ONE, ADMIN, API)
*/
1418declare function orderSource(desc: string): OrderSource;
1419/** Order status code. */
1420declare type OrderStatus = "CANCELLED" | "TRADED" | "TRANSIT" | "REJECTED" | "PENDING" | "EXPIRED";
1421/**
* Get order status description.
* @param code order status code (CANCELLED, TRADED, ...)
* @returns order status description
*/
1426declare function orderStatusDescription(code: OrderStatus): string;
1427/**
* Get order status code.
* @param desc order status description
* @returns order status code (CANCELLED, TRADED, ...)
*/
1432declare function orderStatus(desc: string): OrderStatus;
1433/** Order type code. */
1434declare type OrderType = "LIMIT" | "MARKET" | "SL_MARKET" | "SL_LIMIT";
1435/**
* Get order type description.
* @param code order type code (LIMIT, MARKET, SL_MARKET, SL_LIMIT)
* @returns order type description
*/
1440declare function orderTypeDescription(code: OrderType): string;
1441/**
* Get order type code.
* @param desc order type description
* @returns order type code (LIMIT, MARKET, SL_MARKET, SL_LIMIT)
*/
1446declare function orderType(desc: string): OrderType;
1447/** Order validity code. */
1448declare type OrderValidity = "DAY" | "IOC";
1449/**
* Get order validity description.
* @param code order validity code (DAY, IOC)
* @returns order validity description
*/
1454declare function orderValidityDescription(code: OrderValidity): string;
1455/**
* Get order validity code.
* @param desc order validity description
* @returns order validity code (DAY, IOC)
*/
1460declare function orderValidity(desc: string): OrderValidity;
1461/** Option type code. */
1462declare type OptionType = "CE" | "PE";
1463/**
* Get option type description.
* @param code option type code (CE, PE)
* @returns option type description
*/
1468declare function optionTypeDescription(code: OptionType): string;
1469/**
* Get option type code.
* @param desc option type description
* @returns option type code (CE, PE)
*/
1474declare function optionType(desc: string): OptionType;
1475/** Derivative type code. */
1476declare type DerivativeType = "FUT" | "CE" | "PE";
1477/**
* Get derivative type description.
* @param code derivative type code (FUT, CE, PE)
* @returns derivative type description
*/
1482declare function derivativeTypeDescription(code: DerivativeType): string;
1483/**
* Get derivative type code.
* @param desc derivative type description
* @returns derivative type code (CE, PE)
*/
1488declare function derivativeType(desc: string): DerivativeType;
1489/** Holding type code. */
1490declare type HoldingType = "T1" | "HLD";
1491/**
* Get holding type description.
* @param code holding type code (T1, HLD)
* @returns holding type description
*/
1496declare function holdingTypeDescription(code: HoldingType): string;
1497/**
* Get holding type code.
* @param desc holding type description
* @returns holding type code (T1, HLD)
*/
1502declare function holdingType(desc: string): HoldingType;
1503/** Product type code. */
1504declare type ProductType = "CNC" | "INTRADAY" | "MARGIN" | "CO" | "BO";
1505/**
* Get product type description.
* @param code product type code (CNC, INTRADAY, MARGIN, CO, BO)
* @returns product type description
*/
1510declare function productTypeDescription(code: ProductType): string;
1511/**
* Get product type code.
* @param desc product type description
* @returns product type code (CNC, INTRADAY, MARGIN, CO, BO)
*/
1516declare function productType(desc: string): ProductType;
1517/** Instrument type code. */
1518declare type InstrumentType = "EQ" | "PREFSHARES" | "DEBENTURES" | "WARRANTS" | "MISC" | "INDEX" | // CM segment
1519"FUTIDX" | "FUTIVX" | "FUTSTK" | "OPTIDX" | "OPTSTK" | // FO segment
1520"FUTCUR" | "FUTIRT" | "FUTIRC" | "OPTCUR" | "UNDCUR" | "UNDIRC" | "UNDIRT" | "UNDIRD" | "INDEX_CD" | "FUTIRD" | // CD segment
1521"FUTCOM" | "OPTFUT" | "OPTCOM";
1522/**
* Get instrument type description.
* @param code instrument type code
* @returns instrument type description
*/
1527declare function instrumentTypeDescription(code: InstrumentType): string;
1528/**
* Get instrument type code.
* @param desc instrument type description
* @returns instrument type code
*/
1533declare function instrumentType(desc: string): InstrumentType;
1534/** Essential details of a symbol, as given in Symbol master CSV file. */
1535interface SymbolDetails {
  /** Eg: NSE:RCOM-EQ. */
  symbol: string;
  /** A unique identifier for every symbol. */
  token: string;
  /** Description of the symbol. */
  description: string;
  /** Minimum lot size for the symbol. */
  lotSize: number;
  /** ISIN code of stock. */
  isin: string;
1546}
1547/**
* Get symbol exchange, underlying, currency-pair, or commodity name.
* @param code symbol code
* @returns symbol name
*/
1552declare function symbolName(code: string): string;
1553/**
* Get symbol exchange.
* @param code symbol code
* @returns symbol exchange
*/
1558declare function symbolExchange(code: string): Exchange;
1559/**
* Get symbol exchange series.
* @param code symbol code
* @returns symbol exchange series (EQ, BE, MF, ME, ...)
*/
1564declare function symbolSeries(code: string): string | null;
1565/**
* Get symbol option type.
* @param code symbol code
* @returns symbol option type
*/
1570declare function symbolOptionType(code: string): OptionType | null;
1571/**
* Get symbol derivative type.
* @param code symbol code
* @returns symbol derivative type
*/
1576declare function symbolDerivativeType(code: string): DerivativeType | null;
1577/**
* Get symbol strike price.
* @param code symbol code
* @returns symbol strike price
*/
1582declare function symbolStrikePrice(code: string): number;
1583/**
* Get symbol token, a unique identifier.
* @param code symbol code
* @param map symbol details map
* @returns symbol token
*/
1589declare function symbolToken(code: string, map: Map<string, SymbolDetails>): string;
1590/**
* Get symbol description.
* @param code symbol code
* @param map symbol details map
* @returns symbol description
*/
1596declare function symbolDescription(code: string, map: Map<string, SymbolDetails>): string;
1597/**
* Get symbol ISIN.
* @param code symbol code
* @param map symbol details map
* @returns symbol ISIN
*/
1603declare function symbolIsin(code: string, map: Map<string, SymbolDetails>): string;
1604/**
* Get symbol minimum lot size.
* @param code symbol code
* @param map symbol details map
* @returns symbol minimum lot size
*/
1610declare function symbolLotSize(code: string, map: Map<string, SymbolDetails>): number;
1611/** Attributes required for authorization of all requests. */
1612interface Authorization {
  /** This is the app_id which you have received after creating the app. */
  appId: string;
  /** This value will be used for all the requests. */
  accessToken: string;
1617}
1618/** Login step 1 request. */
1619interface LoginStep1Request {
  /** This is the app_id which you have received after creating the app. */
  appId: string;
  /** This is where the user will be redirected after successful login. */
  redirectUrl: string;
  /** The same value will be returned after successful login to the redirect uri. */
  state: string;
1626}
1627/** Login step 1 response. */
1628interface LoginStep1Response {
  /** String value which will be used to generate the access_token. */
  authorizationCode: string;
  /** This value is returned as is from the first request. */
  state: string;
1633}
1634/** Login step 2 request. */
1635interface LoginStep2Request {
  /** SHA-256 of `api_id:app_secret` in hex. */
  appHash: string;
  /** This is the auth_code which is received from the first step. */
  authorizationCode: string;
1640}
1641/** Login step 2 response. */
1642interface LoginStep2Response {
  /** This value will be used for all the subsequent requests. */
  accessToken: string;
1645}
1646/** Basic details of the client. */
1647interface Profile {
  /** The client id of the fyers user. */
  id: string;
  /** Email address of the client. */
  email: string;
  /** Name of the client. */
  name: string;
  /** PAN of the client. */
  pan: string;
1656}
1657/** Limits for equity/commodity fund. */
1658interface Fund {
  /** Limit at start of the day. */
  start: number;
  /** Fund Transfer. */
  deposits: number;
  /** Realized Profit and Loss. */
  realizedReturns: number;
  /** Collaterals. */
  collaterals: number;
  /** Adhoc Limit. */
  adhoc: number;
  /** Utilized Amount. */
  utilized: number;
  /** Receivables. */
  receivables: number;
  /** Available Balance. */
  available: number;
  /** Clear Balance. */
  clear: number;
  /** Total Balance. */
  total: number;
1679}
1680/** Balance available for the user for capital as well as the commodity market. */
1681interface Funds {
  /** Fund limits for capital market. */
  equity: Fund;
  /** Fund limits for commodity market. */
  commodity: Fund;
1686}
1687/** Details of each holding. */
1688interface Holding {
  /** 12-digit International Securities Identification Number. */
  isin: string;
  /** Eg: NSE:RCOM-EQ. */
  symbol: string;
  /** A unique identifier for every symbol. */
  token: string;
  /** The exchange in which order is placed. */
  exchange: Exchange;
  /** Identify the type of holding. */
  type: HoldingType;
  /** The quantity of the symbol which the user has at the beginning of the day. */
  quantity: number;
  /** This reflects the quantity - the quantity sold during the day. */
  remainingQuantity: number;
  /** The original buy price of the holding. */
  buyPrice: number;
  /** The original buy value of the holding. */
  buyValue: number;
  /** LTP is the price from which the next sale of the stocks happens. */
  currentPrice: number;
  /** The Market value of the current holding. */
  currentValue: number;
  /** Profit and loss made. */
  returns: number;
  /** Profit and loss percent made. */
  returnsPercent: number;
1715}
1716/** Overall status of holdings in this demat account. */
1717interface HoldingsOverall {
  /** Total number of holdings present. */
  count: number;
  /** Total number of settled holdings (HLD). */
  settledCount: number;
  /** Invested amount for the current holdings. */
  investedValue: number;
  /** The present value of the holdings. */
  currentValue: number;
  /** Total profit and loss made. */
  returns: number;
  /** Percentage value of the total pnl. */
  returnsPercent: number;
1730}
1731/** Equity and mutual fund holdings which the user has in this demat account. */
1732interface Holdings {
  /** Details of each holding. */
  details: Holding[];
  /** Overall status of holdings in this demat account. */
  overall: HoldingsOverall;
1737}
1738/** Order placed by the user in the current trading day. */
1739interface Order {
  /** The order id assigned for each order. */
  id: string;
  /** The symbol for which order is placed. */
  symbol: string;
  /** A unique identifier for every symbol. */
  token: string;
  /** The name of symbol for which order is placed. */
  name: string;
  /** The exchange in which order is placed. */
  exchange: Exchange;
  /** Short name for the symbol Eg: “SBIN-EQ”. */
  description?: string;
  /** The segment this order is placed in. */
  segment: Segment;
  /** Exchange instrument type. */
  instrument: InstrumentType;
  /** The type of order. */
  type: OrderType;
  /** The order is buy or sell. */
  side: OrderSide;
  /** The product type. */
  productType: ProductType;
  /** Source from where the order was placed. */
  source: OrderSource;
  /** The status of the order. */
  status: OrderStatus;
  /** True when placing AMO order. */
  offline: boolean;
  /** The limit price for the order. */
  limitPrice: number;
  /** The stop price for the order. */
  stopPrice: number;
  /** The original order qty. */
  quantity: number;
  /** The remaining qty. */
  remainingQuantity: number;
  /** The filled qty after partial trades. */
  tradedQuantity: number;
  /** Disclosed quantity. */
  disclosedQuantity: number;
  /** Remaining disclosed quantity. */
  remainingDisclosedQuantity: number;
  /** Day or IOC. */
  validity: OrderValidity;
  /** The order time as per DD-MMM-YYYY hh:mm:ss in IST. */
  date: string;
  /** The parent order id will be provided only for applicable orders. */
  parentId?: string;
  /** Price change from previous trading day. */
  priceChange: number;
  /** Percent price change from previous trading day. */
  priceChangePercent: number;
  /** Last price of symbol. */
  currentPrice: number;
  /** The average traded price for the order. */
  tradedPrice: number;
  /** The error messages are shown here. */
  message: string;
  /** PAN of the client. */
  pan: string;
  /** The client id of the fyers user. */
  clientId: string;
1802}
1803/** Overall status of orders for the current trading day. */
1804interface OrdersOverall {
  /** Total number of orders present. */
  count: number;
  /** Total number of open orders. */
  openCount: number;
  /** Total number of closed orders. */
  closedCount: number;
  /** The original order qty. */
  quantity: number;
  /** The remaining qty. */
  remainingQuantity: number;
  /** The filled qty after partial trades. */
  tradedQuantity: number;
  /** Disclosed quantity. */
  disclosedQuantity: number;
  /** Remaining disclosed quantity. */
  remainingDisclosedQuantity: number;
1821}
1822/** All the orders placed by the user in the current trading day. */
1823interface Orders {
  /** List of all orders places during the day. */
  details: Order[];
  /** Overall status of orders. */
  overall: OrdersOverall;
1828}
1829/** Current open and closed position for the current trading day. */
1830interface Position {
  /** The unique value for each position. */
  id: string;
  /** Eg: NSE:SBIN-EQ. */
  symbol: string;
  /** A unique identifier for every symbol. */
  token: string;
  /** The segment in which the position is taken. */
  segment: Segment;
  /** The product type of the position. */
  productType: ProductType;
  /** The side shows whether the position is long / short. */
  side: PositionSide;
  /** Absolute value of net qty. */
  quantity: number;
  /** Incase of commodity positions, this multiplier is required for p&l calculation. */
  quantityMultiplier: number;
  /** Average buy price. */
  buyPrice: number;
  /** Total buy qty. */
  buyQuantity: number;
  /** Total buy value. */
  buyValue: number;
  /** Average sell price. */
  sellPrice: number;
  /** Total sell qty. */
  sellQuantity: number;
  /** Total sell value. */
  sellValue: number;
  /** Net average price. */
  netPrice: number;
  /** Net qty. */
  netQuantity: number;
  /** The total p&l of the position. */
  returns: number;
  /** The realized p&l of the position. */
  realizedReturns: number;
  /** The unrealized p&l of the open position. */
  unrealizedReturns: number;
  /** Is it a cross currency position? */
  crossCurrency: boolean;
  /** Incase of cross currency position, the rbi reference rate will be required to calculate the p&l. */
  rbiRefRate: number;
  /** LTP is the price from which the next sale of the stocks happens. */
  currentPrice: number;
1875}
1876/** Overall status of positions for the current trading day. */
1877interface PositionsOverall {
  /** Total number of positions present. */
  count: number;
  /** Total number of positions opened. */
  openCount: number;
  /** Total number of positions closed. */
  closedCount: number;
  /** Total buy value. */
  buyValue: number;
  /** Total sell value. */
  sellValue: number;
  /** Total profit and losses. */
  returns: number;
  /** Profit and losses when the owned product is sold. */
  realizedReturns: number;
  /** Profit and loses when the product is owned, but is not sold. */
  unrealizedReturns: number;
1894}
1895/** Current open and closed positions for the current trading day. */
1896interface Positions {
  /** List of all positions for the current trading day. */
  details: Position[];
  /** Overall status of positions for the current trading day. */
  overall: PositionsOverall;
1901}
1902/** Trade for the current day across all platforms and exchanges in the current trading day. */
1903interface Trade {
  /** The unique id to sort the trades. */
  id: string;
  /** The order id for which the trade occurred. */
  orderId: string;
  /** Eg: NSE:SBIN-EQ. */
  symbol: string;
  /** A unique identifier for every symbol. */
  token: string;
  /** The segment in which order is placed. */
  segment: Segment;
  /** The exchange in which order is placed. */
  exchange: Exchange;
  /** The trade is buy or sell. */
  side: OrderSide;
  /** The product in which the order was placed. */
  productType: ProductType;
  /** The type of order. */
  orderType: OrderType;
  /** The time when the trade occured in “DD-MM-YYYY hh:mm:ss” format in IST. */
  orderDate: string;
  /** The traded price. */
  price: number;
  /** The total traded qty. */
  quantity: number;
  /** The total traded value. */
  value: number;
  /** Client id. */
  clientId: string;
1932}
1933/** Overall trades for the current trading day. */
1934interface TradesOverall {
  /** Total number of trades. */
  count: number;
  /** The total traded qty. */
  quantity: number;
  /** The total traded value. */
  value: number;
1941}
1942/** All the trades for the current day across all platforms and exchanges in the current trading day. */
1943interface Trades {
  /** List of all trades for the current trading day. */
  details: Trade[];
  /** Overall trades for the current trading day. */
  overall: TradesOverall;
1948}
1949/** Defines an order to any exchange via Fyers. */
1950interface PlaceOrder {
  /** Eg: NSE:SBIN-EQ. */
  symbol: string;
  /** The type of order. */
  type?: OrderType;
  /** The order is buy or sell. */
  side?: OrderSide;
  /** The product in which the order was placed. */
  productType?: ProductType;
  /** Provide valid price for Limit and Stoplimit orders. */
  limitPrice?: number;
  /** Provide valid price for Stop and Stoplimit orders. */
  stopPrice?: number;
  /** The quantity should be in multiples of lot size for derivatives. */
  quantity: number;
  /** Allowed only for Equity. */
  disclosedQuantity?: number;
  /** Day or IOC. */
  validity?: OrderValidity;
  /** True when placing AMO order. */
  offline?: boolean;
  /** Provide valid price for CO and BO orders. */
  stopLoss?: number;
  /** Provide valid price for BO orders. */
  takeProfit?: number;
1975}
1976/** Defines an order modification request to Fyers. */
1977interface ModifyOrder {
  /** The order id assigned for each order. */
  id: string;
  /** The type of order. */
  type: OrderType;
  /** The original order qty. */
  quantity?: number;
  /** Disclosed quantity. */
  disclosedQuantity?: number;
  /** The limit price for the order. */
  limitPrice?: number;
  /** The stop price for the order. */
  stopPrice?: number;
1990}
1991/** Defines a convert position request to Fyers. */
1992interface ConvertPosition {
  /** Mandatory. Eg: 119031547242. */
  symbol: string;
  /** The side shows whether the position is long / short. */
  side?: PositionSide;
  /** Quantity to be converted. Has to be in multiples of lot size for derivatives. */
  quantity: number;
  /** Existing productType (CNC positions cannot be converted). */
  fromProductType?: ProductType;
  /** The new product type. */
  toProductType?: ProductType;
2003}
2004/** Current market status of an exchange's segment. */
2005interface MarketStatus {
  /** The exchange in which the position is taken. */
  exchange: Exchange;
  /** The segment in which the position is taken. */
  segment: Segment;
  /** TODO: The type of market: NL, MS, ES, ... */
  type: string;
  /** TODO: Market status: OPEN, CLOSE. */
  status: string;
2014}
2015/** Overall status of market segments. */
2016interface MarketsStatusOverall {
  /** Total number of market segments. */
  count: number;
  /** Total number of open market segments. */
  openCount: number;
  /** Total number of closed market segments. */
  closedCount: number;
2023}
2024/** Market status of all the exchanges and their segments. */
2025interface MarketsStatus {
  /** List of statuses of various market segments. */
  details: MarketStatus[];
  /** Overall status of market segments. */
  overall: MarketsStatusOverall;
2030}
2031/** Request for getting market history of a symbol. */
2032interface GetMarketHistory {
  /** Eg: NSE:RCOM-EQ. */
  symbol: string;
  /** The candle resolution in minutes. */
  resolution: number;
  /** Indicating the start date of records (epoch, yyyy-mm-dd). */
  fromDate: number;
  /** Indicating the end date of records. */
  toDate: number;
  /** Set cont flag 1 for continues data and future options. */
  continuous: boolean;
2043}
2044/** Candle in market history, quotes. */
2045interface Candle {
  /** UNIX epoch time. */
  date: number;
  /** Open price. */
  openPrice: number;
  /** High price. */
  highPrice: number;
  /** Low price. */
  lowPrice: number;
  /** Previous Close price. */
  closePrice: number;
  /** Volume. */
  volume: number;
2058}
2059/** Overall market history details. */
2060interface MarketHistoryOverall {
  /** Start UNIX epoch time. */
  fromDate: number;
  /** Stop UNIX epoch time. */
  toDate: number;
  /** Open price. */
  openPrice: number;
  /** High price. */
  highPrice: number;
  /** Low price. */
  lowPrice: number;
  /** Close price. */
  closePrice: number;
  /** Volume. */
  volume: number;
2075}
2076/** Market history of a particular stock. */
2077interface MarketHistory {
  /** List of candes. */
  details: Candle[];
  /** Overall status of market history. */
  overall: MarketHistoryOverall;
2082}
2083/** Market quote details for a particular symbol. */
2084interface MarketQuote {
  /** Symbol name provided by the user. */
  symbol: string;
  /** A unique identifier for every symbol. */
  token: string;
  /** Short name for the symbol Eg: “SBIN-EQ”. */
  name: string;
  /** Name of the exchange. Eg: “NSE” or “BSE”. */
  exchange: Exchange;
  /** Description of the symbol. */
  description?: string;
  /** Today’s time. */
  date: number;
  /** Last traded price. */
  currentPrice: number;
  /** Price at market opening time. */
  openPrice: number;
  /** Highest price for the day. */
  highPrice: number;
  /** Lowest price for the day. */
  lowPrice: number;
  /** Close price of the previous trading day. */
  closePrice: number;
  /** Volume traded. */
  volume: number;
  /** Change value. */
  priceChange: number;
  /** Percentage of change between the current value and the previous day's market close. */
  priceChangePercent: number;
  /** Current time, open, high, low price and volume with HH:MM timestamp. */
  candle: Candle;
  /** Asking price for the symbol. */
  sellPrice: number;
  /** Bidding price for the symbol. */
  buyPrice: number;
  /** Difference between lowest asking and highest bidding price. */
  priceSpread: number;
2121}
2122/** Open buy/sell orders at a particular price. */
2123interface MarketOffer {
  /** Bid/ask price. */
  price: number;
  /** Bid/ask volume. */
  volume: number;
  /** Orders? */
  orders: number;
2130}
2131/** A measure of the supply and demand for a symbol. */
2132interface MarketDepth {
  /** Symbol name provided by the user. */
  symbol: string;
  /** A unique identifier for every symbol. */
  token: string | null;
  /** Short name for the symbol Eg: “SBIN-EQ”. */
  name: string;
  /** Name of the exchange. Eg: “NSE” or “BSE”. */
  exchange: Exchange;
  /** Expiry date. */
  expiryDate: string;
  /** Last traded price. */
  currentPrice: number;
  /** Lower circuit price. */
  lowerCircuitPrice: number;
  /** Upper circuit price. */
  upperCircuitPrice: number;
  /** Price at market opening time. */
  openPrice?: number;
  /** Highest price for the day. */
  highPrice?: number;
  /** Lowest price for the day. */
  lowPrice?: number;
  /** Price at the of market closing. */
  closePrice?: number;
  /** Volume traded. */
  volume?: number;
  /** Change value. */
  priceChange: number;
  /** Percentage of change between the current value and the previous day's market close. */
  priceChangePercent: number;
  /** Open interest. */
  openInterest: number;
  /** Previous day open interest. */
  previousOpenInterest: number;
  /** Change in open Interest percentage. */
  openInterestChangePercent: number;
  /** Last traded time. */
  tradedDate: number;
  /** Last traded quantity. */
  tradedQuantity: number;
  /** Average traded price. */
  netPrice: number;
  /** Total buying quantity. */
  buyQuantity: number;
  /** Total selling quantity. */
  sellQuantity: number;
  /** Bidding price along with volume and total number of orders. */
  buyOffers: MarketOffer[];
  /** Offer price with volume and total number of orders. */
  sellOffers: MarketOffer[];
2183}
2184/** Details of an e-DIS transaction. */
2185interface EdisTransaction {
  /** Transaction id. */
  id: string;
  /** ISIN code of stock. */
  isin: string;
  /** Quantity to transact. */
  quantity: number;
  /** Quantity already transacted? */
  remainingQuantity: number;
  /** Transaction create date-time/ */
  entryDate: string;
  /** Transaction processing start date? */
  startDate: string;
  /** Transaction processing end date? */
  endDate: string;
  /** Source of transaction. */
  source: string;
  /** SUCCESS, FAILURE? */
  status: string;
  /** Unique client code? */
  clientId: string;
  /** Error code (NA). */
  errorCode: string;
  /** Error count (0). */
  errorCount: string;
  /** Message. */
  reason: string;
2212}
2213/** Overall status of e-DIS transaction in this demat account. */
2214interface EdisTransactionsOverall {
  /** Total number of transactions. */
  count: number;
  /** Quantity to transact. */
  quantity: number;
  /** Quantity already transacted? */
  remainingQuantity: number;
2221}
2222/** Details of all e-DIS transactions. */
2223interface EdisTransactions {
  /** List of e-DIS transactions. */
  details: EdisTransaction[];
  /** Overall status of transactions. */
  overall: EdisTransactionsOverall;
2228}
2229/** e-DIS securities held in a demat account. */
2230interface EdisHolding {
  /** 12-digit alphanumeric code of specific symbol. */
  isin: string;
  /** Quantity of securities held. */
  quantity: number;
2235}
2236/** Order update notification from WebSocket. */
2237interface OrderUpdateNotification {
  /** The unique order id assigned for each order. */
  id: string;
  /** The symbol for which order is placed. */
  symbol: string;
  /** A unique identifier for every symbol. */
  token: string;
  /** The type of order. */
  type: OrderType;
  /** The order is buy or sell. */
  side: OrderSide;
  /** The product type. */
  productType: ProductType;
  /** The status of the order. */
  status: OrderStatus;
  /** Day or IOC. */
  validity: OrderValidity;
  /** True when placing AMO order. */
  offline: boolean;
  /** The original order qty. */
  quantity: number;
  /** The remaining qty. */
  remainingQuantity: number;
  /** The filled qty after partial trades. */
  filledQuantity: number;
  /** Disclosed quantity. */
  disclosedQuantity: number;
  /** Remaining disclosed quantity. */
  remainingDisclosedQuantity: number;
  /** The limit price for the order. */
  limitPrice: number;
  /** The stop price for the order. */
  stopPrice: number;
  /** The order time as per DD-MMM-YYYY hh:mm:ss in IST. */
  date: string;
  /** The parent order id will be provided only for applicable orders. */
  parentId?: string;
  /** The average traded price for the order. */
  tradedPrice: number;
  /** The error messages are shown here. */
  message: string;
2278}
2279/** Market quote notification from WebSocket. */
2280interface MarketQuoteNotification {
  /** The symbol for which order is placed. */
  symbol?: string;
  /** A unique identifier for every symbol. */
  token: string;
  /** Short name for the symbol Eg: “SBIN-EQ”. */
  name: string | null;
  /** Name of the exchange. Eg: “NSE” or “BSE”. */
  exchange: Exchange | null;
  /** Timestamp sent by exchange (UNIX epoch). */
  date: number;
  /** Market status flag? */
  marketStatus: number;
  /** LTP is the price from which the next sale of the stocks happens. */
  currentPrice: number;
  /** Price at market opening time. */
  openPrice: number;
  /** Highest price for the day. */
  highPrice: number;
  /** Lowest price for the day. */
  lowPrice: number;
  /** Close price of the previous trading day. */
  closePrice: number;
  /** Change value. */
  priceChange: number;
  /** Percentage of change between the current value and the previous day's market close. */
  priceChangePercent: number;
  /** 1 minute candle. */
  candle: Candle;
  /** Open interest. */
  openInterest: number;
  /** Previous day open interest. */
  previousOpenInterest: number;
  /** Last traded quantity. */
  tradedQuantity: number;
  /** Last traded time (UNIX epoch). */
  tradedDate: number;
  /** Average traded price. */
  tradedPrice: number;
  /** Today's volume. */
  volume: number;
  /** Total buy quantity. */
  buyQuantity: number;
  /** Total sell quantity. */
  sellQuantity: number;
  /** Highest bid price. */
  buyPrice: number;
  /** Lowest ask price. */
  sellPrice: number;
  /** Difference between lowest asking and highest bidding price. */
  priceSpread: number;
2331}
2332/** Market depth notification from WebSocket. */
2333interface MarketDepthNotification extends MarketQuoteNotification {
  /** Bidding price along with volume and total number of orders. */
  buyOffers: MarketOffer[];
  /** Offer price with volume and total number of orders. */
  sellOffers: MarketOffer[];
2338}
2339/** Market depth notification from WebSocket. */
2340interface MarketDataNotification extends MarketDepthNotification {
2341}
2342/**
* Market data notified function.
* @param notification notification
*/
2346declare type OnMarketDataNotification = (notification: MarketDataNotification) => void;
2347/**
* Order update notified function.
* @param notification notification
*/
2351declare type OnOrderUpdateNotification = (notification: OrderUpdateNotification) => void;
2352/**
* Get equity delivery charges.
* @param side order side (BUY, SELL)
* @param value traded value
* @returns total charges including brokerage and taxes
*/
2358declare function equityDeliveryCharges(side: OrderSide, value: number): number;
2359/**
* Get equity intraday charges.
* @param side order side (BUY, SELL)
* @param value traded value
* @returns total charges including brokerage and taxes
*/
2365declare function equityIntradayCharges(side: OrderSide, value: number): number;
2366/**
* Get equity futures charges.
* @param side order side (BUY, SELL)
* @param value traded value
* @returns total charges including brokerage and taxes
*/
2372declare function equityFuturesCharges(side: OrderSide, value: number): number;
2373/**
* Get equity options charges.
* @param side order side (BUY, SELL)
* @param value traded value
* @returns total charges including brokerage and taxes
*/
2379declare function equityOptionsCharges(side: OrderSide, value: number): number;
2380/**
* Get currency futures charges.
* @param side order side (BUY, SELL)
* @param value traded value
* @returns total charges including brokerage and taxes
*/
2386declare function currencyFuturesCharges(side: OrderSide, value: number): number;
2387/**
* Get currency options charges.
* @param side order side (BUY, SELL)
* @param value traded value
* @returns total charges including brokerage and taxes
*/
2393declare function currencyOptionsCharges(side: OrderSide, value: number): number;
2394/**
* Get commodity futures charges.
* @param side order side (BUY, SELL)
* @param value traded value
* @returns total charges including brokerage and taxes
*/
2400declare function commodityFuturesCharges(side: OrderSide, value: number): number;
2401/**
* Get commodity options charges.
* @param side order side (BUY, SELL)
* @param value traded value
* @returns total charges including brokerage and taxes
*/
2407declare function commodityOptionsCharges(side: OrderSide, value: number): number;
2408/**
* Get request step 1 for authorization.
* @param appId app_id which you have received after creating the app
* @param redirectUrl where the user will be redirected after login
* @param state same value will be returned after login to the redirect url
* @returns request step 1 for authorization
*/
2415declare function loginStep1(appId: string, redirectUrl: string, state?: string): HttpRequestOptions;
2416/**
* Get request step 2 for authorization.
* @param appHash SHA-256 of `api_id:app_secret` in hex
* @param authorizationCode auth_code which is received from the first step
* @returns request step 2 for authorization
*/
2422declare function loginStep2(appHash: string, authorizationCode: string): HttpRequestOptions;
2423/**
* Get basic details of the client.
* @param auth authorization \{appId, accessToken\}
* @returns details of user's profile \{id, email, name, ...\}
*/
2428declare function getProfile(auth: Authorization): Promise<Profile>;
2429/**
* Get balance available for the user for capital as well as the commodity market.
* @param auth authorization \{appId, accessToken\}
* @returns details of user's funds \{equity: \{start, ...\}, commodity: \{start, ...\}\}
*/
2434declare function getFunds(auth: Authorization): Promise<Funds>;
2435/**
* Get the equity and mutual fund holdings which the user has in this demat account.
* @param auth authorization \{appId, accessToken\}
* @returns details of user's holdings \{details: [\{isin, ...\}], overall: \{count, ...\}\}
*/
2440declare function getHoldings(auth: Authorization): Promise<Holdings>;
2441/**
* Get details of an order placed in the current trading day.
* @param auth authorization \{appId, accessToken\}
* @param id order id
* @returns details of an order \{id, symbol, ticker, ...\}
*/
2447declare function getOrder(auth: Authorization, id: string): Promise<Order>;
2448/**
* Get details of all the orders placed in the current trading day.
* @param auth authorization \{appId, accessToken\}
* @returns details of orders \{details: [\{id, ...\}], overall: \{count, ...\}\}
*/
2453declare function getOrders(auth: Authorization): Promise<Orders>;
2454/**
* Get details of all the positions in the current trading day.
* @param auth authorization \{appId, accessToken\}
* @returns details of positions \{details: [\{id, ...\}], overall: \{count, ...\}\}
*/
2459declare function getPositions(auth: Authorization): Promise<Positions>;
2460/**
* Get details of all the trades in the current trading day.
* @param auth authorization \{appId, accessToken\}
* @returns details of trades \{details: [\{id, ...\}], overall: \{count, ...\}\}
*/
2465declare function getTrades(auth: Authorization): Promise<Trades>;
2466/**
* Place an order to any exchange via Fyers.
* @param auth authorization \{appId, accessToken\}
* @param order details of an order \{symbol, type, side, ...\}
* @returns order id
*/
2472declare function placeOrder(auth: Authorization, order: PlaceOrder): Promise<string>;
2473/**
* Place multiple orders to any exchange via Fyers.
* @param auth authorization \{appId, accessToken\}
* @param orders details of multiple orders [\{symbol, type, side, ...\}]
* @returns unique order ids
*/
2479declare function placeOrders(auth: Authorization, orders: PlaceOrder[]): Promise<string>[];
2480/**
* Modifies an order placed on any exchange via Fyers.
* @param auth authorization \{appId, accessToken\}
* @param order details of order \{id, type, quantity, ...\}
* @returns order id
*/
2486declare function modifyOrder(auth: Authorization, order: ModifyOrder): Promise<string>;
2487/**
* Modifies orders placed on any exchange via Fyers.
* @param auth authorization \{appId, accessToken\}
* @param orders details of orders [\{id, type, quantity, ...\}]
* @returns unique order ids
*/
2493declare function modifyOrders(auth: Authorization, orders: ModifyOrder[]): Promise<void>[];
2494/**
* Cancels an order placed on any exchange via Fyers.
* @param auth authorization \{appId, accessToken\}
* @param id order id
* @returns order id
*/
2500declare function cancelOrder(auth: Authorization, id: string): Promise<void>;
2501/**
* Cancels orders placed on any exchange via Fyers.
* @param auth authorization \{appId, accessToken\}
* @param ids unique order ids
* @returns unique order ids
*/
2507declare function cancelOrders(auth: Authorization, ids: string[]): Promise<void>[];
2508/**
* Exits a position on the current trading day.
* @param auth authorization \{appId, accessToken\}
* @param id position id
*/
2513declare function exitPosition(auth: Authorization, id: string): Promise<void>;
2514/**
* Exits all positions on the current trading day.
* @param auth authorization \{appId, accessToken\}
*/
2518declare function exitAllPositions(auth: Authorization): Promise<void>;
2519/**
* Converts a position on the current trading day.
* @param auth authorization \{appId, accessToken\}
* @param conversion details of conversion \{symbol, side, quantity, ...\}
*/
2524declare function convertPosition(auth: Authorization, conversion: ConvertPosition): Promise<void>;
2525/**
* Get the current market status of all the exchanges and their segments.
* @param auth authorization \{appId, accessToken\}
* @returns markets status \{details: [\{exchange, ...\}], overall: \{count, ...\}\}
*/
2530declare function getMarketStatus(auth: Authorization): Promise<MarketsStatus>;
2531/**
* Get the market history for a particular symbol.
* @param auth authorization \{appId, accessToken\}
* @param market market details \{symbol, resolution, fromDate, ...\}
* @returns market history \{details: [\{date, ...\}], overall: \{dateFrom, ...\}\}
*/
2537declare function getMarketHistory(auth: Authorization, market: GetMarketHistory): Promise<MarketHistory>;
2538/**
* Get the current market quotes for a set of symbols.
* @param auth authorization \{appId, accessToken\}
* @param symbols list of symbols
* @returns market quotes [\{symbol, name, exchange, ...\}]
*/
2544declare function getMarketQuotes(auth: Authorization, symbols: string[]): Promise<MarketQuote[]>;
2545/**
* Get the current market depth for a particular symbol.
* @param auth authorization \{appId, accessToken\}
* @param symbol symbol name
* @returns market depth \{buyQuantity, sellQuantity, buyOffers, ...\}
*/
2551declare function getMarketDepth(auth: Authorization, symbol: string): Promise<MarketDepth>;
2552/**
* Get all the latest symbols of all the exchanges from the symbol master files.
* @param auth authorization (unused)
* @param exchange exchange name
* @param segment segment name
* @returns symbol master file as text
*/
2559declare function getSymbolMaster(auth: null, exchange: string, segment: string): Promise<string>;
2560/**
* Get details of symbols from the symbol master file text.
* @param csv symbol master file text
* @returns list of symbol details [\{symbol, description, lotSize, ...\}]
*/
2565declare function processSymbolMaster(csv: string): SymbolDetails[];
2566/**
* Get details of symbols from the symbol master files.
* @param auth authorization (unused)
* @param exchange exchange name
* @param segment segment name
* @returns list of symbol details [\{symbol, description, lotSize, ...\}]
*/
2573declare function loadSymbolMaster(auth: null, exchange: string, segment: string): Promise<SymbolDetails[]>;
2574/**
* Generate e-DIS TPIN for validating/authorising transaction.
* @param auth authorization \{appId, accessToken\}
*/
2578declare function generateEdisTpin(auth: Authorization): Promise<void>;
2579/**
* Get the necessary information regarding the holdings you have on your and also the status of the holdings. If the “sell” for the particular holdings is a success or not.
* @param auth authorization \{appId, accessToken\}
* @returns list of e-DIS transactions \{details: [\{id, isin, ...\}], overall: \{count, quantity, ...\}\}
*/
2584declare function getEdisTransactions(auth: Authorization): Promise<EdisTransactions>;
2585/**
* Redirect to CDSL page for login where you can submit your Holdings information and accordingly you can provide the same to exchange to Sell your holdings (browser only).
* @param auth authorization \{appId, accessToken\}
* @param holdings holding details [\{isin, quantity\}]
* @returns HTTP(s) request options (manual)
*/
2591declare function submitEdisHoldingsStep(auth: Authorization, holdings: EdisHolding[]): HttpRequestOptions;
2592/**
* Inquire the information/status of the provided transaction Id for the respective holdings you have on your end.
* @param auth authorization \{appId, accessToken\}
* @param id transaction id
* @returns edis status
*/
2598declare function inquireEdisTransaction(auth: Authorization, id: string): Promise<number>;
2599/**
* Connect to Order update URL with WebSocket.
* @param auth authorization \{appId, accessToken\}
* @param fn notified function
* @returns WebSocket connection
*/
2605declare function connectOrderUpdate(auth: Authorization, fn: OnOrderUpdateNotification): Promise<Connection>;
2606/**
* Subscribe to order update.
* @param conn websocket connection
*/
2610declare function subscribeOrderUpdate(conn: Connection): Promise<void>;
2611/**
* Unsubscribe to order update.
* @param conn websocket connection
*/
2615declare function unsubscribeOrderUpdate(conn: Connection): Promise<void>;
2616/**
* Connect to Market data URL with WebSocket.
* @param auth authorization \{appId, accessToken\}
* @param fn notified function
* @returns WebSocket connection
*/
2622declare function connectMarketData(auth: Authorization, fn: OnMarketDataNotification, map?: Map<string, string>): Promise<Connection>;
2623/**
* Subscribe to market quote.
* @param conn websocket connection
* @param symbols list of symbols
*/
2628declare function subscribeMarketQuote(conn: Connection, symbols: string[]): Promise<void>;
2629/**
* Subscribe to market depth.
* @param conn websocket connection
* @param symbols list of symbols
*/
2634declare function subscribeMarketDepth(conn: Connection, symbols: string[]): Promise<void>;
2635/**
* Unsubscribe to market quote.
* @param conn websocket connection
* @param symbols list of symbols
*/
2640declare function unsubscribeMarketQuote(conn: Connection, symbols: string[]): Promise<void>;
2641/**
* Unsubscribe to market depth.
* @param conn websocket connection
* @param symbols list of symbols
*/
2646declare function unsubscribeMarketDepth(conn: Connection, symbols: string[]): Promise<void>;
2647/** Stateful interface for FYERS API. */
2648declare class Api implements Authorization {
  appId: string;
  accessToken: string;
  /** Symbol to symbol details map. */
  symbolDetails: Map<string, SymbolDetails>;
  /** Token to symbol map. */
  tokenSymbol: Map<string, string>;
  /** Order update notification connection. */
  orderUpdateConnection: Promise<Connection>;
  /** Market data notification connection. */
  marketDataConnection: Promise<Connection>;
  /**
   * Create a container that stores authorization, symbol maps, and connections (WebSocket).
   * @param appId unique app_id received after creating app
   * @param accessToken access token for the current trading day recieved after authorization
   */
  constructor(appId: string, accessToken: string);
  /**
   * Get request step 1 for authorization.
   * @param appId app_id which you have received after creating the app
   * @param redirectUrl where the user will be redirected after login
   * @param state same value will be returned after login to the redirect url
   * @returns request step 1 for authorization
   */
  static loginStep1(appId: string, redirectUrl: string, state?: string): HttpRequestOptions;
  /**
   * Get request step 2 for authorization.
   * @param appHash SHA-256 of `api_id:app_secret` in hex
   * @param authorizationCode auth_code which is received from the first step
   * @returns request step 2 for authorization
   */
  static loginStep2(appHash: string, authorizationCode: string): HttpRequestOptions;
  /**
   * Get all the latest symbols of all the exchanges from the symbol master files.
   * @param exchange exchange name
   * @param segment segment name
   * @returns symbol master file as text
   */
  static getSymbolMaster(exchange: string, segment: string): Promise<string>;
  /**
   * Get basic details of the client.
   * @returns details of user's profile \{id, email, name, ...\}
   */
  getProfile(): Promise<Profile>;
  /**
   * Get balance available for the user for capital as well as the commodity market.
   * @returns details of user's funds \{equity: \{start, ...\}, commodity: \{start, ...\}\}
   */
  getFunds(): Promise<Funds>;
  /**
   * Get the equity and mutual fund holdings which the user has in this demat account.
   * @returns details of user's holdings \{details: [\{isin, ...\}], overall: \{count, ...\}\}
   */
  getHoldings(): Promise<Holdings>;
  /**
   * Get details of an order placed in the current trading day.
   * @param id order id
   * @returns details of an order \{id, symbol, ticker, ...\}
   */
  getOrder(id: string): Promise<Order>;
  /**
   * Get details of all the orders placed in the current trading day.
   * @returns details of orders \{details: [\{id, ...\}], overall: \{count, ...\}\}
   */
  getOrders(): Promise<Orders>;
  /**
   * Get details of all the positions in the current trading day.
   * @returns details of positions \{details: [\{id, ...\}], overall: \{count, ...\}\}
   */
  getPositions(): Promise<Positions>;
  /**
   * Get details of all the trades in the current trading day.
   * @returns details of trades \{details: [\{id, ...\}], overall: \{count, ...\}\}
   */
  getTrades(): Promise<Trades>;
  /**
   * Place an order to any exchange via Fyers.
   * @param order details of an order \{symbol, type, side, ...\}
   * @returns order id
   */
  placeOrder(order: PlaceOrder): Promise<string>;
  /**
   * Place multiple orders to any exchange via Fyers.
   * @param orders details of multiple orders [\{symbol, type, side, ...\}]
   * @returns unique order ids
   */
  placeOrders(orders: PlaceOrder[]): Promise<string>[];
  /**
   * Modifies an order placed on any exchange via Fyers.
   * @param order details of order \{id, type, quantity, ...\}
   * @returns order id
   */
  modifyOrder(order: ModifyOrder): Promise<string>;
  /**
   * Modifies orders placed on any exchange via Fyers.
   * @param orders details of orders [\{id, type, quantity, ...\}]
   * @returns unique order ids
   */
  modifyOrders(orders: ModifyOrder[]): Promise<void>[];
  /**
   * Cancels an order placed on any exchange via Fyers.
   * @param id order id
   * @returns order id
   */
  cancelOrder(id: string): Promise<void>;
  /**
   * Cancels orders placed on any exchange via Fyers.
   * @param ids unique order ids
   * @returns unique order ids
   */
  cancelOrders(ids: string[]): Promise<void>[];
  /**
   * Exits a position on the current trading day.
   * @param id position id
   * @returns position status
   */
  exitPosition(id: string): Promise<void>;
  /**
   * Exits all positions on the current trading day.
   * @returns positions status
   */
  exitAllPositions(): Promise<void>;
  /**
   * Converts a position on the current trading day.
   * @param conversion details of conversion \{symbol, side, quantity, ...\}
   * @returns conversion status
   */
  convertPosition(conversion: ConvertPosition): Promise<void>;
  /**
   * Get the current market status of all the exchanges and their segments.
   * @returns markets status \{details: [\{exchange, ...\}], overall: \{count, ...\}\}
   */
  getMarketStatus(): Promise<MarketsStatus>;
  /**
   * Get the market history for a particular symbol.
   * @param market market details \{symbol, resolution, fromDate, ...\}
   * @returns market history \{details: [\{date, ...\}], overall: \{dateFrom, ...\}\}
   */
  getMarketHistory(market: GetMarketHistory): Promise<MarketHistory>;
  /**
   * Get the current market quotes for a set of symbols.
   * @param symbols list of symbols
   * @returns market quotes [\{symbol, name, exchange, ...\}]
   */
  getMarketQuotes(symbols: string[]): Promise<MarketQuote[]>;
  /**
   * Get the current market depth for a particular symbol.
   * @param symbol symbol name
   * @returns market depth \{buyQuantity, sellQuantity, buyOffers, ...\}
   */
  getMarketDepth(symbol: string): Promise<MarketDepth>;
  /**
   * Get details of symbols from the symbol master file text.
   * @param csv symbol master file text
   * @returns list of symbol details [\{symbol, description, lotSize, ...\}]
   */
  processSymbolMaster(csv: string): SymbolDetails[];
  /**
   * Get details of symbols from the symbol master files.
   * @param exchange exchange name
   * @param segment segment name
   * @returns list of symbol details [\{symbol, description, lotSize, ...\}]
   */
  loadSymbolMaster(exchange: string, segment: string): Promise<SymbolDetails[]>;
  /**
   * Generate e-DIS TPIN for validating/authorising transaction.
   * @returns optional data
   */
  generateEdisTpin(): Promise<void>;
  /**
   * Get the necessary information regarding the holdings you have on your and also the status of the holdings. If the “sell” for the particular holdings is a success or not.
   * @returns list of e-DIS transactions \{details: [\{id, isin, ...\}], overall: \{count, quantity, ...\}\}
   */
  getEdisTransactions(): Promise<EdisTransactions>;
  /**
   * Redirect to CDSL page for login where you can submit your Holdings information and accordingly you can provide the same to exchange to Sell your holdings (browser only).
   * @param holdings holding details [\{isin, quantity\}]
   * @returns HTTP(s) request options (manual)
   */
  submitEdisHoldingsStep(holdings: EdisHolding[]): HttpRequestOptions;
  /**
   * Inquire the information/status of the provided transaction Id for the respective holdings you have on your end.
   * @param id transaction id
   * @returns edis status
   */
  inquireEdisTransaction(id: string): Promise<number>;
  /**
   * Connect to Order update URL with WebSocket.
   * @param fn notified function
   * @returns WebSocket connection
   */
  connectOrderUpdate(fn: OnOrderUpdateNotification): Promise<Connection>;
  /**
   * Subscribe to order update.
   */
  subscribeOrderUpdate(): Promise<void>;
  /**
   * Unsubscribe to order update.
   */
  unsubscribeOrderUpdate(): Promise<void>;
  /**
   * Connect to Market data URL with WebSocket.
   * @param fn notified function
   * @returns WebSocket connection
   */
  connectMarketData(fn: OnMarketDataNotification): Promise<Connection>;
  /**
   * Subscribe to market quote.
   * @param symbols list of symbols
   */
  subscribeMarketQuote(symbols: string[]): Promise<void>;
  /**
   * Subscribe to market depth.
   * @param symbols list of symbols
   */
  subscribeMarketDepth(symbols: string[]): Promise<void>;
  /**
   * Unsubscribe to market quote.
   * @param symbols list of symbols
   */
  unsubscribeMarketQuote(symbols: string[]): Promise<void>;
  /**
   * Unsubscribe to market depth.
   * @param symbols list of symbols
   */
  unsubscribeMarketDepth(symbols: string[]): Promise<void>;
2874}
2875
2876export { Api, Authorization, Candle, ConvertPosition, DerivativeType, EdisHolding, EdisTransaction, EdisTransactions, EdisTransactionsOverall, Exchange, Fund, Funds, GetMarketHistory, Holding, HoldingType, Holdings, HoldingsOverall, HttpHeaders, HttpRequestOptions, InstrumentType, LoginStep1Request, LoginStep1Response, LoginStep2Request, LoginStep2Response, MarketDataNotification, MarketDepth, MarketDepthNotification, MarketHistory, MarketHistoryOverall, MarketOffer, MarketQuote, MarketQuoteNotification, MarketStatus, MarketsStatus, MarketsStatusOverall, ModifyOrder, OnMarketDataNotification, OnOrderUpdateNotification, OptionType, Order, OrderSide, OrderSource, OrderStatus, OrderType, OrderUpdateNotification, OrderValidity, Orders, OrdersOverall, PlaceOrder, Position, PositionSide, Positions, PositionsOverall, ProductType, Profile, Segment, SymbolDetails, Trade, Trades, TradesOverall, cancelOrder, cancelOrders, commodityFuturesCharges, commodityOptionsCharges, connectMarketData, connectOrderUpdate, convertPosition, currencyFuturesCharges, currencyOptionsCharges, derivativeType, derivativeTypeDescription, equityDeliveryCharges, equityFuturesCharges, equityIntradayCharges, equityOptionsCharges, exchange, exchangeDescription, exitAllPositions, exitPosition, generateEdisTpin, getEdisTransactions, getFunds, getHoldings, getMarketDepth, getMarketHistory, getMarketQuotes, getMarketStatus, getOrder, getOrders, getPositions, getProfile, getSymbolMaster, getTrades, holdingType, holdingTypeDescription, http_d as http, inquireEdisTransaction, instrumentType, instrumentTypeDescription, loadSymbolMaster, loginStep1, loginStep2, modifyOrder, modifyOrders, optionType, optionTypeDescription, orderSide, orderSideDescription, orderSource, orderSourceDescription, orderStatus, orderStatusDescription, orderType, orderTypeDescription, orderValidity, orderValidityDescription, placeOrder, placeOrders, positionSide, positionSideDescription, processSymbolMaster, productType, productTypeDescription, segment, segmentDescription, submitEdisHoldingsStep, subscribeMarketDepth, subscribeMarketQuote, subscribeOrderUpdate, symbolDerivativeType, symbolDescription, symbolExchange, symbolIsin, symbolLotSize, symbolName, symbolOptionType, symbolSeries, symbolStrikePrice, symbolToken, unsubscribeMarketDepth, unsubscribeMarketQuote, unsubscribeOrderUpdate, websocket_d as websocket };
1	`/// <reference types="ws" />`
2	`import { WebSocket } from 'ws';`
3
4	`/** HTTP(s) header keys and values. */`
5	`interface HttpHeaders {`
6	`[key: string]: string;`
7	`}`
8	`/** HTTP(s) request options. */`
9	`interface HttpRequestOptions {`
10	`/** Full URL, inluding protocol and query. */`
11	`url: string;`
12	`/** HTTP(s) method (GET). */`
13	`method?: string;`
14	`/** Body of request (JSON). */`
15	`body?: object \| null;`
16	`/** Request headers. */`
17	`headers?: HttpHeaders;`
18	`/** What if we don't get a response? */`
19	`timeout?: number;`
20	`}`
21
22	`/** Root URL for API requests. */`
23	`declare const API_URL: string;`
24	`/** Root URL for Data API requests. */`
25	`declare const DATA_URL: string;`
26	`/** Root URL for Symbol master files. */`
27	`declare const SYMBOLS_URL: string;`
28	`/** Common response format. */`
29	`interface Response {`
30	`/** ok / error. */`
31	`s: string;`
32	`/** This is the code to identify specific responses. */`
33	`code?: number;`
34	`/** This is the message to identify the specific error responses. */`
35	`message?: string;`
36	`}`
37	`/** HTTP data of multi-response. */`
38	`interface ProxyResponse<Body> {`
39	`/** HTTP status code. */`
40	`statusCode: number;`