Upstox Developer API

https://upstox.com/developer/api-documentation/
Admin
Upstox Developer API is a comprehensive REST API platform for building trading and investment...
Tokens:650,391
Snippets:3,260
Trust Score:10
Update:5 days ago
Show doc for...
Tokens:
Raw
### Manual setup: Clone repository and install Python dependency

Source: https://upstox.com/developer/api-documentation/agent-skills

Clone the upstox-skills repository and install the upstox-python-sdk dependency. Then point your agent at the skills/upstox/SKILL.md entry point.

```bash
git clone https://github.com/upstox/upstox-skills.git
cd upstox-skills
pip install upstox-python-sdk
```

--------------------------------

### Java sample for Get Payins

Source: https://upstox.com/developer/api-documentation/get-user-payins

Java example using java.net.http to fetch pay-in transactions. Requires an access token.

```java
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Main {
    public static void main(String[] args) throws Exception {
        HttpRequest req = HttpRequest.newBuilder()
                .uri(URI.create("https://api.upstox.com/v2/user/payments/payin"))
                .header("accept", "application/json")
                .header("Authorization", "Bearer {your_access_token}")
                .GET()
                .build();
        System.out.println(HttpClient.newHttpClient().send(req, HttpResponse.BodyHandlers.ofString()).body());
    }
}
```

--------------------------------

### Python sample for Get Payins

Source: https://upstox.com/developer/api-documentation/get-user-payins

Python example using the requests library to fetch pay-in transactions. Requires an access token.

```python
import requests

url = 'https://api.upstox.com/v2/user/payments/payin'
headers = {
    'accept': 'application/json',
    'Authorization': 'Bearer {your_access_token}',
}
print(requests.get(url, headers=headers).json())
```

--------------------------------

### PHP sample for Get Payins

Source: https://upstox.com/developer/api-documentation/get-user-payins

PHP example using cURL to fetch pay-in transactions. Requires an access token.

```php
<?php
$url = 'https://api.upstox.com/v2/user/payments/payin';
$ch = curl_init($url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'accept: application/json',
    'Authorization: Bearer {your_access_token}',
]);
echo curl_exec($ch);
curl_close($ch);
```

--------------------------------

### Node.js sample for Get Payins

Source: https://upstox.com/developer/api-documentation/get-user-payins

Node.js example using axios to fetch pay-in transactions. Requires an access token.

```javascript
const axios = require('axios');
axios.get('https://api.upstox.com/v2/user/payments/payin', {
  headers: {
    accept: 'application/json',
    Authorization: 'Bearer {your_access_token}',
  },
}).then(r => console.log(r.data));
```

--------------------------------

### Get Brokerage for Equity Futures and Options Intraday with Python requests

Source: https://upstox.com/developer/api-documentation/get-brokerage

Python example using the requests library to call the Get Brokerage API with product 'I' for equity futures and options intraday orders. Replace {your_access_token} with a valid access token.

```python
import requests

url = 'https://api.upstox.com/v2/charges/brokerage'
headers = {
    'Content-Type': 'application/json',
    'Accept': 'application/json',
    'Authorization': 'Bearer {your_access_token}'
}

params = {
    'instrument_token': 'NSE_FO|35271',
    'quantity': '10',
    'product': 'I',
    'transaction_type': 'BUY',
    'price': '1400'
}

response = requests.get(url, headers=headers, params=params)

print(response.status_code)
print(response.json())
```

--------------------------------

### Initialize a new Node.js project

Source: https://upstox.com/developer/api-documentation/prerequisites-for-an-sdk

Creates a directory 'upstox-sdk', changes into it, and initializes a new Node.js project with npm.

```bash
mkdir upstox-sdk && cd upstox-sdk
npm init -y
```

--------------------------------

### Get Brokerage with PHP cURL

Source: https://upstox.com/developer/api-documentation/get-brokerage

PHP example using cURL to call the Upstox Get Brokerage API. Replace {your_access_token} with a valid access token. The example builds the query string with http_build_query and prints the HTTP response code and body.

