Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
package com.factset.sdk.FactSetEstimatesReportBuilder.api;
import com.factset.sdk.FactSetEstimatesReportBuilder.ApiException;
import com.factset.sdk.FactSetEstimatesReportBuilder.ApiClient;
import com.factset.sdk.FactSetEstimatesReportBuilder.ApiResponse;
import com.factset.sdk.FactSetEstimatesReportBuilder.Configuration;
import com.factset.sdk.FactSetEstimatesReportBuilder.Pair;
import jakarta.ws.rs.core.GenericType;
import java.util.HashMap;
import java.util.Map;
import java.util.Objects;
import com.factset.sdk.FactSetEstimatesReportBuilder.models.ErrorResponse;
import com.factset.sdk.FactSetEstimatesReportBuilder.models.Response;
@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen")
public class AllEstimatesApi {
private ApiClient apiClient;
public AllEstimatesApi() {
this(Configuration.getDefaultApiClient());
}
public AllEstimatesApi(ApiClient apiClient) {
this.apiClient = apiClient;
}
private static final Map getEstimatesBalanceSheetResponseTypeMap = new HashMap();
static {
getEstimatesBalanceSheetResponseTypeMap.put(200, new GenericType(){});
getEstimatesBalanceSheetResponseTypeMap.put(400, new GenericType(){});
getEstimatesBalanceSheetResponseTypeMap.put(403, new GenericType(){});
getEstimatesBalanceSheetResponseTypeMap.put(404, new GenericType(){});
getEstimatesBalanceSheetResponseTypeMap.put(500, new GenericType(){});
}
private static final Map getEstimatesCashFlowResponseTypeMap = new HashMap();
static {
getEstimatesCashFlowResponseTypeMap.put(200, new GenericType(){});
getEstimatesCashFlowResponseTypeMap.put(400, new GenericType(){});
getEstimatesCashFlowResponseTypeMap.put(403, new GenericType(){});
getEstimatesCashFlowResponseTypeMap.put(404, new GenericType(){});
getEstimatesCashFlowResponseTypeMap.put(500, new GenericType(){});
}
private static final Map getEstimatesGeographicSegmentsResponseTypeMap = new HashMap();
static {
getEstimatesGeographicSegmentsResponseTypeMap.put(200, new GenericType(){});
getEstimatesGeographicSegmentsResponseTypeMap.put(400, new GenericType(){});
getEstimatesGeographicSegmentsResponseTypeMap.put(403, new GenericType(){});
getEstimatesGeographicSegmentsResponseTypeMap.put(404, new GenericType(){});
getEstimatesGeographicSegmentsResponseTypeMap.put(500, new GenericType(){});
}
private static final Map getEstimatesIncomeStatementResponseTypeMap = new HashMap();
static {
getEstimatesIncomeStatementResponseTypeMap.put(200, new GenericType(){});
getEstimatesIncomeStatementResponseTypeMap.put(400, new GenericType(){});
getEstimatesIncomeStatementResponseTypeMap.put(403, new GenericType(){});
getEstimatesIncomeStatementResponseTypeMap.put(404, new GenericType(){});
getEstimatesIncomeStatementResponseTypeMap.put(500, new GenericType(){});
}
private static final Map getEstimatesIndustryMetricsResponseTypeMap = new HashMap();
static {
getEstimatesIndustryMetricsResponseTypeMap.put(200, new GenericType(){});
getEstimatesIndustryMetricsResponseTypeMap.put(400, new GenericType(){});
getEstimatesIndustryMetricsResponseTypeMap.put(403, new GenericType(){});
getEstimatesIndustryMetricsResponseTypeMap.put(404, new GenericType(){});
getEstimatesIndustryMetricsResponseTypeMap.put(500, new GenericType(){});
}
private static final Map getEstimatesPerShareResponseTypeMap = new HashMap();
static {
getEstimatesPerShareResponseTypeMap.put(200, new GenericType(){});
getEstimatesPerShareResponseTypeMap.put(400, new GenericType(){});
getEstimatesPerShareResponseTypeMap.put(403, new GenericType(){});
getEstimatesPerShareResponseTypeMap.put(404, new GenericType(){});
getEstimatesPerShareResponseTypeMap.put(500, new GenericType(){});
}
private static final Map getEstimatesProductSegmentsResponseTypeMap = new HashMap();
static {
getEstimatesProductSegmentsResponseTypeMap.put(200, new GenericType(){});
getEstimatesProductSegmentsResponseTypeMap.put(400, new GenericType(){});
getEstimatesProductSegmentsResponseTypeMap.put(403, new GenericType(){});
getEstimatesProductSegmentsResponseTypeMap.put(404, new GenericType(){});
getEstimatesProductSegmentsResponseTypeMap.put(500, new GenericType(){});
}
private static final Map getEstimatesValuationResponseTypeMap = new HashMap();
static {
getEstimatesValuationResponseTypeMap.put(200, new GenericType(){});
getEstimatesValuationResponseTypeMap.put(400, new GenericType(){});
getEstimatesValuationResponseTypeMap.put(403, new GenericType(){});
getEstimatesValuationResponseTypeMap.put(404, new GenericType(){});
getEstimatesValuationResponseTypeMap.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;
}
/**
* Balance Sheet
* Returns historical and future period broker estimate consensus in a statement format for Balance Sheet line items.
* @param id Company Ticker (required)
* @param periodicity Periodicity or frequency of the fiscal periods. (optional, default to ANN)
* @param schema The schema that the data is returned as. The following are descriptions for the accepted values: - table_group_level - STACH 2.0 row organized package format with parent-child relationships represented using STACH group level cell metadata - table_parent_child_columns - STACH 2.0 row organized package format with parent-child relationships represented using STACH parent-child columns (optional, default to table_parent_child_columns)
* @return Response
* @throws ApiException if fails to make API call
* @http.response.details
Status Code
Description
Response Headers
200
Expected response; returns JSON data containing STACH 2.0 row organized package format
* X-DataDirect-Request-Key - FactSet request ID * Api-Supported-Versions - Supported API versions (semantic versioning) * Api-Version - API version (semantic versioning)
400
Bad Request. For further assistance, file an issue under \"Workflow & Throttling - 400 or 429 Response\" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.
* X-DataDirect-Request-Key - FactSet request ID * Api-Supported-Versions - Supported API versions (semantic versioning) * Api-Version - API version (semantic versioning)
401
Missing or invalid authentication. Ensure you are logged in and have successfully generated an API KEY for the IP range you are connecting from. For further assistance, file an issue under \"Connectivty - 401 or 403 Responses\" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.
* X-DataDirect-Request-Key - FactSet request ID
403
User is forbidden access with current credentials. Reach out to your local FactSet Account Manager for assistance, or file an issue under \"Connectivty - 401 or 403 Responses\" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.
* X-DataDirect-Request-Key - FactSet request ID
404
Not found. For further assistance, file an issue under \"Performance - 404 and 500 Responses\" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.
* X-DataDirect-Request-Key - FactSet request ID
429
Too many requests - this API is rate-limited to 20 requests per second. For further assistance, file an issue under \"Workflow & Throttling - 400 or 429 Response\" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.
* X-DataDirect-Request-Key - FactSet request ID
500
Server error. For further assistance, file an issue under \"Performance - 404 and 500 Responses\" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.
* X-DataDirect-Request-Key - FactSet request ID
503
Service unavailable. Typically a timeout, or result of a rejected request to prevent service overload. For further assistance, file an issue under \"Performance - 404 and 500 Responses\" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.
* X-DataDirect-Request-Key - FactSet request ID
*/
public Response getEstimatesBalanceSheet(String id, String periodicity, String schema) throws ApiException {
return getEstimatesBalanceSheetWithHttpInfo(id, periodicity, schema).getData();
}
/**
* Balance Sheet
* Returns historical and future period broker estimate consensus in a statement format for Balance Sheet line items.
* @param id Company Ticker (required)
* @param periodicity Periodicity or frequency of the fiscal periods. (optional, default to ANN)
* @param schema The schema that the data is returned as. The following are descriptions for the accepted values: - table_group_level - STACH 2.0 row organized package format with parent-child relationships represented using STACH group level cell metadata - table_parent_child_columns - STACH 2.0 row organized package format with parent-child relationships represented using STACH parent-child columns (optional, default to table_parent_child_columns)
* @return ApiResponse<Response>
* @throws ApiException if fails to make API call
* @http.response.details
Status Code
Description
Response Headers
200
Expected response; returns JSON data containing STACH 2.0 row organized package format
* X-DataDirect-Request-Key - FactSet request ID * Api-Supported-Versions - Supported API versions (semantic versioning) * Api-Version - API version (semantic versioning)
400
Bad Request. For further assistance, file an issue under \"Workflow & Throttling - 400 or 429 Response\" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.
* X-DataDirect-Request-Key - FactSet request ID * Api-Supported-Versions - Supported API versions (semantic versioning) * Api-Version - API version (semantic versioning)
401
Missing or invalid authentication. Ensure you are logged in and have successfully generated an API KEY for the IP range you are connecting from. For further assistance, file an issue under \"Connectivty - 401 or 403 Responses\" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.
* X-DataDirect-Request-Key - FactSet request ID
403
User is forbidden access with current credentials. Reach out to your local FactSet Account Manager for assistance, or file an issue under \"Connectivty - 401 or 403 Responses\" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.
* X-DataDirect-Request-Key - FactSet request ID
404
Not found. For further assistance, file an issue under \"Performance - 404 and 500 Responses\" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.
* X-DataDirect-Request-Key - FactSet request ID
429
Too many requests - this API is rate-limited to 20 requests per second. For further assistance, file an issue under \"Workflow & Throttling - 400 or 429 Response\" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.
* X-DataDirect-Request-Key - FactSet request ID
500
Server error. For further assistance, file an issue under \"Performance - 404 and 500 Responses\" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.
* X-DataDirect-Request-Key - FactSet request ID
503
Service unavailable. Typically a timeout, or result of a rejected request to prevent service overload. For further assistance, file an issue under \"Performance - 404 and 500 Responses\" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.
* X-DataDirect-Request-Key - FactSet request ID
*/
public ApiResponse getEstimatesBalanceSheetWithHttpInfo(String id, String periodicity, String schema) throws ApiException {
Object localVarPostBody = null;
// verify the required parameter 'id' is set
if (id == null) {
throw new ApiException(400, "Missing the required parameter 'id' when calling getEstimatesBalanceSheet");
}
// create path and map variables
String localVarPath = "/balance-sheet";
// 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("", "id", id));
localVarQueryParams.addAll(apiClient.parameterToPairs("", "periodicity", periodicity));
localVarQueryParams.addAll(apiClient.parameterToPairs("", "schema", schema));
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<
Response
> apiResponse = apiClient.invokeAPI("AllEstimatesApi.getEstimatesBalanceSheet", localVarPath, "GET", localVarQueryParams, localVarPostBody,
localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType,
localVarAuthNames, getEstimatesBalanceSheetResponseTypeMap, false);
return apiResponse;
}
/**
* Cash Flow
* Returns historical and future period broker estimate consensus in a statement format for Cash Flow line items.
* @param id Company Ticker (required)
* @param periodicity Periodicity or frequency of the fiscal periods. (optional, default to ANN)
* @param schema The schema that the data is returned as. The following are descriptions for the accepted values: - table_group_level - STACH 2.0 row organized package format with parent-child relationships represented using STACH group level cell metadata - table_parent_child_columns - STACH 2.0 row organized package format with parent-child relationships represented using STACH parent-child columns (optional, default to table_parent_child_columns)
* @return Response
* @throws ApiException if fails to make API call
* @http.response.details
Status Code
Description
Response Headers
200
Expected response; returns JSON data containing STACH 2.0 row organized package format
* X-DataDirect-Request-Key - FactSet request ID * Api-Supported-Versions - Supported API versions (semantic versioning) * Api-Version - API version (semantic versioning)
400
Bad Request. For further assistance, file an issue under \"Workflow & Throttling - 400 or 429 Response\" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.
* X-DataDirect-Request-Key - FactSet request ID * Api-Supported-Versions - Supported API versions (semantic versioning) * Api-Version - API version (semantic versioning)
401
Missing or invalid authentication. Ensure you are logged in and have successfully generated an API KEY for the IP range you are connecting from. For further assistance, file an issue under \"Connectivty - 401 or 403 Responses\" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.
* X-DataDirect-Request-Key - FactSet request ID
403
User is forbidden access with current credentials. Reach out to your local FactSet Account Manager for assistance, or file an issue under \"Connectivty - 401 or 403 Responses\" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.
* X-DataDirect-Request-Key - FactSet request ID
404
Not found. For further assistance, file an issue under \"Performance - 404 and 500 Responses\" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.
* X-DataDirect-Request-Key - FactSet request ID
429
Too many requests - this API is rate-limited to 20 requests per second. For further assistance, file an issue under \"Workflow & Throttling - 400 or 429 Response\" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.
* X-DataDirect-Request-Key - FactSet request ID
500
Server error. For further assistance, file an issue under \"Performance - 404 and 500 Responses\" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.
* X-DataDirect-Request-Key - FactSet request ID
503
Service unavailable. Typically a timeout, or result of a rejected request to prevent service overload. For further assistance, file an issue under \"Performance - 404 and 500 Responses\" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.
* X-DataDirect-Request-Key - FactSet request ID
*/
public Response getEstimatesCashFlow(String id, String periodicity, String schema) throws ApiException {
return getEstimatesCashFlowWithHttpInfo(id, periodicity, schema).getData();
}
/**
* Cash Flow
* Returns historical and future period broker estimate consensus in a statement format for Cash Flow line items.
* @param id Company Ticker (required)
* @param periodicity Periodicity or frequency of the fiscal periods. (optional, default to ANN)
* @param schema The schema that the data is returned as. The following are descriptions for the accepted values: - table_group_level - STACH 2.0 row organized package format with parent-child relationships represented using STACH group level cell metadata - table_parent_child_columns - STACH 2.0 row organized package format with parent-child relationships represented using STACH parent-child columns (optional, default to table_parent_child_columns)
* @return ApiResponse<Response>
* @throws ApiException if fails to make API call
* @http.response.details
Status Code
Description
Response Headers
200
Expected response; returns JSON data containing STACH 2.0 row organized package format
* X-DataDirect-Request-Key - FactSet request ID * Api-Supported-Versions - Supported API versions (semantic versioning) * Api-Version - API version (semantic versioning)
400
Bad Request. For further assistance, file an issue under \"Workflow & Throttling - 400 or 429 Response\" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.
* X-DataDirect-Request-Key - FactSet request ID * Api-Supported-Versions - Supported API versions (semantic versioning) * Api-Version - API version (semantic versioning)
401
Missing or invalid authentication. Ensure you are logged in and have successfully generated an API KEY for the IP range you are connecting from. For further assistance, file an issue under \"Connectivty - 401 or 403 Responses\" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.
* X-DataDirect-Request-Key - FactSet request ID
403
User is forbidden access with current credentials. Reach out to your local FactSet Account Manager for assistance, or file an issue under \"Connectivty - 401 or 403 Responses\" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.
* X-DataDirect-Request-Key - FactSet request ID
404
Not found. For further assistance, file an issue under \"Performance - 404 and 500 Responses\" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.
* X-DataDirect-Request-Key - FactSet request ID
429
Too many requests - this API is rate-limited to 20 requests per second. For further assistance, file an issue under \"Workflow & Throttling - 400 or 429 Response\" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.
* X-DataDirect-Request-Key - FactSet request ID
500
Server error. For further assistance, file an issue under \"Performance - 404 and 500 Responses\" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.
* X-DataDirect-Request-Key - FactSet request ID
503
Service unavailable. Typically a timeout, or result of a rejected request to prevent service overload. For further assistance, file an issue under \"Performance - 404 and 500 Responses\" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.
* X-DataDirect-Request-Key - FactSet request ID
*/
public ApiResponse getEstimatesCashFlowWithHttpInfo(String id, String periodicity, String schema) throws ApiException {
Object localVarPostBody = null;
// verify the required parameter 'id' is set
if (id == null) {
throw new ApiException(400, "Missing the required parameter 'id' when calling getEstimatesCashFlow");
}
// create path and map variables
String localVarPath = "/cash-flow";
// 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("", "id", id));
localVarQueryParams.addAll(apiClient.parameterToPairs("", "periodicity", periodicity));
localVarQueryParams.addAll(apiClient.parameterToPairs("", "schema", schema));
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<
Response
> apiResponse = apiClient.invokeAPI("AllEstimatesApi.getEstimatesCashFlow", localVarPath, "GET", localVarQueryParams, localVarPostBody,
localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType,
localVarAuthNames, getEstimatesCashFlowResponseTypeMap, false);
return apiResponse;
}
/**
* Geographic Segments
* Returns historical and future period broker estimate consensus in a statement format for line items broken down geographically.
* @param id Company Ticker (required)
* @param periodicity Periodicity or frequency of the fiscal periods. (optional, default to ANN)
* @param schema The schema that the data is returned as. The following are descriptions for the accepted values: - table_group_level - STACH 2.0 row organized package format with parent-child relationships represented using STACH group level cell metadata - table_parent_child_columns - STACH 2.0 row organized package format with parent-child relationships represented using STACH parent-child columns (optional, default to table_parent_child_columns)
* @return Response
* @throws ApiException if fails to make API call
* @http.response.details
Status Code
Description
Response Headers
200
Expected response; returns JSON data containing STACH 2.0 row organized package format
* X-DataDirect-Request-Key - FactSet request ID * Api-Supported-Versions - Supported API versions (semantic versioning) * Api-Version - API version (semantic versioning)
400
Bad Request. For further assistance, file an issue under \"Workflow & Throttling - 400 or 429 Response\" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.
* X-DataDirect-Request-Key - FactSet request ID * Api-Supported-Versions - Supported API versions (semantic versioning) * Api-Version - API version (semantic versioning)
401
Missing or invalid authentication. Ensure you are logged in and have successfully generated an API KEY for the IP range you are connecting from. For further assistance, file an issue under \"Connectivty - 401 or 403 Responses\" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.
* X-DataDirect-Request-Key - FactSet request ID
403
User is forbidden access with current credentials. Reach out to your local FactSet Account Manager for assistance, or file an issue under \"Connectivty - 401 or 403 Responses\" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.
* X-DataDirect-Request-Key - FactSet request ID
404
Not found. For further assistance, file an issue under \"Performance - 404 and 500 Responses\" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.
* X-DataDirect-Request-Key - FactSet request ID
429
Too many requests - this API is rate-limited to 20 requests per second. For further assistance, file an issue under \"Workflow & Throttling - 400 or 429 Response\" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.
* X-DataDirect-Request-Key - FactSet request ID
500
Server error. For further assistance, file an issue under \"Performance - 404 and 500 Responses\" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.
* X-DataDirect-Request-Key - FactSet request ID
503
Service unavailable. Typically a timeout, or result of a rejected request to prevent service overload. For further assistance, file an issue under \"Performance - 404 and 500 Responses\" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.
* X-DataDirect-Request-Key - FactSet request ID
*/
public Response getEstimatesGeographicSegments(String id, String periodicity, String schema) throws ApiException {
return getEstimatesGeographicSegmentsWithHttpInfo(id, periodicity, schema).getData();
}
/**
* Geographic Segments
* Returns historical and future period broker estimate consensus in a statement format for line items broken down geographically.
* @param id Company Ticker (required)
* @param periodicity Periodicity or frequency of the fiscal periods. (optional, default to ANN)
* @param schema The schema that the data is returned as. The following are descriptions for the accepted values: - table_group_level - STACH 2.0 row organized package format with parent-child relationships represented using STACH group level cell metadata - table_parent_child_columns - STACH 2.0 row organized package format with parent-child relationships represented using STACH parent-child columns (optional, default to table_parent_child_columns)
* @return ApiResponse<Response>
* @throws ApiException if fails to make API call
* @http.response.details
Status Code
Description
Response Headers
200
Expected response; returns JSON data containing STACH 2.0 row organized package format
* X-DataDirect-Request-Key - FactSet request ID * Api-Supported-Versions - Supported API versions (semantic versioning) * Api-Version - API version (semantic versioning)
400
Bad Request. For further assistance, file an issue under \"Workflow & Throttling - 400 or 429 Response\" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.
* X-DataDirect-Request-Key - FactSet request ID * Api-Supported-Versions - Supported API versions (semantic versioning) * Api-Version - API version (semantic versioning)
401
Missing or invalid authentication. Ensure you are logged in and have successfully generated an API KEY for the IP range you are connecting from. For further assistance, file an issue under \"Connectivty - 401 or 403 Responses\" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.
* X-DataDirect-Request-Key - FactSet request ID
403
User is forbidden access with current credentials. Reach out to your local FactSet Account Manager for assistance, or file an issue under \"Connectivty - 401 or 403 Responses\" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.
* X-DataDirect-Request-Key - FactSet request ID
404
Not found. For further assistance, file an issue under \"Performance - 404 and 500 Responses\" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.
* X-DataDirect-Request-Key - FactSet request ID
429
Too many requests - this API is rate-limited to 20 requests per second. For further assistance, file an issue under \"Workflow & Throttling - 400 or 429 Response\" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.
* X-DataDirect-Request-Key - FactSet request ID
500
Server error. For further assistance, file an issue under \"Performance - 404 and 500 Responses\" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.
* X-DataDirect-Request-Key - FactSet request ID
503
Service unavailable. Typically a timeout, or result of a rejected request to prevent service overload. For further assistance, file an issue under \"Performance - 404 and 500 Responses\" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.
* X-DataDirect-Request-Key - FactSet request ID
*/
public ApiResponse getEstimatesGeographicSegmentsWithHttpInfo(String id, String periodicity, String schema) throws ApiException {
Object localVarPostBody = null;
// verify the required parameter 'id' is set
if (id == null) {
throw new ApiException(400, "Missing the required parameter 'id' when calling getEstimatesGeographicSegments");
}
// create path and map variables
String localVarPath = "/geographic-segments";
// 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("", "id", id));
localVarQueryParams.addAll(apiClient.parameterToPairs("", "periodicity", periodicity));
localVarQueryParams.addAll(apiClient.parameterToPairs("", "schema", schema));
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<
Response
> apiResponse = apiClient.invokeAPI("AllEstimatesApi.getEstimatesGeographicSegments", localVarPath, "GET", localVarQueryParams, localVarPostBody,
localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType,
localVarAuthNames, getEstimatesGeographicSegmentsResponseTypeMap, false);
return apiResponse;
}
/**
* Income Statement
* Returns historical and future period broker estimate consensus in a statement format for Income Statement line items.
* @param id Company Ticker (required)
* @param periodicity Periodicity or frequency of the fiscal periods. (optional, default to ANN)
* @param schema The schema that the data is returned as. The following are descriptions for the accepted values: - table_group_level - STACH 2.0 row organized package format with parent-child relationships represented using STACH group level cell metadata - table_parent_child_columns - STACH 2.0 row organized package format with parent-child relationships represented using STACH parent-child columns (optional, default to table_parent_child_columns)
* @return Response
* @throws ApiException if fails to make API call
* @http.response.details
Status Code
Description
Response Headers
200
Expected response; returns JSON data containing STACH 2.0 row organized package format
* X-DataDirect-Request-Key - FactSet request ID * Api-Supported-Versions - Supported API versions (semantic versioning) * Api-Version - API version (semantic versioning)
400
Bad Request. For further assistance, file an issue under \"Workflow & Throttling - 400 or 429 Response\" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.
* X-DataDirect-Request-Key - FactSet request ID * Api-Supported-Versions - Supported API versions (semantic versioning) * Api-Version - API version (semantic versioning)
401
Missing or invalid authentication. Ensure you are logged in and have successfully generated an API KEY for the IP range you are connecting from. For further assistance, file an issue under \"Connectivty - 401 or 403 Responses\" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.
* X-DataDirect-Request-Key - FactSet request ID
403
User is forbidden access with current credentials. Reach out to your local FactSet Account Manager for assistance, or file an issue under \"Connectivty - 401 or 403 Responses\" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.
* X-DataDirect-Request-Key - FactSet request ID
404
Not found. For further assistance, file an issue under \"Performance - 404 and 500 Responses\" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.
* X-DataDirect-Request-Key - FactSet request ID
429
Too many requests - this API is rate-limited to 20 requests per second. For further assistance, file an issue under \"Workflow & Throttling - 400 or 429 Response\" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.
* X-DataDirect-Request-Key - FactSet request ID
500
Server error. For further assistance, file an issue under \"Performance - 404 and 500 Responses\" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.
* X-DataDirect-Request-Key - FactSet request ID
503
Service unavailable. Typically a timeout, or result of a rejected request to prevent service overload. For further assistance, file an issue under \"Performance - 404 and 500 Responses\" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.
* X-DataDirect-Request-Key - FactSet request ID
*/
public Response getEstimatesIncomeStatement(String id, String periodicity, String schema) throws ApiException {
return getEstimatesIncomeStatementWithHttpInfo(id, periodicity, schema).getData();
}
/**
* Income Statement
* Returns historical and future period broker estimate consensus in a statement format for Income Statement line items.
* @param id Company Ticker (required)
* @param periodicity Periodicity or frequency of the fiscal periods. (optional, default to ANN)
* @param schema The schema that the data is returned as. The following are descriptions for the accepted values: - table_group_level - STACH 2.0 row organized package format with parent-child relationships represented using STACH group level cell metadata - table_parent_child_columns - STACH 2.0 row organized package format with parent-child relationships represented using STACH parent-child columns (optional, default to table_parent_child_columns)
* @return ApiResponse<Response>
* @throws ApiException if fails to make API call
* @http.response.details
Status Code
Description
Response Headers
200
Expected response; returns JSON data containing STACH 2.0 row organized package format
* X-DataDirect-Request-Key - FactSet request ID * Api-Supported-Versions - Supported API versions (semantic versioning) * Api-Version - API version (semantic versioning)
400
Bad Request. For further assistance, file an issue under \"Workflow & Throttling - 400 or 429 Response\" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.
* X-DataDirect-Request-Key - FactSet request ID * Api-Supported-Versions - Supported API versions (semantic versioning) * Api-Version - API version (semantic versioning)
401
Missing or invalid authentication. Ensure you are logged in and have successfully generated an API KEY for the IP range you are connecting from. For further assistance, file an issue under \"Connectivty - 401 or 403 Responses\" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.
* X-DataDirect-Request-Key - FactSet request ID
403
User is forbidden access with current credentials. Reach out to your local FactSet Account Manager for assistance, or file an issue under \"Connectivty - 401 or 403 Responses\" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.
* X-DataDirect-Request-Key - FactSet request ID
404
Not found. For further assistance, file an issue under \"Performance - 404 and 500 Responses\" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.
* X-DataDirect-Request-Key - FactSet request ID
429
Too many requests - this API is rate-limited to 20 requests per second. For further assistance, file an issue under \"Workflow & Throttling - 400 or 429 Response\" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.
* X-DataDirect-Request-Key - FactSet request ID
500
Server error. For further assistance, file an issue under \"Performance - 404 and 500 Responses\" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.
* X-DataDirect-Request-Key - FactSet request ID
503
Service unavailable. Typically a timeout, or result of a rejected request to prevent service overload. For further assistance, file an issue under \"Performance - 404 and 500 Responses\" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.
* X-DataDirect-Request-Key - FactSet request ID
*/
public ApiResponse getEstimatesIncomeStatementWithHttpInfo(String id, String periodicity, String schema) throws ApiException {
Object localVarPostBody = null;
// verify the required parameter 'id' is set
if (id == null) {
throw new ApiException(400, "Missing the required parameter 'id' when calling getEstimatesIncomeStatement");
}
// create path and map variables
String localVarPath = "/income-statement";
// 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("", "id", id));
localVarQueryParams.addAll(apiClient.parameterToPairs("", "periodicity", periodicity));
localVarQueryParams.addAll(apiClient.parameterToPairs("", "schema", schema));
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<
Response
> apiResponse = apiClient.invokeAPI("AllEstimatesApi.getEstimatesIncomeStatement", localVarPath, "GET", localVarQueryParams, localVarPostBody,
localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType,
localVarAuthNames, getEstimatesIncomeStatementResponseTypeMap, false);
return apiResponse;
}
/**
* Industry Metrics
* Returns historical and future period broker estimate consensus in a statement format for industry-specific metrics.
* @param id Company Ticker (required)
* @param periodicity Periodicity or frequency of the fiscal periods. (optional, default to ANN)
* @param schema The schema that the data is returned as. The following are descriptions for the accepted values: - table_group_level - STACH 2.0 row organized package format with parent-child relationships represented using STACH group level cell metadata - table_parent_child_columns - STACH 2.0 row organized package format with parent-child relationships represented using STACH parent-child columns (optional, default to table_parent_child_columns)
* @return Response
* @throws ApiException if fails to make API call
* @http.response.details
Status Code
Description
Response Headers
200
Expected response; returns JSON data containing STACH 2.0 row organized package format
* X-DataDirect-Request-Key - FactSet request ID * Api-Supported-Versions - Supported API versions (semantic versioning) * Api-Version - API version (semantic versioning)
400
Bad Request. For further assistance, file an issue under \"Workflow & Throttling - 400 or 429 Response\" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.
* X-DataDirect-Request-Key - FactSet request ID * Api-Supported-Versions - Supported API versions (semantic versioning) * Api-Version - API version (semantic versioning)
401
Missing or invalid authentication. Ensure you are logged in and have successfully generated an API KEY for the IP range you are connecting from. For further assistance, file an issue under \"Connectivty - 401 or 403 Responses\" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.
* X-DataDirect-Request-Key - FactSet request ID
403
User is forbidden access with current credentials. Reach out to your local FactSet Account Manager for assistance, or file an issue under \"Connectivty - 401 or 403 Responses\" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.
* X-DataDirect-Request-Key - FactSet request ID
404
Not found. For further assistance, file an issue under \"Performance - 404 and 500 Responses\" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.
* X-DataDirect-Request-Key - FactSet request ID
429
Too many requests - this API is rate-limited to 20 requests per second. For further assistance, file an issue under \"Workflow & Throttling - 400 or 429 Response\" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.
* X-DataDirect-Request-Key - FactSet request ID
500
Server error. For further assistance, file an issue under \"Performance - 404 and 500 Responses\" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.
* X-DataDirect-Request-Key - FactSet request ID
503
Service unavailable. Typically a timeout, or result of a rejected request to prevent service overload. For further assistance, file an issue under \"Performance - 404 and 500 Responses\" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.
* X-DataDirect-Request-Key - FactSet request ID
*/
public Response getEstimatesIndustryMetrics(String id, String periodicity, String schema) throws ApiException {
return getEstimatesIndustryMetricsWithHttpInfo(id, periodicity, schema).getData();
}
/**
* Industry Metrics
* Returns historical and future period broker estimate consensus in a statement format for industry-specific metrics.
* @param id Company Ticker (required)
* @param periodicity Periodicity or frequency of the fiscal periods. (optional, default to ANN)
* @param schema The schema that the data is returned as. The following are descriptions for the accepted values: - table_group_level - STACH 2.0 row organized package format with parent-child relationships represented using STACH group level cell metadata - table_parent_child_columns - STACH 2.0 row organized package format with parent-child relationships represented using STACH parent-child columns (optional, default to table_parent_child_columns)
* @return ApiResponse<Response>
* @throws ApiException if fails to make API call
* @http.response.details
Status Code
Description
Response Headers
200
Expected response; returns JSON data containing STACH 2.0 row organized package format
* X-DataDirect-Request-Key - FactSet request ID * Api-Supported-Versions - Supported API versions (semantic versioning) * Api-Version - API version (semantic versioning)
400
Bad Request. For further assistance, file an issue under \"Workflow & Throttling - 400 or 429 Response\" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.
* X-DataDirect-Request-Key - FactSet request ID * Api-Supported-Versions - Supported API versions (semantic versioning) * Api-Version - API version (semantic versioning)
401
Missing or invalid authentication. Ensure you are logged in and have successfully generated an API KEY for the IP range you are connecting from. For further assistance, file an issue under \"Connectivty - 401 or 403 Responses\" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.
* X-DataDirect-Request-Key - FactSet request ID
403
User is forbidden access with current credentials. Reach out to your local FactSet Account Manager for assistance, or file an issue under \"Connectivty - 401 or 403 Responses\" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.
* X-DataDirect-Request-Key - FactSet request ID
404
Not found. For further assistance, file an issue under \"Performance - 404 and 500 Responses\" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.
* X-DataDirect-Request-Key - FactSet request ID
429
Too many requests - this API is rate-limited to 20 requests per second. For further assistance, file an issue under \"Workflow & Throttling - 400 or 429 Response\" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.
* X-DataDirect-Request-Key - FactSet request ID
500
Server error. For further assistance, file an issue under \"Performance - 404 and 500 Responses\" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.
* X-DataDirect-Request-Key - FactSet request ID
503
Service unavailable. Typically a timeout, or result of a rejected request to prevent service overload. For further assistance, file an issue under \"Performance - 404 and 500 Responses\" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.
* X-DataDirect-Request-Key - FactSet request ID
*/
public ApiResponse getEstimatesIndustryMetricsWithHttpInfo(String id, String periodicity, String schema) throws ApiException {
Object localVarPostBody = null;
// verify the required parameter 'id' is set
if (id == null) {
throw new ApiException(400, "Missing the required parameter 'id' when calling getEstimatesIndustryMetrics");
}
// create path and map variables
String localVarPath = "/industry-metrics";
// 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("", "id", id));
localVarQueryParams.addAll(apiClient.parameterToPairs("", "periodicity", periodicity));
localVarQueryParams.addAll(apiClient.parameterToPairs("", "schema", schema));
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<
Response
> apiResponse = apiClient.invokeAPI("AllEstimatesApi.getEstimatesIndustryMetrics", localVarPath, "GET", localVarQueryParams, localVarPostBody,
localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType,
localVarAuthNames, getEstimatesIndustryMetricsResponseTypeMap, false);
return apiResponse;
}
/**
* Per Share
* Returns historical and future period broker estimate consensus in a statement format for Per Share line items.
* @param id Company Ticker (required)
* @param periodicity Periodicity or frequency of the fiscal periods. (optional, default to ANN)
* @param schema The schema that the data is returned as. The following are descriptions for the accepted values: - table_group_level - STACH 2.0 row organized package format with parent-child relationships represented using STACH group level cell metadata - table_parent_child_columns - STACH 2.0 row organized package format with parent-child relationships represented using STACH parent-child columns (optional, default to table_parent_child_columns)
* @return Response
* @throws ApiException if fails to make API call
* @http.response.details
Status Code
Description
Response Headers
200
Expected response; returns JSON data containing STACH 2.0 row organized package format
* X-DataDirect-Request-Key - FactSet request ID * Api-Supported-Versions - Supported API versions (semantic versioning) * Api-Version - API version (semantic versioning)
400
Bad Request. For further assistance, file an issue under \"Workflow & Throttling - 400 or 429 Response\" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.
* X-DataDirect-Request-Key - FactSet request ID * Api-Supported-Versions - Supported API versions (semantic versioning) * Api-Version - API version (semantic versioning)
401
Missing or invalid authentication. Ensure you are logged in and have successfully generated an API KEY for the IP range you are connecting from. For further assistance, file an issue under \"Connectivty - 401 or 403 Responses\" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.
* X-DataDirect-Request-Key - FactSet request ID
403
User is forbidden access with current credentials. Reach out to your local FactSet Account Manager for assistance, or file an issue under \"Connectivty - 401 or 403 Responses\" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.
* X-DataDirect-Request-Key - FactSet request ID
404
Not found. For further assistance, file an issue under \"Performance - 404 and 500 Responses\" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.
* X-DataDirect-Request-Key - FactSet request ID
429
Too many requests - this API is rate-limited to 20 requests per second. For further assistance, file an issue under \"Workflow & Throttling - 400 or 429 Response\" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.
* X-DataDirect-Request-Key - FactSet request ID
500
Server error. For further assistance, file an issue under \"Performance - 404 and 500 Responses\" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.
* X-DataDirect-Request-Key - FactSet request ID
503
Service unavailable. Typically a timeout, or result of a rejected request to prevent service overload. For further assistance, file an issue under \"Performance - 404 and 500 Responses\" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.
* X-DataDirect-Request-Key - FactSet request ID
*/
public Response getEstimatesPerShare(String id, String periodicity, String schema) throws ApiException {
return getEstimatesPerShareWithHttpInfo(id, periodicity, schema).getData();
}
/**
* Per Share
* Returns historical and future period broker estimate consensus in a statement format for Per Share line items.
* @param id Company Ticker (required)
* @param periodicity Periodicity or frequency of the fiscal periods. (optional, default to ANN)
* @param schema The schema that the data is returned as. The following are descriptions for the accepted values: - table_group_level - STACH 2.0 row organized package format with parent-child relationships represented using STACH group level cell metadata - table_parent_child_columns - STACH 2.0 row organized package format with parent-child relationships represented using STACH parent-child columns (optional, default to table_parent_child_columns)
* @return ApiResponse<Response>
* @throws ApiException if fails to make API call
* @http.response.details
Status Code
Description
Response Headers
200
Expected response; returns JSON data containing STACH 2.0 row organized package format
* X-DataDirect-Request-Key - FactSet request ID * Api-Supported-Versions - Supported API versions (semantic versioning) * Api-Version - API version (semantic versioning)
400
Bad Request. For further assistance, file an issue under \"Workflow & Throttling - 400 or 429 Response\" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.
* X-DataDirect-Request-Key - FactSet request ID * Api-Supported-Versions - Supported API versions (semantic versioning) * Api-Version - API version (semantic versioning)
401
Missing or invalid authentication. Ensure you are logged in and have successfully generated an API KEY for the IP range you are connecting from. For further assistance, file an issue under \"Connectivty - 401 or 403 Responses\" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.
* X-DataDirect-Request-Key - FactSet request ID
403
User is forbidden access with current credentials. Reach out to your local FactSet Account Manager for assistance, or file an issue under \"Connectivty - 401 or 403 Responses\" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.
* X-DataDirect-Request-Key - FactSet request ID
404
Not found. For further assistance, file an issue under \"Performance - 404 and 500 Responses\" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.
* X-DataDirect-Request-Key - FactSet request ID
429
Too many requests - this API is rate-limited to 20 requests per second. For further assistance, file an issue under \"Workflow & Throttling - 400 or 429 Response\" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.
* X-DataDirect-Request-Key - FactSet request ID
500
Server error. For further assistance, file an issue under \"Performance - 404 and 500 Responses\" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.
* X-DataDirect-Request-Key - FactSet request ID
503
Service unavailable. Typically a timeout, or result of a rejected request to prevent service overload. For further assistance, file an issue under \"Performance - 404 and 500 Responses\" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.
* X-DataDirect-Request-Key - FactSet request ID
*/
public ApiResponse getEstimatesPerShareWithHttpInfo(String id, String periodicity, String schema) throws ApiException {
Object localVarPostBody = null;
// verify the required parameter 'id' is set
if (id == null) {
throw new ApiException(400, "Missing the required parameter 'id' when calling getEstimatesPerShare");
}
// create path and map variables
String localVarPath = "/per-share";
// 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("", "id", id));
localVarQueryParams.addAll(apiClient.parameterToPairs("", "periodicity", periodicity));
localVarQueryParams.addAll(apiClient.parameterToPairs("", "schema", schema));
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<
Response
> apiResponse = apiClient.invokeAPI("AllEstimatesApi.getEstimatesPerShare", localVarPath, "GET", localVarQueryParams, localVarPostBody,
localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType,
localVarAuthNames, getEstimatesPerShareResponseTypeMap, false);
return apiResponse;
}
/**
* Product Segments
* Returns historical and future period broker estimate consensus in a statement format for line items broken down by product and business.
* @param id Company Ticker (required)
* @param periodicity Periodicity or frequency of the fiscal periods. (optional, default to ANN)
* @param schema The schema that the data is returned as. The following are descriptions for the accepted values: - table_group_level - STACH 2.0 row organized package format with parent-child relationships represented using STACH group level cell metadata - table_parent_child_columns - STACH 2.0 row organized package format with parent-child relationships represented using STACH parent-child columns (optional, default to table_parent_child_columns)
* @return Response
* @throws ApiException if fails to make API call
* @http.response.details
Status Code
Description
Response Headers
200
Expected response; returns JSON data containing STACH 2.0 row organized package format
* X-DataDirect-Request-Key - FactSet request ID * Api-Supported-Versions - Supported API versions (semantic versioning) * Api-Version - API version (semantic versioning)
400
Bad Request. For further assistance, file an issue under \"Workflow & Throttling - 400 or 429 Response\" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.
* X-DataDirect-Request-Key - FactSet request ID * Api-Supported-Versions - Supported API versions (semantic versioning) * Api-Version - API version (semantic versioning)
401
Missing or invalid authentication. Ensure you are logged in and have successfully generated an API KEY for the IP range you are connecting from. For further assistance, file an issue under \"Connectivty - 401 or 403 Responses\" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.
* X-DataDirect-Request-Key - FactSet request ID
403
User is forbidden access with current credentials. Reach out to your local FactSet Account Manager for assistance, or file an issue under \"Connectivty - 401 or 403 Responses\" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.
* X-DataDirect-Request-Key - FactSet request ID
404
Not found. For further assistance, file an issue under \"Performance - 404 and 500 Responses\" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.
* X-DataDirect-Request-Key - FactSet request ID
429
Too many requests - this API is rate-limited to 20 requests per second. For further assistance, file an issue under \"Workflow & Throttling - 400 or 429 Response\" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.
* X-DataDirect-Request-Key - FactSet request ID
500
Server error. For further assistance, file an issue under \"Performance - 404 and 500 Responses\" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.
* X-DataDirect-Request-Key - FactSet request ID
503
Service unavailable. Typically a timeout, or result of a rejected request to prevent service overload. For further assistance, file an issue under \"Performance - 404 and 500 Responses\" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.
* X-DataDirect-Request-Key - FactSet request ID
*/
public Response getEstimatesProductSegments(String id, String periodicity, String schema) throws ApiException {
return getEstimatesProductSegmentsWithHttpInfo(id, periodicity, schema).getData();
}
/**
* Product Segments
* Returns historical and future period broker estimate consensus in a statement format for line items broken down by product and business.
* @param id Company Ticker (required)
* @param periodicity Periodicity or frequency of the fiscal periods. (optional, default to ANN)
* @param schema The schema that the data is returned as. The following are descriptions for the accepted values: - table_group_level - STACH 2.0 row organized package format with parent-child relationships represented using STACH group level cell metadata - table_parent_child_columns - STACH 2.0 row organized package format with parent-child relationships represented using STACH parent-child columns (optional, default to table_parent_child_columns)
* @return ApiResponse<Response>
* @throws ApiException if fails to make API call
* @http.response.details
Status Code
Description
Response Headers
200
Expected response; returns JSON data containing STACH 2.0 row organized package format
* X-DataDirect-Request-Key - FactSet request ID * Api-Supported-Versions - Supported API versions (semantic versioning) * Api-Version - API version (semantic versioning)
400
Bad Request. For further assistance, file an issue under \"Workflow & Throttling - 400 or 429 Response\" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.
* X-DataDirect-Request-Key - FactSet request ID * Api-Supported-Versions - Supported API versions (semantic versioning) * Api-Version - API version (semantic versioning)
401
Missing or invalid authentication. Ensure you are logged in and have successfully generated an API KEY for the IP range you are connecting from. For further assistance, file an issue under \"Connectivty - 401 or 403 Responses\" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.
* X-DataDirect-Request-Key - FactSet request ID
403
User is forbidden access with current credentials. Reach out to your local FactSet Account Manager for assistance, or file an issue under \"Connectivty - 401 or 403 Responses\" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.
* X-DataDirect-Request-Key - FactSet request ID
404
Not found. For further assistance, file an issue under \"Performance - 404 and 500 Responses\" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.
* X-DataDirect-Request-Key - FactSet request ID
429
Too many requests - this API is rate-limited to 20 requests per second. For further assistance, file an issue under \"Workflow & Throttling - 400 or 429 Response\" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.
* X-DataDirect-Request-Key - FactSet request ID
500
Server error. For further assistance, file an issue under \"Performance - 404 and 500 Responses\" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.
* X-DataDirect-Request-Key - FactSet request ID
503
Service unavailable. Typically a timeout, or result of a rejected request to prevent service overload. For further assistance, file an issue under \"Performance - 404 and 500 Responses\" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.
* X-DataDirect-Request-Key - FactSet request ID
*/
public ApiResponse getEstimatesProductSegmentsWithHttpInfo(String id, String periodicity, String schema) throws ApiException {
Object localVarPostBody = null;
// verify the required parameter 'id' is set
if (id == null) {
throw new ApiException(400, "Missing the required parameter 'id' when calling getEstimatesProductSegments");
}
// create path and map variables
String localVarPath = "/product-segments";
// 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("", "id", id));
localVarQueryParams.addAll(apiClient.parameterToPairs("", "periodicity", periodicity));
localVarQueryParams.addAll(apiClient.parameterToPairs("", "schema", schema));
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<
Response
> apiResponse = apiClient.invokeAPI("AllEstimatesApi.getEstimatesProductSegments", localVarPath, "GET", localVarQueryParams, localVarPostBody,
localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType,
localVarAuthNames, getEstimatesProductSegmentsResponseTypeMap, false);
return apiResponse;
}
/**
* Valuation
* Returns valuation ratios in a statement format calculated from historical and future period broker estimate consensus.
* @param id Company Ticker (required)
* @param periodicity Periodicity or frequency of the fiscal periods. (optional, default to ANN)
* @param schema The schema that the data is returned as. The following are descriptions for the accepted values: - table_group_level - STACH 2.0 row organized package format with parent-child relationships represented using STACH group level cell metadata - table_parent_child_columns - STACH 2.0 row organized package format with parent-child relationships represented using STACH parent-child columns (optional, default to table_parent_child_columns)
* @return Response
* @throws ApiException if fails to make API call
* @http.response.details
Status Code
Description
Response Headers
200
Expected response; returns JSON data containing STACH 2.0 row organized package format
* X-DataDirect-Request-Key - FactSet request ID * Api-Supported-Versions - Supported API versions (semantic versioning) * Api-Version - API version (semantic versioning)
400
Bad Request. For further assistance, file an issue under \"Workflow & Throttling - 400 or 429 Response\" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.
* X-DataDirect-Request-Key - FactSet request ID * Api-Supported-Versions - Supported API versions (semantic versioning) * Api-Version - API version (semantic versioning)
401
Missing or invalid authentication. Ensure you are logged in and have successfully generated an API KEY for the IP range you are connecting from. For further assistance, file an issue under \"Connectivty - 401 or 403 Responses\" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.
* X-DataDirect-Request-Key - FactSet request ID
403
User is forbidden access with current credentials. Reach out to your local FactSet Account Manager for assistance, or file an issue under \"Connectivty - 401 or 403 Responses\" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.
* X-DataDirect-Request-Key - FactSet request ID
404
Not found. For further assistance, file an issue under \"Performance - 404 and 500 Responses\" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.
* X-DataDirect-Request-Key - FactSet request ID
429
Too many requests - this API is rate-limited to 20 requests per second. For further assistance, file an issue under \"Workflow & Throttling - 400 or 429 Response\" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.
* X-DataDirect-Request-Key - FactSet request ID
500
Server error. For further assistance, file an issue under \"Performance - 404 and 500 Responses\" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.
* X-DataDirect-Request-Key - FactSet request ID
503
Service unavailable. Typically a timeout, or result of a rejected request to prevent service overload. For further assistance, file an issue under \"Performance - 404 and 500 Responses\" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.
* X-DataDirect-Request-Key - FactSet request ID
*/
public Response getEstimatesValuation(String id, String periodicity, String schema) throws ApiException {
return getEstimatesValuationWithHttpInfo(id, periodicity, schema).getData();
}
/**
* Valuation
* Returns valuation ratios in a statement format calculated from historical and future period broker estimate consensus.
* @param id Company Ticker (required)
* @param periodicity Periodicity or frequency of the fiscal periods. (optional, default to ANN)
* @param schema The schema that the data is returned as. The following are descriptions for the accepted values: - table_group_level - STACH 2.0 row organized package format with parent-child relationships represented using STACH group level cell metadata - table_parent_child_columns - STACH 2.0 row organized package format with parent-child relationships represented using STACH parent-child columns (optional, default to table_parent_child_columns)
* @return ApiResponse<Response>
* @throws ApiException if fails to make API call
* @http.response.details
Status Code
Description
Response Headers
200
Expected response; returns JSON data containing STACH 2.0 row organized package format
* X-DataDirect-Request-Key - FactSet request ID * Api-Supported-Versions - Supported API versions (semantic versioning) * Api-Version - API version (semantic versioning)
400
Bad Request. For further assistance, file an issue under \"Workflow & Throttling - 400 or 429 Response\" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.
* X-DataDirect-Request-Key - FactSet request ID * Api-Supported-Versions - Supported API versions (semantic versioning) * Api-Version - API version (semantic versioning)
401
Missing or invalid authentication. Ensure you are logged in and have successfully generated an API KEY for the IP range you are connecting from. For further assistance, file an issue under \"Connectivty - 401 or 403 Responses\" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.
* X-DataDirect-Request-Key - FactSet request ID
403
User is forbidden access with current credentials. Reach out to your local FactSet Account Manager for assistance, or file an issue under \"Connectivty - 401 or 403 Responses\" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.
* X-DataDirect-Request-Key - FactSet request ID
404
Not found. For further assistance, file an issue under \"Performance - 404 and 500 Responses\" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.
* X-DataDirect-Request-Key - FactSet request ID
429
Too many requests - this API is rate-limited to 20 requests per second. For further assistance, file an issue under \"Workflow & Throttling - 400 or 429 Response\" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.
* X-DataDirect-Request-Key - FactSet request ID
500
Server error. For further assistance, file an issue under \"Performance - 404 and 500 Responses\" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.
* X-DataDirect-Request-Key - FactSet request ID
503
Service unavailable. Typically a timeout, or result of a rejected request to prevent service overload. For further assistance, file an issue under \"Performance - 404 and 500 Responses\" using `Report Issue` at the top of this page, including the X-DataDirect-Request-Key from the header to assist in troubleshooting.
* X-DataDirect-Request-Key - FactSet request ID
*/
public ApiResponse getEstimatesValuationWithHttpInfo(String id, String periodicity, String schema) throws ApiException {
Object localVarPostBody = null;
// verify the required parameter 'id' is set
if (id == null) {
throw new ApiException(400, "Missing the required parameter 'id' when calling getEstimatesValuation");
}
// create path and map variables
String localVarPath = "/valuation";
// 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("", "id", id));
localVarQueryParams.addAll(apiClient.parameterToPairs("", "periodicity", periodicity));
localVarQueryParams.addAll(apiClient.parameterToPairs("", "schema", schema));
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<
Response
> apiResponse = apiClient.invokeAPI("AllEstimatesApi.getEstimatesValuation", localVarPath, "GET", localVarQueryParams, localVarPostBody,
localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType,
localVarAuthNames, getEstimatesValuationResponseTypeMap, false);
return apiResponse;
}
}
