Get Company Profile
API to retrieve the company profile for a given ISIN. The response includes a business description, sector classification, and sector market capitalisation in both INR and USD.
Path Parameters
| Name | Required | Type | Description |
|---|---|---|---|
| isin | true | string | International Securities Identification Number (ISIN) of the company. Example: INE002A01018. |
Request
curl --location 'https://api.upstox.com/v2/fundamentals/INE002A01018/profile' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {your_access_token}'
For additional samples in various languages, please refer to the Sample code section on this page.
Responses
- 200
- 4XX
Response Body
{
"status": "success",
"data": {
"company_profile": "Reliance Industries Limited is engaged in the activities of hydrocarbon exploration and production, petroleum refining and marketing, petrochemicals, advanced materials and composites, renewables, retail and digital services.",
"sector": "Refineries",
"sector_market_cap_inr": {
"value": 1942866.05,
"unit": "crore",
"formatted": "1,942,866.05 Cr"
},
"sector_market_cap_usd": {
"value": 215.87,
"unit": "billion",
"formatted": "$215.87B"
}
}
}
| Name | Type | Description |
|---|---|---|
| status | string | A string indicating the outcome of the request. Possible values: success, error. |
| data.company_profile | string | Detailed business description of the company. |
| data.sector | string | The sector to which the company belongs. |
| data.sector_market_cap_inr | object | Total market capitalisation of the sector in Indian Rupees. |
| data.sector_market_cap_inr.value | number | Numeric market cap value in Crore. |
| data.sector_market_cap_inr.unit | string | Unit of the value. Value: crore. |
| data.sector_market_cap_inr.formatted | string | Human-readable formatted value, e.g., "1,942,866.05 Cr". |
| data.sector_market_cap_usd | object | Total market capitalisation of the sector in US Dollars. |
| data.sector_market_cap_usd.value | number | Numeric market cap value in the specified unit. |
| data.sector_market_cap_usd.unit | string | Unit of the value. Possible values: billion, million. |
| data.sector_market_cap_usd.formatted | string | Human-readable formatted value, e.g., "$215.87B". |
Error codes
| Error code | Description |
|---|---|
| UDAPI1206 | Invalid ISIN - The provided ISIN is invalid. |
Sample Code
- Python
- Node.js
- Java
- PHP
import requests
url = 'https://api.upstox.com/v2/fundamentals/INE002A01018/profile'
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {your_access_token}'
}
response = requests.get(url, headers=headers)
print(response.json())
const axios = require('axios');
axios.get('https://api.upstox.com/v2/fundamentals/INE002A01018/profile', {
headers: {
'Accept': 'application/json',
'Authorization': 'Bearer {your_access_token}'
}
}).then(response => console.log(response.data))
.catch(error => console.error('Error:', error));
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
public class GetCompanyProfile {
public static void main(String[] args) throws Exception {
HttpRequest request = HttpRequest.newBuilder()
.uri(new URI("https://api.upstox.com/v2/fundamentals/INE002A01018/profile"))
.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());
}
}
<?php
$url = 'https://api.upstox.com/v2/fundamentals/INE002A01018/profile';
$headers = [
'Accept: application/json',
'Authorization: Bearer {your_access_token}'
];
$ch = curl_init($url);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_errno($ch) ? print('Error: ' . curl_error($ch)) : print($response);
curl_close($ch);
?>
Loading...