fds.analyticsapi.engines.DatesApi

All URIs are relative to https://api.factset.com

Method	HTTP request	Description
convert_pa_dates_to_absolute_format	GET /analytics/engines/pa/v3/dates	Convert PA dates to absolute format
convert_vault_dates_to_absolute_format	GET /analytics/engines/vault/v3/dates	Convert Vault dates to absolute format

convert_pa_dates_to_absolute_format

DateParametersSummaryRoot convert_pa_dates_to_absolute_format(enddate, componentid, account)

Convert PA dates to absolute format

This endpoint converts the given start and end dates in FactSet date format to yyyymmdd format for a PA calculation. For more information on FactSet date format, please refer to the PA Engine API documentation under the ‘API Documentation’ section in the developer portal.

Example

Basic Authentication (Basic):
Bearer Authentication (Bearer): ```python import time import fds.analyticsapi.engines from fds.analyticsapi.engines.api import dates_api from fds.analyticsapi.engines.model.date_parameters_summary_root import DateParametersSummaryRoot from fds.analyticsapi.engines.model.client_error_response import ClientErrorResponse from pprint import pprint
Defining the host is optional and defaults to https://api.factset.com

See configuration.py for a list of all supported configuration parameters.

configuration = fds.analyticsapi.engines.Configuration( host = “https://api.factset.com” )

The client must configure the authentication and authorization parameters

in accordance with the API server security policy.

Examples for each auth method are provided below, use the example that

satisfies your auth use case.

Configure HTTP basic authorization: Basic

configuration = fds.analyticsapi.engines.Configuration( username = ‘YOUR_USERNAME’, password = ‘YOUR_PASSWORD’ )

Configure Bearer authorization: Bearer

configuration = fds.analyticsapi.engines.Configuration( access_token = ‘YOUR_BEARER_TOKEN’ )

Enter a context with an instance of the API client

with fds.analyticsapi.engines.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = dates_api.DatesApi(api_client) enddate = “-1AY” # str | End Date componentid = “801B800245E468A52AEBEC4BE31CFF5AF82F371DAEF5F158AC2E98C2FA324B46” # str | Component Id account = “Client:/Folder1/Folder2/AccountName.ACCT” # str | Account ( Account Name ending with .ACCT or .ACTM ) startdate = “-3AY” # str | Start Date (optional)

# example passing only required values which don't have defaults set
try:
    # Convert PA dates to absolute format
    api_response = api_instance.convert_pa_dates_to_absolute_format(enddate, componentid, account)
    pprint(api_response)
except fds.analyticsapi.engines.ApiException as e:
    print("Exception when calling DatesApi->convert_pa_dates_to_absolute_format: %s\n" % e)

# example passing only required values which don't have defaults set
# and optional values
try:
    # Convert PA dates to absolute format
    api_response = api_instance.convert_pa_dates_to_absolute_format(enddate, componentid, account, startdate=startdate)
    pprint(api_response)
except fds.analyticsapi.engines.ApiException as e:
    print("Exception when calling DatesApi->convert_pa_dates_to_absolute_format: %s\n" % e) ```

Parameters

Name	Type	Description	Notes
enddate	str	End Date
componentid	str	Component Id
account	str	Account ( Account Name ending with .ACCT or .ACTM )
startdate	str	Start Date	[optional]

Return type

A tuple with response data, HTTP status code and response headers.
Response datatype: DateParametersSummaryRoot

Authorization

Basic, Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| 200 | Expected response, returns the converted dates in yyyymmdd format. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| 400 | Invalid query parameter or value is provided. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| 404 | Document or account not found. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| 401 | Missing or invalid authentication. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| 403 | User is forbidden with current credentials | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| 406 | Unsupported Accept header. Header needs to be set to application/json. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| 429 | Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* Retry-After - Time to wait in seconds before making a new request as the rate limit has reached.
| 500 | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| 503 | Request timed out. Retry the request in sometime. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
|

[Back to top] [Back to API list] [Back to Model list] [Back to README]

convert_vault_dates_to_absolute_format

DateParametersSummaryRoot convert_vault_dates_to_absolute_format(enddate, componentid, account)

Convert Vault dates to absolute format