```php
<?php
$url = 'https://api.upstox.com/v2/charges/brokerage';
$accessToken = '{your_access_token}'; // Replace {your_access_token} with your actual access token

// Construct URL with parameters
$params = http_build_query([
    'instrument_token' => 'NSE_FO|35271',
    'quantity' => '10',
    'product' => 'D',
    'transaction_type' => 'BUY',
    'price' => '1400',
]);

$fullUrl = $url . '?' . $params;

// Set headers
$headers = [
    'Content-Type: application/json',
    'Accept: application/json',
    'Authorization: Bearer ' . $accessToken,
];

// Initialize cURL session
$ch = curl_init($fullUrl);

// Set cURL options
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

// Execute cURL session and get the response
$response = curl_exec($ch);

// Get HTTP response code
$httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);

// Close cURL session
curl_close($ch);

// Print response code and body
echo "Response Code: $httpCode\n";
echo "Response: $response\n";

?>
```

--------------------------------

### curl request for Get Competitors

Source: https://upstox.com/developer/api-documentation/get-competitors

Example curl command to call the Get Competitors API. Requires an access token in the Authorization header.

```bash
curl --location 'https://api.upstox.com/v2/fundamentals/INE002A01018/competitors' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {your_access_token}'
```

--------------------------------

### PHP SDK: MarketDataStreamerV3 setup and event loop

Source: https://upstox.com/developer/api-documentation/streamer-function

Configures the Upstox client with an access token, creates a MarketDataStreamerV3 instance with instrument keys and mode 'full', registers a message callback, connects, and runs the event loop.

```php
use Upstox\Client\Configuration;
use Upstox\Client\Feeder\MarketDataStreamerV3;
use Revolt\EventLoop;

function on_message($streamer, $data)
{
    print($data);
}

$config = Configuration::getDefaultConfiguration()->setAccessToken(<ACCESS_TOKEN>);

$streamer = new MarketDataStreamerV3($config, ["NSE_INDEX|Nifty 50", "NSE_INDEX|Nifty Bank"], "full");

$streamer->on("message", 'on_message');
$streamer->connect();

EventLoop::run();
```

--------------------------------

### curl request for Get Trades

Source: https://upstox.com/developer/api-documentation/get-trade-history

Example curl command to call the Get Trades API. Requires a valid access token in the Authorization header.

```bash
curl --location 'https://api.upstox.com/v2/order/trades/get-trades-for-day' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {your_access_token}'
```

--------------------------------

### curl request to get user profile

Source: https://upstox.com/developer/api-documentation/get-profile

Example curl command to call the Get Profile API. Requires a valid access token in the Authorization header.

```bash
curl --location 'https://api.upstox.com/v2/user/profile' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {your_access_token}'
```

--------------------------------

### Java SDK: MarketDataStreamerV3 setup and listener

Source: https://upstox.com/developer/api-documentation/streamer-function

Sets up the default API client, adds instrument keys, sets the OAuth access token, creates a MarketDataStreamerV3 with Mode.FULL, and registers a listener to print market updates.

```java
public class MarketFeederTest {
    public static void main(String[] args) throws ApiException {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        Set<String> instrumentKeys = new HashSet<>();
        instrumentKeys.add("NSE_INDEX|Nifty 50");
        instrumentKeys.add("NSE_INDEX|Nifty Bank");

        OAuth oAuth = (OAuth) defaultClient.getAuthentication("OAUTH2");
        oAuth.setAccessToken(<ACESS_TOKEN>);

        final MarketDataStreamerV3 marketDataStreamer = new MarketDataStreamerV3(defaultClient, instrumentKeys, Mode.FULL);

        marketDataStreamer.setOnMarketUpdateListener(new OnMarketUpdateV3Listener() {

            @Override
            public void onUpdate(MarketUpdateV3 marketUpdate) {
                System.out.println(marketUpdate);
            }
        });

        marketDataStreamer.connect();
    }
}
```

--------------------------------

### Usage Example: Subscribing to Market Data on Connection Open (PHP)

Source: https://upstox.com/developer/api-documentation/streamer-function

PHP SDK example demonstrating how to connect, subscribe to instrument keys, and handle incoming messages.

```APIDOC
## PHP SDK Example

### Description
Subscribes to market data upon connection open and prints incoming messages.

### Code
```bash
use Upstox\Client\Configuration;
use Upstox\Client\Feeder\MarketDataStreamerV3;
use Revolt\EventLoop;

function on_open($streamer)
{
    print("Connection Established");
    $streamer->subscribe(["NSE_INDEX|Nifty 50", "NSE_INDEX|Nifty Bank"], "full");
}

function on_message($streamer, $data)
{
    print($data);
}

$config = Configuration::getDefaultConfiguration()->setAccessToken(<ACCESS_TOKEN>);

