fds.analyticsapi.engines.FICalculationsApi

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

Method	HTTP request	Description
cancel_calculation_by_id	DELETE /analytics/engines/fi/v3/calculations/{id}	Cancel FI calculation by id
get_calculation_parameters	GET /analytics/engines/fi/v3/calculations/{id}	Get FI calculation parameters by id
get_calculation_result	GET /analytics/engines/fi/v3/calculations/{id}/result	Get FI calculation result by id
get_calculation_status_by_id	GET /analytics/engines/fi/v3/calculations/{id}/status	Get FI calculation status by id
post_and_calculate	POST /analytics/engines/fi/v3/calculations	Create and Run FI calculation
put_and_calculate	PUT /analytics/engines/fi/v3/calculations/{id}	Create or Update FI calculation and run it.

cancel_calculation_by_id

cancel_calculation_by_id(id)

Cancel FI calculation by id

This is the endpoint to cancel a previously submitted calculation.

Example

Basic Authentication (Basic):
Bearer Authentication (Bearer): ```python import time import fds.analyticsapi.engines from fds.analyticsapi.engines.api import fi_calculations_api 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

# example passing only required values which don't have defaults set
try:
    # Cancel FI calculation by id
    api_instance.cancel_calculation_by_id(id)
except fds.analyticsapi.engines.ApiException as e:
    print("Exception when calling FICalculationsApi->cancel_calculation_by_id: %s\n" % e) ```

Parameters

Name	Type	Description	Notes
id	str	from url, provided from the location header in the Create and Run FI calculation endpoint

Return type

A tuple with response data, HTTP status code and response headers.
Response datatype: None (empty response body)

Authorization

Basic, Bearer

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| 204 | Expected response, calculation was canceled successfully. | * 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 identifier 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 | There was no request for the calculation identifier provided, or the request was already canceled for the provided identifier. | * 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.
| 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]

get_calculation_parameters

FICalculationParametersRoot get_calculation_parameters(id)

Get FI calculation parameters by id

This is the endpoint that returns the calculation parameters passed for a calculation.

Example

Basic Authentication (Basic):
Bearer Authentication (Bearer): ```python import time import fds.analyticsapi.engines from fds.analyticsapi.engines.api import fi_calculations_api from fds.analyticsapi.engines.model.fi_calculation_parameters_root import FICalculationParametersRoot 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

# example passing only required values which don't have defaults set
try:
    # Get FI calculation parameters by id
    api_response = api_instance.get_calculation_parameters(id)
    pprint(api_response)
except fds.analyticsapi.engines.ApiException as e:
    print("Exception when calling FICalculationsApi->get_calculation_parameters: %s\n" % e) ```

Parameters

Name	Type	Description	Notes
id	str	from url, provided from the location header in the Create and Run FI calculation endpoint

Return type

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

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 FI calculation parameters. | * Content-Encoding - Standard HTTP header. Header value based on Accept-Encoding Request header.
* Content-Type - Standard HTTP header.
* Transfer-Encoding - Standard HTTP header. Header value will be set to Chunked if Accept-Encoding header is specified.
* 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 identifier 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 | Calculation id 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.
| 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]

get_calculation_result

ObjectRoot get_calculation_result(id)

Get FI calculation result by id

This is the endpoint to get the result of a previously requested calculation. If the calculation has finished computing, the body of the response will contain the requested document in JSON.

Example

Basic Authentication (Basic):
Bearer Authentication (Bearer): ```python import time import fds.analyticsapi.engines from fds.analyticsapi.engines.api import fi_calculations_api from fds.analyticsapi.engines.model.object_root import ObjectRoot 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

# example passing only required values which don't have defaults set
try:
    # Get FI calculation result by id
    api_response = api_instance.get_calculation_result(id)
    pprint(api_response)
except fds.analyticsapi.engines.ApiException as e:
    print("Exception when calling FICalculationsApi->get_calculation_result: %s\n" % e) ```

Parameters

Name	Type	Description	Notes
id	str	from url, provided from the location header in the Get FI calculation status by id endpoint

Return type

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

Authorization

