Download the PHP package upstox/upstox-php-sdk without Composer

On this page you can find all versions of the php package upstox/upstox-php-sdk. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of upstox/upstox-php-sdk

Informations about the package upstox-php-sdk

Upstox PHP SDK for API v2

Latest Stable Version

Introduction

The official PHP client for communicating with the Upstox API.

Upstox API is a set of rest APIs that provide data required to build a complete investment and trading platform. Execute orders in real time, manage user portfolio, stream live market data (using Websocket), and more, with the easy to understand API collection.

This PHP package is automatically generated by the Swagger Codegen project:

Documentation.

Upstox API Documentation

Requirements

PHP 7.4 and later

Installation & Usage

Composer

Run composer require upstox/upstox-php-sdk to install the SDK from Packagist.

Github

Composer Installation

Download the latest release and run composer install

Manual Installation

Download the files and include autoload.php:

Tests

To run the unit tests:

Examples

Sample Implementations can be found within /examples folder.

Documentation for API Endpoints

All URIs are relative to https://api.upstox.com/v2/

Class Method HTTP request Description
ChargeApi getBrokerage GET /v2/charges/brokerage Brokerage details
ChargeApi postMargin POST /v2/charges/margin Calculate Margin
HistoryApi getHistoricalCandleData GET /v2/historical-candle/{instrumentKey}/{interval}/{to_date} Historical candle data
HistoryApi getHistoricalCandleData1 GET /v2/historical-candle/{instrumentKey}/{interval}/{to_date}/{from_date} Historical candle data
HistoryApi getIntraDayCandleData GET /v2/historical-candle/intraday/{instrumentKey}/{interval} Intra day candle data
LoginApi authorize GET /v2/login/authorization/dialog Authorize API
LoginApi logout DELETE /v2/logout Logout
LoginApi token POST /v2/login/authorization/token Get token API
MarketHolidaysAndTimingsApi getExchangeTimings GET /v2/market/timings/{date} Get Exchange Timings on particular date
MarketHolidaysAndTimingsApi getHoliday GET /v2/market/holidays/{date} Get Holiday on particular date
MarketHolidaysAndTimingsApi getHolidays GET /v2/market/holidays Get Holiday list of current year
MarketHolidaysAndTimingsApi getMarketStatus GET /v2/market/status/{exchange} Get Market status for particular exchange
MarketQuoteApi getFullMarketQuote GET /v2/market-quote/quotes Market quotes and instruments - Full market quotes
MarketQuoteApi getMarketQuoteOHLC GET /v2/market-quote/ohlc Market quotes and instruments - OHLC quotes
MarketQuoteApi ltp GET /v2/market-quote/ltp Market quotes and instruments - LTP quotes.
OptionsApi getOptionContracts GET /v2/option/contract Get option contracts
OptionsApi getPutCallOptionChain GET /v2/option/chain Get option chain
OrderApi cancelMultiOrder DELETE /v2/order/multi/cancel Cancel multi order
OrderApi cancelOrder DELETE /v2/order/cancel Cancel order
OrderApi exitPositions POST /v2/order/positions/exit Exit all positions
OrderApi getOrderBook GET /v2/order/retrieve-all Get order book
OrderApi getOrderDetails GET /v2/order/history Get order history
OrderApi getOrderStatus GET /v2/order/details Get order details
OrderApi getTradeHistory GET /v2/order/trades/get-trades-for-day Get trades
OrderApi getTradesByOrder GET /v2/order/trades Get trades for order
OrderApi modifyOrder PUT /v2/order/modify Modify order
OrderApi placeMultiOrder POST /v2/order/multi/place Place multi order
OrderApi placeOrder POST /v2/order/place Place order
PortfolioApi convertPositions PUT /v2/portfolio/convert-position Convert Positions
PortfolioApi getHoldings GET /v2/portfolio/long-term-holdings Get Holdings
PortfolioApi getPositions GET /v2/portfolio/short-term-positions Get Positions
PostTradeApi getTradesByDateRange GET /v2/charges/historical-trades Get historical trades
TradeProfitAndLossApi getProfitAndLossCharges GET /v2/trade/profit-loss/charges Get profit and loss on trades
TradeProfitAndLossApi getTradeWiseProfitAndLossData GET /v2/trade/profit-loss/data Get Trade-wise Profit and Loss Report Data
TradeProfitAndLossApi getTradeWiseProfitAndLossMetaData GET /v2/trade/profit-loss/metadata Get profit and loss meta data on trades
UserApi getProfile GET /v2/user/profile Get profile
UserApi getUserFundMargin GET /v2/user/get-funds-and-margin Get User Fund And Margin
WebsocketApi getMarketDataFeed GET /v2/feed/market-data-feed Market Data Feed
WebsocketApi getMarketDataFeedAuthorize GET /v2/feed/market-data-feed/authorize Market Data Feed Authorize
WebsocketApi getPortfolioStreamFeed GET /v2/feed/portfolio-stream-feed Portfolio Stream Feed
WebsocketApi getPortfolioStreamFeedAuthorize GET /v2/feed/portfolio-stream-feed/authorize Portfolio Stream Feed Authorize