$streamer = new MarketDataStreamerV3($config);

$streamer->on("open", 'on_open');
$streamer->on("message", 'on_message');
$streamer->connect();

EventLoop::run();
```
```

--------------------------------

### Usage Example: Subscribing to Market Data on Connection Open (Java)

Source: https://upstox.com/developer/api-documentation/streamer-function

Java SDK example demonstrating how to connect, subscribe to instrument keys, and handle incoming messages.

```APIDOC
## Java SDK Example

### Description
Subscribes to market data upon connection open and prints incoming messages.

### Code
```java
public class MarketFeederTest {
    public static void main(String[] args) throws ApiException {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        OAuth oAuth = (OAuth) defaultClient.getAuthentication("OAUTH2");
        oAuth.setAccessToken(<ACCESS_TOKEN>);

        final MarketDataStreamerV3 marketDataStreamer = new MarketDataStreamerV3(defaultClient);

        marketDataStreamer.setOnOpenListener(new OnOpenListener() {

            @Override
            public void onOpen() {
                System.out.println("Connection Established");

                Set<String> instrumentKeys = new HashSet<>();
                instrumentKeys.add("NSE_INDEX|Nifty 50");
                instrumentKeys.add("NSE_INDEX|Nifty Bank");

                marketDataStreamer.subscribe(instrumentKeys, Mode.FULL);

            }
        });

        marketDataStreamer.setOnMarketUpdateListener(new OnMarketUpdateV3Listener() {

            @Override
            public void onUpdate(MarketUpdateV3 marketUpdate) {
                System.out.println(marketUpdate);
            }
        });

        marketDataStreamer.connect();
    }
}
```
```

--------------------------------

### Get Profit Loss Report - cURL Example

Source: https://upstox.com/developer/api-documentation/get-profit-and-loss-report

Example cURL command to fetch the profit loss report with query parameters. Replace {your_access_token} with a valid access token.

```bash
curl --location 'https://api.upstox.com/v2/trade/profit-loss/data?from_date=05-11-2023&to_date=19-12-2023&segment=EQ&financial_year=2324&page_number=1&page_size=4' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {your_access_token}'
```

--------------------------------

### Initialize Sandbox Client

Source: https://upstox.com/developer/api-documentation/agent-skills

Configure the client for sandbox testing to avoid using real money.

```python
Configuration(sandbox=True)
```

--------------------------------

### Java HttpURLConnection example to get report meta data

Source: https://upstox.com/developer/api-documentation/example-code/trade-profit-and-loss/get-report-meta-data

Uses HttpURLConnection to send a GET request with URL-encoded query parameters. Prints the response code and response body.

```java
import java.io.BufferedReader;
import java.io.InputStreamReader;
import java.net.HttpURLConnection;
import java.net.URL;
import java.net.URLEncoder;

public class Main {
    public static void main(String[] args) throws Exception {
        String url = "https://api.upstox.com/v2/trade/profit-loss/metadata";
        String acceptHeader = "application/json";
        String authToken = "Bearer {your_access_token}";

        String fromDate = "05-11-2023";
        String toDate = "19-12-2023";
        String segment = "FO";
        String financialYear = "2324";

        String encodedParams = String.format("from_date=%s&to_date=%s&segment=%s&financial_year=%s",
                URLEncoder.encode(fromDate, "UTF-8"),
                URLEncoder.encode(toDate, "UTF-8"),
                URLEncoder.encode(segment, "UTF-8"),
                URLEncoder.encode(financialYear, "UTF-8"));

        String fullUrl = url + "?" + encodedParams;

        URL obj = new URL(fullUrl);
        HttpURLConnection connection = (HttpURLConnection) obj.openConnection();

        // Set request method
        connection.setRequestMethod("GET");

        connection.setRequestProperty("Accept", acceptHeader);
        connection.setRequestProperty("Authorization", authToken);

        int responseCode = connection.getResponseCode();

        System.out.println("Sending 'GET' request to URL: " + fullUrl);
        System.out.println("Response Code: " + responseCode);

        BufferedReader in = new BufferedReader(new InputStreamReader(connection.getInputStream()));
        String inputLine;
        StringBuilder response = new StringBuilder();

        while ((inputLine = in.readLine()) != null) {
            response.append(inputLine);
        }
        in.close();

        // Print the response
        System.out.println("Response: " + response.toString());
    }
}
```