Basic, Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json, application/x-protobuf

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| 200 | Expected response once calculation is completed, returns JSON in the format specified in the Calculation parameters. | * Content-Encoding - Standard HTTP header. Header value based on Accept-Encoding Request header.
* Content-Type - Standard HTTP header.
* Transfer-Encoding - Standard HTTP header. Header value will be set to Chunked if Accept-Encoding header is specified.
* 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 identifier 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 | Calculation was already returned, provided id was not a requested calculation, or the calculation was cancelled | * 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.
| 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]

get_calculation_status_by_id

ObjectRoot get_calculation_status_by_id(id)

Get FI calculation status by id

This is the endpoint to check on the progress of a previously requested calculation. If the calculation has finished computing, the body of the response will contain the requested document in JSON. Otherwise, the calculation is still running and the X-FactSet-Api-PickUp-Progress header will contain a progress percentage.

Example

Basic Authentication (Basic):
Bearer Authentication (Bearer): ```python import time import fds.analyticsapi.engines from fds.analyticsapi.engines.api import fi_calculations_api from fds.analyticsapi.engines.model.object_root import ObjectRoot 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

# example passing only required values which don't have defaults set
try:
    # Get FI calculation status by id
    api_response = api_instance.get_calculation_status_by_id(id)
    pprint(api_response)
except fds.analyticsapi.engines.ApiException as e:
    print("Exception when calling FICalculationsApi->get_calculation_status_by_id: %s\n" % e) ```

Parameters

Name	Type	Description	Notes
id	str	from url, provided from the location header in the Create and Run FI calculation endpoint

Return type

A tuple with response data, HTTP status code and response headers.
Response datatype: (For 201 status - ObjectRoot)(For 202 status - None (empty response body) )

Authorization

Basic, Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json, application/x-protobuf

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| 201 | Expected response once calculation is completed, returns JSON in the format specified in the Calculation parameters. | * 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.
| 202 | Expected response returned if the calculation is not yet completed, should contain X-FactSet-Api-PickUp-Progress header. | * X-FactSet-Api-PickUp-Progress - FactSet's progress header.
* Cache-Control - Standard HTTP header. Header will specify max-age in seconds. Polling can be adjusted based on the max-age value.
* 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 identifier 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 | Calculation was already returned, provided id was not a requested calculation, or the calculation was cancelled | * 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.
| 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]

post_and_calculate

ObjectRoot post_and_calculate()

Create and Run FI calculation

This endpoint creates and runs a new FI calculation specified in the post body.

Example

