FrequenciesApi: Frequencies operations

In factset.analyticsapi.engines: 'FactSet' Engines API Client

Description

factset.analyticsapi.engines.Frequencies

Format

An R6Class generator object

Methods

GetPAFrequencies Get PA frequencies This endpoint lists all the frequencies that can be applied to a PA calculation.

• @returnType named list( Frequency )
  

• On encountering errors, an error of subclass ApiException will be thrown.

• status code : 200 | Expected response, returns a list of PA frequencies.

• return type : map(Frequency)

• response headers :

  X-RateLimit-Remaining	Number of requests left for the time window.
  X-FactSet-Api-Request-Key	Key to uniquely identify an Analytics API request. Only available after successful authentication.
  X-RateLimit-Reset	Number of seconds remaining till rate limit resets.
  X-RateLimit-Limit	Number of allowed requests for the time window.
  X-DataDirect-Request-Key	FactSet's request key header.

• status code : 401 | Missing or invalid authentication.

• response headers :

  X-RateLimit-Remaining	Number of requests left for the time window.
  X-FactSet-Api-Request-Key	Key to uniquely identify an Analytics API request. Only available after successful authentication.
  X-RateLimit-Reset	Number of seconds remaining till rate limit resets.
  X-RateLimit-Limit	Number of allowed requests for the time window.
  X-DataDirect-Request-Key	FactSet's request key header.

• status code : 403 | User is forbidden with current credentials

• response headers :

  X-RateLimit-Remaining	Number of requests left for the time window.
  X-FactSet-Api-Request-Key	Key to uniquely identify an Analytics API request. Only available after successful authentication.
  X-RateLimit-Reset	Number of seconds remaining till rate limit resets.
  X-RateLimit-Limit	Number of allowed requests for the time window.
  X-DataDirect-Request-Key	FactSet's request key header.

• status code : 406 | Unsupported Accept header. Header needs to be set to application/json.

• response headers :

  X-RateLimit-Remaining	Number of requests left for the time window.
  X-FactSet-Api-Request-Key	Key to uniquely identify an Analytics API request. Only available after successful authentication.
  X-RateLimit-Reset	Number of seconds remaining till rate limit resets.
  X-RateLimit-Limit	Number of allowed requests for the time window.
  X-DataDirect-Request-Key	FactSet's request key header.

• status code : 500 | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting.

• response headers :

  X-RateLimit-Remaining	Number of requests left for the time window.
  X-FactSet-Api-Request-Key	Key to uniquely identify an Analytics API request. Only available after successful authentication.
  X-RateLimit-Reset	Number of seconds remaining till rate limit resets.
  X-RateLimit-Limit	Number of allowed requests for the time window.
  X-DataDirect-Request-Key	FactSet's request key header.

• status code : 503 | Request timed out. Retry the request in sometime.

• response headers :

  X-RateLimit-Remaining	Number of requests left for the time window.
  X-FactSet-Api-Request-Key	Key to uniquely identify an Analytics API request. Only available after successful authentication.
  X-RateLimit-Reset	Number of seconds remaining till rate limit resets.
  X-RateLimit-Limit	Number of allowed requests for the time window.
  X-DataDirect-Request-Key	FactSet's request key header.

GetSPARFrequencies Get SPAR frequencies This endpoint lists all the frequencies that can be applied to a SPAR calculation.

• @returnType named list( Frequency )
  

• On encountering errors, an error of subclass ApiException will be thrown.

• status code : 200 | Expected response, returns a list of SPAR frequencies.

• return type : map(Frequency)

• response headers :

  X-RateLimit-Remaining	Number of requests left for the time window.
  X-FactSet-Api-Request-Key	Key to uniquely identify an Analytics API request. Only available after successful authentication.
  X-RateLimit-Reset	Number of seconds remaining till rate limit resets.
  X-RateLimit-Limit	Number of allowed requests for the time window.
  X-DataDirect-Request-Key	FactSet's request key header.

• status code : 401 | Missing or invalid authentication.

• response headers :

  X-RateLimit-Remaining	Number of requests left for the time window.
  X-FactSet-Api-Request-Key	Key to uniquely identify an Analytics API request. Only available after successful authentication.
  X-RateLimit-Reset	Number of seconds remaining till rate limit resets.
  X-RateLimit-Limit	Number of allowed requests for the time window.
  X-DataDirect-Request-Key	FactSet's request key header.