--------------------------------

### Usage Example: Subscribing to Market Data on Connection Open (Python)

Source: https://upstox.com/developer/api-documentation/streamer-function

Python SDK example demonstrating how to connect, subscribe to instrument keys, and handle incoming messages.

```APIDOC
## Python SDK Example

### Description
Subscribes to market data upon connection open and prints incoming messages.

### Code
```python
import upstox_client

def main():
    configuration = upstox_client.Configuration()
    access_token = <ACCESS_TOKEN>
    configuration.access_token = access_token

    streamer = upstox_client.MarketDataStreamerV3(
        upstox_client.ApiClient(configuration))

    def on_open():
        streamer.subscribe(
            ["NSE_EQ|INE020B01018", "NSE_EQ|INE467B01029"], "full")

    def on_message(message):
        print(message)

    streamer.on("open", on_open)
    streamer.on("message", on_message)

    streamer.connect()

if __name__ == "__main__":
    main()
```
```

--------------------------------

### Get Expiries using Java HttpClient

Source: https://upstox.com/developer/api-documentation/example-code/expired-instruments/get-expiries

Java example using java.net.http.HttpClient to call the Get Expiries endpoint. It prints the response body on success or an error message on failure.

```java
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Main {

    public static void main(String[] args) {
        String url = "https://api.upstox.com/v2/expired-instruments/expiries?instrument_key=NSE_INDEX%7CNifty%2050";

        HttpClient httpClient = HttpClient.newHttpClient();
        HttpRequest httpRequest = HttpRequest.newBuilder()
                .uri(URI.create(url))
                .header("Authorization", "Bearer {your_access_token}")
                .header("Accept", "application/json")
                .build();

        try {
            HttpResponse<String> httpResponse = httpClient.send(httpRequest, HttpResponse.BodyHandlers.ofString());

            // Check the response status
            if (httpResponse.statusCode() == 200) {
                // Do something with the response body (e.g., print it)
                System.out.println(httpResponse.body());
            } else {
                // Print an error message if the request was not successful
                System.err.println("Error: " + httpResponse.statusCode() + " - " + httpResponse.body());
            }
        } catch (Exception e) {
            // Handle exceptions
            e.printStackTrace();
        }
    }
}
```

--------------------------------

### Python SDK: MarketDataStreamerV3 setup and message handling

Source: https://upstox.com/developer/api-documentation/streamer-function

Sets up the Upstox client with an access token, creates a MarketDataStreamerV3 instance with instrument keys and mode 'full', and connects to receive market updates. The on_message callback prints each message.

```python
import upstox_client

def on_message(message):
    print(message)

def main():
    configuration = upstox_client.Configuration()
    access_token = <ACCESS_TOKEN>
    configuration.access_token = access_token

    streamer = upstox_client.MarketDataStreamerV3(
        upstox_client.ApiClient(configuration), ["NSE_INDEX|Nifty 50", "NSE_INDEX|Nifty Bank"], "full")

    streamer.on("message", on_message)

    streamer.connect()

if __name__ == "__main__":
    main()
```

--------------------------------

### Get Expiries using Node.js axios

Source: https://upstox.com/developer/api-documentation/example-code/expired-instruments/get-expiries

Node.js example using axios to call the Get Expiries endpoint. It logs the response data on success or an error message on failure.

```javascript
const axios = require('axios');

const url = 'https://api.upstox.com/v2/expired-instruments/expiries?instrument_key=NSE_INDEX%7CNifty%2050';
const headers = {
    'Authorization': 'Bearer {your_access_token}',
    'Accept': 'application/json'
};

axios.get(url, { headers })
    .then(response => {
        // Do something with the response data (e.g., print it)
        console.log(response.data);
    })
    .catch(error => {
        // Print an error message if the request was not successful
        console.error(`Error: ${error.response.status} - ${error.response.data}`);
    });
```

--------------------------------

### Get IPO Order Details - cURL Example

Source: https://upstox.com/developer/api-documentation/get-ipo-order-details

Example cURL command to retrieve IPO order details for a specific application ID. Replace {your_access_token} with a valid access token.

```bash
curl --location 'https://api.upstox.com/v2/ipos/orders/UPROYAL00000003' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {your_access_token}'
```

--------------------------------

### Install and use Upstox Agent Skills

Source: https://upstox.com/developer/api-documentation/api-overview

