Get Fund And Margin

API to retrieve user funds data for both the equity and commodity markets, including data such as the margin utilized by the user, the available margin for trading, and the total payin amount during the day.

Request

curl --location 'https://api.upstox.com/v2/user/get-funds-and-margin' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {your_access_token}'

Additional samples in various languages are available in the Sample Code section on this page.

Query Parameters

Name	Required	Type	Description
segment	false	string	Determines the market segment related to the transaction. Without a specified segment in the request, the response will encompass results for both commodities and equities. Possible values: for Equity use SEC, for Commodity use COM

Responses

• 200
• 4XX

---

Response Body

{
  "status": "success",
  "data": {
    "equity": {
      "used_margin": 0.8,
      "payin_amount": 200.0,
      "span_margin": 0.0,
      "adhoc_margin": 0.0,
      "notional_cash": 0.0,
      "available_margin": 15507.46,
      "exposure_margin": 0.0
    },
    "commodity": {
      "used_margin": 0,
      "payin_amount": 0,
      "span_margin": 0,
      "adhoc_margin": 0,
      "notional_cash": 0,
      "available_margin": 0,
      "exposure_margin": 0
    }
  }
}

Name	Type	Description
status	string	A string indicating the outcome of the request. Typically success for successful operations.
data	object	Response data for Balance
data.used_margin	float	Positive values denote the amount blocked into an Open order or position. Negative value denotes the amount being released.
data.payin_amount	float	Instant payin will reflect here
data.span_margin	float	Amount blocked on futures and options towards SPAN
data.adhoc_margin	float	Payin amount credited through a manual process
data.notional_cash	float	The amount maintained for withdrawal
data.available_margin	float	Total margin available for trading
data.exposure_margin	float	Amount blocked on futures and options towards Exposure

Error codes

Error code	Description
UDAPI100072	The Funds service is accessible from 5:30 AM to 12:00 AM IST daily - Thrown when an funds API is called between midnight and 5:30 AM in the morning.

Sample Code

Python

import requests

url = 'https://api.upstox.com/v2/user/get-funds-and-margin'

headers = {
    'Content-Type': 'application/json',
    'Accept': 'application/json',
    'Authorization': 'Bearer {your_access_token}'
}

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

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

Node.js

const axios = require('axios');

const url = 'https://api.upstox.com/v2/user/get-funds-and-margin';

const headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'Bearer {your_access_token}'
};

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

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/user/get-funds-and-margin";
        String acceptHeader = "application/json";
        String authorizationHeader = "Bearer {your_access_token}";

        HttpClient httpClient = HttpClient.newHttpClient();

        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create(url))
                .header("Content-Type", "application/json")
                .header("Accept", acceptHeader)
                .header("Authorization", authorizationHeader)
                .GET()
                .build();

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

            System.out.println("Status Code: " + response.statusCode());
            System.out.println("Response Body: " + response.body());
        } catch (Exception e) {
            System.err.println("Error: " + e.getMessage());
        }
    }
}

PHP

<?php

$url = 'https://api.upstox.com/v2/user/get-funds-and-margin';
$acceptHeader = 'application/json';
$authorizationHeader = 'Bearer {your_access_token}';

$ch = curl_init($url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, array(
    'Content-Type: application/json',
    'Accept: ' . $acceptHeader,
    'Authorization: ' . $authorizationHeader,
));

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

curl_close($ch);

echo "Status Code: " . $status_code . PHP_EOL;
echo "Response Body: " . $response . PHP_EOL;

?>

Python SDK

import upstox_client
from upstox_client.rest import ApiException

configuration = upstox_client.Configuration()
configuration.access_token = '{your_access_token}'
api_version = '2.0'

api_instance = upstox_client.UserApi(upstox_client.ApiClient(configuration))

try:
    # Get User Fund And Margin
    api_response = api_instance.get_user_fund_margin(api_version)
    print(api_response)
except ApiException as e:
    print("Exception when calling UserApi->get_user_fund_margin: %s\n" % e)

Node.js SDK

let UpstoxClient = require('upstox-js-sdk');
let defaultClient = UpstoxClient.ApiClient.instance;
var OAUTH2 = defaultClient.authentications['OAUTH2'];
OAUTH2.accessToken = "{your_access_token}";
let apiInstance = new UpstoxClient.UserApi();
let apiVersion = "2.0"; 

apiInstance.getUserFundMargin(apiVersion, null, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + JSON.stringify(data));
  }
});

Java SDK

import com.upstox.ApiClient;
import com.upstox.ApiException;
import com.upstox.Configuration;
import com.upstox.api.GetUserFundMarginResponse;
import com.upstox.auth.*;
import io.swagger.client.api.UserApi;
public class Main {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        OAuth OAUTH2 = (OAuth) defaultClient.getAuthentication("OAUTH2");
        OAUTH2.setAccessToken("{your_access_token}");

        UserApi apiInstance = new UserApi();
        String apiVersion = "2.0"; // String | API Version Header
        String segment = ""; 
        try {
            GetUserFundMarginResponse result = apiInstance.getUserFundMargin(apiVersion, segment);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserApi#getUserFundMargin");
            e.printStackTrace();
        }
    }
}

Loading...