• status code : 403 | User is forbidden with current credentials

• response headers :

  X-RateLimit-Remaining	Number of requests left for the time window.
  X-FactSet-Api-Request-Key	Key to uniquely identify an Analytics API request. Only available after successful authentication.
  X-RateLimit-Reset	Number of seconds remaining till rate limit resets.
  X-RateLimit-Limit	Number of allowed requests for the time window.
  X-DataDirect-Request-Key	FactSet's request key header.

• status code : 406 | Unsupported Accept header. Header needs to be set to application/json.

• response headers :

  X-RateLimit-Remaining	Number of requests left for the time window.
  X-FactSet-Api-Request-Key	Key to uniquely identify an Analytics API request. Only available after successful authentication.
  X-RateLimit-Reset	Number of seconds remaining till rate limit resets.
  X-RateLimit-Limit	Number of allowed requests for the time window.
  X-DataDirect-Request-Key	FactSet's request key header.

• status code : 500 | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting.

• response headers :

  X-RateLimit-Remaining	Number of requests left for the time window.
  X-FactSet-Api-Request-Key	Key to uniquely identify an Analytics API request. Only available after successful authentication.
  X-RateLimit-Reset	Number of seconds remaining till rate limit resets.
  X-RateLimit-Limit	Number of allowed requests for the time window.
  X-DataDirect-Request-Key	FactSet's request key header.

• status code : 503 | Request timed out. Retry the request in sometime.

• response headers :

  X-RateLimit-Remaining	Number of requests left for the time window.
  X-FactSet-Api-Request-Key	Key to uniquely identify an Analytics API request. Only available after successful authentication.
  X-RateLimit-Reset	Number of seconds remaining till rate limit resets.
  X-RateLimit-Limit	Number of allowed requests for the time window.
  X-DataDirect-Request-Key	FactSet's request key header.

GetVaultFrequencies Get Vault frequencies This endpoint lists all the frequencies that can be applied to a Vault calculation.

• @returnType named list( Frequency )
  

• On encountering errors, an error of subclass ApiException will be thrown.

• status code : 200 | Expected response, returns a list of Vault frequencies.

• return type : map(Frequency)

• response headers :

  X-RateLimit-Remaining	Number of requests left for the time window.
  X-FactSet-Api-Request-Key	Key to uniquely identify an Analytics API request. Only available after successful authentication.
  X-RateLimit-Reset	Number of seconds remaining till rate limit resets.
  X-RateLimit-Limit	Number of allowed requests for the time window.
  X-DataDirect-Request-Key	FactSet's request key header.

• status code : 401 | Missing or invalid authentication.

• response headers :

  X-RateLimit-Remaining	Number of requests left for the time window.
  X-FactSet-Api-Request-Key	Key to uniquely identify an Analytics API request. Only available after successful authentication.
  X-RateLimit-Reset	Number of seconds remaining till rate limit resets.
  X-RateLimit-Limit	Number of allowed requests for the time window.
  X-DataDirect-Request-Key	FactSet's request key header.

• status code : 403 | User is forbidden with current credentials

• response headers :

  X-RateLimit-Remaining	Number of requests left for the time window.
  X-FactSet-Api-Request-Key	Key to uniquely identify an Analytics API request. Only available after successful authentication.
  X-RateLimit-Reset	Number of seconds remaining till rate limit resets.
  X-RateLimit-Limit	Number of allowed requests for the time window.
  X-DataDirect-Request-Key	FactSet's request key header.

• status code : 406 | Unsupported Accept header. Header needs to be set to application/json.

• response headers :

  X-RateLimit-Remaining	Number of requests left for the time window.
  X-FactSet-Api-Request-Key	Key to uniquely identify an Analytics API request. Only available after successful authentication.
  X-RateLimit-Reset	Number of seconds remaining till rate limit resets.
  X-RateLimit-Limit	Number of allowed requests for the time window.
  X-DataDirect-Request-Key	FactSet's request key header.

• status code : 500 | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting.

• response headers :

  X-RateLimit-Remaining	Number of requests left for the time window.
  X-FactSet-Api-Request-Key	Key to uniquely identify an Analytics API request. Only available after successful authentication.
  X-RateLimit-Reset	Number of seconds remaining till rate limit resets.
  X-RateLimit-Limit	Number of allowed requests for the time window.
  X-DataDirect-Request-Key	FactSet's request key header.