This shell tour shows how to install the Upstox skill pack, authenticate with an access token, and interact with your agent to place an order. The skill includes guardrails like order confirmation and LIMIT-by-default pricing.

```bash
# 1. Install the skill pack
$ npx skills add upstox/upstox-skills --skill upstox
✓ installed (10 references · 10 examples)

# 2. Authenticate once
$ export UPSTOX_ACCESS_TOKEN="<your-daily-token>"

# 3. Talk to your agent
> "Buy 10 SBIN at 820, intraday"
✓ Order summary shown — awaiting your confirmation
```

--------------------------------

### Usage Example: Subscribing to Market Data on Connection Open (Node.js)

Source: https://upstox.com/developer/api-documentation/streamer-function

Node.js SDK example demonstrating how to connect, subscribe to instrument keys, and handle incoming messages.

```APIDOC
## Node.js SDK Example

### Description
Subscribes to market data upon connection open and logs incoming messages.

### Code
```javascript
let UpstoxClient = require("upstox-js-sdk");
let defaultClient = UpstoxClient.ApiClient.instance;
var OAUTH2 = defaultClient.authentications["OAUTH2"];
OAUTH2.accessToken = <ACCESS_TOKEN>;

const streamer = new UpstoxClient.MarketDataStreamerV3();
streamer.connect();

// Subscribe to instrument keys upon the 'open' event
streamer.on("open", () => {
  streamer.subscribe(["NSE_EQ|INE020B01018", "NSE_EQ|INE467B01029"], "full");
});

// Handle incoming market data messages
streamer.on("message", (data) => {
  const feed = data.toString("utf-8");
  console.log(feed);
});
```
```

--------------------------------

### Node.js axios example to get report meta data

Source: https://upstox.com/developer/api-documentation/example-code/trade-profit-and-loss/get-report-meta-data

Uses axios to send a GET request with headers and query parameters. Logs the response status and data, and handles errors.

```javascript
const axios = require('axios');

const url = 'https://api.upstox.com/v2/trade/profit-loss/metadata';
const headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {your_access_token}'
};

const params = {
  'from_date': '05-11-2023',
  'to_date': '19-12-2023',
  'segment': 'FO',
  'financial_year': '2324'
};

axios.get(url, { headers, params })
  .then(response => {
    console.log(response.status);
    console.log(response.data);
  })
  .catch(error => {
    console.error('Error:', error.message || error);
  });
```

--------------------------------

### Python requests example to get report meta data

Source: https://upstox.com/developer/api-documentation/example-code/trade-profit-and-loss/get-report-meta-data

Uses the requests library to make a GET request with query parameters. Prints the HTTP status code and JSON response.

```python
import requests

url = 'https://api.upstox.com/v2/trade/profit-loss/metadata'
headers = {
    'Accept': 'application/json',
    'Authorization': 'Bearer {your_access_token}'
}

params = {
    'from_date': '05-11-2023',
    'to_date': '19-12-2023',
    'segment': 'FO',
    'financial_year': '2324'
}

response = requests.get(url, headers=headers, params=params)

print(response.status_code)
print(response.json())
```

--------------------------------

### Java sample code

Source: https://upstox.com/developer/api-documentation/get-corporate-actions

Java example using HttpClient to fetch corporate actions. Prints the response body.

```java
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class GetCorporateActions {
    public static void main(String[] args) throws Exception {
        HttpRequest request = HttpRequest.newBuilder()
                .uri(new URI("https://api.upstox.com/v2/fundamentals/INE002A01018/corporate-actions"))
                .header("Accept", "application/json")
                .header("Authorization", "Bearer {your_access_token}")
                .GET()
                .build();
        HttpClient client = HttpClient.newHttpClient();
        HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.body());
    }
}
```

--------------------------------

### Node.js axios example to get profit loss report

Source: https://upstox.com/developer/api-documentation/example-code/trade-profit-and-loss/get-profit-loss-report

Uses axios to make a GET request to the Upstox API. Logs the status and data, and handles errors. Requires an access token.

```javascript
const axios = require('axios');

const url = 'https://api.upstox.com/v2/trade/profit-loss/data';
const headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {your_access_token}'
};

const params = {
  'from_date': '05-11-2023',
  'to_date': '19-12-2023',
  'segment': 'FO',
  'financial_year': '2324',
  'page_number': '1',
  'page_size': '4'
};

axios.get(url, { headers, params })
  .then(response => {
    console.log(response.status);
    console.log(response.data);
  })
  .catch(error => {
    console.error('Error:', error.message || error);
  });
```

