├── mocha.opts
├── .github
└── workflows
│ └── CODEOWNER
├── test
├── sdk
│ ├── DataToken.js
│ ├── PortfolioStreamer.js
│ └── PlaceOrder.js
├── model
│ ├── OrderMetadata.spec.js
│ ├── GttOrderData.spec.js
│ ├── MarginRequest.spec.js
│ ├── MultiOrderV3Data.spec.js
│ ├── GttCancelOrderRequest.spec.js
│ ├── IndieUserTokenRequest.spec.js
│ ├── TradeHistoryResponseMetaData.spec.js
│ ├── CancelOrExitMultiOrderData.spec.js
│ ├── GetHolidayResponse.spec.js
│ ├── PostMarginResponse.spec.js
│ ├── GetOptionChainResponse.spec.js
│ ├── GetMarketStatusResponse.spec.js
│ ├── GetOrderDetailsResponse.spec.js
│ ├── MultiOrderData.spec.js
│ ├── GetExchangeTimingResponse.spec.js
│ ├── GetOptionContractResponse.spec.js
│ ├── IndieUserInitTokenResponse.spec.js
│ ├── IndieUserInitTokenData.spec.js
│ ├── GttRule.spec.js
│ ├── GetGttOrderResponse.spec.js
│ ├── BatchExecutionSummary.spec.js
│ ├── PlaceOrderV3Response.spec.js
│ ├── TradeHistoryResponse.spec.js
│ ├── CancelOrderV3Response.spec.js
│ ├── ModifyOrderV3Response.spec.js
│ ├── MarginData.spec.js
│ ├── MarketStatusData.spec.js
│ ├── ExchangeTimingData.spec.js
│ ├── GttTriggerOrderResponse.spec.js
│ └── PutCallOptionChainData.spec.js
└── api
│ └── PostTradeApi.spec.js
├── .travis.yml
├── examples
├── websocket
│ ├── react_websocket
│ │ ├── public
│ │ │ ├── robots.txt
│ │ │ ├── favicon.ico
│ │ │ ├── logo192.png
│ │ │ ├── logo512.png
│ │ │ ├── manifest.json
│ │ │ └── index.html
│ │ ├── src
│ │ │ ├── index.js
│ │ │ ├── App.js
│ │ │ └── App.css
│ │ ├── .gitignore
│ │ ├── package.json
│ │ └── README.md
│ └── order_updates
│ │ └── README.md
└── README.md
├── docs
├── OrderMetadata.md
├── ModifyOrderData.md
├── MultiOrderV3Data.md
├── IntraDayCandleData.md
├── CancelOrderData.md
├── HistoricalCandleData.md
├── MarginRequest.md
├── GttOrderData.md
├── BrokerageWrapperData.md
├── PlaceOrderData.md
├── CancelOrExitMultiOrderData.md
├── ConvertPositionData.md
├── WebsocketAuthRedirectResponseData.md
├── DpPlan.md
├── GttCancelOrderRequest.md
├── DepthMap.md
├── ProfitAndLossMetaDataWrapper.md
├── TradeHistoryResponseMetaData.md
├── Depth.md
├── ProfitAndLossChargesWrapperData.md
├── MarketQuoteSymbolLtp.md
├── MarketStatusData.md
├── ProfitAndLossMetaData.md
├── ExchangeTimingData.md
├── IndieUserTokenRequest.md
├── IndieUserInitTokenData.md
├── BrokerageTaxes.md
├── MarketQuoteOHLC.md
├── OtherTaxes.md
├── ProfitAndLossChargesTaxes.md
├── MultiOrderData.md
├── PutCallOptionChainData.md
├── TradeHistoryResponsePageData.md
├── TradeWiseMetaData.md
├── LogoutResponse.md
├── MarketQuoteSymbolLtpV3.md
├── OAuthClientExceptionCauseSuppressed.md
├── AnalyticsData.md
├── MarketQuoteOHLCV3.md
├── PostMarginResponse.md
├── GetProfileResponse.md
├── MarginData.md
├── ApiGatewayErrorResponse.md
├── PlaceOrderResponse.md
├── CancelOrderResponse.md
├── ModifyOrderResponse.md
├── Rule.md
├── GetTradeResponse.md
├── GetBrokerageResponse.md
├── GetMarketStatusResponse.md
├── ConvertPositionResponse.md
├── GetIntraDayCandleResponse.md
├── GetOrderResponse.md
├── GetHoldingsResponse.md
├── GetHolidayResponse.md
├── GetExpiriesResponse.md
├── GetFullMarketQuoteResponse.md
├── GetHistoricalCandleResponse.md
├── GetMarketQuoteOHLCResponse.md
├── GetOrderBookResponse.md
├── GetPositionResponse.md
├── GetOptionChainResponse.md
├── GetOptionContractResponse.md
├── GetTradeWiseProfitAndLossMetaDataResponse.md
├── GetUserFundMarginResponse.md
├── GetExchangeTimingResponse.md
├── GetMarketQuoteLastTradedPriceResponse.md
├── GetOrderDetailsResponse.md
├── GetProfitAndLossChargesResponse.md
├── Ohlc.md
├── WebsocketAuthRedirectResponse.md
├── BrokerageData.md
├── IndieUserInitTokenResponse.md
├── GetExpiredFuturesContractResponse.md
├── GetMarketQuoteOHLCResponseV3.md
├── OAuthClientExceptionCause.md
├── ProfitAndLossOtherChargesTaxes.md
├── BatchExecutionSummary.md
├── ProfitAndLossChargesData.md
├── Instrument.md
├── GetMarketQuoteOptionGreekResponseV3.md
├── GetMarketQuoteLastTradedPriceResponseV3.md
├── CancelOrderV3Response.md
├── GttTriggerOrderResponse.md
├── MarketData.md
├── ModifyOrderV3Response.md
├── PlaceOrderV3Response.md
├── TradeHistoryResponse.md
├── GetGttOrderResponse.md
├── OptionStrikeData.md
├── OAuthClientExceptionCauseStackTrace.md
├── TokenRequest.md
├── OAuthClientException.md
├── GetTradeWiseProfitAndLossDataResponse.md
├── Problem.md
├── OhlcV3.md
├── GttOrderDetails.md
├── MarketQuoteOptionGreekV3.md
├── MultiOrderResponse.md
├── HolidayData.md
├── CancelOrExitMultiOrderResponse.md
├── GttModifyOrderRequest.md
├── MultiOrderError.md
├── CancelOrExitOrderErrorData.md
├── GttRule.md
├── MultiOrderSummary.md
├── Margin.md
├── UserFundMarginData.md
├── TradeHistoryResponseTradeData.md
├── TradeWiseProfitAndLossData.md
├── ConvertPositionRequest.md
├── GttPlaceOrderRequest.md
├── ModifyOrderRequest.md
├── ExpiredFutureData.md
├── MarketQuoteSymbol.md
├── ProfileData.md
├── PlaceOrderV3Request.md
├── TokenResponse.md
├── PlaceOrderRequest.md
├── InstrumentData.md
├── MultiOrderRequest.md
└── HoldingsData.md
├── .npmignore
├── src
├── feeder
│ ├── PortfolioDataStreamer.js
│ └── Feeder.js
└── model
│ ├── OrderMetadata.js
│ ├── MultiOrderV3Data.js
│ ├── GttOrderData.js
│ ├── IndieUserTokenRequest.js
│ ├── MarginRequest.js
│ ├── CancelOrExitMultiOrderData.js
│ ├── TradeHistoryResponseMetaData.js
│ ├── GttCancelOrderRequest.js
│ ├── MultiOrderData.js
│ ├── IndieUserInitTokenData.js
│ ├── ExchangeTimingData.js
│ ├── MarketStatusData.js
│ ├── MarginData.js
│ ├── PostMarginResponse.js
│ ├── GetHolidayResponse.js
│ ├── PutCallOptionChainData.js
│ ├── GetExpiriesResponse.js
│ ├── GetMarketStatusResponse.js
│ ├── GetOptionChainResponse.js
│ └── BatchExecutionSummary.js
├── .babelrc
└── package.json
/mocha.opts:
--------------------------------------------------------------------------------
1 | --timeout 10000
2 |
--------------------------------------------------------------------------------
/.github/workflows/CODEOWNER:
--------------------------------------------------------------------------------
1 | # CODEOWNERS
2 | * @upstox-security-review
3 |
--------------------------------------------------------------------------------
/test/sdk/DataToken.js:
--------------------------------------------------------------------------------
1 | let accessToken = "access_token";
2 | module.exports = {accessToken};
--------------------------------------------------------------------------------
/.travis.yml:
--------------------------------------------------------------------------------
1 | language: node_js
2 | node_js:
3 | - "6"
4 | - "6.1"
5 | - "5"
6 | - "5.11"
7 |
8 |
--------------------------------------------------------------------------------
/examples/websocket/react_websocket/public/robots.txt:
--------------------------------------------------------------------------------
1 | # https://www.robotstxt.org/robotstxt.html
2 | User-agent: *
3 | Disallow:
4 |
--------------------------------------------------------------------------------
/examples/websocket/react_websocket/public/favicon.ico:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/upstox/upstox-nodejs/HEAD/examples/websocket/react_websocket/public/favicon.ico
--------------------------------------------------------------------------------
/examples/websocket/react_websocket/public/logo192.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/upstox/upstox-nodejs/HEAD/examples/websocket/react_websocket/public/logo192.png
--------------------------------------------------------------------------------
/examples/websocket/react_websocket/public/logo512.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/upstox/upstox-nodejs/HEAD/examples/websocket/react_websocket/public/logo512.png
--------------------------------------------------------------------------------
/docs/OrderMetadata.md:
--------------------------------------------------------------------------------
1 | # UpstoxClient.OrderMetadata
2 |
3 | ## Properties
4 | Name | Type | Description | Notes
5 | ------------ | ------------- | ------------- | -------------
6 | **latency** | **Number** | | [optional]
7 |
--------------------------------------------------------------------------------
/docs/ModifyOrderData.md:
--------------------------------------------------------------------------------
1 | # UpstoxClient.ModifyOrderData
2 |
3 | ## Properties
4 | Name | Type | Description | Notes
5 | ------------ | ------------- | ------------- | -------------
6 | **orderId** | **String** | Order ID | [optional]
7 |
--------------------------------------------------------------------------------
/docs/MultiOrderV3Data.md:
--------------------------------------------------------------------------------
1 | # UpstoxClient.MultiOrderV3Data
2 |
3 | ## Properties
4 | Name | Type | Description | Notes
5 | ------------ | ------------- | ------------- | -------------
6 | **orderIds** | **[String]** | | [optional]
7 |
--------------------------------------------------------------------------------
/docs/IntraDayCandleData.md:
--------------------------------------------------------------------------------
1 | # UpstoxClient.IntraDayCandleData
2 |
3 | ## Properties
4 | Name | Type | Description | Notes
5 | ------------ | ------------- | ------------- | -------------
6 | **candles** | **[[Object]]** | | [optional]
7 |
--------------------------------------------------------------------------------
/docs/CancelOrderData.md:
--------------------------------------------------------------------------------
1 | # UpstoxClient.CancelOrderData
2 |
3 | ## Properties
4 | Name | Type | Description | Notes
5 | ------------ | ------------- | ------------- | -------------
6 | **orderId** | **String** | Reference order ID | [optional]
7 |
--------------------------------------------------------------------------------
/docs/HistoricalCandleData.md:
--------------------------------------------------------------------------------
1 | # UpstoxClient.HistoricalCandleData
2 |
3 | ## Properties
4 | Name | Type | Description | Notes
5 | ------------ | ------------- | ------------- | -------------
6 | **candles** | **[[Object]]** | | [optional]
7 |
--------------------------------------------------------------------------------
/docs/MarginRequest.md:
--------------------------------------------------------------------------------
1 | # UpstoxClient.MarginRequest
2 |
3 | ## Properties
4 | Name | Type | Description | Notes
5 | ------------ | ------------- | ------------- | -------------
6 | **instruments** | [**[Instrument]**](Instrument.md) | instruments |
7 |
--------------------------------------------------------------------------------
/examples/websocket/react_websocket/src/index.js:
--------------------------------------------------------------------------------
1 | import React from "react";
2 | import ReactDOM from "react-dom/client";
3 | import App from "./App";
4 |
5 | const root = ReactDOM.createRoot(document.getElementById("root"));
6 | root.render();
7 |
--------------------------------------------------------------------------------
/docs/GttOrderData.md:
--------------------------------------------------------------------------------
1 | # UpstoxClient.GttOrderData
2 |
3 | ## Properties
4 | Name | Type | Description | Notes
5 | ------------ | ------------- | ------------- | -------------
6 | **gttOrderIds** | **[String]** | Order ID for the placed GTT order | [optional]
7 |
--------------------------------------------------------------------------------
/docs/BrokerageWrapperData.md:
--------------------------------------------------------------------------------
1 | # UpstoxClient.BrokerageWrapperData
2 |
3 | ## Properties
4 | Name | Type | Description | Notes
5 | ------------ | ------------- | ------------- | -------------
6 | **charges** | [**BrokerageData**](BrokerageData.md) | | [optional]
7 |
--------------------------------------------------------------------------------
/docs/PlaceOrderData.md:
--------------------------------------------------------------------------------
1 | # UpstoxClient.PlaceOrderData
2 |
3 | ## Properties
4 | Name | Type | Description | Notes
5 | ------------ | ------------- | ------------- | -------------
6 | **orderId** | **String** | An order ID for the order request placed | [optional]
7 |
--------------------------------------------------------------------------------
/docs/CancelOrExitMultiOrderData.md:
--------------------------------------------------------------------------------
1 | # UpstoxClient.CancelOrExitMultiOrderData
2 |
3 | ## Properties
4 | Name | Type | Description | Notes
5 | ------------ | ------------- | ------------- | -------------
6 | **orderIds** | **[String]** | Reference order IDs | [optional]
7 |
--------------------------------------------------------------------------------
/docs/ConvertPositionData.md:
--------------------------------------------------------------------------------
1 | # UpstoxClient.ConvertPositionData
2 |
3 | ## Properties
4 | Name | Type | Description | Notes
5 | ------------ | ------------- | ------------- | -------------
6 | **status** | **String** | Status message for convert position request | [optional]
7 |
--------------------------------------------------------------------------------
/docs/WebsocketAuthRedirectResponseData.md:
--------------------------------------------------------------------------------
1 | # UpstoxClient.WebsocketAuthRedirectResponseData
2 |
3 | ## Properties
4 | Name | Type | Description | Notes
5 | ------------ | ------------- | ------------- | -------------
6 | **authorizedRedirectUri** | **String** | | [optional]
7 |
--------------------------------------------------------------------------------
/docs/DpPlan.md:
--------------------------------------------------------------------------------
1 | # UpstoxClient.DpPlan
2 |
3 | ## Properties
4 | Name | Type | Description | Notes
5 | ------------ | ------------- | ------------- | -------------
6 | **name** | **String** | Name | [optional]
7 | **minExpense** | **Number** | Minimum expense charges | [optional]
8 |
--------------------------------------------------------------------------------
/docs/GttCancelOrderRequest.md:
--------------------------------------------------------------------------------
1 | # UpstoxClient.GttCancelOrderRequest
2 |
3 | ## Properties
4 | Name | Type | Description | Notes
5 | ------------ | ------------- | ------------- | -------------
6 | **gttOrderId** | **String** | Unique identifier of the GTT order to be cancelled |
7 |
--------------------------------------------------------------------------------
/docs/DepthMap.md:
--------------------------------------------------------------------------------
1 | # UpstoxClient.DepthMap
2 |
3 | ## Properties
4 | Name | Type | Description | Notes
5 | ------------ | ------------- | ------------- | -------------
6 | **buy** | [**[Depth]**](Depth.md) | Bids | [optional]
7 | **sell** | [**[Depth]**](Depth.md) | Asks | [optional]
8 |
--------------------------------------------------------------------------------
/docs/ProfitAndLossMetaDataWrapper.md:
--------------------------------------------------------------------------------
1 | # UpstoxClient.ProfitAndLossMetaDataWrapper
2 |
3 | ## Properties
4 | Name | Type | Description | Notes
5 | ------------ | ------------- | ------------- | -------------
6 | **page** | [**ProfitAndLossMetaData**](ProfitAndLossMetaData.md) | | [optional]
7 |
--------------------------------------------------------------------------------
/docs/TradeHistoryResponseMetaData.md:
--------------------------------------------------------------------------------
1 | # UpstoxClient.TradeHistoryResponseMetaData
2 |
3 | ## Properties
4 | Name | Type | Description | Notes
5 | ------------ | ------------- | ------------- | -------------
6 | **page** | [**TradeHistoryResponsePageData**](TradeHistoryResponsePageData.md) | | [optional]
7 |
--------------------------------------------------------------------------------
/docs/Depth.md:
--------------------------------------------------------------------------------
1 | # UpstoxClient.Depth
2 |
3 | ## Properties
4 | Name | Type | Description | Notes
5 | ------------ | ------------- | ------------- | -------------
6 | **quantity** | **Number** | quantity | [optional]
7 | **price** | **Number** | price | [optional]
8 | **orders** | **Number** | orders | [optional]
9 |
--------------------------------------------------------------------------------
/docs/ProfitAndLossChargesWrapperData.md:
--------------------------------------------------------------------------------
1 | # UpstoxClient.ProfitAndLossChargesWrapperData
2 |
3 | ## Properties
4 | Name | Type | Description | Notes
5 | ------------ | ------------- | ------------- | -------------
6 | **chargesBreakdown** | [**ProfitAndLossChargesData**](ProfitAndLossChargesData.md) | | [optional]
7 |
--------------------------------------------------------------------------------
/docs/MarketQuoteSymbolLtp.md:
--------------------------------------------------------------------------------
1 | # UpstoxClient.MarketQuoteSymbolLtp
2 |
3 | ## Properties
4 | Name | Type | Description | Notes
5 | ------------ | ------------- | ------------- | -------------
6 | **lastPrice** | **Number** | The last traded price of symbol | [optional]
7 | **instrumentToken** | **String** | | [optional]
8 |
--------------------------------------------------------------------------------
/docs/MarketStatusData.md:
--------------------------------------------------------------------------------
1 | # UpstoxClient.MarketStatusData
2 |
3 | ## Properties
4 | Name | Type | Description | Notes
5 | ------------ | ------------- | ------------- | -------------
6 | **exchange** | **String** | | [optional]
7 | **status** | **String** | | [optional]
8 | **lastUpdated** | **Number** | | [optional]
9 |
--------------------------------------------------------------------------------
/docs/ProfitAndLossMetaData.md:
--------------------------------------------------------------------------------
1 | # UpstoxClient.ProfitAndLossMetaData
2 |
3 | ## Properties
4 | Name | Type | Description | Notes
5 | ------------ | ------------- | ------------- | -------------
6 | **pageNumber** | **Number** | pageNumber for pagination | [optional]
7 | **pageSize** | **Number** | Page size | [optional]
8 |
--------------------------------------------------------------------------------
/docs/ExchangeTimingData.md:
--------------------------------------------------------------------------------
1 | # UpstoxClient.ExchangeTimingData
2 |
3 | ## Properties
4 | Name | Type | Description | Notes
5 | ------------ | ------------- | ------------- | -------------
6 | **exchange** | **String** | | [optional]
7 | **startTime** | **Number** | | [optional]
8 | **endTime** | **Number** | | [optional]
9 |
--------------------------------------------------------------------------------
/docs/IndieUserTokenRequest.md:
--------------------------------------------------------------------------------
1 | # UpstoxClient.IndieUserTokenRequest
2 |
3 | ## Properties
4 | Name | Type | Description | Notes
5 | ------------ | ------------- | ------------- | -------------
6 | **clientSecret** | **String** | OAuth client secret that is a private secret known only to app and authorization server | [optional]
7 |
--------------------------------------------------------------------------------
/docs/IndieUserInitTokenData.md:
--------------------------------------------------------------------------------
1 | # UpstoxClient.IndieUserInitTokenData
2 |
3 | ## Properties
4 | Name | Type | Description | Notes
5 | ------------ | ------------- | ------------- | -------------
6 | **authorizationExpiry** | **String** | authorize token expiry | [optional]
7 | **notifierUrl** | **String** | notifier webhook url | [optional]
8 |
--------------------------------------------------------------------------------
/docs/BrokerageTaxes.md:
--------------------------------------------------------------------------------
1 | # UpstoxClient.BrokerageTaxes
2 |
3 | ## Properties
4 | Name | Type | Description | Notes
5 | ------------ | ------------- | ------------- | -------------
6 | **gst** | **Number** | GST charges | [optional]
7 | **stt** | **Number** | STT charges | [optional]
8 | **stampDuty** | **Number** | Stamp duty charges | [optional]
9 |
--------------------------------------------------------------------------------
/docs/MarketQuoteOHLC.md:
--------------------------------------------------------------------------------
1 | # UpstoxClient.MarketQuoteOHLC
2 |
3 | ## Properties
4 | Name | Type | Description | Notes
5 | ------------ | ------------- | ------------- | -------------
6 | **ohlc** | [**Ohlc**](Ohlc.md) | | [optional]
7 | **lastPrice** | **Number** | The last traded price of symbol | [optional]
8 | **instrumentToken** | **String** | | [optional]
9 |
--------------------------------------------------------------------------------
/docs/OtherTaxes.md:
--------------------------------------------------------------------------------
1 | # UpstoxClient.OtherTaxes
2 |
3 | ## Properties
4 | Name | Type | Description | Notes
5 | ------------ | ------------- | ------------- | -------------
6 | **transaction** | **Number** | Transaction charges | [optional]
7 | **clearing** | **Number** | Clearing charges | [optional]
8 | **sebiTurnover** | **Number** | SEBI turnover charges | [optional]
9 |
--------------------------------------------------------------------------------
/docs/ProfitAndLossChargesTaxes.md:
--------------------------------------------------------------------------------
1 | # UpstoxClient.ProfitAndLossChargesTaxes
2 |
3 | ## Properties
4 | Name | Type | Description | Notes
5 | ------------ | ------------- | ------------- | -------------
6 | **gst** | **Number** | GST charges | [optional]
7 | **stt** | **Number** | STT charges | [optional]
8 | **stampDuty** | **Number** | Stamp duty charges | [optional]
9 |
--------------------------------------------------------------------------------
/docs/MultiOrderData.md:
--------------------------------------------------------------------------------
1 | # UpstoxClient.MultiOrderData
2 |
3 | ## Properties
4 | Name | Type | Description | Notes
5 | ------------ | ------------- | ------------- | -------------
6 | **correlationId** | **String** | A unique identifier for tracking individual orders within the batch | [optional]
7 | **orderId** | **String** | An order ID for the order request placed | [optional]
8 |
--------------------------------------------------------------------------------
/docs/PutCallOptionChainData.md:
--------------------------------------------------------------------------------
1 | # UpstoxClient.PutCallOptionChainData
2 |
3 | ## Properties
4 | Name | Type | Description | Notes
5 | ------------ | ------------- | ------------- | -------------
6 | **instrumentKey** | **String** | | [optional]
7 | **marketData** | [**MarketData**](MarketData.md) | | [optional]
8 | **optionGreeks** | [**AnalyticsData**](AnalyticsData.md) | | [optional]
9 |
--------------------------------------------------------------------------------
/docs/TradeHistoryResponsePageData.md:
--------------------------------------------------------------------------------
1 | # UpstoxClient.TradeHistoryResponsePageData
2 |
3 | ## Properties
4 | Name | Type | Description | Notes
5 | ------------ | ------------- | ------------- | -------------
6 | **pageNumber** | **Number** | | [optional]
7 | **pageSize** | **Number** | | [optional]
8 | **totalRecords** | **Number** | | [optional]
9 | **totalPages** | **Number** | | [optional]
10 |
--------------------------------------------------------------------------------
/docs/TradeWiseMetaData.md:
--------------------------------------------------------------------------------
1 | # UpstoxClient.TradeWiseMetaData
2 |
3 | ## Properties
4 | Name | Type | Description | Notes
5 | ------------ | ------------- | ------------- | -------------
6 | **tradesCount** | **Number** | Total count of trades in the trade wise P and L report | [optional]
7 | **pageSizeLimit** | **Number** | Maximum number of trades in a page of the trade wise P and L report API | [optional]
8 |
--------------------------------------------------------------------------------
/docs/LogoutResponse.md:
--------------------------------------------------------------------------------
1 | # UpstoxClient.LogoutResponse
2 |
3 | ## Properties
4 | Name | Type | Description | Notes
5 | ------------ | ------------- | ------------- | -------------
6 | **status** | **String** | | [optional]
7 | **data** | **Boolean** | Logout status | [optional]
8 |
9 |
10 | ## Enum: StatusEnum
11 |
12 | * `success` (value: `"success"`)
13 | * `error` (value: `"error"`)
14 |
15 |
--------------------------------------------------------------------------------
/docs/MarketQuoteSymbolLtpV3.md:
--------------------------------------------------------------------------------
1 | # UpstoxClient.MarketQuoteSymbolLtpV3
2 |
3 | ## Properties
4 | Name | Type | Description | Notes
5 | ------------ | ------------- | ------------- | -------------
6 | **lastPrice** | **Number** | | [optional]
7 | **instrumentToken** | **String** | | [optional]
8 | **ltq** | **Number** | | [optional]
9 | **volume** | **Number** | | [optional]
10 | **cp** | **Number** | | [optional]
11 |
--------------------------------------------------------------------------------
/docs/OAuthClientExceptionCauseSuppressed.md:
--------------------------------------------------------------------------------
1 | # UpstoxClient.OAuthClientExceptionCauseSuppressed
2 |
3 | ## Properties
4 | Name | Type | Description | Notes
5 | ------------ | ------------- | ------------- | -------------
6 | **stackTrace** | [**[OAuthClientExceptionCauseStackTrace]**](OAuthClientExceptionCauseStackTrace.md) | | [optional]
7 | **message** | **String** | | [optional]
8 | **localizedMessage** | **String** | | [optional]
9 |
--------------------------------------------------------------------------------
/docs/AnalyticsData.md:
--------------------------------------------------------------------------------
1 | # UpstoxClient.AnalyticsData
2 |
3 | ## Properties
4 | Name | Type | Description | Notes
5 | ------------ | ------------- | ------------- | -------------
6 | **vega** | **Number** | | [optional]
7 | **theta** | **Number** | | [optional]
8 | **gamma** | **Number** | | [optional]
9 | **delta** | **Number** | | [optional]
10 | **iv** | **Number** | | [optional]
11 | **pop** | **Number** | | [optional]
12 |
--------------------------------------------------------------------------------
/docs/MarketQuoteOHLCV3.md:
--------------------------------------------------------------------------------
1 | # UpstoxClient.MarketQuoteOHLCV3
2 |
3 | ## Properties
4 | Name | Type | Description | Notes
5 | ------------ | ------------- | ------------- | -------------
6 | **lastPrice** | **Number** | The last traded price of symbol | [optional]
7 | **instrumentToken** | **String** | | [optional]
8 | **prevOhlc** | [**OhlcV3**](OhlcV3.md) | | [optional]
9 | **liveOhlc** | [**OhlcV3**](OhlcV3.md) | | [optional]
10 |
--------------------------------------------------------------------------------
/docs/PostMarginResponse.md:
--------------------------------------------------------------------------------
1 | # UpstoxClient.PostMarginResponse
2 |
3 | ## Properties
4 | Name | Type | Description | Notes
5 | ------------ | ------------- | ------------- | -------------
6 | **status** | **String** | | [optional]
7 | **data** | [**MarginData**](MarginData.md) | | [optional]
8 |
9 |
10 | ## Enum: StatusEnum
11 |
12 | * `success` (value: `"success"`)
13 | * `error` (value: `"error"`)
14 |
15 |
--------------------------------------------------------------------------------
/docs/GetProfileResponse.md:
--------------------------------------------------------------------------------
1 | # UpstoxClient.GetProfileResponse
2 |
3 | ## Properties
4 | Name | Type | Description | Notes
5 | ------------ | ------------- | ------------- | -------------
6 | **status** | **String** | | [optional]
7 | **data** | [**ProfileData**](ProfileData.md) | | [optional]
8 |
9 |
10 | ## Enum: StatusEnum
11 |
12 | * `success` (value: `"success"`)
13 | * `error` (value: `"error"`)
14 |
15 |
--------------------------------------------------------------------------------
/docs/MarginData.md:
--------------------------------------------------------------------------------
1 | # UpstoxClient.MarginData
2 |
3 | ## Properties
4 | Name | Type | Description | Notes
5 | ------------ | ------------- | ------------- | -------------
6 | **margins** | [**[Margin]**](Margin.md) | Response data for instrument margin details | [optional]
7 | **requiredMargin** | **Number** | Total margin required to execute the orders | [optional]
8 | **finalMargin** | **Number** | Total margin after margin benefit | [optional]
9 |
--------------------------------------------------------------------------------
/docs/ApiGatewayErrorResponse.md:
--------------------------------------------------------------------------------
1 | # UpstoxClient.ApiGatewayErrorResponse
2 |
3 | ## Properties
4 | Name | Type | Description | Notes
5 | ------------ | ------------- | ------------- | -------------
6 | **status** | **String** | | [optional]
7 | **errors** | [**[Problem]**](Problem.md) | | [optional]
8 |
9 |
10 | ## Enum: StatusEnum
11 |
12 | * `success` (value: `"success"`)
13 | * `error` (value: `"error"`)
14 |
15 |
--------------------------------------------------------------------------------
/docs/PlaceOrderResponse.md:
--------------------------------------------------------------------------------
1 | # UpstoxClient.PlaceOrderResponse
2 |
3 | ## Properties
4 | Name | Type | Description | Notes
5 | ------------ | ------------- | ------------- | -------------
6 | **status** | **String** | | [optional]
7 | **data** | [**PlaceOrderData**](PlaceOrderData.md) | | [optional]
8 |
9 |
10 | ## Enum: StatusEnum
11 |
12 | * `success` (value: `"success"`)
13 | * `error` (value: `"error"`)
14 |
15 |
--------------------------------------------------------------------------------
/docs/CancelOrderResponse.md:
--------------------------------------------------------------------------------
1 | # UpstoxClient.CancelOrderResponse
2 |
3 | ## Properties
4 | Name | Type | Description | Notes
5 | ------------ | ------------- | ------------- | -------------
6 | **status** | **String** | | [optional]
7 | **data** | [**CancelOrderData**](CancelOrderData.md) | | [optional]
8 |
9 |
10 | ## Enum: StatusEnum
11 |
12 | * `success` (value: `"success"`)
13 | * `error` (value: `"error"`)
14 |
15 |
--------------------------------------------------------------------------------
/docs/ModifyOrderResponse.md:
--------------------------------------------------------------------------------
1 | # UpstoxClient.ModifyOrderResponse
2 |
3 | ## Properties
4 | Name | Type | Description | Notes
5 | ------------ | ------------- | ------------- | -------------
6 | **status** | **String** | | [optional]
7 | **data** | [**ModifyOrderData**](ModifyOrderData.md) | | [optional]
8 |
9 |
10 | ## Enum: StatusEnum
11 |
12 | * `success` (value: `"success"`)
13 | * `error` (value: `"error"`)
14 |
15 |
--------------------------------------------------------------------------------
/docs/Rule.md:
--------------------------------------------------------------------------------
1 | # UpstoxClient.Rule
2 |
3 | ## Properties
4 | Name | Type | Description | Notes
5 | ------------ | ------------- | ------------- | -------------
6 | **strategy** | **String** | | [optional]
7 | **status** | **String** | | [optional]
8 | **triggerType** | **String** | | [optional]
9 | **triggerPrice** | **Number** | | [optional]
10 | **transactionType** | **String** | | [optional]
11 | **orderId** | **String** | | [optional]
12 |
--------------------------------------------------------------------------------
/docs/GetTradeResponse.md:
--------------------------------------------------------------------------------
1 | # UpstoxClient.GetTradeResponse
2 |
3 | ## Properties
4 | Name | Type | Description | Notes
5 | ------------ | ------------- | ------------- | -------------
6 | **status** | **String** | | [optional]
7 | **data** | [**[TradeData]**](TradeData.md) | Response data for trades | [optional]
8 |
9 |
10 | ## Enum: StatusEnum
11 |
12 | * `success` (value: `"success"`)
13 | * `error` (value: `"error"`)
14 |
15 |
--------------------------------------------------------------------------------
/examples/websocket/react_websocket/.gitignore:
--------------------------------------------------------------------------------
1 | # See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
2 |
3 | # dependencies
4 | /node_modules
5 | /.pnp
6 | .pnp.js
7 |
8 | # testing
9 | /coverage
10 |
11 | # production
12 | /build
13 |
14 | # misc
15 | .DS_Store
16 | .env.local
17 | .env.development.local
18 | .env.test.local
19 | .env.production.local
20 |
21 | npm-debug.log*
22 | yarn-debug.log*
23 | yarn-error.log*
24 |
--------------------------------------------------------------------------------
/docs/GetBrokerageResponse.md:
--------------------------------------------------------------------------------
1 | # UpstoxClient.GetBrokerageResponse
2 |
3 | ## Properties
4 | Name | Type | Description | Notes
5 | ------------ | ------------- | ------------- | -------------
6 | **status** | **String** | | [optional]
7 | **data** | [**BrokerageWrapperData**](BrokerageWrapperData.md) | | [optional]
8 |
9 |
10 | ## Enum: StatusEnum
11 |
12 | * `success` (value: `"success"`)
13 | * `error` (value: `"error"`)
14 |
15 |
--------------------------------------------------------------------------------
/docs/GetMarketStatusResponse.md:
--------------------------------------------------------------------------------
1 | # UpstoxClient.GetMarketStatusResponse
2 |
3 | ## Properties
4 | Name | Type | Description | Notes
5 | ------------ | ------------- | ------------- | -------------
6 | **status** | **String** | | [optional]
7 | **data** | [**MarketStatusData**](MarketStatusData.md) | | [optional]
8 |
9 |
10 | ## Enum: StatusEnum
11 |
12 | * `success` (value: `"success"`)
13 | * `error` (value: `"error"`)
14 |
15 |
--------------------------------------------------------------------------------
/docs/ConvertPositionResponse.md:
--------------------------------------------------------------------------------
1 | # UpstoxClient.ConvertPositionResponse
2 |
3 | ## Properties
4 | Name | Type | Description | Notes
5 | ------------ | ------------- | ------------- | -------------
6 | **status** | **String** | | [optional]
7 | **data** | [**ConvertPositionData**](ConvertPositionData.md) | | [optional]
8 |
9 |
10 | ## Enum: StatusEnum
11 |
12 | * `success` (value: `"success"`)
13 | * `error` (value: `"error"`)
14 |
15 |
--------------------------------------------------------------------------------
/docs/GetIntraDayCandleResponse.md:
--------------------------------------------------------------------------------
1 | # UpstoxClient.GetIntraDayCandleResponse
2 |
3 | ## Properties
4 | Name | Type | Description | Notes
5 | ------------ | ------------- | ------------- | -------------
6 | **status** | **String** | | [optional]
7 | **data** | [**IntraDayCandleData**](IntraDayCandleData.md) | | [optional]
8 |
9 |
10 | ## Enum: StatusEnum
11 |
12 | * `success` (value: `"success"`)
13 | * `error` (value: `"error"`)
14 |
15 |
--------------------------------------------------------------------------------
/docs/GetOrderResponse.md:
--------------------------------------------------------------------------------
1 | # UpstoxClient.GetOrderResponse
2 |
3 | ## Properties
4 | Name | Type | Description | Notes
5 | ------------ | ------------- | ------------- | -------------
6 | **status** | **String** | | [optional]
7 | **data** | [**[OrderData]**](OrderData.md) | Response data for order details | [optional]
8 |
9 |
10 | ## Enum: StatusEnum
11 |
12 | * `success` (value: `"success"`)
13 | * `error` (value: `"error"`)
14 |
15 |
--------------------------------------------------------------------------------
/examples/websocket/react_websocket/src/App.js:
--------------------------------------------------------------------------------
1 | import OrderDataFeed from "./socket/OrderDataFeed";
2 | import MarketDataFeed from "./socket/MarketDataFeed";
3 | import "./App.css";
4 |
5 | function App() {
6 | const auth_token = "ACCESS_TOKEN";
7 |
8 | return (
9 |
10 |
11 |
12 |
13 | );
14 | }
15 |
16 | export default App;
17 |
--------------------------------------------------------------------------------
/docs/GetHoldingsResponse.md:
--------------------------------------------------------------------------------
1 | # UpstoxClient.GetHoldingsResponse
2 |
3 | ## Properties
4 | Name | Type | Description | Notes
5 | ------------ | ------------- | ------------- | -------------
6 | **status** | **String** | | [optional]
7 | **data** | [**[HoldingsData]**](HoldingsData.md) | Response data for holdings | [optional]
8 |
9 |
10 | ## Enum: StatusEnum
11 |
12 | * `success` (value: `"success"`)
13 | * `error` (value: `"error"`)
14 |
15 |
--------------------------------------------------------------------------------
/docs/GetHolidayResponse.md:
--------------------------------------------------------------------------------
1 | # UpstoxClient.GetHolidayResponse
2 |
3 | ## Properties
4 | Name | Type | Description | Notes
5 | ------------ | ------------- | ------------- | -------------
6 | **status** | **String** | | [optional]
7 | **data** | [**[HolidayData]**](HolidayData.md) | Response data for holiday list | [optional]
8 |
9 |
10 | ## Enum: StatusEnum
11 |
12 | * `success` (value: `"success"`)
13 | * `error` (value: `"error"`)
14 |
15 |
--------------------------------------------------------------------------------
/docs/GetExpiriesResponse.md:
--------------------------------------------------------------------------------
1 | # UpstoxClient.GetExpiriesResponse
2 |
3 | ## Properties
4 | Name | Type | Description | Notes
5 | ------------ | ------------- | ------------- | -------------
6 | **status** | **String** | | [optional]
7 | **data** | **[String]** | | [optional]
8 |
9 |
10 | ## Enum: StatusEnum
11 |
12 | * `success` (value: `"success"`)
13 | * `error` (value: `"error"`)
14 | * `partialSuccess` (value: `"partial_success"`)
15 |
16 |
--------------------------------------------------------------------------------
/docs/GetFullMarketQuoteResponse.md:
--------------------------------------------------------------------------------
1 | # UpstoxClient.GetFullMarketQuoteResponse
2 |
3 | ## Properties
4 | Name | Type | Description | Notes
5 | ------------ | ------------- | ------------- | -------------
6 | **status** | **String** | | [optional]
7 | **data** | [**{String: MarketQuoteSymbol}**](MarketQuoteSymbol.md) | | [optional]
8 |
9 |
10 | ## Enum: StatusEnum
11 |
12 | * `success` (value: `"success"`)
13 | * `error` (value: `"error"`)
14 |
15 |
--------------------------------------------------------------------------------
/docs/GetHistoricalCandleResponse.md:
--------------------------------------------------------------------------------
1 | # UpstoxClient.GetHistoricalCandleResponse
2 |
3 | ## Properties
4 | Name | Type | Description | Notes
5 | ------------ | ------------- | ------------- | -------------
6 | **status** | **String** | | [optional]
7 | **data** | [**HistoricalCandleData**](HistoricalCandleData.md) | | [optional]
8 |
9 |
10 | ## Enum: StatusEnum
11 |
12 | * `success` (value: `"success"`)
13 | * `error` (value: `"error"`)
14 |
15 |
--------------------------------------------------------------------------------
/docs/GetMarketQuoteOHLCResponse.md:
--------------------------------------------------------------------------------
1 | # UpstoxClient.GetMarketQuoteOHLCResponse
2 |
3 | ## Properties
4 | Name | Type | Description | Notes
5 | ------------ | ------------- | ------------- | -------------
6 | **status** | **String** | | [optional]
7 | **data** | [**{String: MarketQuoteOHLC}**](MarketQuoteOHLC.md) | | [optional]
8 |
9 |
10 | ## Enum: StatusEnum
11 |
12 | * `success` (value: `"success"`)
13 | * `error` (value: `"error"`)
14 |
15 |
--------------------------------------------------------------------------------
/docs/GetOrderBookResponse.md:
--------------------------------------------------------------------------------
1 | # UpstoxClient.GetOrderBookResponse
2 |
3 | ## Properties
4 | Name | Type | Description | Notes
5 | ------------ | ------------- | ------------- | -------------
6 | **status** | **String** | | [optional]
7 | **data** | [**[OrderBookData]**](OrderBookData.md) | Response data for order Book | [optional]
8 |
9 |
10 | ## Enum: StatusEnum
11 |
12 | * `success` (value: `"success"`)
13 | * `error` (value: `"error"`)
14 |
15 |
--------------------------------------------------------------------------------
/docs/GetPositionResponse.md:
--------------------------------------------------------------------------------
1 | # UpstoxClient.GetPositionResponse
2 |
3 | ## Properties
4 | Name | Type | Description | Notes
5 | ------------ | ------------- | ------------- | -------------
6 | **status** | **String** | | [optional]
7 | **data** | [**[PositionData]**](PositionData.md) | Response data for position details | [optional]
8 |
9 |
10 | ## Enum: StatusEnum
11 |
12 | * `success` (value: `"success"`)
13 | * `error` (value: `"error"`)
14 |
15 |
--------------------------------------------------------------------------------
/test/sdk/PortfolioStreamer.js:
--------------------------------------------------------------------------------
1 | const { accessToken } = require('./DataToken');
2 | let UpstoxClient = require("upstox-js-sdk");
3 | let defaultClient = UpstoxClient.ApiClient.instance;
4 | var OAUTH2 = defaultClient.authentications["OAUTH2"];
5 | OAUTH2.accessToken = accessToken;
6 | const streamer = new UpstoxClient.PortfolioDataStreamer();
7 | streamer.connect();
8 |
9 | streamer.on("message", (data) => {
10 | const feed = data.toString("utf-8");
11 | console.log(feed);
12 | });
13 |
--------------------------------------------------------------------------------
/docs/GetOptionChainResponse.md:
--------------------------------------------------------------------------------
1 | # UpstoxClient.GetOptionChainResponse
2 |
3 | ## Properties
4 | Name | Type | Description | Notes
5 | ------------ | ------------- | ------------- | -------------
6 | **status** | **String** | | [optional]
7 | **data** | [**[OptionStrikeData]**](OptionStrikeData.md) | Response data for option chain data | [optional]
8 |
9 |
10 | ## Enum: StatusEnum
11 |
12 | * `success` (value: `"success"`)
13 | * `error` (value: `"error"`)
14 |
15 |
--------------------------------------------------------------------------------
/docs/GetOptionContractResponse.md:
--------------------------------------------------------------------------------
1 | # UpstoxClient.GetOptionContractResponse
2 |
3 | ## Properties
4 | Name | Type | Description | Notes
5 | ------------ | ------------- | ------------- | -------------
6 | **status** | **String** | | [optional]
7 | **data** | [**[InstrumentData]**](InstrumentData.md) | Response data for option contracts | [optional]
8 |
9 |
10 | ## Enum: StatusEnum
11 |
12 | * `success` (value: `"success"`)
13 | * `error` (value: `"error"`)
14 |
15 |
--------------------------------------------------------------------------------
/docs/GetTradeWiseProfitAndLossMetaDataResponse.md:
--------------------------------------------------------------------------------
1 | # UpstoxClient.GetTradeWiseProfitAndLossMetaDataResponse
2 |
3 | ## Properties
4 | Name | Type | Description | Notes
5 | ------------ | ------------- | ------------- | -------------
6 | **status** | **String** | | [optional]
7 | **data** | [**TradeWiseMetaData**](TradeWiseMetaData.md) | | [optional]
8 |
9 |
10 | ## Enum: StatusEnum
11 |
12 | * `success` (value: `"success"`)
13 | * `error` (value: `"error"`)
14 |
15 |
--------------------------------------------------------------------------------
/docs/GetUserFundMarginResponse.md:
--------------------------------------------------------------------------------
1 | # UpstoxClient.GetUserFundMarginResponse
2 |
3 | ## Properties
4 | Name | Type | Description | Notes
5 | ------------ | ------------- | ------------- | -------------
6 | **status** | **String** | | [optional]
7 | **data** | [**{String: UserFundMarginData}**](UserFundMarginData.md) | Response data for Balance | [optional]
8 |
9 |
10 | ## Enum: StatusEnum
11 |
12 | * `success` (value: `"success"`)
13 | * `error` (value: `"error"`)
14 |
15 |
--------------------------------------------------------------------------------
/docs/GetExchangeTimingResponse.md:
--------------------------------------------------------------------------------
1 | # UpstoxClient.GetExchangeTimingResponse
2 |
3 | ## Properties
4 | Name | Type | Description | Notes
5 | ------------ | ------------- | ------------- | -------------
6 | **status** | **String** | | [optional]
7 | **data** | [**[ExchangeTimingData]**](ExchangeTimingData.md) | Response data for exchange timing list | [optional]
8 |
9 |
10 | ## Enum: StatusEnum
11 |
12 | * `success` (value: `"success"`)
13 | * `error` (value: `"error"`)
14 |
15 |
--------------------------------------------------------------------------------
/docs/GetMarketQuoteLastTradedPriceResponse.md:
--------------------------------------------------------------------------------
1 | # UpstoxClient.GetMarketQuoteLastTradedPriceResponse
2 |
3 | ## Properties
4 | Name | Type | Description | Notes
5 | ------------ | ------------- | ------------- | -------------
6 | **status** | **String** | | [optional]
7 | **data** | [**{String: MarketQuoteSymbolLtp}**](MarketQuoteSymbolLtp.md) | | [optional]
8 |
9 |
10 | ## Enum: StatusEnum
11 |
12 | * `success` (value: `"success"`)
13 | * `error` (value: `"error"`)
14 |
15 |
--------------------------------------------------------------------------------
/docs/GetOrderDetailsResponse.md:
--------------------------------------------------------------------------------
1 | # UpstoxClient.GetOrderDetailsResponse
2 |
3 | ## Properties
4 | Name | Type | Description | Notes
5 | ------------ | ------------- | ------------- | -------------
6 | **status** | **String** | | [optional]
7 | **data** | [**OrderBookData**](OrderBookData.md) | | [optional]
8 |
9 |
10 | ## Enum: StatusEnum
11 |
12 | * `success` (value: `"success"`)
13 | * `error` (value: `"error"`)
14 | * `partialSuccess` (value: `"partial_success"`)
15 |
16 |
--------------------------------------------------------------------------------
/docs/GetProfitAndLossChargesResponse.md:
--------------------------------------------------------------------------------
1 | # UpstoxClient.GetProfitAndLossChargesResponse
2 |
3 | ## Properties
4 | Name | Type | Description | Notes
5 | ------------ | ------------- | ------------- | -------------
6 | **status** | **String** | | [optional]
7 | **data** | [**ProfitAndLossChargesWrapperData**](ProfitAndLossChargesWrapperData.md) | | [optional]
8 |
9 |
10 | ## Enum: StatusEnum
11 |
12 | * `success` (value: `"success"`)
13 | * `error` (value: `"error"`)
14 |
15 |
--------------------------------------------------------------------------------
/docs/Ohlc.md:
--------------------------------------------------------------------------------
1 | # UpstoxClient.Ohlc
2 |
3 | ## Properties
4 | Name | Type | Description | Notes
5 | ------------ | ------------- | ------------- | -------------
6 | **open** | **Number** | The open price of the trading session | [optional]
7 | **high** | **Number** | The high price of the trading session | [optional]
8 | **low** | **Number** | The low price of the trading session | [optional]
9 | **close** | **Number** | The close price of the symbol from the previous session of trading | [optional]
10 |
--------------------------------------------------------------------------------
/docs/WebsocketAuthRedirectResponse.md:
--------------------------------------------------------------------------------
1 | # UpstoxClient.WebsocketAuthRedirectResponse
2 |
3 | ## Properties
4 | Name | Type | Description | Notes
5 | ------------ | ------------- | ------------- | -------------
6 | **status** | **String** | | [optional]
7 | **data** | [**WebsocketAuthRedirectResponseData**](WebsocketAuthRedirectResponseData.md) | | [optional]
8 |
9 |
10 | ## Enum: StatusEnum
11 |
12 | * `success` (value: `"success"`)
13 | * `error` (value: `"error"`)
14 |
15 |
--------------------------------------------------------------------------------
/docs/BrokerageData.md:
--------------------------------------------------------------------------------
1 | # UpstoxClient.BrokerageData
2 |
3 | ## Properties
4 | Name | Type | Description | Notes
5 | ------------ | ------------- | ------------- | -------------
6 | **total** | **Number** | Total charges for the order | [optional]
7 | **brokerage** | **Number** | Brokerage charges for the order | [optional]
8 | **taxes** | [**BrokerageTaxes**](BrokerageTaxes.md) | | [optional]
9 | **otherTaxes** | [**OtherTaxes**](OtherTaxes.md) | | [optional]
10 | **dpPlan** | [**DpPlan**](DpPlan.md) | | [optional]
11 |
--------------------------------------------------------------------------------
/docs/IndieUserInitTokenResponse.md:
--------------------------------------------------------------------------------
1 | # UpstoxClient.IndieUserInitTokenResponse
2 |
3 | ## Properties
4 | Name | Type | Description | Notes
5 | ------------ | ------------- | ------------- | -------------
6 | **status** | **String** | | [optional]
7 | **data** | [**IndieUserInitTokenData**](IndieUserInitTokenData.md) | | [optional]
8 |
9 |
10 | ## Enum: StatusEnum
11 |
12 | * `success` (value: `"success"`)
13 | * `error` (value: `"error"`)
14 | * `partialSuccess` (value: `"partial_success"`)
15 |
16 |
--------------------------------------------------------------------------------
/docs/GetExpiredFuturesContractResponse.md:
--------------------------------------------------------------------------------
1 | # UpstoxClient.GetExpiredFuturesContractResponse
2 |
3 | ## Properties
4 | Name | Type | Description | Notes
5 | ------------ | ------------- | ------------- | -------------
6 | **status** | **String** | | [optional]
7 | **data** | [**[ExpiredFutureData]**](ExpiredFutureData.md) | | [optional]
8 |
9 |
10 | ## Enum: StatusEnum
11 |
12 | * `success` (value: `"success"`)
13 | * `error` (value: `"error"`)
14 | * `partialSuccess` (value: `"partial_success"`)
15 |
16 |
--------------------------------------------------------------------------------
/docs/GetMarketQuoteOHLCResponseV3.md:
--------------------------------------------------------------------------------
1 | # UpstoxClient.GetMarketQuoteOHLCResponseV3
2 |
3 | ## Properties
4 | Name | Type | Description | Notes
5 | ------------ | ------------- | ------------- | -------------
6 | **status** | **String** | | [optional]
7 | **data** | [**{String: MarketQuoteOHLCV3}**](MarketQuoteOHLCV3.md) | | [optional]
8 |
9 |
10 | ## Enum: StatusEnum
11 |
12 | * `success` (value: `"success"`)
13 | * `error` (value: `"error"`)
14 | * `partialSuccess` (value: `"partial_success"`)
15 |
16 |
--------------------------------------------------------------------------------
/docs/OAuthClientExceptionCause.md:
--------------------------------------------------------------------------------
1 | # UpstoxClient.OAuthClientExceptionCause
2 |
3 | ## Properties
4 | Name | Type | Description | Notes
5 | ------------ | ------------- | ------------- | -------------
6 | **stackTrace** | [**[OAuthClientExceptionCauseStackTrace]**](OAuthClientExceptionCauseStackTrace.md) | | [optional]
7 | **message** | **String** | | [optional]
8 | **suppressed** | [**[OAuthClientExceptionCauseSuppressed]**](OAuthClientExceptionCauseSuppressed.md) | | [optional]
9 | **localizedMessage** | **String** | | [optional]
10 |
--------------------------------------------------------------------------------
/docs/ProfitAndLossOtherChargesTaxes.md:
--------------------------------------------------------------------------------
1 | # UpstoxClient.ProfitAndLossOtherChargesTaxes
2 |
3 | ## Properties
4 | Name | Type | Description | Notes
5 | ------------ | ------------- | ------------- | -------------
6 | **transaction** | **Number** | transaction charges | [optional]
7 | **clearing** | **Number** | clearing charges | [optional]
8 | **others** | **Number** | others charges | [optional]
9 | **sebiTurnover** | **Number** | SEBI turnover | [optional]
10 | **dematTransaction** | **Number** | demat transaction charges | [optional]
11 |
--------------------------------------------------------------------------------
/docs/BatchExecutionSummary.md:
--------------------------------------------------------------------------------
1 | # UpstoxClient.BatchExecutionSummary
2 |
3 | ## Properties
4 | Name | Type | Description | Notes
5 | ------------ | ------------- | ------------- | -------------
6 | **total** | **Number** | The total number of order lines present in the payload. | [optional]
7 | **success** | **Number** | The number of order lines that were successfully placed without any errors. | [optional]
8 | **error** | **Number** | The number of order lines that encountered errors during processing, despite their payloads being valid. | [optional]
9 |
--------------------------------------------------------------------------------
/docs/ProfitAndLossChargesData.md:
--------------------------------------------------------------------------------
1 | # UpstoxClient.ProfitAndLossChargesData
2 |
3 | ## Properties
4 | Name | Type | Description | Notes
5 | ------------ | ------------- | ------------- | -------------
6 | **total** | **Number** | Total charges for the user | [optional]
7 | **brokerage** | **Number** | Brokerage charges for the order | [optional]
8 | **taxes** | [**ProfitAndLossChargesTaxes**](ProfitAndLossChargesTaxes.md) | | [optional]
9 | **charges** | [**ProfitAndLossOtherChargesTaxes**](ProfitAndLossOtherChargesTaxes.md) | | [optional]
10 |
--------------------------------------------------------------------------------
/docs/Instrument.md:
--------------------------------------------------------------------------------
1 | # UpstoxClient.Instrument
2 |
3 | ## Properties
4 | Name | Type | Description | Notes
5 | ------------ | ------------- | ------------- | -------------
6 | **instrumentKey** | **String** | Instrument Key of the Instrument |
7 | **quantity** | **Number** | Quantity of the instrument to buy or sell for margin calculation |
8 | **product** | **String** | Product with which the order is to be placed |
9 | **transactionType** | **String** | Indicates whether its a BUY or SELL order |
10 | **price** | **Number** | price | [optional]
11 |
--------------------------------------------------------------------------------
/docs/GetMarketQuoteOptionGreekResponseV3.md:
--------------------------------------------------------------------------------
1 | # UpstoxClient.GetMarketQuoteOptionGreekResponseV3
2 |
3 | ## Properties
4 | Name | Type | Description | Notes
5 | ------------ | ------------- | ------------- | -------------
6 | **status** | **String** | | [optional]
7 | **data** | [**{String: MarketQuoteOptionGreekV3}**](MarketQuoteOptionGreekV3.md) | | [optional]
8 |
9 |
10 | ## Enum: StatusEnum
11 |
12 | * `success` (value: `"success"`)
13 | * `error` (value: `"error"`)
14 | * `partialSuccess` (value: `"partial_success"`)
15 |
16 |
--------------------------------------------------------------------------------
/docs/GetMarketQuoteLastTradedPriceResponseV3.md:
--------------------------------------------------------------------------------
1 | # UpstoxClient.GetMarketQuoteLastTradedPriceResponseV3
2 |
3 | ## Properties
4 | Name | Type | Description | Notes
5 | ------------ | ------------- | ------------- | -------------
6 | **status** | **String** | | [optional]
7 | **data** | [**{String: MarketQuoteSymbolLtpV3}**](MarketQuoteSymbolLtpV3.md) | | [optional]
8 |
9 |
10 | ## Enum: StatusEnum
11 |
12 | * `success` (value: `"success"`)
13 | * `error` (value: `"error"`)
14 | * `partialSuccess` (value: `"partial_success"`)
15 |
16 |
--------------------------------------------------------------------------------
/docs/CancelOrderV3Response.md:
--------------------------------------------------------------------------------
1 | # UpstoxClient.CancelOrderV3Response
2 |
3 | ## Properties
4 | Name | Type | Description | Notes
5 | ------------ | ------------- | ------------- | -------------
6 | **status** | **String** | | [optional]
7 | **data** | [**CancelOrderData**](CancelOrderData.md) | | [optional]
8 | **metadata** | [**OrderMetadata**](OrderMetadata.md) | | [optional]
9 |
10 |
11 | ## Enum: StatusEnum
12 |
13 | * `success` (value: `"success"`)
14 | * `error` (value: `"error"`)
15 | * `partialSuccess` (value: `"partial_success"`)
16 |
17 |
--------------------------------------------------------------------------------
/docs/GttTriggerOrderResponse.md:
--------------------------------------------------------------------------------
1 | # UpstoxClient.GttTriggerOrderResponse
2 |
3 | ## Properties
4 | Name | Type | Description | Notes
5 | ------------ | ------------- | ------------- | -------------
6 | **status** | **String** | | [optional]
7 | **data** | [**GttOrderData**](GttOrderData.md) | | [optional]
8 | **metadata** | [**OrderMetadata**](OrderMetadata.md) | | [optional]
9 |
10 |
11 | ## Enum: StatusEnum
12 |
13 | * `success` (value: `"success"`)
14 | * `error` (value: `"error"`)
15 | * `partialSuccess` (value: `"partial_success"`)
16 |
17 |
--------------------------------------------------------------------------------
/docs/MarketData.md:
--------------------------------------------------------------------------------
1 | # UpstoxClient.MarketData
2 |
3 | ## Properties
4 | Name | Type | Description | Notes
5 | ------------ | ------------- | ------------- | -------------
6 | **ltp** | **Number** | | [optional]
7 | **volume** | **Number** | | [optional]
8 | **oi** | **Number** | | [optional]
9 | **closePrice** | **Number** | | [optional]
10 | **bidPrice** | **Number** | | [optional]
11 | **bidQty** | **Number** | | [optional]
12 | **askPrice** | **Number** | | [optional]
13 | **askQty** | **Number** | | [optional]
14 | **prevOi** | **Number** | | [optional]
15 |
--------------------------------------------------------------------------------
/docs/ModifyOrderV3Response.md:
--------------------------------------------------------------------------------
1 | # UpstoxClient.ModifyOrderV3Response
2 |
3 | ## Properties
4 | Name | Type | Description | Notes
5 | ------------ | ------------- | ------------- | -------------
6 | **status** | **String** | | [optional]
7 | **data** | [**ModifyOrderData**](ModifyOrderData.md) | | [optional]
8 | **metadata** | [**OrderMetadata**](OrderMetadata.md) | | [optional]
9 |
10 |
11 | ## Enum: StatusEnum
12 |
13 | * `success` (value: `"success"`)
14 | * `error` (value: `"error"`)
15 | * `partialSuccess` (value: `"partial_success"`)
16 |
17 |
--------------------------------------------------------------------------------
/docs/PlaceOrderV3Response.md:
--------------------------------------------------------------------------------
1 | # UpstoxClient.PlaceOrderV3Response
2 |
3 | ## Properties
4 | Name | Type | Description | Notes
5 | ------------ | ------------- | ------------- | -------------
6 | **status** | **String** | | [optional]
7 | **data** | [**MultiOrderV3Data**](MultiOrderV3Data.md) | | [optional]
8 | **metadata** | [**OrderMetadata**](OrderMetadata.md) | | [optional]
9 |
10 |
11 | ## Enum: StatusEnum
12 |
13 | * `success` (value: `"success"`)
14 | * `error` (value: `"error"`)
15 | * `partialSuccess` (value: `"partial_success"`)
16 |
17 |
--------------------------------------------------------------------------------
/docs/TradeHistoryResponse.md:
--------------------------------------------------------------------------------
1 | # UpstoxClient.TradeHistoryResponse
2 |
3 | ## Properties
4 | Name | Type | Description | Notes
5 | ------------ | ------------- | ------------- | -------------
6 | **status** | **String** | | [optional]
7 | **data** | [**[TradeHistoryResponseTradeData]**](TradeHistoryResponseTradeData.md) | | [optional]
8 | **metaData** | [**TradeHistoryResponseMetaData**](TradeHistoryResponseMetaData.md) | | [optional]
9 |
10 |
11 | ## Enum: StatusEnum
12 |
13 | * `success` (value: `"success"`)
14 | * `error` (value: `"error"`)
15 |
16 |
--------------------------------------------------------------------------------
/docs/GetGttOrderResponse.md:
--------------------------------------------------------------------------------
1 | # UpstoxClient.GetGttOrderResponse
2 |
3 | ## Properties
4 | Name | Type | Description | Notes
5 | ------------ | ------------- | ------------- | -------------
6 | **status** | **String** | | [optional]
7 | **data** | [**[GttOrderDetails]**](GttOrderDetails.md) | Response data for order details | [optional]
8 | **metadata** | [**OrderMetadata**](OrderMetadata.md) | | [optional]
9 |
10 |
11 | ## Enum: StatusEnum
12 |
13 | * `success` (value: `"success"`)
14 | * `error` (value: `"error"`)
15 | * `partialSuccess` (value: `"partial_success"`)
16 |
17 |
--------------------------------------------------------------------------------
/docs/OptionStrikeData.md:
--------------------------------------------------------------------------------
1 | # UpstoxClient.OptionStrikeData
2 |
3 | ## Properties
4 | Name | Type | Description | Notes
5 | ------------ | ------------- | ------------- | -------------
6 | **expiry** | **Date** | | [optional]
7 | **pcr** | **Number** | | [optional]
8 | **strikePrice** | **Number** | | [optional]
9 | **underlyingKey** | **String** | | [optional]
10 | **underlyingSpotPrice** | **Number** | | [optional]
11 | **callOptions** | [**PutCallOptionChainData**](PutCallOptionChainData.md) | | [optional]
12 | **putOptions** | [**PutCallOptionChainData**](PutCallOptionChainData.md) | | [optional]
13 |
--------------------------------------------------------------------------------
/docs/OAuthClientExceptionCauseStackTrace.md:
--------------------------------------------------------------------------------
1 | # UpstoxClient.OAuthClientExceptionCauseStackTrace
2 |
3 | ## Properties
4 | Name | Type | Description | Notes
5 | ------------ | ------------- | ------------- | -------------
6 | **classLoaderName** | **String** | | [optional]
7 | **moduleName** | **String** | | [optional]
8 | **moduleVersion** | **String** | | [optional]
9 | **methodName** | **String** | | [optional]
10 | **fileName** | **String** | | [optional]
11 | **lineNumber** | **Number** | | [optional]
12 | **className** | **String** | | [optional]
13 | **nativeMethod** | **Boolean** | | [optional]
14 |
--------------------------------------------------------------------------------
/docs/TokenRequest.md:
--------------------------------------------------------------------------------
1 | # UpstoxClient.TokenRequest
2 |
3 | ## Properties
4 | Name | Type | Description | Notes
5 | ------------ | ------------- | ------------- | -------------
6 | **code** | **String** | |
7 | **clientId** | **String** | OAuth API key that is a public identifier for app |
8 | **clientSecret** | **String** | OAuth client secret that is a private secret known only to app and authorization server |
9 | **redirectUri** | **String** | Authorization server will redirect the user back to the application via redirect url |
10 | **grantType** | **String** | Type of grant used to get an access token |
11 |
--------------------------------------------------------------------------------
/docs/OAuthClientException.md:
--------------------------------------------------------------------------------
1 | # UpstoxClient.OAuthClientException
2 |
3 | ## Properties
4 | Name | Type | Description | Notes
5 | ------------ | ------------- | ------------- | -------------
6 | **cause** | [**OAuthClientExceptionCause**](OAuthClientExceptionCause.md) | | [optional]
7 | **stackTrace** | [**[OAuthClientExceptionCauseStackTrace]**](OAuthClientExceptionCauseStackTrace.md) | | [optional]
8 | **message** | **String** | | [optional]
9 | **suppressed** | [**[OAuthClientExceptionCauseSuppressed]**](OAuthClientExceptionCauseSuppressed.md) | | [optional]
10 | **localizedMessage** | **String** | | [optional]
11 |
--------------------------------------------------------------------------------
/docs/GetTradeWiseProfitAndLossDataResponse.md:
--------------------------------------------------------------------------------
1 | # UpstoxClient.GetTradeWiseProfitAndLossDataResponse
2 |
3 | ## Properties
4 | Name | Type | Description | Notes
5 | ------------ | ------------- | ------------- | -------------
6 | **status** | **String** | | [optional]
7 | **data** | [**[TradeWiseProfitAndLossData]**](TradeWiseProfitAndLossData.md) | Response data for trade wise data details | [optional]
8 | **metadata** | [**ProfitAndLossMetaDataWrapper**](ProfitAndLossMetaDataWrapper.md) | | [optional]
9 |
10 |
11 | ## Enum: StatusEnum
12 |
13 | * `success` (value: `"success"`)
14 | * `error` (value: `"error"`)
15 |
16 |
--------------------------------------------------------------------------------
/examples/websocket/react_websocket/public/manifest.json:
--------------------------------------------------------------------------------
1 | {
2 | "short_name": "React App",
3 | "name": "Create React App Sample",
4 | "icons": [
5 | {
6 | "src": "favicon.ico",
7 | "sizes": "64x64 32x32 24x24 16x16",
8 | "type": "image/x-icon"
9 | },
10 | {
11 | "src": "logo192.png",
12 | "type": "image/png",
13 | "sizes": "192x192"
14 | },
15 | {
16 | "src": "logo512.png",
17 | "type": "image/png",
18 | "sizes": "512x512"
19 | }
20 | ],
21 | "start_url": ".",
22 | "display": "standalone",
23 | "theme_color": "#000000",
24 | "background_color": "#ffffff"
25 | }
26 |
--------------------------------------------------------------------------------
/docs/Problem.md:
--------------------------------------------------------------------------------
1 | # UpstoxClient.Problem
2 |
3 | ## Properties
4 | Name | Type | Description | Notes
5 | ------------ | ------------- | ------------- | -------------
6 | **errorCode** | **String** | Unique code for the error state | [optional]
7 | **message** | **String** | Verbose message for the error state | [optional]
8 | **propertyPath** | **String** | Path to property failing validation | [optional]
9 | **invalidValue** | **Object** | Invalid value for the property failing validation | [optional]
10 | **errorCode** | **String** | | [optional]
11 | **propertyPath** | **String** | | [optional]
12 | **invalidValue** | **Object** | | [optional]
13 |
--------------------------------------------------------------------------------
/docs/OhlcV3.md:
--------------------------------------------------------------------------------
1 | # UpstoxClient.OhlcV3
2 |
3 | ## Properties
4 | Name | Type | Description | Notes
5 | ------------ | ------------- | ------------- | -------------
6 | **open** | **Number** | The open price of the trading session | [optional]
7 | **high** | **Number** | The high price of the trading session | [optional]
8 | **low** | **Number** | The low price of the trading session | [optional]
9 | **close** | **Number** | The close price of the symbol from the previous session of trading | [optional]
10 | **volume** | **Number** | The volume of the symbol traded in the session | [optional]
11 | **ts** | **Number** | Starting timestamp of candle | [optional]
12 |
--------------------------------------------------------------------------------
/docs/GttOrderDetails.md:
--------------------------------------------------------------------------------
1 | # UpstoxClient.GttOrderDetails
2 |
3 | ## Properties
4 | Name | Type | Description | Notes
5 | ------------ | ------------- | ------------- | -------------
6 | **type** | **String** | | [optional]
7 | **exchange** | **String** | | [optional]
8 | **quantity** | **Number** | | [optional]
9 | **product** | **String** | | [optional]
10 | **rules** | [**[Rule]**](Rule.md) | | [optional]
11 | **tradingSymbol** | **String** | | [optional]
12 | **instrumentToken** | **String** | | [optional]
13 | **gttOrderId** | **String** | | [optional]
14 | **expiresAt** | **Number** | | [optional]
15 | **createdAt** | **Number** | | [optional]
16 |
--------------------------------------------------------------------------------
/.npmignore:
--------------------------------------------------------------------------------
1 | # Created by https://www.gitignore.io/api/node
2 |
3 | ### Node ###
4 | # Logs
5 | logs
6 | *.log
7 | npm-debug.log*
8 |
9 | # Docs
10 | docs
11 |
12 | # Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
13 | .grunt
14 |
15 | # Compiled binary addons (http://nodejs.org/api/addons.html)
16 | build/Release
17 |
18 | # Dependency directories
19 | node_modules
20 |
21 | # Optional npm cache directory
22 | .npm
23 |
24 | # Optional REPL history
25 | .node_repl_history
26 | .gitignore
27 | .idea
28 | .*.swp
29 | ._*
30 | .DS_Store
31 | .git
32 | .hg
33 | .npmrc
34 | .lock-wscript
35 | .svn
36 | .wafpickle-*
37 | CVS
38 | npm-debug.log
39 |
--------------------------------------------------------------------------------
/docs/MarketQuoteOptionGreekV3.md:
--------------------------------------------------------------------------------
1 | # UpstoxClient.MarketQuoteOptionGreekV3
2 |
3 | ## Properties
4 | Name | Type | Description | Notes
5 | ------------ | ------------- | ------------- | -------------
6 | **lastPrice** | **Number** | | [optional]
7 | **instrumentToken** | **String** | | [optional]
8 | **ltq** | **Number** | | [optional]
9 | **volume** | **Number** | | [optional]
10 | **cp** | **Number** | | [optional]
11 | **iv** | **Number** | | [optional]
12 | **vega** | **Number** | | [optional]
13 | **gamma** | **Number** | | [optional]
14 | **theta** | **Number** | | [optional]
15 | **delta** | **Number** | | [optional]
16 | **oi** | **Number** | | [optional]
17 |
--------------------------------------------------------------------------------
/docs/MultiOrderResponse.md:
--------------------------------------------------------------------------------
1 | # UpstoxClient.MultiOrderResponse
2 |
3 | ## Properties
4 | Name | Type | Description | Notes
5 | ------------ | ------------- | ------------- | -------------
6 | **status** | **String** | | [optional]
7 | **data** | [**[MultiOrderData]**](MultiOrderData.md) | Response data for multi order request | [optional]
8 | **errors** | [**[MultiOrderError]**](MultiOrderError.md) | Error details for multi order request | [optional]
9 | **summary** | [**MultiOrderSummary**](MultiOrderSummary.md) | | [optional]
10 |
11 |
12 | ## Enum: StatusEnum
13 |
14 | * `success` (value: `"success"`)
15 | * `error` (value: `"error"`)
16 | * `partialSuccess` (value: `"partial_success"`)
17 |
18 |
--------------------------------------------------------------------------------
/docs/HolidayData.md:
--------------------------------------------------------------------------------
1 | # UpstoxClient.HolidayData
2 |
3 | ## Properties
4 | Name | Type | Description | Notes
5 | ------------ | ------------- | ------------- | -------------
6 | **_date** | **Date** | | [optional]
7 | **description** | **String** | | [optional]
8 | **holidayType** | **String** | | [optional]
9 | **closedExchanges** | **[String]** | | [optional]
10 | **openExchanges** | [**[ExchangeTimingData]**](ExchangeTimingData.md) | | [optional]
11 |
12 |
13 | ## Enum: HolidayTypeEnum
14 |
15 | * `ALL` (value: `"ALL"`)
16 | * `SETTLEMENT_HOLIDAY` (value: `"SETTLEMENT_HOLIDAY"`)
17 | * `TRADING_HOLIDAY` (value: `"TRADING_HOLIDAY"`)
18 | * `SPECIAL_TIMING` (value: `"SPECIAL_TIMING"`)
19 |
20 |
--------------------------------------------------------------------------------
/docs/CancelOrExitMultiOrderResponse.md:
--------------------------------------------------------------------------------
1 | # UpstoxClient.CancelOrExitMultiOrderResponse
2 |
3 | ## Properties
4 | Name | Type | Description | Notes
5 | ------------ | ------------- | ------------- | -------------
6 | **status** | **String** | | [optional]
7 | **data** | [**CancelOrExitMultiOrderData**](CancelOrExitMultiOrderData.md) | | [optional]
8 | **errors** | [**[CancelOrExitOrderErrorData]**](CancelOrExitOrderErrorData.md) | Error data for cancel or exit order request | [optional]
9 | **summary** | [**BatchExecutionSummary**](BatchExecutionSummary.md) | | [optional]
10 |
11 |
12 | ## Enum: StatusEnum
13 |
14 | * `success` (value: `"success"`)
15 | * `error` (value: `"error"`)
16 | * `partialSuccess` (value: `"partial_success"`)
17 |
18 |
--------------------------------------------------------------------------------
/docs/GttModifyOrderRequest.md:
--------------------------------------------------------------------------------
1 | # UpstoxClient.GttModifyOrderRequest
2 |
3 | ## Properties
4 | Name | Type | Description | Notes
5 | ------------ | ------------- | ------------- | -------------
6 | **type** | **String** | Type of GTT order. It can be one of the following: SINGLE refers to a single-leg GTT order MULTIPLE refers to a multi-leg GTT order |
7 | **quantity** | **Number** | Quantity with which the order is to be placed |
8 | **rules** | [**[GttRule]**](GttRule.md) | List of rules defining the conditions for each leg in the GTT order |
9 | **gttOrderId** | **String** | Unique identifier of the GTT order to be modified |
10 |
11 |
12 | ## Enum: TypeEnum
13 |
14 | * `SINGLE` (value: `"SINGLE"`)
15 | * `MULTIPLE` (value: `"MULTIPLE"`)
16 |
17 |
--------------------------------------------------------------------------------
/docs/MultiOrderError.md:
--------------------------------------------------------------------------------
1 | # UpstoxClient.MultiOrderError
2 |
3 | ## Properties
4 | Name | Type | Description | Notes
5 | ------------ | ------------- | ------------- | -------------
6 | **errorCode** | **String** | Unique code for the error state | [optional]
7 | **message** | **String** | Verbose message for the error state | [optional]
8 | **propertyPath** | **String** | Path to property failing validation | [optional]
9 | **invalidValue** | **Object** | Invalid value for the property failing validation | [optional]
10 | **errorCode** | **String** | | [optional]
11 | **propertyPath** | **String** | | [optional]
12 | **invalidValue** | **Object** | | [optional]
13 | **correlationId** | **String** | A unique identifier for tracking individual orders within the batch | [optional]
14 |
--------------------------------------------------------------------------------
/docs/CancelOrExitOrderErrorData.md:
--------------------------------------------------------------------------------
1 | # UpstoxClient.CancelOrExitOrderErrorData
2 |
3 | ## Properties
4 | Name | Type | Description | Notes
5 | ------------ | ------------- | ------------- | -------------
6 | **errorCode** | **String** | Unique code for the error state | [optional]
7 | **message** | **String** | Verbose message for the error state | [optional]
8 | **propertyPath** | **String** | Path to property failing validation | [optional]
9 | **invalidValue** | **Object** | Invalid value for the property failing validation | [optional]
10 | **errorCode** | **String** | | [optional]
11 | **propertyPath** | **String** | | [optional]
12 | **invalidValue** | **Object** | | [optional]
13 | **instrumentKey** | **String** | Key of instrument | [optional]
14 | **orderId** | **String** | Reference order ID | [optional]
15 |
--------------------------------------------------------------------------------
/docs/GttRule.md:
--------------------------------------------------------------------------------
1 | # UpstoxClient.GttRule
2 |
3 | ## Properties
4 | Name | Type | Description | Notes
5 | ------------ | ------------- | ------------- | -------------
6 | **strategy** | **String** | Defines the strategy for the GTT order leg: ENTRY - First leg order STOPLOSS - Stop-loss order TARGET - Target order |
7 | **triggerType** | **String** | Trigger type for each leg of the order |
8 | **triggerPrice** | **Number** | Trigger price for the GTT order leg |
9 |
10 |
11 | ## Enum: StrategyEnum
12 |
13 | * `ENTRY` (value: `"ENTRY"`)
14 | * `STOPLOSS` (value: `"STOPLOSS"`)
15 | * `TARGET` (value: `"TARGET"`)
16 |
17 |
18 |
19 | ## Enum: TriggerTypeEnum
20 |
21 | * `ABOVE` (value: `"ABOVE"`)
22 | * `BELOW` (value: `"BELOW"`)
23 | * `IMMEDIATE` (value: `"IMMEDIATE"`)
24 |
25 |
--------------------------------------------------------------------------------
/docs/MultiOrderSummary.md:
--------------------------------------------------------------------------------
1 | # UpstoxClient.MultiOrderSummary
2 |
3 | ## Properties
4 | Name | Type | Description | Notes
5 | ------------ | ------------- | ------------- | -------------
6 | **total** | **Number** | The total number of order lines present in the payload. | [optional]
7 | **success** | **Number** | The number of order lines that were successfully placed without any errors. | [optional]
8 | **error** | **Number** | The number of order lines that encountered errors during processing, despite their payloads being valid. | [optional]
9 | **payloadError** | **Number** | The number of order lines with payload errors, indicating formatting or data validity issues.<br/><br/><b>Note</b>: Orders are processed only if the entire batch is free of payload_error, ensuring error-free transactions. | [optional]
10 |
--------------------------------------------------------------------------------
/src/feeder/PortfolioDataStreamer.js:
--------------------------------------------------------------------------------
1 | import { PortfolioDataFeeder } from "./PortfolioDataFeeder";
2 | import Streamer from "./Streamer";
3 |
4 | class PortfolioDataStreamer extends Streamer {
5 | constructor(orderUpdate = true, positionUpdate = false, holdingUpdate = false, gttUpdate = false) {
6 | super();
7 | this.orderUpdate = orderUpdate;
8 | this.positionUpdate = positionUpdate;
9 | this.holdingUpdate = holdingUpdate;
10 | this.gttUpdate = gttUpdate;
11 | }
12 |
13 | async connect() {
14 | this.streamer = new PortfolioDataFeeder();
15 | this.setupEventListeners();
16 | await this.streamer.connect(this.orderUpdate, this.positionUpdate, this.holdingUpdate, this.gttUpdate);
17 | }
18 |
19 | disconnect() {
20 | this.streamer.disconnect();
21 | }
22 | }
23 |
24 | export { PortfolioDataStreamer };
25 |
--------------------------------------------------------------------------------
/docs/Margin.md:
--------------------------------------------------------------------------------
1 | # UpstoxClient.Margin
2 |
3 | ## Properties
4 | Name | Type | Description | Notes
5 | ------------ | ------------- | ------------- | -------------
6 | **spanMargin** | **Number** | Upfront margin mandatory by exchange for derivatives trade applicable on only FNO trade | [optional]
7 | **exposureMargin** | **Number** | Based on ELM percentage values provided by exchange, applicable on only FNO trade | [optional]
8 | **equityMargin** | **Number** | Margin applicable for any equity trade | [optional]
9 | **netBuyPremium** | **Number** | Option premium required. | [optional]
10 | **additionalMargin** | **Number** | Application margin applicable on MCX FNO trade for certain commodities | [optional]
11 | **totalMargin** | **Number** | Total margin required for the basket | [optional]
12 | **tenderMargin** | **Number** | Tender margin | [optional]
13 |
--------------------------------------------------------------------------------
/test/sdk/PlaceOrder.js:
--------------------------------------------------------------------------------
1 | let UpstoxClient = require('upstox-js-sdk');
2 | const { accessToken } = require('./DataToken');
3 | let defaultClient = UpstoxClient.ApiClient.instance;
4 | var OAUTH2 = defaultClient.authentications['OAUTH2'];
5 | OAUTH2.accessToken = accessToken;
6 |
7 | let apiInstance = new UpstoxClient.OrderApi();
8 | let body = new UpstoxClient.PlaceOrderRequest(1, UpstoxClient.PlaceOrderRequest.ProductEnum.D, UpstoxClient.PlaceOrderRequest.ValidityEnum.DAY, 0.0, "NSE_EQ|INE528G01035",UpstoxClient.PlaceOrderRequest.OrderTypeEnum.MARKET,UpstoxClient.PlaceOrderRequest.TransactionTypeEnum.BUY, 0, 0.0, false);
9 | let apiVersion = "2.0";
10 |
11 | apiInstance.placeOrder(body, apiVersion, (error, data, response) => {
12 | if (error) {
13 | console.error(error.response.text);
14 | } else {
15 | console.log('API called successfully. Returned data: ' + data);
16 | }
17 | });
--------------------------------------------------------------------------------
/docs/UserFundMarginData.md:
--------------------------------------------------------------------------------
1 | # UpstoxClient.UserFundMarginData
2 |
3 | ## Properties
4 | Name | Type | Description | Notes
5 | ------------ | ------------- | ------------- | -------------
6 | **usedMargin** | **Number** | Positive values denote the amount blocked into an Open order or position. Negative value denotes the amount being released. | [optional]
7 | **payinAmount** | **Number** | Instant payin will reflect here | [optional]
8 | **spanMargin** | **Number** | Amount blocked on futures and options towards SPAN | [optional]
9 | **adhocMargin** | **Number** | Payin amount credited through a manual process | [optional]
10 | **notionalCash** | **Number** | The amount maintained for withdrawal | [optional]
11 | **availableMargin** | **Number** | Total margin available for trading | [optional]
12 | **exposureMargin** | **Number** | Amount blocked on futures and options towards Exposure | [optional]
13 |
--------------------------------------------------------------------------------
/docs/TradeHistoryResponseTradeData.md:
--------------------------------------------------------------------------------
1 | # UpstoxClient.TradeHistoryResponseTradeData
2 |
3 | ## Properties
4 | Name | Type | Description | Notes
5 | ------------ | ------------- | ------------- | -------------
6 | **exchange** | **String** | | [optional]
7 | **segment** | **String** | | [optional]
8 | **optionType** | **String** | | [optional]
9 | **quantity** | **Number** | | [optional]
10 | **amount** | **Number** | | [optional]
11 | **tradeId** | **String** | | [optional]
12 | **tradeDate** | **String** | | [optional]
13 | **transactionType** | **String** | | [optional]
14 | **scripName** | **String** | | [optional]
15 | **strikePrice** | **String** | | [optional]
16 | **expiry** | **String** | | [optional]
17 | **price** | **Number** | | [optional]
18 | **isin** | **String** | | [optional]
19 | **symbol** | **String** | | [optional]
20 | **instrumentToken** | **String** | | [optional]
21 |
--------------------------------------------------------------------------------
/examples/websocket/react_websocket/package.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "react-websocket-example",
3 | "version": "1.0.0",
4 | "private": true,
5 | "dependencies": {
6 | "buffer": "^6.0.3",
7 | "protobufjs": "^7.2.5",
8 | "react": "^18.2.0",
9 | "react-dom": "^18.2.0",
10 | "react-scripts": "5.0.1",
11 | "web-vitals": "^2.1.4"
12 | },
13 | "scripts": {
14 | "start": "react-scripts start",
15 | "build": "react-scripts build",
16 | "test": "react-scripts test",
17 | "eject": "react-scripts eject"
18 | },
19 | "eslintConfig": {
20 | "extends": [
21 | "react-app"
22 | ]
23 | },
24 | "browserslist": {
25 | "production": [
26 | ">0.2%",
27 | "not dead",
28 | "not op_mini all"
29 | ],
30 | "development": [
31 | "last 1 chrome version",
32 | "last 1 firefox version",
33 | "last 1 safari version"
34 | ]
35 | }
36 | }
--------------------------------------------------------------------------------
/docs/TradeWiseProfitAndLossData.md:
--------------------------------------------------------------------------------
1 | # UpstoxClient.TradeWiseProfitAndLossData
2 |
3 | ## Properties
4 | Name | Type | Description | Notes
5 | ------------ | ------------- | ------------- | -------------
6 | **quantity** | **Number** | The quantity of stock traded | [optional]
7 | **isin** | **String** | ISIN of the stock | [optional]
8 | **scripName** | **String** | Name of the scrip traded | [optional]
9 | **tradeType** | **String** | FUT - Futures OPT - Options EQ - Equity | [optional]
10 | **buyDate** | **String** | The date on which the stock was bought | [optional]
11 | **buyAverage** | **Number** | The average rate at which each quantity of the stock was bought | [optional]
12 | **sellDate** | **String** | The date on which the stock was sold | [optional]
13 | **sellAverage** | **Number** | The average rate at which each quantity of the stock was sold | [optional]
14 | **buyAmount** | **Number** | Total buy amount | [optional]
15 | **sellAmount** | **Number** | Total sell amount | [optional]
16 |
--------------------------------------------------------------------------------
/examples/README.md:
--------------------------------------------------------------------------------
1 | # Node.js Sample Implementation
2 |
3 | ## Websocket
4 |
5 | ### Market stream feed
6 |
7 | Node.js code to establish a connection with the Upstox Websocket API for streaming live market data. It fetches market data for a list of instrument keys and decodes the incoming protobuf data to a JSON format.
8 |
9 | [Market updates using Upstox's websocket](websocket/market_data/v3)
10 |
11 | ### Porfolio stream feed
12 |
13 | Node.js code to establish a connection with the Upstox WebSocket API for streaming live order updates. It fetches the order updates and prints them to the console.
14 |
15 | [Order updates using Upstox's websocket](websocket/order_updates/)
16 |
17 | ### ReactJS Market and Portfolio stream feed
18 |
19 | A React app that streams both order and market updates in real-time using the Upstox WebSocket API. It connects to the API, listens for updates, and displays them dynamically on the screen as they arrive.
20 |
21 | [ReactJS websocket implementation](websocket/react_websocket/)
22 |
--------------------------------------------------------------------------------
/docs/ConvertPositionRequest.md:
--------------------------------------------------------------------------------
1 | # UpstoxClient.ConvertPositionRequest
2 |
3 | ## Properties
4 | Name | Type | Description | Notes
5 | ------------ | ------------- | ------------- | -------------
6 | **instrumentToken** | **String** | Key of the instrument |
7 | **newProduct** | **String** | Indicates the new product to use for the convert positions |
8 | **oldProduct** | **String** | Indicates the old product to use for the convert positions |
9 | **transactionType** | **String** | Indicates whether its a buy(b) or sell(s) order |
10 | **quantity** | **Number** | Quantity with which the position to convert |
11 |
12 |
13 | ## Enum: NewProductEnum
14 |
15 | * `I` (value: `"I"`)
16 | * `D` (value: `"D"`)
17 | * `CO` (value: `"CO"`)
18 | * `OCO` (value: `"OCO"`)
19 | * `MTF` (value: `"MTF"`)
20 |
21 |
22 |
23 | ## Enum: OldProductEnum
24 |
25 | * `I` (value: `"I"`)
26 | * `D` (value: `"D"`)
27 | * `CO` (value: `"CO"`)
28 | * `OCO` (value: `"OCO"`)
29 | * `MTF` (value: `"MTF"`)
30 |
31 |
32 |
33 | ## Enum: TransactionTypeEnum
34 |
35 | * `BUY` (value: `"BUY"`)
36 | * `SELL` (value: `"SELL"`)
37 |
38 |
--------------------------------------------------------------------------------
/docs/GttPlaceOrderRequest.md:
--------------------------------------------------------------------------------
1 | # UpstoxClient.GttPlaceOrderRequest
2 |
3 | ## Properties
4 | Name | Type | Description | Notes
5 | ------------ | ------------- | ------------- | -------------
6 | **type** | **String** | Type of GTT order. It can be one of the following: SINGLE refers to a single-leg GTT order MULTIPLE refers to a multi-leg GTT order |
7 | **quantity** | **Number** | Quantity with which the order is to be placed |
8 | **product** | **String** | Signifies if the order was either Intraday, Delivery, CO or OCO |
9 | **rules** | [**[GttRule]**](GttRule.md) | List of rules defining the conditions for each leg in the GTT order |
10 | **instrumentToken** | **String** | Key of the instrument |
11 | **transactionType** | **String** | Indicates whether its a buy or sell order |
12 |
13 |
14 | ## Enum: TypeEnum
15 |
16 | * `SINGLE` (value: `"SINGLE"`)
17 | * `MULTIPLE` (value: `"MULTIPLE"`)
18 |
19 |
20 |
21 | ## Enum: ProductEnum
22 |
23 | * `I` (value: `"I"`)
24 | * `D` (value: `"D"`)
25 |
26 |
27 |
28 | ## Enum: TransactionTypeEnum
29 |
30 | * `BUY` (value: `"BUY"`)
31 | * `SELL` (value: `"SELL"`)
32 |
33 |
--------------------------------------------------------------------------------
/.babelrc:
--------------------------------------------------------------------------------
1 | {
2 | "presets": [
3 | [
4 | "@babel/preset-env",
5 | {
6 | "targets": {
7 | "node": "current"
8 | }
9 | }
10 | ]
11 | ],
12 | "plugins": [
13 | "@babel/plugin-syntax-dynamic-import",
14 | "@babel/plugin-syntax-import-meta",
15 | "@babel/plugin-proposal-class-properties",
16 | "@babel/plugin-proposal-json-strings",
17 | [
18 | "@babel/plugin-proposal-decorators",
19 | {
20 | "legacy": true
21 | }
22 | ],
23 | "@babel/plugin-proposal-function-sent",
24 | "@babel/plugin-proposal-export-namespace-from",
25 | "@babel/plugin-proposal-numeric-separator",
26 | "@babel/plugin-proposal-throw-expressions",
27 | "@babel/plugin-proposal-export-default-from",
28 | "@babel/plugin-proposal-logical-assignment-operators",
29 | "@babel/plugin-proposal-optional-chaining",
30 | [
31 | "@babel/plugin-proposal-pipeline-operator",
32 | {
33 | "proposal": "minimal"
34 | }
35 | ],
36 | "@babel/plugin-proposal-nullish-coalescing-operator",
37 | "@babel/plugin-proposal-do-expressions",
38 | "@babel/plugin-proposal-function-bind",
39 | "@babel/plugin-transform-private-methods"
40 | ]
41 | }
42 |
--------------------------------------------------------------------------------
/examples/websocket/react_websocket/src/App.css:
--------------------------------------------------------------------------------
1 | * {
2 | box-sizing: border-box;
3 | -webkit-font-smoothing: antialiased;
4 | -moz-osx-font-smoothing: grayscale;
5 | }
6 |
7 | .app-container {
8 | min-width: 1080px;
9 | display: flex;
10 | column-gap: 2rem;
11 | }
12 |
13 | .app-container .feed-container {
14 | width: 50%;
15 | }
16 |
17 | .app-container .feed-container .header-section {
18 | height: 100px;
19 | }
20 |
21 | .app-container .feed-container .header-section .status.connected span {
22 | color: green;
23 | }
24 |
25 | .app-container .feed-container .header-section .status.not-connected span {
26 | color: red;
27 | }
28 |
29 | .app-container .feed-container .feed-section {
30 | max-height: 700px;
31 | overflow: auto;
32 | background-color: antiquewhite;
33 | border-radius: 1rem;
34 | padding: 0rem 1rem 1rem 1rem;
35 | }
36 |
37 | .app-container .feed-container .feed-section .title {
38 | position: sticky;
39 | top: 0;
40 | background-color: antiquewhite;
41 | height: 3rem;
42 | display: flex;
43 | align-items: center;
44 | font-weight: bold;
45 | font-size: 1.3rem;
46 | }
47 |
48 | .app-container .feed-container .feed-section .feed-item {
49 | word-break: break-all;
50 | margin-bottom: 1rem;
51 | }
52 |
--------------------------------------------------------------------------------
/docs/ModifyOrderRequest.md:
--------------------------------------------------------------------------------
1 | # UpstoxClient.ModifyOrderRequest
2 |
3 | ## Properties
4 | Name | Type | Description | Notes
5 | ------------ | ------------- | ------------- | -------------
6 | **quantity** | **Number** | Quantity with which the order was placed | [optional]
7 | **validity** | **String** | Order validity (DAY- Day and IOC- Immediate or Cancel (IOC) order) |
8 | **price** | **Number** | Price at which the order was placed |
9 | **orderId** | **String** | The order ID for which the order must be modified |
10 | **orderType** | **String** | Type of order. It can be one of the following MARKET refers to market order LIMILT refers to Limit Order SL refers to Stop Loss Limit SL-M refers to Stop Loss Market |
11 | **disclosedQuantity** | **Number** | The quantity that should be disclosed in the market depth | [optional]
12 | **triggerPrice** | **Number** | If the order is a stop loss order then the trigger price to be set is mentioned here |
13 |
14 |
15 | ## Enum: ValidityEnum
16 |
17 | * `DAY` (value: `"DAY"`)
18 | * `IOC` (value: `"IOC"`)
19 |
20 |
21 |
22 | ## Enum: OrderTypeEnum
23 |
24 | * `MARKET` (value: `"MARKET"`)
25 | * `LIMIT` (value: `"LIMIT"`)
26 | * `SL` (value: `"SL"`)
27 | * `SL_M` (value: `"SL-M"`)
28 |
29 |
--------------------------------------------------------------------------------
/docs/ExpiredFutureData.md:
--------------------------------------------------------------------------------
1 | # UpstoxClient.ExpiredFutureData
2 |
3 | ## Properties
4 | Name | Type | Description | Notes
5 | ------------ | ------------- | ------------- | -------------
6 | **name** | **String** | Name of the instrument | [optional]
7 | **segment** | **String** | Segment of the instrument | [optional]
8 | **exchange** | **String** | Exchange of the instrument | [optional]
9 | **expiry** | **String** | Expiry date of the instrument | [optional]
10 | **instrumentKey** | **String** | Unique key identifying the instrument | [optional]
11 | **exchangeToken** | **String** | Token assigned by the exchange | [optional]
12 | **tradingSymbol** | **String** | Symbol used for trading | [optional]
13 | **tickSize** | **Number** | Minimum price movement | [optional]
14 | **lotSize** | **Number** | Number of units per lot | [optional]
15 | **instrumentType** | **String** | Type of the instrument | [optional]
16 | **freezeQuantity** | **Number** | Maximum allowed quantity | [optional]
17 | **underlyingKey** | **String** | Key of the underlying asset | [optional]
18 | **underlyingType** | **String** | Type of the underlying asset | [optional]
19 | **underlyingSymbol** | **String** | Symbol of the underlying asset | [optional]
20 | **minimumLot** | **Number** | Minimum lot size | [optional]
21 |
--------------------------------------------------------------------------------
/docs/MarketQuoteSymbol.md:
--------------------------------------------------------------------------------
1 | # UpstoxClient.MarketQuoteSymbol
2 |
3 | ## Properties
4 | Name | Type | Description | Notes
5 | ------------ | ------------- | ------------- | -------------
6 | **ohlc** | [**Ohlc**](Ohlc.md) | | [optional]
7 | **depth** | [**DepthMap**](DepthMap.md) | | [optional]
8 | **timestamp** | **String** | Time in milliseconds at which the feeds was updated | [optional]
9 | **instrumentToken** | **String** | Key issued by Upstox for the instrument | [optional]
10 | **symbol** | **String** | Shows the trading symbol of the instrument | [optional]
11 | **lastPrice** | **Number** | The last traded price of symbol | [optional]
12 | **volume** | **Number** | The volume traded today on symbol | [optional]
13 | **averagePrice** | **Number** | Average price | [optional]
14 | **oi** | **Number** | Total number of outstanding contracts held by market participants exchange-wide (only F&O) | [optional]
15 | **netChange** | **Number** | The absolute change from yesterday's close to last traded price | [optional]
16 | **totalBuyQuantity** | **Number** | The total number of bid quantity available for trading | [optional]
17 | **totalSellQuantity** | **Number** | The total number of ask quantity available for trading | [optional]
18 | **lowerCircuitLimit** | **Number** | The lower circuit of symbol | [optional]
19 | **upperCircuitLimit** | **Number** | The upper circuit of symbol | [optional]
20 | **lastTradeTime** | **String** | Time in milliseconds at which last trade happened | [optional]
21 | **oiDayHigh** | **Number** | | [optional]
22 | **oiDayLow** | **Number** | | [optional]
23 |
--------------------------------------------------------------------------------
/src/model/OrderMetadata.js:
--------------------------------------------------------------------------------
1 | /*
2 | * OpenAPI definition
3 | * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
4 | *
5 | * OpenAPI spec version: v0
6 | *
7 | * NOTE: This class is auto generated by the swagger code generator program.
8 | * https://github.com/swagger-api/swagger-codegen.git
9 | *
10 | * Swagger Codegen version: 3.0.66
11 | *
12 | * Do not edit the class manually.
13 | *
14 | */
15 | import {ApiClient} from '../ApiClient';
16 |
17 | /**
18 | * The OrderMetadata model module.
19 | * @module model/OrderMetadata
20 | * @version v0
21 | */
22 | export class OrderMetadata {
23 | /**
24 | * Constructs a new OrderMetadata.
25 | * @alias module:model/OrderMetadata
26 | * @class
27 | */
28 | constructor() {
29 | }
30 |
31 | /**
32 | * Constructs a OrderMetadata from a plain JavaScript object, optionally creating a new instance.
33 | * Copies all relevant properties from data to obj if supplied or a new instance if not.
34 | * @param {Object} data The plain JavaScript object bearing properties of interest.
35 | * @param {module:model/OrderMetadata} obj Optional instance to populate.
36 | * @return {module:model/OrderMetadata} The populated OrderMetadata instance.
37 | */
38 | static constructFromObject(data, obj) {
39 | if (data) {
40 | obj = obj || new OrderMetadata();
41 | if (data.hasOwnProperty('latency'))
42 | obj.latency = ApiClient.convertToType(data['latency'], 'Number');
43 | }
44 | return obj;
45 | }
46 | }
47 |
48 | /**
49 | * @member {Number} latency
50 | */
51 | OrderMetadata.prototype.latency = undefined;
52 |
53 |
--------------------------------------------------------------------------------
/src/feeder/Feeder.js:
--------------------------------------------------------------------------------
1 | import { Readable } from "stream";
2 |
3 | /**
4 | * Interface representing a data feeder.
5 | * Implementations should provide functionality for connecting to a data source,
6 | * handling connection events, and streaming data.
7 | */
8 | class Feeder extends Readable {
9 | constructor() {
10 | super();
11 | if (new.target === Feeder) {
12 | throw new Error(
13 | "Feeder is an interface-like class and cannot be instantiated directly."
14 | );
15 | }
16 | }
17 |
18 | /**
19 | * Establishes a connection to the data source.
20 | */
21 | async connect() {
22 | throw new Error("Method 'connect()' must be implemented.");
23 | }
24 |
25 | /**
26 | * Determines if a reconnection is necessary.
27 | */
28 | shouldReconnect() {
29 | throw new Error("Method 'shouldReconnect()' must be implemented.");
30 | }
31 |
32 | /**
33 | * Handles incoming messages from the WebSocket connection.
34 | */
35 | onMessage() {
36 | throw new Error("Method 'onMessage()' must be implemented.");
37 | }
38 |
39 | /**
40 | * Handles the closing of the WebSocket connection.
41 | */
42 | onClose() {
43 | throw new Error("Method 'onClose()' must be implemented.");
44 | }
45 |
46 | /**
47 | * Handles errors from the WebSocket connection.
48 | */
49 | onError() {
50 | throw new Error("Method 'onError()' must be implemented.");
51 | }
52 |
53 | /**
54 | * Disconnects from the data source.
55 | */
56 | disconnect() {
57 | throw new Error("Method 'disconnect()' must be implemented.");
58 | }
59 |
60 | /**
61 | * Implementation of the Readable stream's _read method.
62 | */
63 | _read() {}
64 | }
65 |
66 | export default Feeder;
67 |
--------------------------------------------------------------------------------
/src/model/MultiOrderV3Data.js:
--------------------------------------------------------------------------------
1 | /*
2 | * OpenAPI definition
3 | * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
4 | *
5 | * OpenAPI spec version: v0
6 | *
7 | * NOTE: This class is auto generated by the swagger code generator program.
8 | * https://github.com/swagger-api/swagger-codegen.git
9 | *
10 | * Swagger Codegen version: 3.0.66
11 | *
12 | * Do not edit the class manually.
13 | *
14 | */
15 | import {ApiClient} from '../ApiClient';
16 |
17 | /**
18 | * The MultiOrderV3Data model module.
19 | * @module model/MultiOrderV3Data
20 | * @version v0
21 | */
22 | export class MultiOrderV3Data {
23 | /**
24 | * Constructs a new MultiOrderV3Data.
25 | * @alias module:model/MultiOrderV3Data
26 | * @class
27 | */
28 | constructor() {
29 | }
30 |
31 | /**
32 | * Constructs a MultiOrderV3Data from a plain JavaScript object, optionally creating a new instance.
33 | * Copies all relevant properties from data to obj if supplied or a new instance if not.
34 | * @param {Object} data The plain JavaScript object bearing properties of interest.
35 | * @param {module:model/MultiOrderV3Data} obj Optional instance to populate.
36 | * @return {module:model/MultiOrderV3Data} The populated MultiOrderV3Data instance.
37 | */
38 | static constructFromObject(data, obj) {
39 | if (data) {
40 | obj = obj || new MultiOrderV3Data();
41 | if (data.hasOwnProperty('order_ids'))
42 | obj.orderIds = ApiClient.convertToType(data['order_ids'], ['String']);
43 | }
44 | return obj;
45 | }
46 | }
47 |
48 | /**
49 | * @member {Array.} orderIds
50 | */
51 | MultiOrderV3Data.prototype.orderIds = undefined;
52 |
53 |
--------------------------------------------------------------------------------
/test/model/OrderMetadata.spec.js:
--------------------------------------------------------------------------------
1 | /*
2 | * OpenAPI definition
3 | * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
4 | *
5 | * OpenAPI spec version: v0
6 | *
7 | * NOTE: This class is auto generated by the swagger code generator program.
8 | * https://github.com/swagger-api/swagger-codegen.git
9 | *
10 | * Swagger Codegen version: 3.0.66
11 | *
12 | * Do not edit the class manually.
13 | *
14 | */
15 | (function(root, factory) {
16 | if (typeof define === 'function' && define.amd) {
17 | // AMD.
18 | define(['expect.js', '../../src/index'], factory);
19 | } else if (typeof module === 'object' && module.exports) {
20 | // CommonJS-like environments that support module.exports, like Node.
21 | factory(require('expect.js'), require('../../src/index'));
22 | } else {
23 | // Browser globals (root is window)
24 | factory(root.expect, root.UpstoxClient);
25 | }
26 | }(this, function(expect, UpstoxClient) {
27 | 'use strict';
28 |
29 | var instance;
30 |
31 | describe('(package)', function() {
32 | describe('OrderMetadata', function() {
33 | beforeEach(function() {
34 | instance = new UpstoxClient.OrderMetadata();
35 | });
36 |
37 | it('should create an instance of OrderMetadata', function() {
38 | // TODO: update the code to test OrderMetadata
39 | expect(instance).to.be.a(UpstoxClient.OrderMetadata);
40 | });
41 |
42 | it('should have the property latency (base name: "latency")', function() {
43 | // TODO: update the code to test the property latency
44 | expect(instance).to.have.property('latency');
45 | // expect(instance.latency).to.be(expectedValueLiteral);
46 | });
47 |
48 | });
49 | });
50 |
51 | }));
52 |
--------------------------------------------------------------------------------
/docs/ProfileData.md:
--------------------------------------------------------------------------------
1 | # UpstoxClient.ProfileData
2 |
3 | ## Properties
4 | Name | Type | Description | Notes
5 | ------------ | ------------- | ------------- | -------------
6 | **email** | **String** | E-mail address of the user | [optional]
7 | **exchanges** | **[String]** | Lists the exchanges to which the user has access | [optional]
8 | **products** | **[String]** | Lists the products types to which the user has access | [optional]
9 | **broker** | **String** | The broker ID | [optional]
10 | **userId** | **String** | Uniquely identifies the user | [optional]
11 | **userName** | **String** | Name of the user | [optional]
12 | **orderTypes** | **[String]** | Order types enabled for the user | [optional]
13 | **userType** | **String** | Identifies the user's registered role at the broker. This will be individual for all retail users | [optional]
14 | **poa** | **Boolean** | To depict if the user has given power of attorney for transactions | [optional]
15 | **isActive** | **Boolean** | Whether the status of account is active or not | [optional]
16 |
17 |
18 | ## Enum: [ExchangesEnum]
19 |
20 | * `NSE` (value: `"NSE"`)
21 | * `NFO` (value: `"NFO"`)
22 | * `CDS` (value: `"CDS"`)
23 | * `BSE` (value: `"BSE"`)
24 | * `BCD` (value: `"BCD"`)
25 | * `BFO` (value: `"BFO"`)
26 | * `MCX` (value: `"MCX"`)
27 | * `NSCOM` (value: `"NSCOM"`)
28 |
29 |
30 |
31 | ## Enum: [ProductsEnum]
32 |
33 | * `I` (value: `"I"`)
34 | * `D` (value: `"D"`)
35 | * `CO` (value: `"CO"`)
36 | * `OCO` (value: `"OCO"`)
37 | * `MTF` (value: `"MTF"`)
38 |
39 |
40 |
41 | ## Enum: [OrderTypesEnum]
42 |
43 | * `MARKET` (value: `"MARKET"`)
44 | * `LIMIT` (value: `"LIMIT"`)
45 | * `SL` (value: `"SL"`)
46 | * `SL_M` (value: `"SL-M"`)
47 |
48 |
--------------------------------------------------------------------------------
/test/model/GttOrderData.spec.js:
--------------------------------------------------------------------------------
1 | /*
2 | * OpenAPI definition
3 | * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
4 | *
5 | * OpenAPI spec version: v0
6 | *
7 | * NOTE: This class is auto generated by the swagger code generator program.
8 | * https://github.com/swagger-api/swagger-codegen.git
9 | *
10 | * Swagger Codegen version: 3.0.66
11 | *
12 | * Do not edit the class manually.
13 | *
14 | */
15 | (function(root, factory) {
16 | if (typeof define === 'function' && define.amd) {
17 | // AMD.
18 | define(['expect.js', '../../src/index'], factory);
19 | } else if (typeof module === 'object' && module.exports) {
20 | // CommonJS-like environments that support module.exports, like Node.
21 | factory(require('expect.js'), require('../../src/index'));
22 | } else {
23 | // Browser globals (root is window)
24 | factory(root.expect, root.UpstoxClient);
25 | }
26 | }(this, function(expect, UpstoxClient) {
27 | 'use strict';
28 |
29 | var instance;
30 |
31 | describe('(package)', function() {
32 | describe('GttOrderData', function() {
33 | beforeEach(function() {
34 | instance = new UpstoxClient.GttOrderData();
35 | });
36 |
37 | it('should create an instance of GttOrderData', function() {
38 | // TODO: update the code to test GttOrderData
39 | expect(instance).to.be.a(UpstoxClient.GttOrderData);
40 | });
41 |
42 | it('should have the property gttOrderIds (base name: "gtt_order_ids")', function() {
43 | // TODO: update the code to test the property gttOrderIds
44 | expect(instance).to.have.property('gttOrderIds');
45 | // expect(instance.gttOrderIds).to.be(expectedValueLiteral);
46 | });
47 |
48 | });
49 | });
50 |
51 | }));
52 |
--------------------------------------------------------------------------------
/test/model/MarginRequest.spec.js:
--------------------------------------------------------------------------------
1 | /*
2 | * OpenAPI definition
3 | * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
4 | *
5 | * OpenAPI spec version: v0
6 | *
7 | * NOTE: This class is auto generated by the swagger code generator program.
8 | * https://github.com/swagger-api/swagger-codegen.git
9 | *
10 | * Swagger Codegen version: 3.0.54
11 | *
12 | * Do not edit the class manually.
13 | *
14 | */
15 | (function(root, factory) {
16 | if (typeof define === 'function' && define.amd) {
17 | // AMD.
18 | define(['expect.js', '../../src/index'], factory);
19 | } else if (typeof module === 'object' && module.exports) {
20 | // CommonJS-like environments that support module.exports, like Node.
21 | factory(require('expect.js'), require('../../src/index'));
22 | } else {
23 | // Browser globals (root is window)
24 | factory(root.expect, root.UpstoxClient);
25 | }
26 | }(this, function(expect, UpstoxClient) {
27 | 'use strict';
28 |
29 | var instance;
30 |
31 | describe('(package)', function() {
32 | describe('MarginRequest', function() {
33 | beforeEach(function() {
34 | instance = new UpstoxClient.MarginRequest();
35 | });
36 |
37 | it('should create an instance of MarginRequest', function() {
38 | // TODO: update the code to test MarginRequest
39 | expect(instance).to.be.a(UpstoxClient.MarginRequest);
40 | });
41 |
42 | it('should have the property instruments (base name: "instruments")', function() {
43 | // TODO: update the code to test the property instruments
44 | expect(instance).to.have.property('instruments');
45 | // expect(instance.instruments).to.be(expectedValueLiteral);
46 | });
47 |
48 | });
49 | });
50 |
51 | }));
52 |
--------------------------------------------------------------------------------
/test/model/MultiOrderV3Data.spec.js:
--------------------------------------------------------------------------------
1 | /*
2 | * OpenAPI definition
3 | * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
4 | *
5 | * OpenAPI spec version: v0
6 | *
7 | * NOTE: This class is auto generated by the swagger code generator program.
8 | * https://github.com/swagger-api/swagger-codegen.git
9 | *
10 | * Swagger Codegen version: 3.0.66
11 | *
12 | * Do not edit the class manually.
13 | *
14 | */
15 | (function(root, factory) {
16 | if (typeof define === 'function' && define.amd) {
17 | // AMD.
18 | define(['expect.js', '../../src/index'], factory);
19 | } else if (typeof module === 'object' && module.exports) {
20 | // CommonJS-like environments that support module.exports, like Node.
21 | factory(require('expect.js'), require('../../src/index'));
22 | } else {
23 | // Browser globals (root is window)
24 | factory(root.expect, root.UpstoxClient);
25 | }
26 | }(this, function(expect, UpstoxClient) {
27 | 'use strict';
28 |
29 | var instance;
30 |
31 | describe('(package)', function() {
32 | describe('MultiOrderV3Data', function() {
33 | beforeEach(function() {
34 | instance = new UpstoxClient.MultiOrderV3Data();
35 | });
36 |
37 | it('should create an instance of MultiOrderV3Data', function() {
38 | // TODO: update the code to test MultiOrderV3Data
39 | expect(instance).to.be.a(UpstoxClient.MultiOrderV3Data);
40 | });
41 |
42 | it('should have the property orderIds (base name: "order_ids")', function() {
43 | // TODO: update the code to test the property orderIds
44 | expect(instance).to.have.property('orderIds');
45 | // expect(instance.orderIds).to.be(expectedValueLiteral);
46 | });
47 |
48 | });
49 | });
50 |
51 | }));
52 |
--------------------------------------------------------------------------------
/src/model/GttOrderData.js:
--------------------------------------------------------------------------------
1 | /*
2 | * OpenAPI definition
3 | * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
4 | *
5 | * OpenAPI spec version: v0
6 | *
7 | * NOTE: This class is auto generated by the swagger code generator program.
8 | * https://github.com/swagger-api/swagger-codegen.git
9 | *
10 | * Swagger Codegen version: 3.0.66
11 | *
12 | * Do not edit the class manually.
13 | *
14 | */
15 | import {ApiClient} from '../ApiClient';
16 |
17 | /**
18 | * The GttOrderData model module.
19 | * @module model/GttOrderData
20 | * @version v0
21 | */
22 | export class GttOrderData {
23 | /**
24 | * Constructs a new GttOrderData.
25 | * Response data for GTT order request
26 | * @alias module:model/GttOrderData
27 | * @class
28 | */
29 | constructor() {
30 | }
31 |
32 | /**
33 | * Constructs a GttOrderData from a plain JavaScript object, optionally creating a new instance.
34 | * Copies all relevant properties from data to obj if supplied or a new instance if not.
35 | * @param {Object} data The plain JavaScript object bearing properties of interest.
36 | * @param {module:model/GttOrderData} obj Optional instance to populate.
37 | * @return {module:model/GttOrderData} The populated GttOrderData instance.
38 | */
39 | static constructFromObject(data, obj) {
40 | if (data) {
41 | obj = obj || new GttOrderData();
42 | if (data.hasOwnProperty('gtt_order_ids'))
43 | obj.gttOrderIds = ApiClient.convertToType(data['gtt_order_ids'], ['String']);
44 | }
45 | return obj;
46 | }
47 | }
48 |
49 | /**
50 | * Order ID for the placed GTT order
51 | * @member {Array.} gttOrderIds
52 | */
53 | GttOrderData.prototype.gttOrderIds = undefined;
54 |
55 |
--------------------------------------------------------------------------------
/test/model/GttCancelOrderRequest.spec.js:
--------------------------------------------------------------------------------
1 | /*
2 | * OpenAPI definition
3 | * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
4 | *
5 | * OpenAPI spec version: v0
6 | *
7 | * NOTE: This class is auto generated by the swagger code generator program.
8 | * https://github.com/swagger-api/swagger-codegen.git
9 | *
10 | * Swagger Codegen version: 3.0.66
11 | *
12 | * Do not edit the class manually.
13 | *
14 | */
15 | (function(root, factory) {
16 | if (typeof define === 'function' && define.amd) {
17 | // AMD.
18 | define(['expect.js', '../../src/index'], factory);
19 | } else if (typeof module === 'object' && module.exports) {
20 | // CommonJS-like environments that support module.exports, like Node.
21 | factory(require('expect.js'), require('../../src/index'));
22 | } else {
23 | // Browser globals (root is window)
24 | factory(root.expect, root.UpstoxClient);
25 | }
26 | }(this, function(expect, UpstoxClient) {
27 | 'use strict';
28 |
29 | var instance;
30 |
31 | describe('(package)', function() {
32 | describe('GttCancelOrderRequest', function() {
33 | beforeEach(function() {
34 | instance = new UpstoxClient.GttCancelOrderRequest();
35 | });
36 |
37 | it('should create an instance of GttCancelOrderRequest', function() {
38 | // TODO: update the code to test GttCancelOrderRequest
39 | expect(instance).to.be.a(UpstoxClient.GttCancelOrderRequest);
40 | });
41 |
42 | it('should have the property gttOrderId (base name: "gtt_order_id")', function() {
43 | // TODO: update the code to test the property gttOrderId
44 | expect(instance).to.have.property('gttOrderId');
45 | // expect(instance.gttOrderId).to.be(expectedValueLiteral);
46 | });
47 |
48 | });
49 | });
50 |
51 | }));
52 |
--------------------------------------------------------------------------------
/test/model/IndieUserTokenRequest.spec.js:
--------------------------------------------------------------------------------
1 | /*
2 | * OpenAPI definition
3 | * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
4 | *
5 | * OpenAPI spec version: v0
6 | *
7 | * NOTE: This class is auto generated by the swagger code generator program.
8 | * https://github.com/swagger-api/swagger-codegen.git
9 | *
10 | * Swagger Codegen version: 3.0.66
11 | *
12 | * Do not edit the class manually.
13 | *
14 | */
15 | (function(root, factory) {
16 | if (typeof define === 'function' && define.amd) {
17 | // AMD.
18 | define(['expect.js', '../../src/index'], factory);
19 | } else if (typeof module === 'object' && module.exports) {
20 | // CommonJS-like environments that support module.exports, like Node.
21 | factory(require('expect.js'), require('../../src/index'));
22 | } else {
23 | // Browser globals (root is window)
24 | factory(root.expect, root.UpstoxClient);
25 | }
26 | }(this, function(expect, UpstoxClient) {
27 | 'use strict';
28 |
29 | var instance;
30 |
31 | describe('(package)', function() {
32 | describe('IndieUserTokenRequest', function() {
33 | beforeEach(function() {
34 | instance = new UpstoxClient.IndieUserTokenRequest();
35 | });
36 |
37 | it('should create an instance of IndieUserTokenRequest', function() {
38 | // TODO: update the code to test IndieUserTokenRequest
39 | expect(instance).to.be.a(UpstoxClient.IndieUserTokenRequest);
40 | });
41 |
42 | it('should have the property clientSecret (base name: "client_secret")', function() {
43 | // TODO: update the code to test the property clientSecret
44 | expect(instance).to.have.property('clientSecret');
45 | // expect(instance.clientSecret).to.be(expectedValueLiteral);
46 | });
47 |
48 | });
49 | });
50 |
51 | }));
52 |
--------------------------------------------------------------------------------
/test/model/TradeHistoryResponseMetaData.spec.js:
--------------------------------------------------------------------------------
1 | /*
2 | * OpenAPI definition
3 | * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
4 | *
5 | * OpenAPI spec version: v0
6 | *
7 | * NOTE: This class is auto generated by the swagger code generator program.
8 | * https://github.com/swagger-api/swagger-codegen.git
9 | *
10 | * Swagger Codegen version: 3.0.54
11 | *
12 | * Do not edit the class manually.
13 | *
14 | */
15 | (function(root, factory) {
16 | if (typeof define === 'function' && define.amd) {
17 | // AMD.
18 | define(['expect.js', '../../src/index'], factory);
19 | } else if (typeof module === 'object' && module.exports) {
20 | // CommonJS-like environments that support module.exports, like Node.
21 | factory(require('expect.js'), require('../../src/index'));
22 | } else {
23 | // Browser globals (root is window)
24 | factory(root.expect, root.UpstoxClient);
25 | }
26 | }(this, function(expect, UpstoxClient) {
27 | 'use strict';
28 |
29 | var instance;
30 |
31 | describe('(package)', function() {
32 | describe('TradeHistoryResponseMetaData', function() {
33 | beforeEach(function() {
34 | instance = new UpstoxClient.TradeHistoryResponseMetaData();
35 | });
36 |
37 | it('should create an instance of TradeHistoryResponseMetaData', function() {
38 | // TODO: update the code to test TradeHistoryResponseMetaData
39 | expect(instance).to.be.a(UpstoxClient.TradeHistoryResponseMetaData);
40 | });
41 |
42 | it('should have the property page (base name: "page")', function() {
43 | // TODO: update the code to test the property page
44 | expect(instance).to.have.property('page');
45 | // expect(instance.page).to.be(expectedValueLiteral);
46 | });
47 |
48 | });
49 | });
50 |
51 | }));
52 |
--------------------------------------------------------------------------------
/test/model/CancelOrExitMultiOrderData.spec.js:
--------------------------------------------------------------------------------
1 | /*
2 | * OpenAPI definition
3 | * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
4 | *
5 | * OpenAPI spec version: v0
6 | *
7 | * NOTE: This class is auto generated by the swagger code generator program.
8 | * https://github.com/swagger-api/swagger-codegen.git
9 | *
10 | * Swagger Codegen version: 3.0.62
11 | *
12 | * Do not edit the class manually.
13 | *
14 | */
15 | (function(root, factory) {
16 | if (typeof define === 'function' && define.amd) {
17 | // AMD.
18 | define(['expect.js', '../../src/index'], factory);
19 | } else if (typeof module === 'object' && module.exports) {
20 | // CommonJS-like environments that support module.exports, like Node.
21 | factory(require('expect.js'), require('../../src/index'));
22 | } else {
23 | // Browser globals (root is window)
24 | factory(root.expect, root.UpstoxClient);
25 | }
26 | }(this, function(expect, UpstoxClient) {
27 | 'use strict';
28 |
29 | var instance;
30 |
31 | describe('(package)', function() {
32 | describe('CancelOrExitMultiOrderData', function() {
33 | beforeEach(function() {
34 | instance = new UpstoxClient.CancelOrExitMultiOrderData();
35 | });
36 |
37 | it('should create an instance of CancelOrExitMultiOrderData', function() {
38 | // TODO: update the code to test CancelOrExitMultiOrderData
39 | expect(instance).to.be.a(UpstoxClient.CancelOrExitMultiOrderData);
40 | });
41 |
42 | it('should have the property orderIds (base name: "order_ids")', function() {
43 | // TODO: update the code to test the property orderIds
44 | expect(instance).to.have.property('orderIds');
45 | // expect(instance.orderIds).to.be(expectedValueLiteral);
46 | });
47 |
48 | });
49 | });
50 |
51 | }));
52 |
--------------------------------------------------------------------------------
/docs/PlaceOrderV3Request.md:
--------------------------------------------------------------------------------
1 | # UpstoxClient.PlaceOrderV3Request
2 |
3 | ## Properties
4 | Name | Type | Description | Notes
5 | ------------ | ------------- | ------------- | -------------
6 | **quantity** | **Number** | Quantity with which the order is to be placed |
7 | **product** | **String** | Signifies if the order was either Intraday, Delivery, CO or OCO |
8 | **validity** | **String** | It can be one of the following - DAY(default), IOC |
9 | **price** | **Number** | Price at which the order will be placed |
10 | **tag** | **String** | | [optional]
11 | **slice** | **Boolean** | | [optional]
12 | **instrumentToken** | **String** | Key of the instrument |
13 | **orderType** | **String** | Type of order. It can be one of the following MARKET refers to market order LIMIT refers to Limit Order SL refers to Stop Loss Limit SL-M refers to Stop Loss Market |
14 | **transactionType** | **String** | Indicates whether its a buy or sell order |
15 | **disclosedQuantity** | **Number** | The quantity that should be disclosed in the market depth |
16 | **triggerPrice** | **Number** | If the order is a stop loss order then the trigger price to be set is mentioned here |
17 | **isAmo** | **Boolean** | Signifies if the order is an After Market Order |
18 |
19 |
20 | ## Enum: ProductEnum
21 |
22 | * `I` (value: `"I"`)
23 | * `D` (value: `"D"`)
24 | * `MTF` (value: `"MTF"`)
25 |
26 |
27 |
28 | ## Enum: ValidityEnum
29 |
30 | * `DAY` (value: `"DAY"`)
31 | * `IOC` (value: `"IOC"`)
32 |
33 |
34 |
35 | ## Enum: OrderTypeEnum
36 |
37 | * `MARKET` (value: `"MARKET"`)
38 | * `LIMIT` (value: `"LIMIT"`)
39 | * `SL` (value: `"SL"`)
40 | * `SL_M` (value: `"SL-M"`)
41 |
42 |
43 |
44 | ## Enum: TransactionTypeEnum
45 |
46 | * `BUY` (value: `"BUY"`)
47 | * `SELL` (value: `"SELL"`)
48 |
49 |
--------------------------------------------------------------------------------
/docs/TokenResponse.md:
--------------------------------------------------------------------------------
1 | # UpstoxClient.TokenResponse
2 |
3 | ## Properties
4 | Name | Type | Description | Notes
5 | ------------ | ------------- | ------------- | -------------
6 | **email** | **String** | E-mail address of the user | [optional]
7 | **exchanges** | **[String]** | Lists the exchanges to which the user has access | [optional]
8 | **products** | **[String]** | Lists the products types to which the user has access | [optional]
9 | **broker** | **String** | The broker ID | [optional]
10 | **userId** | **String** | Uniquely identifies the user | [optional]
11 | **userName** | **String** | Name of the user | [optional]
12 | **orderTypes** | **[String]** | Order types enabled for the user | [optional]
13 | **userType** | **String** | Identifies the user's registered role at the broker. This will be individual for all retail users | [optional]
14 | **poa** | **Boolean** | To depict if the user has given power of attorney for transactions | [optional]
15 | **isActive** | **Boolean** | Whether the status of account is active or not | [optional]
16 | **accessToken** | **String** | The authentication token that is to used with every subsequent API requests | [optional]
17 |
18 |
19 | ## Enum: [ExchangesEnum]
20 |
21 | * `NSE` (value: `"NSE"`)
22 | * `NFO` (value: `"NFO"`)
23 | * `CDS` (value: `"CDS"`)
24 | * `BSE` (value: `"BSE"`)
25 | * `BCD` (value: `"BCD"`)
26 | * `BFO` (value: `"BFO"`)
27 | * `MCX` (value: `"MCX"`)
28 |
29 |
30 |
31 | ## Enum: [ProductsEnum]
32 |
33 | * `I` (value: `"I"`)
34 | * `D` (value: `"D"`)
35 | * `CO` (value: `"CO"`)
36 | * `OCO` (value: `"OCO"`)
37 | * `MTF` (value: `"MTF"`)
38 |
39 |
40 |
41 | ## Enum: [OrderTypesEnum]
42 |
43 | * `MARKET` (value: `"MARKET"`)
44 | * `LIMIT` (value: `"LIMIT"`)
45 | * `SL` (value: `"SL"`)
46 | * `SL_M` (value: `"SL-M"`)
47 |
48 |
--------------------------------------------------------------------------------
/docs/PlaceOrderRequest.md:
--------------------------------------------------------------------------------
1 | # UpstoxClient.PlaceOrderRequest
2 |
3 | ## Properties
4 | Name | Type | Description | Notes
5 | ------------ | ------------- | ------------- | -------------
6 | **quantity** | **Number** | Quantity with which the order is to be placed |
7 | **product** | **String** | Signifies if the order was either Intraday, Delivery, CO or OCO |
8 | **validity** | **String** | It can be one of the following - DAY(default), IOC |
9 | **price** | **Number** | Price at which the order will be placed |
10 | **tag** | **String** | Tag for a particular order | [optional]
11 | **instrumentToken** | **String** | Key of the instrument |
12 | **orderType** | **String** | Type of order. It can be one of the following MARKET refers to market order LIMIT refers to Limit Order SL refers to Stop Loss Limit SL-M refers to Stop Loss Market |
13 | **transactionType** | **String** | Indicates whether its a buy or sell order |
14 | **disclosedQuantity** | **Number** | The quantity that should be disclosed in the market depth |
15 | **triggerPrice** | **Number** | If the order is a stop loss order then the trigger price to be set is mentioned here |
16 | **isAmo** | **Boolean** | Signifies if the order is an After Market Order |
17 |
18 |
19 | ## Enum: ProductEnum
20 |
21 | * `I` (value: `"I"`)
22 | * `D` (value: `"D"`)
23 | * `CO` (value: `"CO"`)
24 | * `OCO` (value: `"OCO"`)
25 | * `MTF` (value: `"MTF"`)
26 |
27 |
28 |
29 | ## Enum: ValidityEnum
30 |
31 | * `DAY` (value: `"DAY"`)
32 | * `IOC` (value: `"IOC"`)
33 |
34 |
35 |
36 | ## Enum: OrderTypeEnum
37 |
38 | * `MARKET` (value: `"MARKET"`)
39 | * `LIMIT` (value: `"LIMIT"`)
40 | * `SL` (value: `"SL"`)
41 | * `SL_M` (value: `"SL-M"`)
42 |
43 |
44 |
45 | ## Enum: TransactionTypeEnum
46 |
47 | * `BUY` (value: `"BUY"`)
48 | * `SELL` (value: `"SELL"`)
49 |
50 |
--------------------------------------------------------------------------------
/examples/websocket/react_websocket/public/index.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 |
7 |
8 |
12 |
13 |
17 |
18 |
27 | React App
28 |
29 |
30 |
31 |
32 |
42 |
43 |
44 |
--------------------------------------------------------------------------------
/src/model/IndieUserTokenRequest.js:
--------------------------------------------------------------------------------
1 | /*
2 | * OpenAPI definition
3 | * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
4 | *
5 | * OpenAPI spec version: v0
6 | *
7 | * NOTE: This class is auto generated by the swagger code generator program.
8 | * https://github.com/swagger-api/swagger-codegen.git
9 | *
10 | * Swagger Codegen version: 3.0.66
11 | *
12 | * Do not edit the class manually.
13 | *
14 | */
15 | import {ApiClient} from '../ApiClient';
16 |
17 | /**
18 | * The IndieUserTokenRequest model module.
19 | * @module model/IndieUserTokenRequest
20 | * @version v0
21 | */
22 | export class IndieUserTokenRequest {
23 | /**
24 | * Constructs a new IndieUserTokenRequest.
25 | * @alias module:model/IndieUserTokenRequest
26 | * @class
27 | */
28 | constructor() {
29 | }
30 |
31 | /**
32 | * Constructs a IndieUserTokenRequest from a plain JavaScript object, optionally creating a new instance.
33 | * Copies all relevant properties from data to obj if supplied or a new instance if not.
34 | * @param {Object} data The plain JavaScript object bearing properties of interest.
35 | * @param {module:model/IndieUserTokenRequest} obj Optional instance to populate.
36 | * @return {module:model/IndieUserTokenRequest} The populated IndieUserTokenRequest instance.
37 | */
38 | static constructFromObject(data, obj) {
39 | if (data) {
40 | obj = obj || new IndieUserTokenRequest();
41 | if (data.hasOwnProperty('client_secret'))
42 | obj.clientSecret = ApiClient.convertToType(data['client_secret'], 'String');
43 | }
44 | return obj;
45 | }
46 | }
47 |
48 | /**
49 | * OAuth client secret that is a private secret known only to app and authorization server
50 | * @member {String} clientSecret
51 | */
52 | IndieUserTokenRequest.prototype.clientSecret = undefined;
53 |
54 |
--------------------------------------------------------------------------------
/docs/InstrumentData.md:
--------------------------------------------------------------------------------
1 | # UpstoxClient.InstrumentData
2 |
3 | ## Properties
4 | Name | Type | Description | Notes
5 | ------------ | ------------- | ------------- | -------------
6 | **name** | **String** | | [optional]
7 | **segment** | **String** | | [optional]
8 | **exchange** | **String** | | [optional]
9 | **isin** | **String** | | [optional]
10 | **expiry** | **Date** | | [optional]
11 | **country** | **String** | | [optional]
12 | **latency** | **String** | | [optional]
13 | **description** | **String** | | [optional]
14 | **currency** | **String** | | [optional]
15 | **weekly** | **Boolean** | | [optional]
16 | **instrumentKey** | **String** | | [optional]
17 | **exchangeToken** | **String** | | [optional]
18 | **tradingSymbol** | **String** | | [optional]
19 | **shortName** | **String** | | [optional]
20 | **tickSize** | **Number** | | [optional]
21 | **lotSize** | **Number** | | [optional]
22 | **instrumentType** | **String** | | [optional]
23 | **freezeQuantity** | **Number** | | [optional]
24 | **underlyingKey** | **String** | | [optional]
25 | **underlyingType** | **String** | | [optional]
26 | **underlyingSymbol** | **String** | | [optional]
27 | **lastTradingDate** | **Date** | | [optional]
28 | **strikePrice** | **Number** | | [optional]
29 | **priceQuoteUnit** | **String** | | [optional]
30 | **qtyMultiplier** | **Number** | | [optional]
31 | **minimumLot** | **Number** | | [optional]
32 | **startTime** | **String** | | [optional]
33 | **endTime** | **String** | | [optional]
34 | **weekDays** | **String** | | [optional]
35 | **generalDenominator** | **Number** | | [optional]
36 | **generalNumerator** | **Number** | | [optional]
37 | **priceNumerator** | **Number** | | [optional]
38 | **priceDenominator** | **Number** | | [optional]
39 | **mtfEnabled** | **Boolean** | | [optional]
40 | **mtfBracket** | **Number** | | [optional]
41 | **securityType** | **String** | | [optional]
42 |
--------------------------------------------------------------------------------
/src/model/MarginRequest.js:
--------------------------------------------------------------------------------
1 | /*
2 | * OpenAPI definition
3 | * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
4 | *
5 | * OpenAPI spec version: v0
6 | *
7 | * NOTE: This class is auto generated by the swagger code generator program.
8 | * https://github.com/swagger-api/swagger-codegen.git
9 | *
10 | * Swagger Codegen version: 3.0.54
11 | *
12 | * Do not edit the class manually.
13 | *
14 | */
15 | import {ApiClient} from '../ApiClient';
16 | import {Instrument} from './Instrument';
17 |
18 | /**
19 | * The MarginRequest model module.
20 | * @module model/MarginRequest
21 | * @version v0
22 | */
23 | export class MarginRequest {
24 | /**
25 | * Constructs a new MarginRequest.
26 | * @alias module:model/MarginRequest
27 | * @class
28 | * @param instruments {Array.} instruments
29 | */
30 | constructor(instruments) {
31 | this.instruments = instruments;
32 | }
33 |
34 | /**
35 | * Constructs a MarginRequest from a plain JavaScript object, optionally creating a new instance.
36 | * Copies all relevant properties from data to obj if supplied or a new instance if not.
37 | * @param {Object} data The plain JavaScript object bearing properties of interest.
38 | * @param {module:model/MarginRequest} obj Optional instance to populate.
39 | * @return {module:model/MarginRequest} The populated MarginRequest instance.
40 | */
41 | static constructFromObject(data, obj) {
42 | if (data) {
43 | obj = obj || new MarginRequest();
44 | if (data.hasOwnProperty('instruments'))
45 | obj.instruments = ApiClient.convertToType(data['instruments'], [Instrument]);
46 | }
47 | return obj;
48 | }
49 | }
50 |
51 | /**
52 | * instruments
53 | * @member {Array.} instruments
54 | */
55 | MarginRequest.prototype.instruments = undefined;
56 |
57 |
--------------------------------------------------------------------------------
/src/model/CancelOrExitMultiOrderData.js:
--------------------------------------------------------------------------------
1 | /*
2 | * OpenAPI definition
3 | * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
4 | *
5 | * OpenAPI spec version: v0
6 | *
7 | * NOTE: This class is auto generated by the swagger code generator program.
8 | * https://github.com/swagger-api/swagger-codegen.git
9 | *
10 | * Swagger Codegen version: 3.0.62
11 | *
12 | * Do not edit the class manually.
13 | *
14 | */
15 | import {ApiClient} from '../ApiClient';
16 |
17 | /**
18 | * The CancelOrExitMultiOrderData model module.
19 | * @module model/CancelOrExitMultiOrderData
20 | * @version v0
21 | */
22 | export class CancelOrExitMultiOrderData {
23 | /**
24 | * Constructs a new CancelOrExitMultiOrderData.
25 | * Response data for cancel or exit order request
26 | * @alias module:model/CancelOrExitMultiOrderData
27 | * @class
28 | */
29 | constructor() {
30 | }
31 |
32 | /**
33 | * Constructs a CancelOrExitMultiOrderData from a plain JavaScript object, optionally creating a new instance.
34 | * Copies all relevant properties from data to obj if supplied or a new instance if not.
35 | * @param {Object} data The plain JavaScript object bearing properties of interest.
36 | * @param {module:model/CancelOrExitMultiOrderData} obj Optional instance to populate.
37 | * @return {module:model/CancelOrExitMultiOrderData} The populated CancelOrExitMultiOrderData instance.
38 | */
39 | static constructFromObject(data, obj) {
40 | if (data) {
41 | obj = obj || new CancelOrExitMultiOrderData();
42 | if (data.hasOwnProperty('order_ids'))
43 | obj.orderIds = ApiClient.convertToType(data['order_ids'], ['String']);
44 | }
45 | return obj;
46 | }
47 | }
48 |
49 | /**
50 | * Reference order IDs
51 | * @member {Array.} orderIds
52 | */
53 | CancelOrExitMultiOrderData.prototype.orderIds = undefined;
54 |
55 |
--------------------------------------------------------------------------------
/src/model/TradeHistoryResponseMetaData.js:
--------------------------------------------------------------------------------
1 | /*
2 | * OpenAPI definition
3 | * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
4 | *
5 | * OpenAPI spec version: v0
6 | *
7 | * NOTE: This class is auto generated by the swagger code generator program.
8 | * https://github.com/swagger-api/swagger-codegen.git
9 | *
10 | * Swagger Codegen version: 3.0.54
11 | *
12 | * Do not edit the class manually.
13 | *
14 | */
15 | import {ApiClient} from '../ApiClient';
16 | import {TradeHistoryResponsePageData} from './TradeHistoryResponsePageData';
17 |
18 | /**
19 | * The TradeHistoryResponseMetaData model module.
20 | * @module model/TradeHistoryResponseMetaData
21 | * @version v0
22 | */
23 | export class TradeHistoryResponseMetaData {
24 | /**
25 | * Constructs a new TradeHistoryResponseMetaData.
26 | * @alias module:model/TradeHistoryResponseMetaData
27 | * @class
28 | */
29 | constructor() {
30 | }
31 |
32 | /**
33 | * Constructs a TradeHistoryResponseMetaData from a plain JavaScript object, optionally creating a new instance.
34 | * Copies all relevant properties from data to obj if supplied or a new instance if not.
35 | * @param {Object} data The plain JavaScript object bearing properties of interest.
36 | * @param {module:model/TradeHistoryResponseMetaData} obj Optional instance to populate.
37 | * @return {module:model/TradeHistoryResponseMetaData} The populated TradeHistoryResponseMetaData instance.
38 | */
39 | static constructFromObject(data, obj) {
40 | if (data) {
41 | obj = obj || new TradeHistoryResponseMetaData();
42 | if (data.hasOwnProperty('page'))
43 | obj.page = TradeHistoryResponsePageData.constructFromObject(data['page']);
44 | }
45 | return obj;
46 | }
47 | }
48 |
49 | /**
50 | * @member {module:model/TradeHistoryResponsePageData} page
51 | */
52 | TradeHistoryResponseMetaData.prototype.page = undefined;
53 |
54 |
--------------------------------------------------------------------------------
/src/model/GttCancelOrderRequest.js:
--------------------------------------------------------------------------------
1 | /*
2 | * OpenAPI definition
3 | * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
4 | *
5 | * OpenAPI spec version: v0
6 | *
7 | * NOTE: This class is auto generated by the swagger code generator program.
8 | * https://github.com/swagger-api/swagger-codegen.git
9 | *
10 | * Swagger Codegen version: 3.0.66
11 | *
12 | * Do not edit the class manually.
13 | *
14 | */
15 | import {ApiClient} from '../ApiClient';
16 |
17 | /**
18 | * The GttCancelOrderRequest model module.
19 | * @module model/GttCancelOrderRequest
20 | * @version v0
21 | */
22 | export class GttCancelOrderRequest {
23 | /**
24 | * Constructs a new GttCancelOrderRequest.
25 | * @alias module:model/GttCancelOrderRequest
26 | * @class
27 | * @param gttOrderId {String} Unique identifier of the GTT order to be cancelled
28 | */
29 | constructor(gttOrderId) {
30 | this.gttOrderId = gttOrderId;
31 | }
32 |
33 | /**
34 | * Constructs a GttCancelOrderRequest from a plain JavaScript object, optionally creating a new instance.
35 | * Copies all relevant properties from data to obj if supplied or a new instance if not.
36 | * @param {Object} data The plain JavaScript object bearing properties of interest.
37 | * @param {module:model/GttCancelOrderRequest} obj Optional instance to populate.
38 | * @return {module:model/GttCancelOrderRequest} The populated GttCancelOrderRequest instance.
39 | */
40 | static constructFromObject(data, obj) {
41 | if (data) {
42 | obj = obj || new GttCancelOrderRequest();
43 | if (data.hasOwnProperty('gtt_order_id'))
44 | obj.gttOrderId = ApiClient.convertToType(data['gtt_order_id'], 'String');
45 | }
46 | return obj;
47 | }
48 | }
49 |
50 | /**
51 | * Unique identifier of the GTT order to be cancelled
52 | * @member {String} gttOrderId
53 | */
54 | GttCancelOrderRequest.prototype.gttOrderId = undefined;
55 |
56 |
--------------------------------------------------------------------------------
/docs/MultiOrderRequest.md:
--------------------------------------------------------------------------------
1 | # UpstoxClient.MultiOrderRequest
2 |
3 | ## Properties
4 | Name | Type | Description | Notes
5 | ------------ | ------------- | ------------- | -------------
6 | **quantity** | **Number** | Quantity with which the order is to be placed |
7 | **product** | **String** | Signifies if the order was either Intraday, Delivery, CO or OCO |
8 | **validity** | **String** | It can be one of the following - DAY(default), IOC |
9 | **price** | **Number** | Price at which the order will be placed |
10 | **tag** | **String** | | [optional]
11 | **slice** | **Boolean** | To divide the order line based on predefined exchange definitions |
12 | **instrumentToken** | **String** | Key of the instrument |
13 | **orderType** | **String** | Type of order. It can be one of the following MARKET refers to market order LIMIT refers to Limit Order SL refers to Stop Loss Limit SL-M refers to Stop Loss Market |
14 | **transactionType** | **String** | Indicates whether its a buy or sell order |
15 | **disclosedQuantity** | **Number** | The quantity that should be disclosed in the market depth |
16 | **triggerPrice** | **Number** | If the order is a stop loss order then the trigger price to be set is mentioned here |
17 | **isAmo** | **Boolean** | Signifies if the order is an After Market Order |
18 | **correlationId** | **String** | A unique identifier for tracking individual orders within the batch |
19 |
20 |
21 | ## Enum: ProductEnum
22 |
23 | * `I` (value: `"I"`)
24 | * `D` (value: `"D"`)
25 | * `MTF` (value: `"MTF"`)
26 |
27 |
28 |
29 | ## Enum: ValidityEnum
30 |
31 | * `DAY` (value: `"DAY"`)
32 | * `IOC` (value: `"IOC"`)
33 |
34 |
35 |
36 | ## Enum: OrderTypeEnum
37 |
38 | * `MARKET` (value: `"MARKET"`)
39 | * `LIMIT` (value: `"LIMIT"`)
40 | * `SL` (value: `"SL"`)
41 | * `SL_M` (value: `"SL-M"`)
42 |
43 |
44 |
45 | ## Enum: TransactionTypeEnum
46 |
47 | * `BUY` (value: `"BUY"`)
48 | * `SELL` (value: `"SELL"`)
49 |
50 |
--------------------------------------------------------------------------------
/test/model/GetHolidayResponse.spec.js:
--------------------------------------------------------------------------------
1 | /*
2 | * OpenAPI definition
3 | * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
4 | *
5 | * OpenAPI spec version: v0
6 | *
7 | * NOTE: This class is auto generated by the swagger code generator program.
8 | * https://github.com/swagger-api/swagger-codegen.git
9 | *
10 | * Swagger Codegen version: 3.0.54
11 | *
12 | * Do not edit the class manually.
13 | *
14 | */
15 | (function(root, factory) {
16 | if (typeof define === 'function' && define.amd) {
17 | // AMD.
18 | define(['expect.js', '../../src/index'], factory);
19 | } else if (typeof module === 'object' && module.exports) {
20 | // CommonJS-like environments that support module.exports, like Node.
21 | factory(require('expect.js'), require('../../src/index'));
22 | } else {
23 | // Browser globals (root is window)
24 | factory(root.expect, root.UpstoxClient);
25 | }
26 | }(this, function(expect, UpstoxClient) {
27 | 'use strict';
28 |
29 | var instance;
30 |
31 | describe('(package)', function() {
32 | describe('GetHolidayResponse', function() {
33 | beforeEach(function() {
34 | instance = new UpstoxClient.GetHolidayResponse();
35 | });
36 |
37 | it('should create an instance of GetHolidayResponse', function() {
38 | // TODO: update the code to test GetHolidayResponse
39 | expect(instance).to.be.a(UpstoxClient.GetHolidayResponse);
40 | });
41 |
42 | it('should have the property status (base name: "status")', function() {
43 | // TODO: update the code to test the property status
44 | expect(instance).to.have.property('status');
45 | // expect(instance.status).to.be(expectedValueLiteral);
46 | });
47 |
48 | it('should have the property data (base name: "data")', function() {
49 | // TODO: update the code to test the property data
50 | expect(instance).to.have.property('data');
51 | // expect(instance.data).to.be(expectedValueLiteral);
52 | });
53 |
54 | });
55 | });
56 |
57 | }));
58 |
--------------------------------------------------------------------------------
/test/model/PostMarginResponse.spec.js:
--------------------------------------------------------------------------------
1 | /*
2 | * OpenAPI definition
3 | * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
4 | *
5 | * OpenAPI spec version: v0
6 | *
7 | * NOTE: This class is auto generated by the swagger code generator program.
8 | * https://github.com/swagger-api/swagger-codegen.git
9 | *
10 | * Swagger Codegen version: 3.0.54
11 | *
12 | * Do not edit the class manually.
13 | *
14 | */
15 | (function(root, factory) {
16 | if (typeof define === 'function' && define.amd) {
17 | // AMD.
18 | define(['expect.js', '../../src/index'], factory);
19 | } else if (typeof module === 'object' && module.exports) {
20 | // CommonJS-like environments that support module.exports, like Node.
21 | factory(require('expect.js'), require('../../src/index'));
22 | } else {
23 | // Browser globals (root is window)
24 | factory(root.expect, root.UpstoxClient);
25 | }
26 | }(this, function(expect, UpstoxClient) {
27 | 'use strict';
28 |
29 | var instance;
30 |
31 | describe('(package)', function() {
32 | describe('PostMarginResponse', function() {
33 | beforeEach(function() {
34 | instance = new UpstoxClient.PostMarginResponse();
35 | });
36 |
37 | it('should create an instance of PostMarginResponse', function() {
38 | // TODO: update the code to test PostMarginResponse
39 | expect(instance).to.be.a(UpstoxClient.PostMarginResponse);
40 | });
41 |
42 | it('should have the property status (base name: "status")', function() {
43 | // TODO: update the code to test the property status
44 | expect(instance).to.have.property('status');
45 | // expect(instance.status).to.be(expectedValueLiteral);
46 | });
47 |
48 | it('should have the property data (base name: "data")', function() {
49 | // TODO: update the code to test the property data
50 | expect(instance).to.have.property('data');
51 | // expect(instance.data).to.be(expectedValueLiteral);
52 | });
53 |
54 | });
55 | });
56 |
57 | }));
58 |
--------------------------------------------------------------------------------
/test/model/GetOptionChainResponse.spec.js:
--------------------------------------------------------------------------------
1 | /*
2 | * OpenAPI definition
3 | * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
4 | *
5 | * OpenAPI spec version: v0
6 | *
7 | * NOTE: This class is auto generated by the swagger code generator program.
8 | * https://github.com/swagger-api/swagger-codegen.git
9 | *
10 | * Swagger Codegen version: 3.0.54
11 | *
12 | * Do not edit the class manually.
13 | *
14 | */
15 | (function(root, factory) {
16 | if (typeof define === 'function' && define.amd) {
17 | // AMD.
18 | define(['expect.js', '../../src/index'], factory);
19 | } else if (typeof module === 'object' && module.exports) {
20 | // CommonJS-like environments that support module.exports, like Node.
21 | factory(require('expect.js'), require('../../src/index'));
22 | } else {
23 | // Browser globals (root is window)
24 | factory(root.expect, root.UpstoxClient);
25 | }
26 | }(this, function(expect, UpstoxClient) {
27 | 'use strict';
28 |
29 | var instance;
30 |
31 | describe('(package)', function() {
32 | describe('GetOptionChainResponse', function() {
33 | beforeEach(function() {
34 | instance = new UpstoxClient.GetOptionChainResponse();
35 | });
36 |
37 | it('should create an instance of GetOptionChainResponse', function() {
38 | // TODO: update the code to test GetOptionChainResponse
39 | expect(instance).to.be.a(UpstoxClient.GetOptionChainResponse);
40 | });
41 |
42 | it('should have the property status (base name: "status")', function() {
43 | // TODO: update the code to test the property status
44 | expect(instance).to.have.property('status');
45 | // expect(instance.status).to.be(expectedValueLiteral);
46 | });
47 |
48 | it('should have the property data (base name: "data")', function() {
49 | // TODO: update the code to test the property data
50 | expect(instance).to.have.property('data');
51 | // expect(instance.data).to.be(expectedValueLiteral);
52 | });
53 |
54 | });
55 | });
56 |
57 | }));
58 |
--------------------------------------------------------------------------------
/test/model/GetMarketStatusResponse.spec.js:
--------------------------------------------------------------------------------
1 | /*
2 | * OpenAPI definition
3 | * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
4 | *
5 | * OpenAPI spec version: v0
6 | *
7 | * NOTE: This class is auto generated by the swagger code generator program.
8 | * https://github.com/swagger-api/swagger-codegen.git
9 | *
10 | * Swagger Codegen version: 3.0.54
11 | *
12 | * Do not edit the class manually.
13 | *
14 | */
15 | (function(root, factory) {
16 | if (typeof define === 'function' && define.amd) {
17 | // AMD.
18 | define(['expect.js', '../../src/index'], factory);
19 | } else if (typeof module === 'object' && module.exports) {
20 | // CommonJS-like environments that support module.exports, like Node.
21 | factory(require('expect.js'), require('../../src/index'));
22 | } else {
23 | // Browser globals (root is window)
24 | factory(root.expect, root.UpstoxClient);
25 | }
26 | }(this, function(expect, UpstoxClient) {
27 | 'use strict';
28 |
29 | var instance;
30 |
31 | describe('(package)', function() {
32 | describe('GetMarketStatusResponse', function() {
33 | beforeEach(function() {
34 | instance = new UpstoxClient.GetMarketStatusResponse();
35 | });
36 |
37 | it('should create an instance of GetMarketStatusResponse', function() {
38 | // TODO: update the code to test GetMarketStatusResponse
39 | expect(instance).to.be.a(UpstoxClient.GetMarketStatusResponse);
40 | });
41 |
42 | it('should have the property status (base name: "status")', function() {
43 | // TODO: update the code to test the property status
44 | expect(instance).to.have.property('status');
45 | // expect(instance.status).to.be(expectedValueLiteral);
46 | });
47 |
48 | it('should have the property data (base name: "data")', function() {
49 | // TODO: update the code to test the property data
50 | expect(instance).to.have.property('data');
51 | // expect(instance.data).to.be(expectedValueLiteral);
52 | });
53 |
54 | });
55 | });
56 |
57 | }));
58 |
--------------------------------------------------------------------------------
/test/model/GetOrderDetailsResponse.spec.js:
--------------------------------------------------------------------------------
1 | /*
2 | * OpenAPI definition
3 | * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
4 | *
5 | * OpenAPI spec version: v0
6 | *
7 | * NOTE: This class is auto generated by the swagger code generator program.
8 | * https://github.com/swagger-api/swagger-codegen.git
9 | *
10 | * Swagger Codegen version: 3.0.62
11 | *
12 | * Do not edit the class manually.
13 | *
14 | */
15 | (function(root, factory) {
16 | if (typeof define === 'function' && define.amd) {
17 | // AMD.
18 | define(['expect.js', '../../src/index'], factory);
19 | } else if (typeof module === 'object' && module.exports) {
20 | // CommonJS-like environments that support module.exports, like Node.
21 | factory(require('expect.js'), require('../../src/index'));
22 | } else {
23 | // Browser globals (root is window)
24 | factory(root.expect, root.UpstoxClient);
25 | }
26 | }(this, function(expect, UpstoxClient) {
27 | 'use strict';
28 |
29 | var instance;
30 |
31 | describe('(package)', function() {
32 | describe('GetOrderDetailsResponse', function() {
33 | beforeEach(function() {
34 | instance = new UpstoxClient.GetOrderDetailsResponse();
35 | });
36 |
37 | it('should create an instance of GetOrderDetailsResponse', function() {
38 | // TODO: update the code to test GetOrderDetailsResponse
39 | expect(instance).to.be.a(UpstoxClient.GetOrderDetailsResponse);
40 | });
41 |
42 | it('should have the property status (base name: "status")', function() {
43 | // TODO: update the code to test the property status
44 | expect(instance).to.have.property('status');
45 | // expect(instance.status).to.be(expectedValueLiteral);
46 | });
47 |
48 | it('should have the property data (base name: "data")', function() {
49 | // TODO: update the code to test the property data
50 | expect(instance).to.have.property('data');
51 | // expect(instance.data).to.be(expectedValueLiteral);
52 | });
53 |
54 | });
55 | });
56 |
57 | }));
58 |
--------------------------------------------------------------------------------
/test/model/MultiOrderData.spec.js:
--------------------------------------------------------------------------------
1 | /*
2 | * OpenAPI definition
3 | * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
4 | *
5 | * OpenAPI spec version: v0
6 | *
7 | * NOTE: This class is auto generated by the swagger code generator program.
8 | * https://github.com/swagger-api/swagger-codegen.git
9 | *
10 | * Swagger Codegen version: 3.0.62
11 | *
12 | * Do not edit the class manually.
13 | *
14 | */
15 | (function(root, factory) {
16 | if (typeof define === 'function' && define.amd) {
17 | // AMD.
18 | define(['expect.js', '../../src/index'], factory);
19 | } else if (typeof module === 'object' && module.exports) {
20 | // CommonJS-like environments that support module.exports, like Node.
21 | factory(require('expect.js'), require('../../src/index'));
22 | } else {
23 | // Browser globals (root is window)
24 | factory(root.expect, root.UpstoxClient);
25 | }
26 | }(this, function(expect, UpstoxClient) {
27 | 'use strict';
28 |
29 | var instance;
30 |
31 | describe('(package)', function() {
32 | describe('MultiOrderData', function() {
33 | beforeEach(function() {
34 | instance = new UpstoxClient.MultiOrderData();
35 | });
36 |
37 | it('should create an instance of MultiOrderData', function() {
38 | // TODO: update the code to test MultiOrderData
39 | expect(instance).to.be.a(UpstoxClient.MultiOrderData);
40 | });
41 |
42 | it('should have the property correlationId (base name: "correlation_id")', function() {
43 | // TODO: update the code to test the property correlationId
44 | expect(instance).to.have.property('correlationId');
45 | // expect(instance.correlationId).to.be(expectedValueLiteral);
46 | });
47 |
48 | it('should have the property orderId (base name: "order_id")', function() {
49 | // TODO: update the code to test the property orderId
50 | expect(instance).to.have.property('orderId');
51 | // expect(instance.orderId).to.be(expectedValueLiteral);
52 | });
53 |
54 | });
55 | });
56 |
57 | }));
58 |
--------------------------------------------------------------------------------
/test/model/GetExchangeTimingResponse.spec.js:
--------------------------------------------------------------------------------
1 | /*
2 | * OpenAPI definition
3 | * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
4 | *
5 | * OpenAPI spec version: v0
6 | *
7 | * NOTE: This class is auto generated by the swagger code generator program.
8 | * https://github.com/swagger-api/swagger-codegen.git
9 | *
10 | * Swagger Codegen version: 3.0.54
11 | *
12 | * Do not edit the class manually.
13 | *
14 | */
15 | (function(root, factory) {
16 | if (typeof define === 'function' && define.amd) {
17 | // AMD.
18 | define(['expect.js', '../../src/index'], factory);
19 | } else if (typeof module === 'object' && module.exports) {
20 | // CommonJS-like environments that support module.exports, like Node.
21 | factory(require('expect.js'), require('../../src/index'));
22 | } else {
23 | // Browser globals (root is window)
24 | factory(root.expect, root.UpstoxClient);
25 | }
26 | }(this, function(expect, UpstoxClient) {
27 | 'use strict';
28 |
29 | var instance;
30 |
31 | describe('(package)', function() {
32 | describe('GetExchangeTimingResponse', function() {
33 | beforeEach(function() {
34 | instance = new UpstoxClient.GetExchangeTimingResponse();
35 | });
36 |
37 | it('should create an instance of GetExchangeTimingResponse', function() {
38 | // TODO: update the code to test GetExchangeTimingResponse
39 | expect(instance).to.be.a(UpstoxClient.GetExchangeTimingResponse);
40 | });
41 |
42 | it('should have the property status (base name: "status")', function() {
43 | // TODO: update the code to test the property status
44 | expect(instance).to.have.property('status');
45 | // expect(instance.status).to.be(expectedValueLiteral);
46 | });
47 |
48 | it('should have the property data (base name: "data")', function() {
49 | // TODO: update the code to test the property data
50 | expect(instance).to.have.property('data');
51 | // expect(instance.data).to.be(expectedValueLiteral);
52 | });
53 |
54 | });
55 | });
56 |
57 | }));
58 |
--------------------------------------------------------------------------------
/test/model/GetOptionContractResponse.spec.js:
--------------------------------------------------------------------------------
1 | /*
2 | * OpenAPI definition
3 | * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
4 | *
5 | * OpenAPI spec version: v0
6 | *
7 | * NOTE: This class is auto generated by the swagger code generator program.
8 | * https://github.com/swagger-api/swagger-codegen.git
9 | *
10 | * Swagger Codegen version: 3.0.54
11 | *
12 | * Do not edit the class manually.
13 | *
14 | */
15 | (function(root, factory) {
16 | if (typeof define === 'function' && define.amd) {
17 | // AMD.
18 | define(['expect.js', '../../src/index'], factory);
19 | } else if (typeof module === 'object' && module.exports) {
20 | // CommonJS-like environments that support module.exports, like Node.
21 | factory(require('expect.js'), require('../../src/index'));
22 | } else {
23 | // Browser globals (root is window)
24 | factory(root.expect, root.UpstoxClient);
25 | }
26 | }(this, function(expect, UpstoxClient) {
27 | 'use strict';
28 |
29 | var instance;
30 |
31 | describe('(package)', function() {
32 | describe('GetOptionContractResponse', function() {
33 | beforeEach(function() {
34 | instance = new UpstoxClient.GetOptionContractResponse();
35 | });
36 |
37 | it('should create an instance of GetOptionContractResponse', function() {
38 | // TODO: update the code to test GetOptionContractResponse
39 | expect(instance).to.be.a(UpstoxClient.GetOptionContractResponse);
40 | });
41 |
42 | it('should have the property status (base name: "status")', function() {
43 | // TODO: update the code to test the property status
44 | expect(instance).to.have.property('status');
45 | // expect(instance.status).to.be(expectedValueLiteral);
46 | });
47 |
48 | it('should have the property data (base name: "data")', function() {
49 | // TODO: update the code to test the property data
50 | expect(instance).to.have.property('data');
51 | // expect(instance.data).to.be(expectedValueLiteral);
52 | });
53 |
54 | });
55 | });
56 |
57 | }));
58 |
--------------------------------------------------------------------------------
/test/api/PostTradeApi.spec.js:
--------------------------------------------------------------------------------
1 | /*
2 | * OpenAPI definition
3 | * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
4 | *
5 | * OpenAPI spec version: v0
6 | *
7 | * NOTE: This class is auto generated by the swagger code generator program.
8 | * https://github.com/swagger-api/swagger-codegen.git
9 | *
10 | * Swagger Codegen version: 3.0.54
11 | *
12 | * Do not edit the class manually.
13 | *
14 | */
15 | (function(root, factory) {
16 | if (typeof define === 'function' && define.amd) {
17 | // AMD.
18 | define(['expect.js', '../../src/index'], factory);
19 | } else if (typeof module === 'object' && module.exports) {
20 | // CommonJS-like environments that support module.exports, like Node.
21 | factory(require('expect.js'), require('../../src/index'));
22 | } else {
23 | // Browser globals (root is window)
24 | factory(root.expect, root.UpstoxClient);
25 | }
26 | }(this, function(expect, UpstoxClient) {
27 | 'use strict';
28 |
29 | var instance;
30 |
31 | beforeEach(function() {
32 | instance = new UpstoxClient.PostTradeApi();
33 | });
34 |
35 | describe('(package)', function() {
36 | describe('PostTradeApi', function() {
37 | describe('getTradesByDateRange', function() {
38 | it('should call getTradesByDateRange successfully', function(done) {
39 | // TODO: uncomment, update parameter values for getTradesByDateRange call and complete the assertions
40 | /*
41 | var opts = {};
42 |
43 | instance.getTradesByDateRange(startDate, endDate, pageNumber, pageSize, opts, function(error, data, response) {
44 | if (error) {
45 | done(error);
46 | return;
47 | }
48 | // TODO: update response assertions
49 | expect(data).to.be.a(UpstoxClient.TradeHistoryResponse);
50 |
51 | done();
52 | });
53 | */
54 | // TODO: uncomment and complete method invocation above, then delete this line and the next:
55 | done();
56 | });
57 | });
58 | });
59 | });
60 |
61 | }));
62 |
--------------------------------------------------------------------------------
/test/model/IndieUserInitTokenResponse.spec.js:
--------------------------------------------------------------------------------
1 | /*
2 | * OpenAPI definition
3 | * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
4 | *
5 | * OpenAPI spec version: v0
6 | *
7 | * NOTE: This class is auto generated by the swagger code generator program.
8 | * https://github.com/swagger-api/swagger-codegen.git
9 | *
10 | * Swagger Codegen version: 3.0.66
11 | *
12 | * Do not edit the class manually.
13 | *
14 | */
15 | (function(root, factory) {
16 | if (typeof define === 'function' && define.amd) {
17 | // AMD.
18 | define(['expect.js', '../../src/index'], factory);
19 | } else if (typeof module === 'object' && module.exports) {
20 | // CommonJS-like environments that support module.exports, like Node.
21 | factory(require('expect.js'), require('../../src/index'));
22 | } else {
23 | // Browser globals (root is window)
24 | factory(root.expect, root.UpstoxClient);
25 | }
26 | }(this, function(expect, UpstoxClient) {
27 | 'use strict';
28 |
29 | var instance;
30 |
31 | describe('(package)', function() {
32 | describe('IndieUserInitTokenResponse', function() {
33 | beforeEach(function() {
34 | instance = new UpstoxClient.IndieUserInitTokenResponse();
35 | });
36 |
37 | it('should create an instance of IndieUserInitTokenResponse', function() {
38 | // TODO: update the code to test IndieUserInitTokenResponse
39 | expect(instance).to.be.a(UpstoxClient.IndieUserInitTokenResponse);
40 | });
41 |
42 | it('should have the property status (base name: "status")', function() {
43 | // TODO: update the code to test the property status
44 | expect(instance).to.have.property('status');
45 | // expect(instance.status).to.be(expectedValueLiteral);
46 | });
47 |
48 | it('should have the property data (base name: "data")', function() {
49 | // TODO: update the code to test the property data
50 | expect(instance).to.have.property('data');
51 | // expect(instance.data).to.be(expectedValueLiteral);
52 | });
53 |
54 | });
55 | });
56 |
57 | }));
58 |
--------------------------------------------------------------------------------
/src/model/MultiOrderData.js:
--------------------------------------------------------------------------------
1 | /*
2 | * OpenAPI definition
3 | * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
4 | *
5 | * OpenAPI spec version: v0
6 | *
7 | * NOTE: This class is auto generated by the swagger code generator program.
8 | * https://github.com/swagger-api/swagger-codegen.git
9 | *
10 | * Swagger Codegen version: 3.0.62
11 | *
12 | * Do not edit the class manually.
13 | *
14 | */
15 | import {ApiClient} from '../ApiClient';
16 |
17 | /**
18 | * The MultiOrderData model module.
19 | * @module model/MultiOrderData
20 | * @version v0
21 | */
22 | export class MultiOrderData {
23 | /**
24 | * Constructs a new MultiOrderData.
25 | * Response data for multi order request
26 | * @alias module:model/MultiOrderData
27 | * @class
28 | */
29 | constructor() {
30 | }
31 |
32 | /**
33 | * Constructs a MultiOrderData from a plain JavaScript object, optionally creating a new instance.
34 | * Copies all relevant properties from data to obj if supplied or a new instance if not.
35 | * @param {Object} data The plain JavaScript object bearing properties of interest.
36 | * @param {module:model/MultiOrderData} obj Optional instance to populate.
37 | * @return {module:model/MultiOrderData} The populated MultiOrderData instance.
38 | */
39 | static constructFromObject(data, obj) {
40 | if (data) {
41 | obj = obj || new MultiOrderData();
42 | if (data.hasOwnProperty('correlation_id'))
43 | obj.correlationId = ApiClient.convertToType(data['correlation_id'], 'String');
44 | if (data.hasOwnProperty('order_id'))
45 | obj.orderId = ApiClient.convertToType(data['order_id'], 'String');
46 | }
47 | return obj;
48 | }
49 | }
50 |
51 | /**
52 | * A unique identifier for tracking individual orders within the batch
53 | * @member {String} correlationId
54 | */
55 | MultiOrderData.prototype.correlationId = undefined;
56 |
57 | /**
58 | * An order ID for the order request placed
59 | * @member {String} orderId
60 | */
61 | MultiOrderData.prototype.orderId = undefined;
62 |
63 |
--------------------------------------------------------------------------------
/docs/HoldingsData.md:
--------------------------------------------------------------------------------
1 | # UpstoxClient.HoldingsData
2 |
3 | ## Properties
4 | Name | Type | Description | Notes
5 | ------------ | ------------- | ------------- | -------------
6 | **isin** | **String** | The standard ISIN representing stocks listed on multiple exchanges | [optional]
7 | **cncUsedQuantity** | **Number** | Quantity either blocked towards open or completed order | [optional]
8 | **collateralType** | **String** | Category of collateral assigned by RMS | [optional]
9 | **companyName** | **String** | Name of the company | [optional]
10 | **haircut** | **Number** | This is the haircut percentage applied from RMS (applicable incase of collateral) | [optional]
11 | **product** | **String** | Shows if the order was either Intraday, Delivery, CO or OCO | [optional]
12 | **quantity** | **Number** | The total holding qty | [optional]
13 | **tradingsymbol** | **String** | Shows the trading symbol of the instrument | [optional]
14 | **lastPrice** | **Number** | The last traded price of the instrument | [optional]
15 | **closePrice** | **Number** | Closing price of the instrument from the last trading day | [optional]
16 | **pnl** | **Number** | Profit and Loss | [optional]
17 | **dayChange** | **Number** | Day's change in absolute value for the stock | [optional]
18 | **dayChangePercentage** | **Number** | Day's change in percentage for the stock | [optional]
19 | **instrumentToken** | **String** | Key issued by Upstox for the instrument | [optional]
20 | **averagePrice** | **Number** | Average price at which the net holding quantity was acquired | [optional]
21 | **collateralQuantity** | **Number** | Quantity marked as collateral by RMS on users request | [optional]
22 | **collateralUpdateQuantity** | **Number** | | [optional]
23 | **t1Quantity** | **Number** | Quantity on T+1 day after order execution | [optional]
24 | **exchange** | **String** | Exchange of the trading symbol | [optional]
25 |
26 |
27 | ## Enum: ExchangeEnum
28 |
29 | * `NSE` (value: `"NSE"`)
30 | * `NFO` (value: `"NFO"`)
31 | * `CDS` (value: `"CDS"`)
32 | * `BSE` (value: `"BSE"`)
33 | * `BCD` (value: `"BCD"`)
34 | * `BFO` (value: `"BFO"`)
35 | * `MCX` (value: `"MCX"`)
36 |
37 |
--------------------------------------------------------------------------------
/test/model/IndieUserInitTokenData.spec.js:
--------------------------------------------------------------------------------
1 | /*
2 | * OpenAPI definition
3 | * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
4 | *
5 | * OpenAPI spec version: v0
6 | *
7 | * NOTE: This class is auto generated by the swagger code generator program.
8 | * https://github.com/swagger-api/swagger-codegen.git
9 | *
10 | * Swagger Codegen version: 3.0.66
11 | *
12 | * Do not edit the class manually.
13 | *
14 | */
15 | (function(root, factory) {
16 | if (typeof define === 'function' && define.amd) {
17 | // AMD.
18 | define(['expect.js', '../../src/index'], factory);
19 | } else if (typeof module === 'object' && module.exports) {
20 | // CommonJS-like environments that support module.exports, like Node.
21 | factory(require('expect.js'), require('../../src/index'));
22 | } else {
23 | // Browser globals (root is window)
24 | factory(root.expect, root.UpstoxClient);
25 | }
26 | }(this, function(expect, UpstoxClient) {
27 | 'use strict';
28 |
29 | var instance;
30 |
31 | describe('(package)', function() {
32 | describe('IndieUserInitTokenData', function() {
33 | beforeEach(function() {
34 | instance = new UpstoxClient.IndieUserInitTokenData();
35 | });
36 |
37 | it('should create an instance of IndieUserInitTokenData', function() {
38 | // TODO: update the code to test IndieUserInitTokenData
39 | expect(instance).to.be.a(UpstoxClient.IndieUserInitTokenData);
40 | });
41 |
42 | it('should have the property authorizationExpiry (base name: "authorization_expiry")', function() {
43 | // TODO: update the code to test the property authorizationExpiry
44 | expect(instance).to.have.property('authorizationExpiry');
45 | // expect(instance.authorizationExpiry).to.be(expectedValueLiteral);
46 | });
47 |
48 | it('should have the property notifierUrl (base name: "notifier_url")', function() {
49 | // TODO: update the code to test the property notifierUrl
50 | expect(instance).to.have.property('notifierUrl');
51 | // expect(instance.notifierUrl).to.be(expectedValueLiteral);
52 | });
53 |
54 | });
55 | });
56 |
57 | }));
58 |
--------------------------------------------------------------------------------
/src/model/IndieUserInitTokenData.js:
--------------------------------------------------------------------------------
1 | /*
2 | * OpenAPI definition
3 | * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
4 | *
5 | * OpenAPI spec version: v0
6 | *
7 | * NOTE: This class is auto generated by the swagger code generator program.
8 | * https://github.com/swagger-api/swagger-codegen.git
9 | *
10 | * Swagger Codegen version: 3.0.66
11 | *
12 | * Do not edit the class manually.
13 | *
14 | */
15 | import {ApiClient} from '../ApiClient';
16 |
17 | /**
18 | * The IndieUserInitTokenData model module.
19 | * @module model/IndieUserInitTokenData
20 | * @version v0
21 | */
22 | export class IndieUserInitTokenData {
23 | /**
24 | * Constructs a new IndieUserInitTokenData.
25 | * Init token response data for indie user
26 | * @alias module:model/IndieUserInitTokenData
27 | * @class
28 | */
29 | constructor() {
30 | }
31 |
32 | /**
33 | * Constructs a IndieUserInitTokenData from a plain JavaScript object, optionally creating a new instance.
34 | * Copies all relevant properties from data to obj if supplied or a new instance if not.
35 | * @param {Object} data The plain JavaScript object bearing properties of interest.
36 | * @param {module:model/IndieUserInitTokenData} obj Optional instance to populate.
37 | * @return {module:model/IndieUserInitTokenData} The populated IndieUserInitTokenData instance.
38 | */
39 | static constructFromObject(data, obj) {
40 | if (data) {
41 | obj = obj || new IndieUserInitTokenData();
42 | if (data.hasOwnProperty('authorization_expiry'))
43 | obj.authorizationExpiry = ApiClient.convertToType(data['authorization_expiry'], 'String');
44 | if (data.hasOwnProperty('notifier_url'))
45 | obj.notifierUrl = ApiClient.convertToType(data['notifier_url'], 'String');
46 | }
47 | return obj;
48 | }
49 | }
50 |
51 | /**
52 | * authorize token expiry
53 | * @member {String} authorizationExpiry
54 | */
55 | IndieUserInitTokenData.prototype.authorizationExpiry = undefined;
56 |
57 | /**
58 | * notifier webhook url
59 | * @member {String} notifierUrl
60 | */
61 | IndieUserInitTokenData.prototype.notifierUrl = undefined;
62 |
63 |
--------------------------------------------------------------------------------
/src/model/ExchangeTimingData.js:
--------------------------------------------------------------------------------
1 | /*
2 | * OpenAPI definition
3 | * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
4 | *
5 | * OpenAPI spec version: v0
6 | *
7 | * NOTE: This class is auto generated by the swagger code generator program.
8 | * https://github.com/swagger-api/swagger-codegen.git
9 | *
10 | * Swagger Codegen version: 3.0.54
11 | *
12 | * Do not edit the class manually.
13 | *
14 | */
15 | import {ApiClient} from '../ApiClient';
16 |
17 | /**
18 | * The ExchangeTimingData model module.
19 | * @module model/ExchangeTimingData
20 | * @version v0
21 | */
22 | export class ExchangeTimingData {
23 | /**
24 | * Constructs a new ExchangeTimingData.
25 | * @alias module:model/ExchangeTimingData
26 | * @class
27 | */
28 | constructor() {
29 | }
30 |
31 | /**
32 | * Constructs a ExchangeTimingData from a plain JavaScript object, optionally creating a new instance.
33 | * Copies all relevant properties from data to obj if supplied or a new instance if not.
34 | * @param {Object} data The plain JavaScript object bearing properties of interest.
35 | * @param {module:model/ExchangeTimingData} obj Optional instance to populate.
36 | * @return {module:model/ExchangeTimingData} The populated ExchangeTimingData instance.
37 | */
38 | static constructFromObject(data, obj) {
39 | if (data) {
40 | obj = obj || new ExchangeTimingData();
41 | if (data.hasOwnProperty('exchange'))
42 | obj.exchange = ApiClient.convertToType(data['exchange'], 'String');
43 | if (data.hasOwnProperty('start_time'))
44 | obj.startTime = ApiClient.convertToType(data['start_time'], 'Number');
45 | if (data.hasOwnProperty('end_time'))
46 | obj.endTime = ApiClient.convertToType(data['end_time'], 'Number');
47 | }
48 | return obj;
49 | }
50 | }
51 |
52 | /**
53 | * @member {String} exchange
54 | */
55 | ExchangeTimingData.prototype.exchange = undefined;
56 |
57 | /**
58 | * @member {Number} startTime
59 | */
60 | ExchangeTimingData.prototype.startTime = undefined;
61 |
62 | /**
63 | * @member {Number} endTime
64 | */
65 | ExchangeTimingData.prototype.endTime = undefined;
66 |
67 |
--------------------------------------------------------------------------------
/src/model/MarketStatusData.js:
--------------------------------------------------------------------------------
1 | /*
2 | * OpenAPI definition
3 | * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
4 | *
5 | * OpenAPI spec version: v0
6 | *
7 | * NOTE: This class is auto generated by the swagger code generator program.
8 | * https://github.com/swagger-api/swagger-codegen.git
9 | *
10 | * Swagger Codegen version: 3.0.54
11 | *
12 | * Do not edit the class manually.
13 | *
14 | */
15 | import {ApiClient} from '../ApiClient';
16 |
17 | /**
18 | * The MarketStatusData model module.
19 | * @module model/MarketStatusData
20 | * @version v0
21 | */
22 | export class MarketStatusData {
23 | /**
24 | * Constructs a new MarketStatusData.
25 | * Response data for market live status
26 | * @alias module:model/MarketStatusData
27 | * @class
28 | */
29 | constructor() {
30 | }
31 |
32 | /**
33 | * Constructs a MarketStatusData from a plain JavaScript object, optionally creating a new instance.
34 | * Copies all relevant properties from data to obj if supplied or a new instance if not.
35 | * @param {Object} data The plain JavaScript object bearing properties of interest.
36 | * @param {module:model/MarketStatusData} obj Optional instance to populate.
37 | * @return {module:model/MarketStatusData} The populated MarketStatusData instance.
38 | */
39 | static constructFromObject(data, obj) {
40 | if (data) {
41 | obj = obj || new MarketStatusData();
42 | if (data.hasOwnProperty('exchange'))
43 | obj.exchange = ApiClient.convertToType(data['exchange'], 'String');
44 | if (data.hasOwnProperty('status'))
45 | obj.status = ApiClient.convertToType(data['status'], 'String');
46 | if (data.hasOwnProperty('last_updated'))
47 | obj.lastUpdated = ApiClient.convertToType(data['last_updated'], 'Number');
48 | }
49 | return obj;
50 | }
51 | }
52 |
53 | /**
54 | * @member {String} exchange
55 | */
56 | MarketStatusData.prototype.exchange = undefined;
57 |
58 | /**
59 | * @member {String} status
60 | */
61 | MarketStatusData.prototype.status = undefined;
62 |
63 | /**
64 | * @member {Number} lastUpdated
65 | */
66 | MarketStatusData.prototype.lastUpdated = undefined;
67 |
68 |
--------------------------------------------------------------------------------
/examples/websocket/react_websocket/README.md:
--------------------------------------------------------------------------------
1 | # React WebSocket Client
2 |
3 | This sample project demonstrates how to connect to the Upstox WebSocket API using ReactJS to stream live market data and order updates. It includes implementations for both market data streaming and order updates. Users need to set up their Upstox API access token and can then start receiving live feeds of market data and order updates.
4 |
5 | ## Getting Started
6 |
7 | Follow these instructions to run the React WebSocket client on your local machine.
8 |
9 | ### Prerequisites
10 |
11 | Before you start, ensure you have Node.js and npm installed on your system. If you haven't installed Node.js and npm yet, you can download them from the official website:
12 |
13 | [Download Node.js](https://nodejs.org/)
14 |
15 | ### Installation
16 |
17 | This project requires several dependencies which can be installed using npm. These dependencies are listed in the `package.json` file. Run the following command in your terminal to install all required packages:
18 |
19 | ```bash
20 | npm install
21 | ```
22 |
23 | ### Configuration
24 |
25 | The application requires an Upstox API access token for authorization. You need to specify your Upstox API access token in the App.js file. Locate the following line in App.js and replace 'ACCESS_TOKEN' with your actual access token:
26 |
27 | ```bash
28 | const auth_token = "ACCESS_TOKEN";
29 | ```
30 |
31 | ### Running the Application
32 |
33 | After installing the prerequisites and configuring your access token, you can start the application. Navigate to the directory containing your project and run the following command:
34 |
35 | ```bash
36 | npm start
37 | ```
38 |
39 | ### Understanding the Code
40 |
41 | The project consists of a React application that establishes connections to the Upstox WebSocket API for market data and order updates. After successful authentication, the application connects to the WebSocket server and starts receiving data. The received data is then decoded, and the live feed is displayed on the screen.
42 |
43 | ### Support
44 |
45 | If you encounter any problems or have any questions about this project, feel free to open an issue in this repository.
46 |
47 | ### Disclaimer
48 |
49 | This is a sample application meant for educational purposes. It may require modifications to work with your specific requirements.
--------------------------------------------------------------------------------
/test/model/GttRule.spec.js:
--------------------------------------------------------------------------------
1 | /*
2 | * OpenAPI definition
3 | * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
4 | *
5 | * OpenAPI spec version: v0
6 | *
7 | * NOTE: This class is auto generated by the swagger code generator program.
8 | * https://github.com/swagger-api/swagger-codegen.git
9 | *
10 | * Swagger Codegen version: 3.0.66
11 | *
12 | * Do not edit the class manually.
13 | *
14 | */
15 | (function(root, factory) {
16 | if (typeof define === 'function' && define.amd) {
17 | // AMD.
18 | define(['expect.js', '../../src/index'], factory);
19 | } else if (typeof module === 'object' && module.exports) {
20 | // CommonJS-like environments that support module.exports, like Node.
21 | factory(require('expect.js'), require('../../src/index'));
22 | } else {
23 | // Browser globals (root is window)
24 | factory(root.expect, root.UpstoxClient);
25 | }
26 | }(this, function(expect, UpstoxClient) {
27 | 'use strict';
28 |
29 | var instance;
30 |
31 | describe('(package)', function() {
32 | describe('GttRule', function() {
33 | beforeEach(function() {
34 | instance = new UpstoxClient.GttRule();
35 | });
36 |
37 | it('should create an instance of GttRule', function() {
38 | // TODO: update the code to test GttRule
39 | expect(instance).to.be.a(UpstoxClient.GttRule);
40 | });
41 |
42 | it('should have the property strategy (base name: "strategy")', function() {
43 | // TODO: update the code to test the property strategy
44 | expect(instance).to.have.property('strategy');
45 | // expect(instance.strategy).to.be(expectedValueLiteral);
46 | });
47 |
48 | it('should have the property triggerType (base name: "trigger_type")', function() {
49 | // TODO: update the code to test the property triggerType
50 | expect(instance).to.have.property('triggerType');
51 | // expect(instance.triggerType).to.be(expectedValueLiteral);
52 | });
53 |
54 | it('should have the property triggerPrice (base name: "trigger_price")', function() {
55 | // TODO: update the code to test the property triggerPrice
56 | expect(instance).to.have.property('triggerPrice');
57 | // expect(instance.triggerPrice).to.be(expectedValueLiteral);
58 | });
59 |
60 | });
61 | });
62 |
63 | }));
64 |
--------------------------------------------------------------------------------
/test/model/GetGttOrderResponse.spec.js:
--------------------------------------------------------------------------------
1 | /*
2 | * OpenAPI definition
3 | * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
4 | *
5 | * OpenAPI spec version: v0
6 | *
7 | * NOTE: This class is auto generated by the swagger code generator program.
8 | * https://github.com/swagger-api/swagger-codegen.git
9 | *
10 | * Swagger Codegen version: 3.0.66
11 | *
12 | * Do not edit the class manually.
13 | *
14 | */
15 | (function(root, factory) {
16 | if (typeof define === 'function' && define.amd) {
17 | // AMD.
18 | define(['expect.js', '../../src/index'], factory);
19 | } else if (typeof module === 'object' && module.exports) {
20 | // CommonJS-like environments that support module.exports, like Node.
21 | factory(require('expect.js'), require('../../src/index'));
22 | } else {
23 | // Browser globals (root is window)
24 | factory(root.expect, root.UpstoxClient);
25 | }
26 | }(this, function(expect, UpstoxClient) {
27 | 'use strict';
28 |
29 | var instance;
30 |
31 | describe('(package)', function() {
32 | describe('GetGttOrderResponse', function() {
33 | beforeEach(function() {
34 | instance = new UpstoxClient.GetGttOrderResponse();
35 | });
36 |
37 | it('should create an instance of GetGttOrderResponse', function() {
38 | // TODO: update the code to test GetGttOrderResponse
39 | expect(instance).to.be.a(UpstoxClient.GetGttOrderResponse);
40 | });
41 |
42 | it('should have the property status (base name: "status")', function() {
43 | // TODO: update the code to test the property status
44 | expect(instance).to.have.property('status');
45 | // expect(instance.status).to.be(expectedValueLiteral);
46 | });
47 |
48 | it('should have the property data (base name: "data")', function() {
49 | // TODO: update the code to test the property data
50 | expect(instance).to.have.property('data');
51 | // expect(instance.data).to.be(expectedValueLiteral);
52 | });
53 |
54 | it('should have the property metadata (base name: "metadata")', function() {
55 | // TODO: update the code to test the property metadata
56 | expect(instance).to.have.property('metadata');
57 | // expect(instance.metadata).to.be(expectedValueLiteral);
58 | });
59 |
60 | });
61 | });
62 |
63 | }));
64 |
--------------------------------------------------------------------------------
/test/model/BatchExecutionSummary.spec.js:
--------------------------------------------------------------------------------
1 | /*
2 | * OpenAPI definition
3 | * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
4 | *
5 | * OpenAPI spec version: v0
6 | *
7 | * NOTE: This class is auto generated by the swagger code generator program.
8 | * https://github.com/swagger-api/swagger-codegen.git
9 | *
10 | * Swagger Codegen version: 3.0.62
11 | *
12 | * Do not edit the class manually.
13 | *
14 | */
15 | (function(root, factory) {
16 | if (typeof define === 'function' && define.amd) {
17 | // AMD.
18 | define(['expect.js', '../../src/index'], factory);
19 | } else if (typeof module === 'object' && module.exports) {
20 | // CommonJS-like environments that support module.exports, like Node.
21 | factory(require('expect.js'), require('../../src/index'));
22 | } else {
23 | // Browser globals (root is window)
24 | factory(root.expect, root.UpstoxClient);
25 | }
26 | }(this, function(expect, UpstoxClient) {
27 | 'use strict';
28 |
29 | var instance;
30 |
31 | describe('(package)', function() {
32 | describe('BatchExecutionSummary', function() {
33 | beforeEach(function() {
34 | instance = new UpstoxClient.BatchExecutionSummary();
35 | });
36 |
37 | it('should create an instance of BatchExecutionSummary', function() {
38 | // TODO: update the code to test BatchExecutionSummary
39 | expect(instance).to.be.a(UpstoxClient.BatchExecutionSummary);
40 | });
41 |
42 | it('should have the property total (base name: "total")', function() {
43 | // TODO: update the code to test the property total
44 | expect(instance).to.have.property('total');
45 | // expect(instance.total).to.be(expectedValueLiteral);
46 | });
47 |
48 | it('should have the property success (base name: "success")', function() {
49 | // TODO: update the code to test the property success
50 | expect(instance).to.have.property('success');
51 | // expect(instance.success).to.be(expectedValueLiteral);
52 | });
53 |
54 | it('should have the property error (base name: "error")', function() {
55 | // TODO: update the code to test the property error
56 | expect(instance).to.have.property('error');
57 | // expect(instance.error).to.be(expectedValueLiteral);
58 | });
59 |
60 | });
61 | });
62 |
63 | }));
64 |
--------------------------------------------------------------------------------
/test/model/PlaceOrderV3Response.spec.js:
--------------------------------------------------------------------------------
1 | /*
2 | * OpenAPI definition
3 | * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
4 | *
5 | * OpenAPI spec version: v0
6 | *
7 | * NOTE: This class is auto generated by the swagger code generator program.
8 | * https://github.com/swagger-api/swagger-codegen.git
9 | *
10 | * Swagger Codegen version: 3.0.66
11 | *
12 | * Do not edit the class manually.
13 | *
14 | */
15 | (function(root, factory) {
16 | if (typeof define === 'function' && define.amd) {
17 | // AMD.
18 | define(['expect.js', '../../src/index'], factory);
19 | } else if (typeof module === 'object' && module.exports) {
20 | // CommonJS-like environments that support module.exports, like Node.
21 | factory(require('expect.js'), require('../../src/index'));
22 | } else {
23 | // Browser globals (root is window)
24 | factory(root.expect, root.UpstoxClient);
25 | }
26 | }(this, function(expect, UpstoxClient) {
27 | 'use strict';
28 |
29 | var instance;
30 |
31 | describe('(package)', function() {
32 | describe('PlaceOrderV3Response', function() {
33 | beforeEach(function() {
34 | instance = new UpstoxClient.PlaceOrderV3Response();
35 | });
36 |
37 | it('should create an instance of PlaceOrderV3Response', function() {
38 | // TODO: update the code to test PlaceOrderV3Response
39 | expect(instance).to.be.a(UpstoxClient.PlaceOrderV3Response);
40 | });
41 |
42 | it('should have the property status (base name: "status")', function() {
43 | // TODO: update the code to test the property status
44 | expect(instance).to.have.property('status');
45 | // expect(instance.status).to.be(expectedValueLiteral);
46 | });
47 |
48 | it('should have the property data (base name: "data")', function() {
49 | // TODO: update the code to test the property data
50 | expect(instance).to.have.property('data');
51 | // expect(instance.data).to.be(expectedValueLiteral);
52 | });
53 |
54 | it('should have the property metadata (base name: "metadata")', function() {
55 | // TODO: update the code to test the property metadata
56 | expect(instance).to.have.property('metadata');
57 | // expect(instance.metadata).to.be(expectedValueLiteral);
58 | });
59 |
60 | });
61 | });
62 |
63 | }));
64 |
--------------------------------------------------------------------------------
/test/model/TradeHistoryResponse.spec.js:
--------------------------------------------------------------------------------
1 | /*
2 | * OpenAPI definition
3 | * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
4 | *
5 | * OpenAPI spec version: v0
6 | *
7 | * NOTE: This class is auto generated by the swagger code generator program.
8 | * https://github.com/swagger-api/swagger-codegen.git
9 | *
10 | * Swagger Codegen version: 3.0.54
11 | *
12 | * Do not edit the class manually.
13 | *
14 | */
15 | (function(root, factory) {
16 | if (typeof define === 'function' && define.amd) {
17 | // AMD.
18 | define(['expect.js', '../../src/index'], factory);
19 | } else if (typeof module === 'object' && module.exports) {
20 | // CommonJS-like environments that support module.exports, like Node.
21 | factory(require('expect.js'), require('../../src/index'));
22 | } else {
23 | // Browser globals (root is window)
24 | factory(root.expect, root.UpstoxClient);
25 | }
26 | }(this, function(expect, UpstoxClient) {
27 | 'use strict';
28 |
29 | var instance;
30 |
31 | describe('(package)', function() {
32 | describe('TradeHistoryResponse', function() {
33 | beforeEach(function() {
34 | instance = new UpstoxClient.TradeHistoryResponse();
35 | });
36 |
37 | it('should create an instance of TradeHistoryResponse', function() {
38 | // TODO: update the code to test TradeHistoryResponse
39 | expect(instance).to.be.a(UpstoxClient.TradeHistoryResponse);
40 | });
41 |
42 | it('should have the property status (base name: "status")', function() {
43 | // TODO: update the code to test the property status
44 | expect(instance).to.have.property('status');
45 | // expect(instance.status).to.be(expectedValueLiteral);
46 | });
47 |
48 | it('should have the property data (base name: "data")', function() {
49 | // TODO: update the code to test the property data
50 | expect(instance).to.have.property('data');
51 | // expect(instance.data).to.be(expectedValueLiteral);
52 | });
53 |
54 | it('should have the property metaData (base name: "metaData")', function() {
55 | // TODO: update the code to test the property metaData
56 | expect(instance).to.have.property('metaData');
57 | // expect(instance.metaData).to.be(expectedValueLiteral);
58 | });
59 |
60 | });
61 | });
62 |
63 | }));
64 |
--------------------------------------------------------------------------------
/test/model/CancelOrderV3Response.spec.js:
--------------------------------------------------------------------------------
1 | /*
2 | * OpenAPI definition
3 | * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
4 | *
5 | * OpenAPI spec version: v0
6 | *
7 | * NOTE: This class is auto generated by the swagger code generator program.
8 | * https://github.com/swagger-api/swagger-codegen.git
9 | *
10 | * Swagger Codegen version: 3.0.66
11 | *
12 | * Do not edit the class manually.
13 | *
14 | */
15 | (function(root, factory) {
16 | if (typeof define === 'function' && define.amd) {
17 | // AMD.
18 | define(['expect.js', '../../src/index'], factory);
19 | } else if (typeof module === 'object' && module.exports) {
20 | // CommonJS-like environments that support module.exports, like Node.
21 | factory(require('expect.js'), require('../../src/index'));
22 | } else {
23 | // Browser globals (root is window)
24 | factory(root.expect, root.UpstoxClient);
25 | }
26 | }(this, function(expect, UpstoxClient) {
27 | 'use strict';
28 |
29 | var instance;
30 |
31 | describe('(package)', function() {
32 | describe('CancelOrderV3Response', function() {
33 | beforeEach(function() {
34 | instance = new UpstoxClient.CancelOrderV3Response();
35 | });
36 |
37 | it('should create an instance of CancelOrderV3Response', function() {
38 | // TODO: update the code to test CancelOrderV3Response
39 | expect(instance).to.be.a(UpstoxClient.CancelOrderV3Response);
40 | });
41 |
42 | it('should have the property status (base name: "status")', function() {
43 | // TODO: update the code to test the property status
44 | expect(instance).to.have.property('status');
45 | // expect(instance.status).to.be(expectedValueLiteral);
46 | });
47 |
48 | it('should have the property data (base name: "data")', function() {
49 | // TODO: update the code to test the property data
50 | expect(instance).to.have.property('data');
51 | // expect(instance.data).to.be(expectedValueLiteral);
52 | });
53 |
54 | it('should have the property metadata (base name: "metadata")', function() {
55 | // TODO: update the code to test the property metadata
56 | expect(instance).to.have.property('metadata');
57 | // expect(instance.metadata).to.be(expectedValueLiteral);
58 | });
59 |
60 | });
61 | });
62 |
63 | }));
64 |
--------------------------------------------------------------------------------
/test/model/ModifyOrderV3Response.spec.js:
--------------------------------------------------------------------------------
1 | /*
2 | * OpenAPI definition
3 | * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
4 | *
5 | * OpenAPI spec version: v0
6 | *
7 | * NOTE: This class is auto generated by the swagger code generator program.
8 | * https://github.com/swagger-api/swagger-codegen.git
9 | *
10 | * Swagger Codegen version: 3.0.66
11 | *
12 | * Do not edit the class manually.
13 | *
14 | */
15 | (function(root, factory) {
16 | if (typeof define === 'function' && define.amd) {
17 | // AMD.
18 | define(['expect.js', '../../src/index'], factory);
19 | } else if (typeof module === 'object' && module.exports) {
20 | // CommonJS-like environments that support module.exports, like Node.
21 | factory(require('expect.js'), require('../../src/index'));
22 | } else {
23 | // Browser globals (root is window)
24 | factory(root.expect, root.UpstoxClient);
25 | }
26 | }(this, function(expect, UpstoxClient) {
27 | 'use strict';
28 |
29 | var instance;
30 |
31 | describe('(package)', function() {
32 | describe('ModifyOrderV3Response', function() {
33 | beforeEach(function() {
34 | instance = new UpstoxClient.ModifyOrderV3Response();
35 | });
36 |
37 | it('should create an instance of ModifyOrderV3Response', function() {
38 | // TODO: update the code to test ModifyOrderV3Response
39 | expect(instance).to.be.a(UpstoxClient.ModifyOrderV3Response);
40 | });
41 |
42 | it('should have the property status (base name: "status")', function() {
43 | // TODO: update the code to test the property status
44 | expect(instance).to.have.property('status');
45 | // expect(instance.status).to.be(expectedValueLiteral);
46 | });
47 |
48 | it('should have the property data (base name: "data")', function() {
49 | // TODO: update the code to test the property data
50 | expect(instance).to.have.property('data');
51 | // expect(instance.data).to.be(expectedValueLiteral);
52 | });
53 |
54 | it('should have the property metadata (base name: "metadata")', function() {
55 | // TODO: update the code to test the property metadata
56 | expect(instance).to.have.property('metadata');
57 | // expect(instance.metadata).to.be(expectedValueLiteral);
58 | });
59 |
60 | });
61 | });
62 |
63 | }));
64 |
--------------------------------------------------------------------------------
/test/model/MarginData.spec.js:
--------------------------------------------------------------------------------
1 | /*
2 | * OpenAPI definition
3 | * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
4 | *
5 | * OpenAPI spec version: v0
6 | *
7 | * NOTE: This class is auto generated by the swagger code generator program.
8 | * https://github.com/swagger-api/swagger-codegen.git
9 | *
10 | * Swagger Codegen version: 3.0.54
11 | *
12 | * Do not edit the class manually.
13 | *
14 | */
15 | (function(root, factory) {
16 | if (typeof define === 'function' && define.amd) {
17 | // AMD.
18 | define(['expect.js', '../../src/index'], factory);
19 | } else if (typeof module === 'object' && module.exports) {
20 | // CommonJS-like environments that support module.exports, like Node.
21 | factory(require('expect.js'), require('../../src/index'));
22 | } else {
23 | // Browser globals (root is window)
24 | factory(root.expect, root.UpstoxClient);
25 | }
26 | }(this, function(expect, UpstoxClient) {
27 | 'use strict';
28 |
29 | var instance;
30 |
31 | describe('(package)', function() {
32 | describe('MarginData', function() {
33 | beforeEach(function() {
34 | instance = new UpstoxClient.MarginData();
35 | });
36 |
37 | it('should create an instance of MarginData', function() {
38 | // TODO: update the code to test MarginData
39 | expect(instance).to.be.a(UpstoxClient.MarginData);
40 | });
41 |
42 | it('should have the property margins (base name: "margins")', function() {
43 | // TODO: update the code to test the property margins
44 | expect(instance).to.have.property('margins');
45 | // expect(instance.margins).to.be(expectedValueLiteral);
46 | });
47 |
48 | it('should have the property requiredMargin (base name: "required_margin")', function() {
49 | // TODO: update the code to test the property requiredMargin
50 | expect(instance).to.have.property('requiredMargin');
51 | // expect(instance.requiredMargin).to.be(expectedValueLiteral);
52 | });
53 |
54 | it('should have the property finalMargin (base name: "final_margin")', function() {
55 | // TODO: update the code to test the property finalMargin
56 | expect(instance).to.have.property('finalMargin');
57 | // expect(instance.finalMargin).to.be(expectedValueLiteral);
58 | });
59 |
60 | });
61 | });
62 |
63 | }));
64 |
--------------------------------------------------------------------------------
/test/model/MarketStatusData.spec.js:
--------------------------------------------------------------------------------
1 | /*
2 | * OpenAPI definition
3 | * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
4 | *
5 | * OpenAPI spec version: v0
6 | *
7 | * NOTE: This class is auto generated by the swagger code generator program.
8 | * https://github.com/swagger-api/swagger-codegen.git
9 | *
10 | * Swagger Codegen version: 3.0.54
11 | *
12 | * Do not edit the class manually.
13 | *
14 | */
15 | (function(root, factory) {
16 | if (typeof define === 'function' && define.amd) {
17 | // AMD.
18 | define(['expect.js', '../../src/index'], factory);
19 | } else if (typeof module === 'object' && module.exports) {
20 | // CommonJS-like environments that support module.exports, like Node.
21 | factory(require('expect.js'), require('../../src/index'));
22 | } else {
23 | // Browser globals (root is window)
24 | factory(root.expect, root.UpstoxClient);
25 | }
26 | }(this, function(expect, UpstoxClient) {
27 | 'use strict';
28 |
29 | var instance;
30 |
31 | describe('(package)', function() {
32 | describe('MarketStatusData', function() {
33 | beforeEach(function() {
34 | instance = new UpstoxClient.MarketStatusData();
35 | });
36 |
37 | it('should create an instance of MarketStatusData', function() {
38 | // TODO: update the code to test MarketStatusData
39 | expect(instance).to.be.a(UpstoxClient.MarketStatusData);
40 | });
41 |
42 | it('should have the property exchange (base name: "exchange")', function() {
43 | // TODO: update the code to test the property exchange
44 | expect(instance).to.have.property('exchange');
45 | // expect(instance.exchange).to.be(expectedValueLiteral);
46 | });
47 |
48 | it('should have the property status (base name: "status")', function() {
49 | // TODO: update the code to test the property status
50 | expect(instance).to.have.property('status');
51 | // expect(instance.status).to.be(expectedValueLiteral);
52 | });
53 |
54 | it('should have the property lastUpdated (base name: "last_updated")', function() {
55 | // TODO: update the code to test the property lastUpdated
56 | expect(instance).to.have.property('lastUpdated');
57 | // expect(instance.lastUpdated).to.be(expectedValueLiteral);
58 | });
59 |
60 | });
61 | });
62 |
63 | }));
64 |
--------------------------------------------------------------------------------
/test/model/ExchangeTimingData.spec.js:
--------------------------------------------------------------------------------
1 | /*
2 | * OpenAPI definition
3 | * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
4 | *
5 | * OpenAPI spec version: v0
6 | *
7 | * NOTE: This class is auto generated by the swagger code generator program.
8 | * https://github.com/swagger-api/swagger-codegen.git
9 | *
10 | * Swagger Codegen version: 3.0.54
11 | *
12 | * Do not edit the class manually.
13 | *
14 | */
15 | (function(root, factory) {
16 | if (typeof define === 'function' && define.amd) {
17 | // AMD.
18 | define(['expect.js', '../../src/index'], factory);
19 | } else if (typeof module === 'object' && module.exports) {
20 | // CommonJS-like environments that support module.exports, like Node.
21 | factory(require('expect.js'), require('../../src/index'));
22 | } else {
23 | // Browser globals (root is window)
24 | factory(root.expect, root.UpstoxClient);
25 | }
26 | }(this, function(expect, UpstoxClient) {
27 | 'use strict';
28 |
29 | var instance;
30 |
31 | describe('(package)', function() {
32 | describe('ExchangeTimingData', function() {
33 | beforeEach(function() {
34 | instance = new UpstoxClient.ExchangeTimingData();
35 | });
36 |
37 | it('should create an instance of ExchangeTimingData', function() {
38 | // TODO: update the code to test ExchangeTimingData
39 | expect(instance).to.be.a(UpstoxClient.ExchangeTimingData);
40 | });
41 |
42 | it('should have the property exchange (base name: "exchange")', function() {
43 | // TODO: update the code to test the property exchange
44 | expect(instance).to.have.property('exchange');
45 | // expect(instance.exchange).to.be(expectedValueLiteral);
46 | });
47 |
48 | it('should have the property startTime (base name: "start_time")', function() {
49 | // TODO: update the code to test the property startTime
50 | expect(instance).to.have.property('startTime');
51 | // expect(instance.startTime).to.be(expectedValueLiteral);
52 | });
53 |
54 | it('should have the property endTime (base name: "end_time")', function() {
55 | // TODO: update the code to test the property endTime
56 | expect(instance).to.have.property('endTime');
57 | // expect(instance.endTime).to.be(expectedValueLiteral);
58 | });
59 |
60 | });
61 | });
62 |
63 | }));
64 |
--------------------------------------------------------------------------------
/test/model/GttTriggerOrderResponse.spec.js:
--------------------------------------------------------------------------------
1 | /*
2 | * OpenAPI definition
3 | * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
4 | *
5 | * OpenAPI spec version: v0
6 | *
7 | * NOTE: This class is auto generated by the swagger code generator program.
8 | * https://github.com/swagger-api/swagger-codegen.git
9 | *
10 | * Swagger Codegen version: 3.0.66
11 | *
12 | * Do not edit the class manually.
13 | *
14 | */
15 | (function(root, factory) {
16 | if (typeof define === 'function' && define.amd) {
17 | // AMD.
18 | define(['expect.js', '../../src/index'], factory);
19 | } else if (typeof module === 'object' && module.exports) {
20 | // CommonJS-like environments that support module.exports, like Node.
21 | factory(require('expect.js'), require('../../src/index'));
22 | } else {
23 | // Browser globals (root is window)
24 | factory(root.expect, root.UpstoxClient);
25 | }
26 | }(this, function(expect, UpstoxClient) {
27 | 'use strict';
28 |
29 | var instance;
30 |
31 | describe('(package)', function() {
32 | describe('GttTriggerOrderResponse', function() {
33 | beforeEach(function() {
34 | instance = new UpstoxClient.GttTriggerOrderResponse();
35 | });
36 |
37 | it('should create an instance of GttTriggerOrderResponse', function() {
38 | // TODO: update the code to test GttTriggerOrderResponse
39 | expect(instance).to.be.a(UpstoxClient.GttTriggerOrderResponse);
40 | });
41 |
42 | it('should have the property status (base name: "status")', function() {
43 | // TODO: update the code to test the property status
44 | expect(instance).to.have.property('status');
45 | // expect(instance.status).to.be(expectedValueLiteral);
46 | });
47 |
48 | it('should have the property data (base name: "data")', function() {
49 | // TODO: update the code to test the property data
50 | expect(instance).to.have.property('data');
51 | // expect(instance.data).to.be(expectedValueLiteral);
52 | });
53 |
54 | it('should have the property metadata (base name: "metadata")', function() {
55 | // TODO: update the code to test the property metadata
56 | expect(instance).to.have.property('metadata');
57 | // expect(instance.metadata).to.be(expectedValueLiteral);
58 | });
59 |
60 | });
61 | });
62 |
63 | }));
64 |
--------------------------------------------------------------------------------
/src/model/MarginData.js:
--------------------------------------------------------------------------------
1 | /*
2 | * OpenAPI definition
3 | * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
4 | *
5 | * OpenAPI spec version: v0
6 | *
7 | * NOTE: This class is auto generated by the swagger code generator program.
8 | * https://github.com/swagger-api/swagger-codegen.git
9 | *
10 | * Swagger Codegen version: 3.0.54
11 | *
12 | * Do not edit the class manually.
13 | *
14 | */
15 | import {ApiClient} from '../ApiClient';
16 | import {Margin} from './Margin';
17 |
18 | /**
19 | * The MarginData model module.
20 | * @module model/MarginData
21 | * @version v0
22 | */
23 | export class MarginData {
24 | /**
25 | * Constructs a new MarginData.
26 | * Response data for margin
27 | * @alias module:model/MarginData
28 | * @class
29 | */
30 | constructor() {
31 | }
32 |
33 | /**
34 | * Constructs a MarginData from a plain JavaScript object, optionally creating a new instance.
35 | * Copies all relevant properties from data to obj if supplied or a new instance if not.
36 | * @param {Object} data The plain JavaScript object bearing properties of interest.
37 | * @param {module:model/MarginData} obj Optional instance to populate.
38 | * @return {module:model/MarginData} The populated MarginData instance.
39 | */
40 | static constructFromObject(data, obj) {
41 | if (data) {
42 | obj = obj || new MarginData();
43 | if (data.hasOwnProperty('margins'))
44 | obj.margins = ApiClient.convertToType(data['margins'], [Margin]);
45 | if (data.hasOwnProperty('required_margin'))
46 | obj.requiredMargin = ApiClient.convertToType(data['required_margin'], 'Number');
47 | if (data.hasOwnProperty('final_margin'))
48 | obj.finalMargin = ApiClient.convertToType(data['final_margin'], 'Number');
49 | }
50 | return obj;
51 | }
52 | }
53 |
54 | /**
55 | * Response data for instrument margin details
56 | * @member {Array.} margins
57 | */
58 | MarginData.prototype.margins = undefined;
59 |
60 | /**
61 | * Total margin required to execute the orders
62 | * @member {Number} requiredMargin
63 | */
64 | MarginData.prototype.requiredMargin = undefined;
65 |
66 | /**
67 | * Total margin after margin benefit
68 | * @member {Number} finalMargin
69 | */
70 | MarginData.prototype.finalMargin = undefined;
71 |
72 |
--------------------------------------------------------------------------------
/src/model/PostMarginResponse.js:
--------------------------------------------------------------------------------
1 | /*
2 | * OpenAPI definition
3 | * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
4 | *
5 | * OpenAPI spec version: v0
6 | *
7 | * NOTE: This class is auto generated by the swagger code generator program.
8 | * https://github.com/swagger-api/swagger-codegen.git
9 | *
10 | * Swagger Codegen version: 3.0.54
11 | *
12 | * Do not edit the class manually.
13 | *
14 | */
15 | import {ApiClient} from '../ApiClient';
16 | import {MarginData} from './MarginData';
17 |
18 | /**
19 | * The PostMarginResponse model module.
20 | * @module model/PostMarginResponse
21 | * @version v0
22 | */
23 | export class PostMarginResponse {
24 | /**
25 | * Constructs a new PostMarginResponse.
26 | * @alias module:model/PostMarginResponse
27 | * @class
28 | */
29 | constructor() {
30 | }
31 |
32 | /**
33 | * Constructs a PostMarginResponse from a plain JavaScript object, optionally creating a new instance.
34 | * Copies all relevant properties from data to obj if supplied or a new instance if not.
35 | * @param {Object} data The plain JavaScript object bearing properties of interest.
36 | * @param {module:model/PostMarginResponse} obj Optional instance to populate.
37 | * @return {module:model/PostMarginResponse} The populated PostMarginResponse instance.
38 | */
39 | static constructFromObject(data, obj) {
40 | if (data) {
41 | obj = obj || new PostMarginResponse();
42 | if (data.hasOwnProperty('status'))
43 | obj.status = ApiClient.convertToType(data['status'], 'String');
44 | if (data.hasOwnProperty('data'))
45 | obj.data = MarginData.constructFromObject(data['data']);
46 | }
47 | return obj;
48 | }
49 | }
50 |
51 | /**
52 | * Allowed values for the status property.
53 | * @enum {String}
54 | * @readonly
55 | */
56 | PostMarginResponse.StatusEnum = {
57 | /**
58 | * value: "success"
59 | * @const
60 | */
61 | success: "success",
62 |
63 | /**
64 | * value: "error"
65 | * @const
66 | */
67 | error: "error"
68 | };
69 | /**
70 | * @member {module:model/PostMarginResponse.StatusEnum} status
71 | */
72 | PostMarginResponse.prototype.status = undefined;
73 |
74 | /**
75 | * @member {module:model/MarginData} data
76 | */
77 | PostMarginResponse.prototype.data = undefined;
78 |
79 |
--------------------------------------------------------------------------------
/examples/websocket/order_updates/README.md:
--------------------------------------------------------------------------------
1 | # Portfolio Stream Feed WebSocket Client
2 |
3 | This Node.js project illustrates how to connect to the Upstox WebSocket API for streaming live order updates. It fetches the order updates and prints them to the console.
4 |
5 | ## Getting Started
6 |
7 | Follow these instructions to run the websocket client.
8 |
9 | ### Prerequisites
10 |
11 | Before you can run this script, you need to have Node.js and npm installed on your system. If you haven't installed Node.js and npm yet, you can download it from the official website:
12 |
13 | [Download Node.js](https://nodejs.org/en/download)
14 |
15 | You will also need to install several npm packages:
16 |
17 | - `upstox-js-sdk`
18 | - `ws`
19 |
20 | You can install these packages using npm, a package manager for Node.js. Open a terminal and enter the following command:
21 |
22 | ```sh
23 | npm install upstox-js-sdk ws
24 | ```
25 |
26 | ### Configuration
27 |
28 | The script requires an Upstox API access token for authorization. You will need to specify your Upstox API access token in the script. Look for the line below and replace 'ACCESS_TOKEN' with your actual access token.
29 |
30 | ```
31 | OAUTH2.accessToken = "ACCESS_TOKEN";
32 | ```
33 |
34 | ### Running the Script
35 |
36 | After installing the prerequisites and setting up your access token, you can run the script. Navigate to the directory containing the script and run the following command:
37 |
38 | ```
39 | node websocket_client.js
40 | ```
41 |
42 | Replace websocket_client.py with the name of your JavaScript file.
43 |
44 | ## Understanding the Code
45 |
46 | The script first authenticates using an OAuth2 access token. It fetches the authorized redirect URI from the Upstox server and uses this to establish a connection to the Websocket server.
47 |
48 | The script then establishes a websocket connection where it continually receives order update messages from the server and prints them to the console..
49 |
50 | ## Support
51 |
52 | If you encounter any problems or have any questions about this project, feel free to open an issue in this repository.
53 |
54 | ## Disclaimer
55 |
56 | This is a sample script meant for educational purposes. It may require modifications to work with your specific requirements.
57 |
58 | Please replace `'ACCESS_TOKEN'` with your actual access token and `websocket_client.js` with the name of your JavaScript file. Modify any other details as needed to fit your project.
59 |
60 |
61 |
--------------------------------------------------------------------------------
/src/model/GetHolidayResponse.js:
--------------------------------------------------------------------------------
1 | /*
2 | * OpenAPI definition
3 | * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
4 | *
5 | * OpenAPI spec version: v0
6 | *
7 | * NOTE: This class is auto generated by the swagger code generator program.
8 | * https://github.com/swagger-api/swagger-codegen.git
9 | *
10 | * Swagger Codegen version: 3.0.54
11 | *
12 | * Do not edit the class manually.
13 | *
14 | */
15 | import {ApiClient} from '../ApiClient';
16 | import {HolidayData} from './HolidayData';
17 |
18 | /**
19 | * The GetHolidayResponse model module.
20 | * @module model/GetHolidayResponse
21 | * @version v0
22 | */
23 | export class GetHolidayResponse {
24 | /**
25 | * Constructs a new GetHolidayResponse.
26 | * @alias module:model/GetHolidayResponse
27 | * @class
28 | */
29 | constructor() {
30 | }
31 |
32 | /**
33 | * Constructs a GetHolidayResponse from a plain JavaScript object, optionally creating a new instance.
34 | * Copies all relevant properties from data to obj if supplied or a new instance if not.
35 | * @param {Object} data The plain JavaScript object bearing properties of interest.
36 | * @param {module:model/GetHolidayResponse} obj Optional instance to populate.
37 | * @return {module:model/GetHolidayResponse} The populated GetHolidayResponse instance.
38 | */
39 | static constructFromObject(data, obj) {
40 | if (data) {
41 | obj = obj || new GetHolidayResponse();
42 | if (data.hasOwnProperty('status'))
43 | obj.status = ApiClient.convertToType(data['status'], 'String');
44 | if (data.hasOwnProperty('data'))
45 | obj.data = ApiClient.convertToType(data['data'], [HolidayData]);
46 | }
47 | return obj;
48 | }
49 | }
50 |
51 | /**
52 | * Allowed values for the status property.
53 | * @enum {String}
54 | * @readonly
55 | */
56 | GetHolidayResponse.StatusEnum = {
57 | /**
58 | * value: "success"
59 | * @const
60 | */
61 | success: "success",
62 |
63 | /**
64 | * value: "error"
65 | * @const
66 | */
67 | error: "error"
68 | };
69 | /**
70 | * @member {module:model/GetHolidayResponse.StatusEnum} status
71 | */
72 | GetHolidayResponse.prototype.status = undefined;
73 |
74 | /**
75 | * Response data for holiday list
76 | * @member {Array.} data
77 | */
78 | GetHolidayResponse.prototype.data = undefined;
79 |
80 |
--------------------------------------------------------------------------------
/src/model/PutCallOptionChainData.js:
--------------------------------------------------------------------------------
1 | /*
2 | * OpenAPI definition
3 | * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
4 | *
5 | * OpenAPI spec version: v0
6 | *
7 | * NOTE: This class is auto generated by the swagger code generator program.
8 | * https://github.com/swagger-api/swagger-codegen.git
9 | *
10 | * Swagger Codegen version: 3.0.54
11 | *
12 | * Do not edit the class manually.
13 | *
14 | */
15 | import {ApiClient} from '../ApiClient';
16 | import {AnalyticsData} from './AnalyticsData';
17 | import {MarketData} from './MarketData';
18 |
19 | /**
20 | * The PutCallOptionChainData model module.
21 | * @module model/PutCallOptionChainData
22 | * @version v0
23 | */
24 | export class PutCallOptionChainData {
25 | /**
26 | * Constructs a new PutCallOptionChainData.
27 | * @alias module:model/PutCallOptionChainData
28 | * @class
29 | */
30 | constructor() {
31 | }
32 |
33 | /**
34 | * Constructs a PutCallOptionChainData from a plain JavaScript object, optionally creating a new instance.
35 | * Copies all relevant properties from data to obj if supplied or a new instance if not.
36 | * @param {Object} data The plain JavaScript object bearing properties of interest.
37 | * @param {module:model/PutCallOptionChainData} obj Optional instance to populate.
38 | * @return {module:model/PutCallOptionChainData} The populated PutCallOptionChainData instance.
39 | */
40 | static constructFromObject(data, obj) {
41 | if (data) {
42 | obj = obj || new PutCallOptionChainData();
43 | if (data.hasOwnProperty('instrument_key'))
44 | obj.instrumentKey = ApiClient.convertToType(data['instrument_key'], 'String');
45 | if (data.hasOwnProperty('market_data'))
46 | obj.marketData = MarketData.constructFromObject(data['market_data']);
47 | if (data.hasOwnProperty('option_greeks'))
48 | obj.optionGreeks = AnalyticsData.constructFromObject(data['option_greeks']);
49 | }
50 | return obj;
51 | }
52 | }
53 |
54 | /**
55 | * @member {String} instrumentKey
56 | */
57 | PutCallOptionChainData.prototype.instrumentKey = undefined;
58 |
59 | /**
60 | * @member {module:model/MarketData} marketData
61 | */
62 | PutCallOptionChainData.prototype.marketData = undefined;
63 |
64 | /**
65 | * @member {module:model/AnalyticsData} optionGreeks
66 | */
67 | PutCallOptionChainData.prototype.optionGreeks = undefined;
68 |
69 |
--------------------------------------------------------------------------------
/test/model/PutCallOptionChainData.spec.js:
--------------------------------------------------------------------------------
1 | /*
2 | * OpenAPI definition
3 | * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
4 | *
5 | * OpenAPI spec version: v0
6 | *
7 | * NOTE: This class is auto generated by the swagger code generator program.
8 | * https://github.com/swagger-api/swagger-codegen.git
9 | *
10 | * Swagger Codegen version: 3.0.54
11 | *
12 | * Do not edit the class manually.
13 | *
14 | */
15 | (function(root, factory) {
16 | if (typeof define === 'function' && define.amd) {
17 | // AMD.
18 | define(['expect.js', '../../src/index'], factory);
19 | } else if (typeof module === 'object' && module.exports) {
20 | // CommonJS-like environments that support module.exports, like Node.
21 | factory(require('expect.js'), require('../../src/index'));
22 | } else {
23 | // Browser globals (root is window)
24 | factory(root.expect, root.UpstoxClient);
25 | }
26 | }(this, function(expect, UpstoxClient) {
27 | 'use strict';
28 |
29 | var instance;
30 |
31 | describe('(package)', function() {
32 | describe('PutCallOptionChainData', function() {
33 | beforeEach(function() {
34 | instance = new UpstoxClient.PutCallOptionChainData();
35 | });
36 |
37 | it('should create an instance of PutCallOptionChainData', function() {
38 | // TODO: update the code to test PutCallOptionChainData
39 | expect(instance).to.be.a(UpstoxClient.PutCallOptionChainData);
40 | });
41 |
42 | it('should have the property instrumentKey (base name: "instrument_key")', function() {
43 | // TODO: update the code to test the property instrumentKey
44 | expect(instance).to.have.property('instrumentKey');
45 | // expect(instance.instrumentKey).to.be(expectedValueLiteral);
46 | });
47 |
48 | it('should have the property marketData (base name: "market_data")', function() {
49 | // TODO: update the code to test the property marketData
50 | expect(instance).to.have.property('marketData');
51 | // expect(instance.marketData).to.be(expectedValueLiteral);
52 | });
53 |
54 | it('should have the property optionGreeks (base name: "option_greeks")', function() {
55 | // TODO: update the code to test the property optionGreeks
56 | expect(instance).to.have.property('optionGreeks');
57 | // expect(instance.optionGreeks).to.be(expectedValueLiteral);
58 | });
59 |
60 | });
61 | });
62 |
63 | }));
64 |
--------------------------------------------------------------------------------
/src/model/GetExpiriesResponse.js:
--------------------------------------------------------------------------------
1 | /*
2 | * OpenAPI definition
3 | * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
4 | *
5 | * OpenAPI spec version: v0
6 | *
7 | * NOTE: This class is auto generated by the swagger code generator program.
8 | * https://github.com/swagger-api/swagger-codegen.git
9 | *
10 | * Swagger Codegen version: 3.0.66
11 | *
12 | * Do not edit the class manually.
13 | *
14 | */
15 | import {ApiClient} from '../ApiClient';
16 |
17 | /**
18 | * The GetExpiriesResponse model module.
19 | * @module model/GetExpiriesResponse
20 | * @version v0
21 | */
22 | export class GetExpiriesResponse {
23 | /**
24 | * Constructs a new GetExpiriesResponse.
25 | * @alias module:model/GetExpiriesResponse
26 | * @class
27 | */
28 | constructor() {
29 | }
30 |
31 | /**
32 | * Constructs a GetExpiriesResponse from a plain JavaScript object, optionally creating a new instance.
33 | * Copies all relevant properties from data to obj if supplied or a new instance if not.
34 | * @param {Object} data The plain JavaScript object bearing properties of interest.
35 | * @param {module:model/GetExpiriesResponse} obj Optional instance to populate.
36 | * @return {module:model/GetExpiriesResponse} The populated GetExpiriesResponse instance.
37 | */
38 | static constructFromObject(data, obj) {
39 | if (data) {
40 | obj = obj || new GetExpiriesResponse();
41 | if (data.hasOwnProperty('status'))
42 | obj.status = ApiClient.convertToType(data['status'], 'String');
43 | if (data.hasOwnProperty('data'))
44 | obj.data = ApiClient.convertToType(data['data'], ['String']);
45 | }
46 | return obj;
47 | }
48 | }
49 |
50 | /**
51 | * Allowed values for the status property.
52 | * @enum {String}
53 | * @readonly
54 | */
55 | GetExpiriesResponse.StatusEnum = {
56 | /**
57 | * value: "success"
58 | * @const
59 | */
60 | success: "success",
61 |
62 | /**
63 | * value: "error"
64 | * @const
65 | */
66 | error: "error",
67 |
68 | /**
69 | * value: "partial_success"
70 | * @const
71 | */
72 | partialSuccess: "partial_success"
73 | };
74 | /**
75 | * @member {module:model/GetExpiriesResponse.StatusEnum} status
76 | */
77 | GetExpiriesResponse.prototype.status = undefined;
78 |
79 | /**
80 | * @member {Array.} data
81 | */
82 | GetExpiriesResponse.prototype.data = undefined;
83 |
84 |
--------------------------------------------------------------------------------
/src/model/GetMarketStatusResponse.js:
--------------------------------------------------------------------------------
1 | /*
2 | * OpenAPI definition
3 | * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
4 | *
5 | * OpenAPI spec version: v0
6 | *
7 | * NOTE: This class is auto generated by the swagger code generator program.
8 | * https://github.com/swagger-api/swagger-codegen.git
9 | *
10 | * Swagger Codegen version: 3.0.54
11 | *
12 | * Do not edit the class manually.
13 | *
14 | */
15 | import {ApiClient} from '../ApiClient';
16 | import {MarketStatusData} from './MarketStatusData';
17 |
18 | /**
19 | * The GetMarketStatusResponse model module.
20 | * @module model/GetMarketStatusResponse
21 | * @version v0
22 | */
23 | export class GetMarketStatusResponse {
24 | /**
25 | * Constructs a new GetMarketStatusResponse.
26 | * @alias module:model/GetMarketStatusResponse
27 | * @class
28 | */
29 | constructor() {
30 | }
31 |
32 | /**
33 | * Constructs a GetMarketStatusResponse from a plain JavaScript object, optionally creating a new instance.
34 | * Copies all relevant properties from data to obj if supplied or a new instance if not.
35 | * @param {Object} data The plain JavaScript object bearing properties of interest.
36 | * @param {module:model/GetMarketStatusResponse} obj Optional instance to populate.
37 | * @return {module:model/GetMarketStatusResponse} The populated GetMarketStatusResponse instance.
38 | */
39 | static constructFromObject(data, obj) {
40 | if (data) {
41 | obj = obj || new GetMarketStatusResponse();
42 | if (data.hasOwnProperty('status'))
43 | obj.status = ApiClient.convertToType(data['status'], 'String');
44 | if (data.hasOwnProperty('data'))
45 | obj.data = MarketStatusData.constructFromObject(data['data']);
46 | }
47 | return obj;
48 | }
49 | }
50 |
51 | /**
52 | * Allowed values for the status property.
53 | * @enum {String}
54 | * @readonly
55 | */
56 | GetMarketStatusResponse.StatusEnum = {
57 | /**
58 | * value: "success"
59 | * @const
60 | */
61 | success: "success",
62 |
63 | /**
64 | * value: "error"
65 | * @const
66 | */
67 | error: "error"
68 | };
69 | /**
70 | * @member {module:model/GetMarketStatusResponse.StatusEnum} status
71 | */
72 | GetMarketStatusResponse.prototype.status = undefined;
73 |
74 | /**
75 | * @member {module:model/MarketStatusData} data
76 | */
77 | GetMarketStatusResponse.prototype.data = undefined;
78 |
79 |
--------------------------------------------------------------------------------
/src/model/GetOptionChainResponse.js:
--------------------------------------------------------------------------------
1 | /*
2 | * OpenAPI definition
3 | * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
4 | *
5 | * OpenAPI spec version: v0
6 | *
7 | * NOTE: This class is auto generated by the swagger code generator program.
8 | * https://github.com/swagger-api/swagger-codegen.git
9 | *
10 | * Swagger Codegen version: 3.0.54
11 | *
12 | * Do not edit the class manually.
13 | *
14 | */
15 | import {ApiClient} from '../ApiClient';
16 | import {OptionStrikeData} from './OptionStrikeData';
17 |
18 | /**
19 | * The GetOptionChainResponse model module.
20 | * @module model/GetOptionChainResponse
21 | * @version v0
22 | */
23 | export class GetOptionChainResponse {
24 | /**
25 | * Constructs a new GetOptionChainResponse.
26 | * @alias module:model/GetOptionChainResponse
27 | * @class
28 | */
29 | constructor() {
30 | }
31 |
32 | /**
33 | * Constructs a GetOptionChainResponse from a plain JavaScript object, optionally creating a new instance.
34 | * Copies all relevant properties from data to obj if supplied or a new instance if not.
35 | * @param {Object} data The plain JavaScript object bearing properties of interest.
36 | * @param {module:model/GetOptionChainResponse} obj Optional instance to populate.
37 | * @return {module:model/GetOptionChainResponse} The populated GetOptionChainResponse instance.
38 | */
39 | static constructFromObject(data, obj) {
40 | if (data) {
41 | obj = obj || new GetOptionChainResponse();
42 | if (data.hasOwnProperty('status'))
43 | obj.status = ApiClient.convertToType(data['status'], 'String');
44 | if (data.hasOwnProperty('data'))
45 | obj.data = ApiClient.convertToType(data['data'], [OptionStrikeData]);
46 | }
47 | return obj;
48 | }
49 | }
50 |
51 | /**
52 | * Allowed values for the status property.
53 | * @enum {String}
54 | * @readonly
55 | */
56 | GetOptionChainResponse.StatusEnum = {
57 | /**
58 | * value: "success"
59 | * @const
60 | */
61 | success: "success",
62 |
63 | /**
64 | * value: "error"
65 | * @const
66 | */
67 | error: "error"
68 | };
69 | /**
70 | * @member {module:model/GetOptionChainResponse.StatusEnum} status
71 | */
72 | GetOptionChainResponse.prototype.status = undefined;
73 |
74 | /**
75 | * Response data for option chain data
76 | * @member {Array.} data
77 | */
78 | GetOptionChainResponse.prototype.data = undefined;
79 |
80 |
--------------------------------------------------------------------------------
/src/model/BatchExecutionSummary.js:
--------------------------------------------------------------------------------
1 | /*
2 | * OpenAPI definition
3 | * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
4 | *
5 | * OpenAPI spec version: v0
6 | *
7 | * NOTE: This class is auto generated by the swagger code generator program.
8 | * https://github.com/swagger-api/swagger-codegen.git
9 | *
10 | * Swagger Codegen version: 3.0.62
11 | *
12 | * Do not edit the class manually.
13 | *
14 | */
15 | import {ApiClient} from '../ApiClient';
16 |
17 | /**
18 | * The BatchExecutionSummary model module.
19 | * @module model/BatchExecutionSummary
20 | * @version v0
21 | */
22 | export class BatchExecutionSummary {
23 | /**
24 | * Constructs a new BatchExecutionSummary.
25 | * Execution summary for cancel or exit order request
26 | * @alias module:model/BatchExecutionSummary
27 | * @class
28 | */
29 | constructor() {
30 | }
31 |
32 | /**
33 | * Constructs a BatchExecutionSummary from a plain JavaScript object, optionally creating a new instance.
34 | * Copies all relevant properties from data to obj if supplied or a new instance if not.
35 | * @param {Object} data The plain JavaScript object bearing properties of interest.
36 | * @param {module:model/BatchExecutionSummary} obj Optional instance to populate.
37 | * @return {module:model/BatchExecutionSummary} The populated BatchExecutionSummary instance.
38 | */
39 | static constructFromObject(data, obj) {
40 | if (data) {
41 | obj = obj || new BatchExecutionSummary();
42 | if (data.hasOwnProperty('total'))
43 | obj.total = ApiClient.convertToType(data['total'], 'Number');
44 | if (data.hasOwnProperty('success'))
45 | obj.success = ApiClient.convertToType(data['success'], 'Number');
46 | if (data.hasOwnProperty('error'))
47 | obj.error = ApiClient.convertToType(data['error'], 'Number');
48 | }
49 | return obj;
50 | }
51 | }
52 |
53 | /**
54 | * The total number of order lines present in the payload.
55 | * @member {Number} total
56 | */
57 | BatchExecutionSummary.prototype.total = undefined;
58 |
59 | /**
60 | * The number of order lines that were successfully placed without any errors.
61 | * @member {Number} success
62 | */
63 | BatchExecutionSummary.prototype.success = undefined;
64 |
65 | /**
66 | * The number of order lines that encountered errors during processing, despite their payloads being valid.
67 | * @member {Number} error
68 | */
69 | BatchExecutionSummary.prototype.error = undefined;
70 |
71 |
--------------------------------------------------------------------------------
/package.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "upstox-js-sdk",
3 | "version": "2.21.0",
4 | "description": "The official Node Js client for communicating with the Upstox API",
5 | "license": "MIT",
6 | "main": "dist/index.js",
7 | "homepage": "https://github.com/upstox/upstox-nodejs#readme",
8 | "scripts": {
9 | "build": "babel src --out-dir dist && shx mkdir -p dist/feeder/proto/ && shx cp src/feeder/proto/*.proto dist/feeder/proto/",
10 | "test": "mocha --require @babel/register --recursive",
11 | "dev-publish-local": "yalc publish",
12 | "dev-push-local": "yalc push",
13 | "dev-release": "npm run build && npm run dev-publish-local && npm run dev-push-local"
14 | },
15 | "keywords": [
16 | "Upstox",
17 | "Share",
18 | "market",
19 | "trading",
20 | "UpstoxAPI"
21 | ],
22 | "browser": {
23 | "fs": false
24 | },
25 | "repository": {
26 | "type": "git",
27 | "url": "git@github.com:upstox/upstox-nodejs.git"
28 | },
29 | "bugs": {
30 | "url": "https://github.com/upstox/upstox-nodejs/issues"
31 | },
32 | "dependencies": {
33 | "@babel/cli": "^7.0.0",
34 | "@babel/traverse": "^7.23.2",
35 | "axios": "^1.7.9",
36 | "minimatch": "^3.0.5",
37 | "nanoid": "^3.1.31",
38 | "protobufjs": "^7.2.6",
39 | "superagent": "^5.3.0",
40 | "uuid4": "^2.0.3",
41 | "ws": "^8.16.0"
42 | },
43 | "devDependencies": {
44 | "@babel/core": "^7.0.0",
45 | "@babel/plugin-proposal-class-properties": "^7.0.0",
46 | "@babel/plugin-proposal-decorators": "^7.0.0",
47 | "@babel/plugin-proposal-do-expressions": "^7.0.0",
48 | "@babel/plugin-proposal-export-default-from": "^7.0.0",
49 | "@babel/plugin-proposal-export-namespace-from": "^7.0.0",
50 | "@babel/plugin-proposal-function-bind": "^7.0.0",
51 | "@babel/plugin-proposal-function-sent": "^7.0.0",
52 | "@babel/plugin-proposal-json-strings": "^7.0.0",
53 | "@babel/plugin-proposal-logical-assignment-operators": "^7.0.0",
54 | "@babel/plugin-proposal-nullish-coalescing-operator": "^7.0.0",
55 | "@babel/plugin-proposal-numeric-separator": "^7.0.0",
56 | "@babel/plugin-proposal-optional-chaining": "^7.0.0",
57 | "@babel/plugin-proposal-pipeline-operator": "^7.0.0",
58 | "@babel/plugin-proposal-throw-expressions": "^7.0.0",
59 | "@babel/plugin-syntax-dynamic-import": "^7.0.0",
60 | "@babel/plugin-syntax-import-meta": "^7.0.0",
61 | "@babel/preset-env": "^7.0.0",
62 | "@babel/register": "^7.0.0",
63 | "expect.js": "^0.3.1",
64 | "mocha": "^10.3.0",
65 | "shx": "^0.3.4",
66 | "sinon": "^7.2.0"
67 | }
68 | }
69 |
--------------------------------------------------------------------------------