Skip to main content

Prerequisites

Before using the Upstox SDK, you need to complete two key steps:

1. Procuring API Credentials​

To access the Upstox API, you must create an app and obtain an API Key and API Secret. Follow the instructions in the official Upstox documentation to create an app and retrieve your credentials:

🔗 Upstox API App Creation Guide

2. Setting Up Your Development Environment​

Depending on your preferred programming language, follow the setup process below to prepare your environment for SDK integration.

Python Environment Setup​

  1. Install Python (if not installed) – Download and install from python.org.
  2. Set up a Virtual Environment (Recommended): 
    python -m venv upstox_env
    source upstox_env/bin/activate  # Mac/Linux
    upstox_env\Scripts\activate     # Windows
  3. Ensure pip is up to date: 
    python -m pip install --upgrade pip
  4. Proceed to SDK installation in the next section

Node.js Environment Setup​

  1. Install Node.js – Download and install from nodejs.org.
  2. Verify installation: 
    node -v
    npm -v
  3. Initialize a new Node.js project (optional but recommended): 
    mkdir upstox-sdk && cd upstox-sdk
    npm init -y
  4. Proceed to SDK installation in the next section

Java Environment Setup​

  1. Install Java (JDK 11 or later) – Download from Adoptium or Oracle.
  2. Set up environment variables (if needed):
    • Add JAVA_HOME to your system variables
    • Ensure java and javac are accessible via CLI: 
      java -version
      javac -version
  3. Set up Maven or Gradle (Recommended for dependency management):
  4. Proceed to SDK installation in the next section

PHP Environment Setup​

  1. Install PHP – Download and install from php.net.
  2. Verify PHP installation: 
    php -v
  3. Install Composer (Dependency Manager for PHP):
    • Download and install from getcomposer.org.
    • Verify installation: 
      composer -v
  4. Proceed to SDK installation in the next section

With your development environment set up, you’re now ready to install and integrate the Upstox SDK in your chosen language! 🚀