Basic Authentication (Basic):
Bearer Authentication (Bearer): ```python import time import fds.analyticsapi.engines from fds.analyticsapi.engines.api import fi_calculations_api from fds.analyticsapi.engines.model.fi_calculation_parameters_root import FICalculationParametersRoot from fds.analyticsapi.engines.model.object_root import ObjectRoot from fds.analyticsapi.engines.model.calculation_info_root import CalculationInfoRoot 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 = fi_calculations_api.FICalculationsApi(api_client) x_fact_set_api_long_running_deadline = 10 # int | Long running deadline in seconds. Example value is set to 10s. Please update it as per requirement before triggering a calculation. (optional) cache_control = “Cache-Control_example” # str | Standard HTTP header. Accepts max-stale. (optional) fi_calculation_parameters_root = FICalculationParametersRoot( data=FICalculationParameters( securities=[ FISecurity( settlement=”settlement_example”, call_method=”No Call”, reference_security=FIReferenceSecurity( security_type=”security_type_example”, security_name=”security_name_example”, calc_from_method=”calc_from_method_example”, calc_from_value=3.14, prepay=FIReferencePrepay( prepay_name=”prepay_name_example”, ), settlement=”settlement_example”, ), bank_loans=FIBankLoans( ignore_sinking_fund=True, ), municipal_bonds=FIMunicipalBonds( ignore_sinking_fund=True, use_anticipated_sink_schedule=True, ), loss=FILoss( loss_name=”loss_name_example”, ), prepay=FIPrepay( prepay_name=”prepay_name_example”, ), matrix_spread_adjustment=3.14, matrix_multiplier=3.14, structured_products=FIStructuredProductsForSecurities( servicer_advances=FIServicerAdvancesForSecurities( principal=3.14, interest=3.14, advance_type=”Advances All”, ), ignore_financial_guarantee=”ignore_financial_guarantee_example”, clean_up_call_method=True, do_opt_redeem=”do_opt_redeem_example”, prepay_lockout=FIPrepayLockout( points_above=”ANY”, ym_above=”ANY”, ), cashflows=FICashflows( optional_redemption_call_when_units=”Manual”, optional_redemption_call_when=1, recovery_lag=1, ), balloon_extension=FIBalloonExtension( months=1, percentage=3.14, amortization_type=”Loan_Amort_None”, units=”units_example”, coupon_stepup=3.14, ), ), attribution=FIAttributionForSecurities( start_price=3.14, end_price=3.14, start_spread=3.14, end_spread=3.14, pricing_method=”Inputted Price”, ), calc_from_method=”calc_from_method_example”, calc_from_value=3.14, face=1, face_type=”Current”, symbol=”symbol_example”, discount_curve=”discount_curve_example”, ), ], calculations=[ “calculations_example”, ], job_settings=FIJobSettings( as_of_date=”as_of_date_example”, partial_duration_months=[ 1, ], call_method=”No Call”, settlement=”settlement_example”, calc_from_method=”calc_from_method_example”, bank_loans=FIBankLoans( ignore_sinking_fund=True, ), municipal_bonds=FIMunicipalBondsForJobSettings( allow_sink_for_installment_payment=True, ignore_sinking_fund=True, use_anticipated_sink_schedule=True, ), market_environment=FIMarketEnvironment( rate_path=”FLAT & FORWARD”, ), structured_products=FIStructuredProductsForJobSettings( servicer_advances=FIServicerAdvances( advance_type=”Advances All”, ), ignore_financial_guarantee=”ignore_financial_guarantee_example”, clean_up_call_method=True, do_opt_redeem=”do_opt_redeem_example”, prepay_lockout=FIPrepayLockout( points_above=”ANY”, ym_above=”ANY”, ), cashflows=FICashflows( optional_redemption_call_when_units=”Manual”, optional_redemption_call_when=1, recovery_lag=1, ), balloon_extension=FIBalloonExtension( months=1, percentage=3.14, amortization_type=”Loan_Amort_None”, units=”units_example”, coupon_stepup=3.14, ), ), attribution=FIAttributionForJobSettings( start_date=”start_date_example”, end_date=”end_date_example”, ), ), ), meta=CalculationMeta( contentorganization=”SimplifiedRow”, stach_content_organization=”SimplifiedRow”, contenttype=”Json”, format=”JsonStach”, ), ) # FICalculationParametersRoot | Calculation Parameters (optional)

# example passing only required values which don't have defaults set
# and optional values
try:
    # Create and Run FI calculation
    api_response = api_instance.post_and_calculate(x_fact_set_api_long_running_deadline=x_fact_set_api_long_running_deadline, cache_control=cache_control, fi_calculation_parameters_root=fi_calculation_parameters_root)
    pprint(api_response)
except fds.analyticsapi.engines.ApiException as e:
    print("Exception when calling FICalculationsApi->post_and_calculate: %s\n" % e) ```

Parameters

Name	Type	Description	Notes
x_fact_set_api_long_running_deadline	int	Long running deadline in seconds. Example value is set to 10s. Please update it as per requirement before triggering a calculation.	[optional]
cache_control	str	Standard HTTP header. Accepts max-stale.	[optional]
fi_calculation_parameters_root	FICalculationParametersRoot	Calculation Parameters	[optional]

Return type

A tuple with response data, HTTP status code and response headers.
Response datatype: (For 202 status - CalculationInfoRoot)(For 201 status - ObjectRoot)

Authorization

Basic, Bearer

HTTP request headers