--------------------------------

### Java sample code for key ratios

Source: https://upstox.com/developer/api-documentation/get-key-ratios

Java example using java.net.http.HttpClient to call the key-ratios endpoint. Prints the response body. Requires Java 11+ and a valid access token.

```java
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class GetKeyRatios {
    public static void main(String[] args) throws Exception {
        HttpRequest request = HttpRequest.newBuilder()
                .uri(new URI("https://api.upstox.com/v2/fundamentals/INE002A01018/key-ratios"))
                .header("Accept", "application/json")
                .header("Authorization", "Bearer {your_access_token}")
                .GET()
                .build();
        HttpClient client = HttpClient.newHttpClient();
        HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.body());
    }
}
```

--------------------------------

### Java HttpURLConnection example to get profit loss report

Source: https://upstox.com/developer/api-documentation/example-code/trade-profit-and-loss/get-profit-loss-report

Uses HttpURLConnection to send a GET request with URL-encoded query parameters. Prints the response code and response body. Requires an access token.

```java
import java.io.BufferedReader;
import java.io.InputStreamReader;
import java.net.HttpURLConnection;
import java.net.URL;
import java.net.URLEncoder;

public class Main {
    public static void main(String[] args) throws Exception {
        String url = "https://api.upstox.com/v2/trade/profit-loss/data";
        String acceptHeader = "application/json";
        String authToken = "Bearer {your_access_token}";

        String fromDate = "05-11-2023";
        String toDate = "19-12-2023";
        String segment = "FO";
        String financialYear = "2324";
        String pageNumber = "1";
        String pageSize = "4";

        String encodedParams = String.format("from_date=%s&to_date=%s&segment=%s&financial_year=%s&page_number=%s&page_size=%s",
                URLEncoder.encode(fromDate, "UTF-8"),
                URLEncoder.encode(toDate, "UTF-8"),
                URLEncoder.encode(segment, "UTF-8"),
                URLEncoder.encode(financialYear, "UTF-8"),
                URLEncoder.encode(pageNumber, "UTF-8"),
                URLEncoder.encode(pageSize, "UTF-8"));

        String fullUrl = url + "?" + encodedParams;

        URL obj = new URL(fullUrl);
        HttpURLConnection connection = (HttpURLConnection) obj.openConnection();

        // Set request method
        connection.setRequestMethod("GET");

        connection.setRequestProperty("Accept", acceptHeader);
        connection.setRequestProperty("Authorization", authToken);

        int responseCode = connection.getResponseCode();

        System.out.println("Sending 'GET' request to URL: " + fullUrl);
        System.out.println("Response Code: " + responseCode);

        BufferedReader in = new BufferedReader(new InputStreamReader(connection.getInputStream()));
        String inputLine;
        StringBuilder response = new StringBuilder();

        while ((inputLine = in.readLine()) != null) {
            response.append(inputLine);
        }
        in.close();

        // Print the response
        System.out.println("Response: " + response.toString());
    }
}
```

--------------------------------

### Node.js SDK: MarketDataStreamerV3 setup and message handling

Source: https://upstox.com/developer/api-documentation/streamer-function

Configures the Upstox client with an access token, creates a MarketDataStreamerV3 instance with instrument keys and mode 'full', connects, and logs incoming messages as UTF-8 strings.

```javascript
let UpstoxClient = require("upstox-js-sdk");
let defaultClient = UpstoxClient.ApiClient.instance;
var OAUTH2 = defaultClient.authentications["OAUTH2"];
OAUTH2.accessToken = <ACCESS_TOKEN>;

const streamer = new UpstoxClient.MarketDataStreamerV3(["MCX_FO|426268", "MCX_FO|427608"], "full");
streamer.connect();

streamer.on("message", (data) => {
  const feed = data.toString("utf-8");
  console.log(feed);
});
```

--------------------------------

### Python requests example to get profit loss report

Source: https://upstox.com/developer/api-documentation/example-code/trade-profit-and-loss/get-profit-loss-report

Uses the requests library to send a GET request to the Upstox API. Prints the status code and JSON response. Requires an access token.