This endpoint converts the given start and end dates in FactSet date format to yyyymmdd format for a Vault calculation. For more information on FactSet date format, please refer to the Vault API documentation under the ‘API Documentation’ section in the developer portal.

Example

Basic Authentication (Basic):
Bearer Authentication (Bearer): ```python import time import fds.analyticsapi.engines from fds.analyticsapi.engines.api import dates_api from fds.analyticsapi.engines.model.date_parameters_summary_root import DateParametersSummaryRoot from fds.analyticsapi.engines.model.client_error_response import ClientErrorResponse from pprint import pprint
Defining the host is optional and defaults to https://api.factset.com

See configuration.py for a list of all supported configuration parameters.

configuration = fds.analyticsapi.engines.Configuration( host = “https://api.factset.com” )

The client must configure the authentication and authorization parameters

in accordance with the API server security policy.

Examples for each auth method are provided below, use the example that

satisfies your auth use case.

Configure HTTP basic authorization: Basic

configuration = fds.analyticsapi.engines.Configuration( username = ‘YOUR_USERNAME’, password = ‘YOUR_PASSWORD’ )

Configure Bearer authorization: Bearer

configuration = fds.analyticsapi.engines.Configuration( access_token = ‘YOUR_BEARER_TOKEN’ )

Enter a context with an instance of the API client

with fds.analyticsapi.engines.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = dates_api.DatesApi(api_client) enddate = “enddate_example” # str | End Date componentid = “componentid_example” # str | Vault Component Id account = “account_example” # str | Account startdate = “startdate_example” # str | Start Date (optional)

# example passing only required values which don't have defaults set
try:
    # Convert Vault dates to absolute format
    api_response = api_instance.convert_vault_dates_to_absolute_format(enddate, componentid, account)
    pprint(api_response)
except fds.analyticsapi.engines.ApiException as e:
    print("Exception when calling DatesApi->convert_vault_dates_to_absolute_format: %s\n" % e)

# example passing only required values which don't have defaults set
# and optional values
try:
    # Convert Vault dates to absolute format
    api_response = api_instance.convert_vault_dates_to_absolute_format(enddate, componentid, account, startdate=startdate)
    pprint(api_response)
except fds.analyticsapi.engines.ApiException as e:
    print("Exception when calling DatesApi->convert_vault_dates_to_absolute_format: %s\n" % e) ```

Parameters

Name	Type	Description	Notes
enddate	str	End Date
componentid	str	Vault Component Id
account	str	Account
startdate	str	Start Date	[optional]

Return type

A tuple with response data, HTTP status code and response headers.
Response datatype: DateParametersSummaryRoot

Authorization

Basic, Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| 200 | Expected response, returns the converted dates in yyyymmdd format. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| 400 | Invalid query parameter or value is provided. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| 404 | vault Document or account not found. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| 401 | Missing or invalid authentication. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| 403 | User is forbidden with current credentials | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| 406 | Unsupported Accept header. Header needs to be set to application/json. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| 429 | Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
* Retry-After - Time to wait in seconds before making a new request as the rate limit has reached.
| 500 | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
| 503 | Request timed out. Retry the request in sometime. | * X-DataDirect-Request-Key - FactSet's request key header.
* X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication.
|

[Back to top] [Back to API list] [Back to Model list] [Back to README]

fds.analyticsapi.engines.DatesApi

convert_pa_dates_to_absolute_format

Example

Defining the host is optional and defaults to https://api.factset.com

See configuration.py for a list of all supported configuration parameters.

The client must configure the authentication and authorization parameters

in accordance with the API server security policy.

Examples for each auth method are provided below, use the example that

satisfies your auth use case.

Configure HTTP basic authorization: Basic

Configure Bearer authorization: Bearer

Enter a context with an instance of the API client

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

convert_vault_dates_to_absolute_format

Example

Defining the host is optional and defaults to https://api.factset.com

See configuration.py for a list of all supported configuration parameters.

The client must configure the authentication and authorization parameters

in accordance with the API server security policy.

Examples for each auth method are provided below, use the example that

satisfies your auth use case.

Configure HTTP basic authorization: Basic

Configure Bearer authorization: Bearer

Enter a context with an instance of the API client

Parameters

Return type

Authorization

HTTP request headers

HTTP response details