Skip to main content
GET 

/us/funds

Get Funds

API to retrieve the user's US stocks wallet balance. Amounts are in USD and are read live from the US broker. Each balance also comes as an INR figure at the indicative exchange_rate, for display only.

Use available_to_trade to check how much you can invest. It includes unsettled credit, so it can be higher than available_to_withdraw.

Request​

curl --location 'https://api.upstox.com/v2/us/funds' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {your_access_token}'

For samples in other languages, see the Sample Code section on this page.

Responses​

Response Body​

{
"status": "success",
"data": {
"available_to_trade": 909.45,
"available_to_withdraw": 806.12,
"cash": 909.45,
"unsettled_cash": 103.33,
"exchange_rate": 96.34,
"available_to_trade_inr": 87616.41,
"available_to_withdraw_inr": 77661.60,
"cash_inr": 87616.41,
"unsettled_cash_inr": 9954.81
}
}
NameTypeDescription
statusstringOutcome of the request. Typically success.
dataobjectThe user's US stocks wallet.
data.available_to_tradenumberBuying power in USD. Includes unsettled instant-funding credit.
data.available_to_withdrawnumberSettled cash in USD that can be withdrawn.
data.cashnumberCash in the wallet, in USD.
data.unsettled_cashnumberCash not yet settled: cash minus available_to_withdraw.
data.exchange_ratenumberIndicative USD to INR rate, for display only.
data.available_to_trade_inrnumberavailable_to_trade in INR at exchange_rate. Indicative, for display only.
data.available_to_withdraw_inrnumberavailable_to_withdraw in INR at exchange_rate. Indicative, for display only.
data.cash_inrnumbercash in INR at exchange_rate. Indicative, for display only.
data.unsettled_cash_inrnumberunsettled_cash in INR at exchange_rate. Indicative, for display only.

Sample Code​

Get US stocks funds​

import requests

url = 'https://api.upstox.com/v2/us/funds'
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {your_access_token}',
}

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

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