Documentation for Feeder Functions

Connecting to the WebSocket for market and portfolio updates is streamlined through two primary Feeder functions:

  1. MarketDataStreamer: Offers real-time market updates, providing a seamless way to receive instantaneous information on various market instruments.
  2. PortfolioDataStreamer: Delivers updates related to the user's orders, enhancing the ability to track order status and portfolio changes effectively.

Both functions are designed to simplify the process of subscribing to essential data streams, ensuring users have quick and easy access to the information they need.

Detailed Explanation of Feeder Interface

MarketDataStreamer

The MarketDataStreamer interface is designed for effortless connection to the market WebSocket, enabling users to receive instantaneous updates on various instruments. The following example demonstrates how to quickly set up and start receiving market updates for selected instrument keys:

In this example, you first authenticate using an access token, then instantiate MarketDataStreamer with specific instrument keys and a subscription mode. Upon connecting, the streamer listens for market updates, which are logged to the console as they arrive.

Feel free to adjust the access token placeholder and any other specifics to better fit your actual implementation or usage scenario.

Exploring the MarketDataStreamer Functionality

Modes

Functions

  1. constructor MarketDataStreamer(apiClient, instrumentKeys, mode): Initializes the streamer with optional instrument keys and mode (full or ltpc).
  2. connect(): Establishes the WebSocket connection.
  3. subscribe(instrumentKeys, mode): Subscribes to updates for given instrument keys in the specified mode. Both parameters are mandatory.
  4. unsubscribe(instrumentKeys): Stops updates for the specified instrument keys.
  5. changeMode(instrumentKeys, mode): Switches the mode for already subscribed instrument keys.
  6. disconnect(): Ends the active WebSocket connection.
  7. autoReconnect(enable, interval, retryCount): Customizes auto-reconnect functionality. Parameters include a flag to enable/disable it, the interval(in seconds) between attempts, and the maximum number of retries.

Events

The following documentation includes examples to illustrate the usage of these functions and events, providing a practical understanding of how to interact with the MarketDataStreamer effectively.


  1. Subscribing to Market Data on Connection Open with MarketDataStreamer


  1. Subscribing to Instruments with Delays


  1. Subscribing and Unsubscribing to Instruments


  1. Subscribe, Change Mode and Unsubscribe


  1. Disable Auto-Reconnect


  1. Modify Auto-Reconnect parameters


PortfolioDataStreamer

Connecting to the Portfolio WebSocket for real-time order updates is straightforward with the PortfolioDataStreamer function. Below is a concise guide to get you started on receiving updates:


Position and holding updates can be enabled by setting the corresponding flag to true in the constructor of the PortfolioDataStreamer class.


This example demonstrates initializing the PortfolioDataStreamer, connecting it to the WebSocket, and setting up an event listener to receive and print order updates. Replace with your valid access token to authenticate the session.

Exploring the PortfolioDataStreamer Functionality

Functions

  1. constructor PortfolioDataStreamer(): Initializes the streamer.
  2. connect(): Establishes the WebSocket connection.
  3. disconnect(): Ends the active WebSocket connection.
  4. autoReconnect(enable, interval, retryCount): Customizes auto-reconnect functionality. Parameters include a flag to enable/disable it, the interval(in seconds) between attempts, and the maximum number of retries.

Events

Documentation For Models

All versions of upstox-php-sdk with dependencies

PHP Build Version
Package Version
Requires php Version ^7.4 || ^8.0
ext-curl Version *
ext-json Version *
ext-mbstring Version *
guzzlehttp/guzzle Version ^7.3
guzzlehttp/psr7 Version ^1.7 || ^2.0
amphp/amp Version ^3.0
amphp/websocket-client Version ^2.0
ramsey/uuid Version ^4.7
google/protobuf Version ^3.25
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package upstox/upstox-php-sdk contains the following files

Loading the files please wait ....