Content-Type: application/json
Accept: application/json, application/x-protobuf

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| 202 | Expected response, contains the poll URL in the Location header. | * Location - URL to poll for the resulting calculation
* 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-Calculations-Limit - Maximum FI request limit.
* X-FactSet-Api-Calculations-Remaining - Number of FI requests remaining till request limit reached.
* 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.
| 201 | Expected response if calculation is completed in a short span, returns JSON in the format specified in the Calculation parameters. | * 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-Calculations-Limit - Maximum FI request limit.
* X-FactSet-Api-Calculations-Remaining - Number of FI requests remaining till request limit reached.
* 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 calculation parameters. | * 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-Calculations-Limit - Maximum FI request limit.
* X-FactSet-Api-Calculations-Remaining - Number of FI requests remaining till request limit reached.
* 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 | One or more calculation settings were unavailable. | * 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-Calculations-Limit - Maximum FI request limit.
* X-FactSet-Api-Calculations-Remaining - Number of FI requests remaining till request limit reached.
* 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.
* X-FactSet-Api-Calculations-Limit - Maximum FI request limit.
* X-FactSet-Api-Calculations-Remaining - Number of FI requests remaining till request limit reached.
| 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-Calculations-Limit - Maximum FI request limit.
* X-FactSet-Api-Calculations-Remaining - Number of FI requests remaining till request limit reached.
* 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.
| 415 | Missing/Invalid Content-Type 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-Calculations-Limit - Maximum FI request limit.
* X-FactSet-Api-Calculations-Remaining - Number of FI requests remaining till request limit reached.
* 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. Cancel older requests using Cancel Calculation endpoint or wait for older requests to finish/expire. | * 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-Calculations-Limit - Maximum FI request limit.
* X-FactSet-Api-Calculations-Remaining - Number of FI requests remaining till request limit reached.
* 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.
* 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.
* X-FactSet-Api-Calculations-Limit - Maximum FI request limit.
* X-FactSet-Api-Calculations-Remaining - Number of FI requests remaining till request limit reached.
| 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.
* X-FactSet-Api-Calculations-Limit - Maximum FI request limit.
* X-FactSet-Api-Calculations-Remaining - Number of FI requests remaining till request limit reached.
|

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

put_and_calculate

ObjectRoot put_and_calculate(id)

Create or Update FI calculation and run it.

This endpoint updates and run the FI optimization specified in the PUT body parameters. It also allows the creation of new FI optimization with custom id.

Example