```python
import requests

url = 'https://api.upstox.com/v2/trade/profit-loss/data'
headers = {
    'Accept': 'application/json',
    'Authorization': 'Bearer {your_access_token}'
}

params = {
    'from_date': '05-11-2023',
    'to_date': '19-12-2023',
    'segment': 'FO',
    'financial_year': '2324',
    'page_number': '1',
    'page_size': '4'
}

response = requests.get(url, headers=headers, params=params)

print(response.status_code)
print(response.json())
```

--------------------------------

### Place order using Python

Source: https://upstox.com/developer/api-documentation/example-code/orders/place-order

This Python example uses the requests library to send a POST request to the order placement endpoint.

```python
import requests

url = 'https://api-hft.upstox.com/v2/order/place'
headers = {
    'Content-Type': 'application/json',
    'Accept': 'application/json',
    'Authorization': 'Bearer {your_access_token}',
}

data = {
    'quantity': 1,
    'product': 'I',
    'validity': 'DAY',
    'price': 0.0,
    'tag': 'string',
    'instrument_token': 'NSE_EQ|INE528G01035',
    'order_type': 'SL-M',
    'transaction_type': 'BUY',
    'disclosed_quantity': 0,
    'trigger_price': 21.5,
    'is_amo': False,
}

try:
    # Send the POST request
    response = requests.post(url, json=data, headers=headers)

    # Print the response status code and body
    print('Response Code:', response.status_code)
    print('Response Body:', response.json())

except Exception as e:
    # Handle exceptions
    print('Error:', str(e))
```

--------------------------------

### PHP cURL example to get report meta data

Source: https://upstox.com/developer/api-documentation/example-code/trade-profit-and-loss/get-report-meta-data

Uses cURL in PHP to send a GET request with query parameters. Outputs the full URL, HTTP response code, and response body.

```php
<?php

$url = 'https://api.upstox.com/v2/trade/profit-loss/metadata';
$acceptHeader = 'application/json';
$authToken = 'Bearer {your_access_token}';

$fromDate = '05-11-2023';
$toDate = '19-12-2023';
$segment = 'FO';
$financialYear = '2324';

$params = [
    'from_date' => $fromDate,
    'to_date' => $toDate,
    'segment' => $segment,
    'financial_year' => $financialYear
];

$encodedParams = http_build_query($params);
$fullUrl = $url . '?' . $encodedParams;

$headers = [
    'Accept: ' . $acceptHeader,
    'Authorization: ' . $authToken,
];

$ch = curl_init($fullUrl);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$response = curl_exec($ch);
$httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);

curl_close($ch);

echo 'URL: ' . $fullUrl . PHP_EOL;
echo 'Response Code: ' . $httpCode . PHP_EOL;
echo 'Response: ' . $response . PHP_EOL;
?>
```

--------------------------------

### Node.js axios example to get brokerage details

Source: https://upstox.com/developer/api-documentation/example-code/charges/brokerage-details

Node.js script using axios to fetch brokerage details. It sends a GET request with headers and query parameters, then logs the response data or error.

```javascript
const axios = require('axios');

const url = 'https://api.upstox.com/v2/charges/brokerage';
const headers = {
    'Accept': 'application/json',
    'Authorization': 'Bearer {your_access_token}'
};

const params = {
    instrument_token: 'NSE_EQ|INE669E01016',
    quantity: '10',
    product: 'I',
    transaction_type: 'BUY',
    price: '13.7'
};

axios.get(url, { headers, params })
    .then(response => {
        console.log(response.data);
    })
    .catch(error => {
        console.error(error.message);
    });
```

--------------------------------

### Connect to PortfolioDataStreamer (PHP)

Source: https://upstox.com/developer/api-documentation/streamer-function

Basic PHP example to connect to the Portfolio WebSocket and print incoming data. Requires an access token and the Upstox PHP SDK.

```php
use Upstox\Client\Configuration;
use Upstox\Client\Feeder\PortfolioDataStreamer;
use Revolt\EventLoop;

function on_message($streamer, $data)
{
    print($data);
}

$config = Configuration::getDefaultConfiguration()->setAccessToken(<ACCESS_TOKEN>);

$streamer = new PortfolioDataStreamer($config);

$streamer->on("message", 'on_message');
$streamer->connect();

EventLoop::run();
```

--------------------------------

### Connect to PortfolioDataStreamer (Java)

Source: https://upstox.com/developer/api-documentation/streamer-function

Basic Java example to connect to the Portfolio WebSocket and print order updates. Requires an access token and the Upstox Java SDK.