• status code : 503 | Request timed out. Retry the request in sometime.

• response headers :

  X-RateLimit-Remaining	Number of requests left for the time window.
  X-FactSet-Api-Request-Key	Key to uniquely identify an Analytics API request. Only available after successful authentication.
  X-RateLimit-Reset	Number of seconds remaining till rate limit resets.
  X-RateLimit-Limit	Number of allowed requests for the time window.
  X-DataDirect-Request-Key	FactSet's request key header.

Public fields

apiClient

Handles the client-server communication.

Methods

Public methods

• FrequenciesApi$new()

• FrequenciesApi$GetPAFrequencies()

• FrequenciesApi$GetPAFrequenciesWithHttpInfo()

• FrequenciesApi$GetSPARFrequencies()

• FrequenciesApi$GetSPARFrequenciesWithHttpInfo()

• FrequenciesApi$GetVaultFrequencies()

• FrequenciesApi$GetVaultFrequenciesWithHttpInfo()

• FrequenciesApi$clone()

---

Method new()

Usage

FrequenciesApi$new(apiClient)

---

Method GetPAFrequencies()

Usage

FrequenciesApi$GetPAFrequencies(...)

---

Method GetPAFrequenciesWithHttpInfo()

Usage

FrequenciesApi$GetPAFrequenciesWithHttpInfo(...)

---

Method GetSPARFrequencies()

Usage

FrequenciesApi$GetSPARFrequencies(...)

---

Method GetSPARFrequenciesWithHttpInfo()

Usage

FrequenciesApi$GetSPARFrequenciesWithHttpInfo(...)

---

Method GetVaultFrequencies()

Usage

FrequenciesApi$GetVaultFrequencies(...)

---

Method GetVaultFrequenciesWithHttpInfo()

Usage

FrequenciesApi$GetVaultFrequenciesWithHttpInfo(...)

---

Method clone()

The objects of this class are cloneable with this method.

Usage

FrequenciesApi$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

Examples

## Not run: 
####################  GetPAFrequencies  ####################

library(factset.analyticsapi.engines)

#Get PA frequencies
api.instance <- FrequenciesApi$new()

#Configure HTTP basic authorization: Basic
# provide your username in the user-serial format
api.instance$apiClient$username <- '<user-serial>'; 
# provide your api key generated using the developer portal
api.instance$apiClient$password <- '<api_key>';

result <- tryCatch(
            api.instance$GetPAFrequencies(),
            ApiException = function(ex) ex 
         )
# In case of error, print the error object 
if(!is.null(result$ApiException)) {
  cat(result$ApiException$toString())
} else {
# deserialized response object
response.object <- result$content
# response headers
response.headers <- result$response$headers
# response status code
response.status.code <- result$response$status_code
}


####################  GetSPARFrequencies  ####################

library(factset.analyticsapi.engines)

#Get SPAR frequencies
api.instance <- FrequenciesApi$new()

#Configure HTTP basic authorization: Basic
# provide your username in the user-serial format
api.instance$apiClient$username <- '<user-serial>'; 
# provide your api key generated using the developer portal
api.instance$apiClient$password <- '<api_key>';

result <- tryCatch(
            api.instance$GetSPARFrequencies(),
            ApiException = function(ex) ex 
         )
# In case of error, print the error object 
if(!is.null(result$ApiException)) {
  cat(result$ApiException$toString())
} else {
# deserialized response object
response.object <- result$content
# response headers
response.headers <- result$response$headers
# response status code
response.status.code <- result$response$status_code
}


####################  GetVaultFrequencies  ####################

library(factset.analyticsapi.engines)

#Get Vault frequencies
api.instance <- FrequenciesApi$new()

#Configure HTTP basic authorization: Basic
# provide your username in the user-serial format
api.instance$apiClient$username <- '<user-serial>'; 
# provide your api key generated using the developer portal
api.instance$apiClient$password <- '<api_key>';

result <- tryCatch(
            api.instance$GetVaultFrequencies(),
            ApiException = function(ex) ex 
         )
# In case of error, print the error object 
if(!is.null(result$ApiException)) {
  cat(result$ApiException$toString())
} else {
# deserialized response object
response.object <- result$content
# response headers
response.headers <- result$response$headers
# response status code
response.status.code <- result$response$status_code
}



## End(Not run)

factset.analyticsapi.engines documentation built on Feb. 2, 2020, 5:06 p.m.