Basic Authentication (Basic):
Bearer Authentication (Bearer): ```python import time import fds.analyticsapi.engines from fds.analyticsapi.engines.api import fi_calculations_api from fds.analyticsapi.engines.model.fi_calculation_parameters_root import FICalculationParametersRoot from fds.analyticsapi.engines.model.object_root import ObjectRoot from fds.analyticsapi.engines.model.calculation_info_root import CalculationInfoRoot 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 = fi_calculations_api.FICalculationsApi(api_client) id = “id_example” # str | from url, provided from the location header in the Create and Run FI calculation endpoint x_fact_set_api_long_running_deadline = 10 # int | Long running deadline in seconds. Example value is set to 10s. Please update it as per requirement before triggering a calculation. (optional) cache_control = “Cache-Control_example” # str | Standard HTTP header. Accepts max-stale. (optional) fi_calculation_parameters_root = FICalculationParametersRoot( data=FICalculationParameters( securities=[ FISecurity( settlement=”settlement_example”, call_method=”No Call”, reference_security=FIReferenceSecurity( security_type=”security_type_example”, security_name=”security_name_example”, calc_from_method=”calc_from_method_example”, calc_from_value=3.14, prepay=FIReferencePrepay( prepay_name=”prepay_name_example”, ), settlement=”settlement_example”, ), bank_loans=FIBankLoans( ignore_sinking_fund=True, ), municipal_bonds=FIMunicipalBonds( ignore_sinking_fund=True, use_anticipated_sink_schedule=True, ), loss=FILoss( loss_name=”loss_name_example”, ), prepay=FIPrepay( prepay_name=”prepay_name_example”, ), matrix_spread_adjustment=3.14, matrix_multiplier=3.14, structured_products=FIStructuredProductsForSecurities( servicer_advances=FIServicerAdvancesForSecurities( principal=3.14, interest=3.14, advance_type=”Advances All”, ), ignore_financial_guarantee=”ignore_financial_guarantee_example”, clean_up_call_method=True, do_opt_redeem=”do_opt_redeem_example”, prepay_lockout=FIPrepayLockout( points_above=”ANY”, ym_above=”ANY”, ), cashflows=FICashflows( optional_redemption_call_when_units=”Manual”, optional_redemption_call_when=1, recovery_lag=1, ), balloon_extension=FIBalloonExtension( months=1, percentage=3.14, amortization_type=”Loan_Amort_None”, units=”units_example”, coupon_stepup=3.14, ), ), attribution=FIAttributionForSecurities( start_price=3.14, end_price=3.14, start_spread=3.14, end_spread=3.14, pricing_method=”Inputted Price”, ), calc_from_method=”calc_from_method_example”, calc_from_value=3.14, face=1, face_type=”Current”, symbol=”symbol_example”, discount_curve=”discount_curve_example”, ), ], calculations=[ “calculations_example”, ], job_settings=FIJobSettings( as_of_date=”as_of_date_example”, partial_duration_months=[ 1, ], call_method=”No Call”, settlement=”settlement_example”, calc_from_method=”calc_from_method_example”, bank_loans=FIBankLoans( ignore_sinking_fund=True, ), municipal_bonds=FIMunicipalBondsForJobSettings( allow_sink_for_installment_payment=True, ignore_sinking_fund=True, use_anticipated_sink_schedule=True, ), market_environment=FIMarketEnvironment( rate_path=”FLAT & FORWARD”, ), structured_products=FIStructuredProductsForJobSettings( servicer_advances=FIServicerAdvances( advance_type=”Advances All”, ), ignore_financial_guarantee=”ignore_financial_guarantee_example”, clean_up_call_method=True, do_opt_redeem=”do_opt_redeem_example”, prepay_lockout=FIPrepayLockout( points_above=”ANY”, ym_above=”ANY”, ), cashflows=FICashflows( optional_redemption_call_when_units=”Manual”, optional_redemption_call_when=1, recovery_lag=1, ), balloon_extension=FIBalloonExtension( months=1, percentage=3.14, amortization_type=”Loan_Amort_None”, units=”units_example”, coupon_stepup=3.14, ), ), attribution=FIAttributionForJobSettings( start_date=”start_date_example”, end_date=”end_date_example”, ), ), ), meta=CalculationMeta( contentorganization=”SimplifiedRow”, stach_content_organization=”SimplifiedRow”, contenttype=”Json”, format=”JsonStach”, ), ) # FICalculationParametersRoot | Calculation Parameters (optional)

# example passing only required values which don't have defaults set
try:
    # Create or Update FI calculation and run it.
    api_response = api_instance.put_and_calculate(id)
    pprint(api_response)
except fds.analyticsapi.engines.ApiException as e:
    print("Exception when calling FICalculationsApi->put_and_calculate: %s\n" % e)

# example passing only required values which don't have defaults set
# and optional values
try:
    # Create or Update FI calculation and run it.
    api_response = api_instance.put_and_calculate(id, x_fact_set_api_long_running_deadline=x_fact_set_api_long_running_deadline, cache_control=cache_control, fi_calculation_parameters_root=fi_calculation_parameters_root)
    pprint(api_response)
except fds.analyticsapi.engines.ApiException as e:
    print("Exception when calling FICalculationsApi->put_and_calculate: %s\n" % e) ```

Parameters

Name	Type	Description	Notes
id	str	from url, provided from the location header in the Create and Run FI calculation endpoint
x_fact_set_api_long_running_deadline	int	Long running deadline in seconds. Example value is set to 10s. Please update it as per requirement before triggering a calculation.	[optional]
cache_control	str	Standard HTTP header. Accepts max-stale.	[optional]
fi_calculation_parameters_root	FICalculationParametersRoot	Calculation Parameters	[optional]

Return type

A tuple with response data, HTTP status code and response headers.
Response datatype: (For 202 status - CalculationInfoRoot)(For 201 status - ObjectRoot)

Authorization

Basic, Bearer

HTTP request headers

Content-Type: application/json
Accept: application/json, application/x-protobuf

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| 202 | Expected response, contains the poll URL in the Location header. | * Location - URL to poll for the resulting calculation
* 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.
| 201 | Expected response if calculation is completed in a short span, returns JSON in the format specified in the Calculation parameters. | * 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 Calculation Parameters. | * 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 | One or more calculation settings were unavailable. | * 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.
| 409 | Duplicate calculation exists with same parameters. | * 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.
| 415 | Missing/Invalid Content-Type 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. Cancel older requests using Cancel Calculation endpoint or wait for older requests to finish/expire. | * 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.
* 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.FICalculationsApi

cancel_calculation_by_id

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

get_calculation_parameters

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

get_calculation_result

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

get_calculation_status_by_id

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

post_and_calculate

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