```java
public class PortfolioFeederTest {
    public static void main(String[] args) throws ApiException {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        OAuth oAuth = (OAuth) defaultClient.getAuthentication("OAUTH2");
        oAuth.setAccessToken(<ACCESS_TOKEN>);

        final PortfolioDataStreamer portfolioDataStreamer = new PortfolioDataStreamer(defaultClient);

        portfolioDataStreamer.setOnOrderUpdateListener(new OnOrderUpdateListener() {

            @Override
            public void onUpdate(OrderUpdate orderUpdate) {
                System.out.println(orderUpdate);

            }
        });

        portfolioDataStreamer.connect();
    }
}
```

--------------------------------

### PHP cURL example to get profit loss report

Source: https://upstox.com/developer/api-documentation/example-code/trade-profit-and-loss/get-profit-loss-report

Uses cURL in PHP to send a GET request with query parameters. Prints the URL, response code, and response body. Requires an access token.

```php
<?php

$url = 'https://api.upstox.com/v2/trade/profit-loss/data';
$acceptHeader = 'application/json';
$authToken = 'Bearer {your_access_token}';

$fromDate = '05-11-2023';
$toDate = '19-12-2023';
$segment = 'FO';
$financialYear = '2324';
$pageNumber = '1';
$pageSize = '4';

$params = [
    'from_date' => $fromDate,
    'to_date' => $toDate,
    'segment' => $segment,
    'financial_year' => $financialYear,
    'page_number' => $pageNumber,
    'page_size' => $pageSize,
];

$encodedParams = http_build_query($params);
$fullUrl = $url . '?' . $encodedParams;

$headers = [
    'Accept: ' . $acceptHeader,
    'Authorization: ' . $authToken,
];

$ch = curl_init($fullUrl);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$response = curl_exec($ch);
$httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);

curl_close($ch);

echo 'URL: ' . $fullUrl . PHP_EOL;
echo 'Response Code: ' . $httpCode . PHP_EOL;
echo 'Response: ' . $response . PHP_EOL;
?>
```

--------------------------------

### Python sample code for key ratios

Source: https://upstox.com/developer/api-documentation/get-key-ratios

Python example using the requests library to call the key-ratios endpoint. Prints the JSON response. Requires the requests library and a valid access token.

```python
import requests

url = 'https://api.upstox.com/v2/fundamentals/INE002A01018/key-ratios'
headers = {
    'Accept': 'application/json',
    'Authorization': 'Bearer {your_access_token}'
}

response = requests.get(url, headers=headers)
print(response.json())
```

--------------------------------

### Get Expiries using Python requests

Source: https://upstox.com/developer/api-documentation/example-code/expired-instruments/get-expiries

Python example using the requests library to call the Get Expiries endpoint. It checks the response status and prints the JSON data on success or an error message on failure.

```python
import requests

url = 'https://api.upstox.com/v2/expired-instruments/expiries?instrument_key=NSE_INDEX%7CNifty%2050'
headers = {
    'Authorization': 'Bearer {your_access_token}',
    'Accept': 'application/json'
}

response = requests.get(url, headers=headers)

# Check the response status
if response.status_code == 200:
    # Do something with the response data (e.g., print it)
    print(response.json())
else:
    # Print an error message if the request was not successful
    print(f"Error: {response.status_code} - {response.text}")
```

--------------------------------

### Connect to PortfolioDataStreamer (Python)

Source: https://upstox.com/developer/api-documentation/streamer-function

Basic Python example to connect to the Portfolio WebSocket and print incoming messages. Requires an access token and the upstox_client library.

```python
import upstox_client

def on_message(message):
    print(message)

def main():
    configuration = upstox_client.Configuration()
    access_token = <ACCESS_TOKEN>
    configuration.access_token = access_token

    streamer = upstox_client.PortfolioDataStreamer(
        upstox_client.ApiClient(configuration))

    streamer.on("message", on_message)

    streamer.connect()

if __name__ == "__main__":
    main()
```

--------------------------------

### Get Expiries cURL Request

Source: https://upstox.com/developer/api-documentation/get-expiries

Example cURL command to fetch expiry dates using an instrument key.

```bash
curl --location 'https://api.upstox.com/v2/expired-instruments/expiries?instrument_key=NSE_INDEX%7CNifty%2050' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_access_token}' \
--header 'Accept: application/json'
```
Tokens:
Raw