com.factset.sdk.FactSetFundamentals.api.CompanyReportsApi Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of factsetfundamentals Show documentation
Show all versions of factsetfundamentals Show documentation
FactSet SDK for Java - factsetfundamentals
package com.factset.sdk.FactSetFundamentals.api;
import com.factset.sdk.FactSetFundamentals.ApiException;
import com.factset.sdk.FactSetFundamentals.ApiClient;
import com.factset.sdk.FactSetFundamentals.ApiResponse;
import com.factset.sdk.FactSetFundamentals.Configuration;
import com.factset.sdk.FactSetFundamentals.Pair;
import jakarta.ws.rs.core.GenericType;
import java.util.HashMap;
import java.util.Map;
import java.util.Objects;
import com.factset.sdk.FactSetFundamentals.models.CompanyFundamentalsResponse;
import com.factset.sdk.FactSetFundamentals.models.ErrorResponse;
import com.factset.sdk.FactSetFundamentals.models.FinancialResponse;
import com.factset.sdk.FactSetFundamentals.models.ProfileResponse;
@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen")
public class CompanyReportsApi {
private ApiClient apiClient;
public CompanyReportsApi() {
this(Configuration.getDefaultApiClient());
}
public CompanyReportsApi(ApiClient apiClient) {
this.apiClient = apiClient;
}
private static final Map getFdsProfilesResponseTypeMap = new HashMap();
static {
getFdsProfilesResponseTypeMap.put(200, new GenericType(){});
getFdsProfilesResponseTypeMap.put(400, new GenericType(){});
getFdsProfilesResponseTypeMap.put(401, new GenericType(){});
getFdsProfilesResponseTypeMap.put(403, new GenericType(){});
getFdsProfilesResponseTypeMap.put(500, new GenericType(){});
}
private static final Map getFundamentalsResponseTypeMap = new HashMap();
static {
getFundamentalsResponseTypeMap.put(200, new GenericType(){});
getFundamentalsResponseTypeMap.put(400, new GenericType(){});
getFundamentalsResponseTypeMap.put(401, new GenericType(){});
getFundamentalsResponseTypeMap.put(403, new GenericType(){});
getFundamentalsResponseTypeMap.put(500, new GenericType(){});
}
/**
* Get the API client
*
* @return API client
*/
public ApiClient getApiClient() {
return apiClient;
}
/**
* Set the API client
*
* @param apiClient an instance of API client
*/
public void setApiClient(ApiClient apiClient) {
this.apiClient = apiClient;
}
/**
* Returns company profile information for a specified list of identifiers.
* Retrieves a comprehensive overview of key profile details and information of specified list of identifiers. The response includes the company name, address, industry, sector, number of employees, CEO, business summary, exchange, market capitalization, shares outstanding, P/E ratio, year founded, and other details. All values provided in the response are absolute.
* @param ids The requested list of security identifiers. Accepted ID types include Market Tickers, SEDOL, ISINs, CUSIPs, or FactSet Permanent Ids. <p>***ids limit** = 50 per request*</p> (required)
* @return ProfileResponse
* @throws ApiException if fails to make API call
* @http.response.details
Status Code Description Response Headers 200 Profile data items - 400 Bad Request. This can occur for several reasons. Please review the \"message\" for more details. - 401 Unauthenticated USERNAME-SERIAL. Ensure you are logged in and have successfully generated an API KEY for the IP range you are connecting from. For more help, select the **Report Issue** in the top right corner of this Developer Portal specification card and choose Connectivity 401 or 403 Responses. - 403 The USERNAME-SERIAL attempted to request the endpoint is not authorized to access. The request was legal, but the server is refusing to respond. Please reach out to FactSet Account Team for assistance with authorization. - 500 Internal Server Error. -
*/
public ProfileResponse getFdsProfiles(java.util.List ids) throws ApiException {
return getFdsProfilesWithHttpInfo(ids).getData();
}
/**
* Returns company profile information for a specified list of identifiers.
* Retrieves a comprehensive overview of key profile details and information of specified list of identifiers. The response includes the company name, address, industry, sector, number of employees, CEO, business summary, exchange, market capitalization, shares outstanding, P/E ratio, year founded, and other details. All values provided in the response are absolute.
* @param ids The requested list of security identifiers. Accepted ID types include Market Tickers, SEDOL, ISINs, CUSIPs, or FactSet Permanent Ids. <p>***ids limit** = 50 per request*</p> (required)
* @return ApiResponse<ProfileResponse>
* @throws ApiException if fails to make API call
* @http.response.details
Status Code Description Response Headers 200 Profile data items - 400 Bad Request. This can occur for several reasons. Please review the \"message\" for more details. - 401 Unauthenticated USERNAME-SERIAL. Ensure you are logged in and have successfully generated an API KEY for the IP range you are connecting from. For more help, select the **Report Issue** in the top right corner of this Developer Portal specification card and choose Connectivity 401 or 403 Responses. - 403 The USERNAME-SERIAL attempted to request the endpoint is not authorized to access. The request was legal, but the server is refusing to respond. Please reach out to FactSet Account Team for assistance with authorization. - 500 Internal Server Error. -
*/
public ApiResponse getFdsProfilesWithHttpInfo(java.util.List ids) throws ApiException {
Object localVarPostBody = null;
// verify the required parameter 'ids' is set
if (ids == null) {
throw new ApiException(400, "Missing the required parameter 'ids' when calling getFdsProfiles");
}
// create path and map variables
String localVarPath = "/company-reports/profile";
// query params
java.util.List localVarQueryParams = new java.util.ArrayList();
java.util.Map localVarHeaderParams = new java.util.HashMap();
java.util.Map localVarCookieParams = new java.util.HashMap();
java.util.Map localVarFormParams = new java.util.HashMap();
localVarQueryParams.addAll(apiClient.parameterToPairs("csv", "ids", ids));
final String[] localVarAccepts = {
"application/json"
};
final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts);
final String[] localVarContentTypes = {
};
final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes);
String[] localVarAuthNames = new String[] { "FactSetApiKey", "FactSetOAuth2", "FactSetOAuth2Client" };
ApiResponse<
ProfileResponse
> apiResponse = apiClient.invokeAPI("CompanyReportsApi.getFdsProfiles", localVarPath, "GET", localVarQueryParams, localVarPostBody,
localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType,
localVarAuthNames, getFdsProfilesResponseTypeMap, false);
return apiResponse;
}
/**
* Returns company fundamentals for a given list of identifiers.
* Returns detailed insights on specified publicly traded company's various key financial measures or fundamentals like cash per share, dividend, EPS, EBIT etc. All values provided in the response are absolute.
* @param ids The requested list of security identifiers. Accepted ID types include Market Tickers, SEDOL, ISINs, CUSIPs, or FactSet Permanent Ids. <p>***ids limit** = 50 per request*</p> (required)
* @return CompanyFundamentalsResponse
* @throws ApiException if fails to make API call
* @http.response.details
Status Code Description Response Headers 200 Fundamental data items - 400 Bad Request. This can occur for several reasons. Please review the \"message\" for more details. - 401 Unauthenticated USERNAME-SERIAL. Ensure you are logged in and have successfully generated an API KEY for the IP range you are connecting from. For more help, select the **Report Issue** in the top right corner of this Developer Portal specification card and choose Connectivity 401 or 403 Responses. - 403 The USERNAME-SERIAL attempted to request the endpoint is not authorized to access. The request was legal, but the server is refusing to respond. Please reach out to FactSet Account Team for assistance with authorization. - 500 Internal Server Error. -
*/
public CompanyFundamentalsResponse getFundamentals(java.util.List ids) throws ApiException {
return getFundamentalsWithHttpInfo(ids).getData();
}
/**
* Returns company fundamentals for a given list of identifiers.
* Returns detailed insights on specified publicly traded company's various key financial measures or fundamentals like cash per share, dividend, EPS, EBIT etc. All values provided in the response are absolute.
* @param ids The requested list of security identifiers. Accepted ID types include Market Tickers, SEDOL, ISINs, CUSIPs, or FactSet Permanent Ids. <p>***ids limit** = 50 per request*</p> (required)
* @return ApiResponse<CompanyFundamentalsResponse>
* @throws ApiException if fails to make API call
* @http.response.details
Status Code Description Response Headers 200 Fundamental data items - 400 Bad Request. This can occur for several reasons. Please review the \"message\" for more details. - 401 Unauthenticated USERNAME-SERIAL. Ensure you are logged in and have successfully generated an API KEY for the IP range you are connecting from. For more help, select the **Report Issue** in the top right corner of this Developer Portal specification card and choose Connectivity 401 or 403 Responses. - 403 The USERNAME-SERIAL attempted to request the endpoint is not authorized to access. The request was legal, but the server is refusing to respond. Please reach out to FactSet Account Team for assistance with authorization. - 500 Internal Server Error. -
*/
public ApiResponse getFundamentalsWithHttpInfo(java.util.List ids) throws ApiException {
Object localVarPostBody = null;
// verify the required parameter 'ids' is set
if (ids == null) {
throw new ApiException(400, "Missing the required parameter 'ids' when calling getFundamentals");
}
// create path and map variables
String localVarPath = "/company-reports/fundamentals";
// query params
java.util.List localVarQueryParams = new java.util.ArrayList();
java.util.Map localVarHeaderParams = new java.util.HashMap();
java.util.Map localVarCookieParams = new java.util.HashMap();
java.util.Map localVarFormParams = new java.util.HashMap();
localVarQueryParams.addAll(apiClient.parameterToPairs("csv", "ids", ids));
final String[] localVarAccepts = {
"application/json"
};
final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts);
final String[] localVarContentTypes = {
};
final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes);
String[] localVarAuthNames = new String[] { "FactSetApiKey", "FactSetOAuth2", "FactSetOAuth2Client" };
ApiResponse<
CompanyFundamentalsResponse
> apiResponse = apiClient.invokeAPI("CompanyReportsApi.getFundamentals", localVarPath, "GET", localVarQueryParams, localVarPostBody,
localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType,
localVarAuthNames, getFundamentalsResponseTypeMap, false);
return apiResponse;
}
}