Important Update to Upstox API Service URL and Header Parameters
Effective Immediately
We are pleased to announce a significant update to the Upstox API Service. This change is part of our ongoing commitment to enhance usability and service efficiency.
What's Changing?
New Base URL: The base URL for accessing the Upstox API has been updated to
https://api.upstox.com/v2
. This change is designed to streamline our API structure for more intuitive access.Simplified Header Requirements: Alongside the new URL, we have updated our header requirements. The 'Api Version' header, previously mandatory and set to 2.0, will no longer be required for API calls to the new URL. This modification reduces the complexity of constructing API requests.
Transition Period
Dual Endpoint Availability: To ensure a seamless transition, both the old URL (
https://api-v2.upstox.com
) and the new URL (https://api.upstox.com/v2
) will be operational for a transitional period. This approach ensures that your existing integrations continue to work without immediate disruption.Recommended Action: While your existing setups using the old URL will continue to function during this phase, we encourage you to migrate to the new URL and updated header configuration as soon as convenient for you.
Migration Steps:
Update the Base URL: Change the base URL in your API integrations from
https://api-v2.upstox.com
tohttps://api.upstox.com/v2
.Remove the 'Api Version' Header: Adjust your API requests to eliminate the 'Api Version' header.
We appreciate your cooperation during this transition and thank you for your continued partnership. Our team is committed to continually enhancing our services to better meet your needs.
Upstox API Documentation
The Upstox API comprises a suite of RESTful APIs designed to supply the necessary data for constructing a comprehensive investment and trading platform. These APIs enable real-time order execution, user portfolio management, live market data streaming via Websockets, and more, all presented in an easily comprehensible API collection.
All requests are transmitted securely via HTTPS, and they are formatted with the 'application/json' content type. All responses are provided in JSON format, except for the instrumental API, which yields a CSV response..
To utilize these APIs, creating an application within the Developer Console is imperative, generating both an apiKey and apiSecret.You need to specify a redirect URL, which will be invoked following the login process with the auth code. Optionally, you can provide a Postback URL where you can receive live updates on order statuses.
For traders, the creation of apps can be accomplished directly from the Upstox mobile app or the desktop platform, accessible from the Apps section within the Account Tab. Head over to create an app. For businesses interested in integrating Upstox APIs, you can contact us, and we will expedite the development of a customized app to meet your specific needs.
It is strongly advised against embedding the apiSecret within your frontend application. Instead, it is recommended to establish a remote backend system responsible for managing the handshake process on behalf of the frontend app. Inadvertently disclosing the apiSecret within the frontend application could render your app susceptible to security threats and potential issues.
We also boast a thriving Upstox developer community that you can tap into to connect with like-minded Upstox API users. Here, you can inquire about API-related questions and engage with the community members.