|
| 1 | + |
| 2 | +# fds.analyticsapi.engines.DiscountCurvesApi |
| 3 | + |
| 4 | +All URIs are relative to *https://api.factset.com* |
| 5 | + |
| 6 | +Method | HTTP request | Description |
| 7 | +------------- | ------------- | ------------- |
| 8 | +[**get_all_fi_discount_curves**](DiscountCurvesApi.md#get_all_fi_discount_curves) | **GET** /analytics/engines/fi/v3/discount-curves | Get Discount Curves |
| 9 | + |
| 10 | + |
| 11 | +# **get_all_fi_discount_curves** |
| 12 | +> FIDiscountCurveInfoRoot get_all_fi_discount_curves() |
| 13 | +
|
| 14 | +Get Discount Curves |
| 15 | + |
| 16 | +This endpoint lists all the discount curves that can be applied to a FI calculation. |
| 17 | + |
| 18 | +### Example |
| 19 | + |
| 20 | +* Basic Authentication (Basic): |
| 21 | +* Bearer Authentication (Bearer): |
| 22 | +```python |
| 23 | +import time |
| 24 | +import fds.analyticsapi.engines |
| 25 | +from fds.analyticsapi.engines.api import discount_curves_api |
| 26 | +from fds.analyticsapi.engines.model.fi_discount_curve_info_root import FIDiscountCurveInfoRoot |
| 27 | +from fds.analyticsapi.engines.model.client_error_response import ClientErrorResponse |
| 28 | +from pprint import pprint |
| 29 | +# Defining the host is optional and defaults to https://api.factset.com |
| 30 | +# See configuration.py for a list of all supported configuration parameters. |
| 31 | +configuration = fds.analyticsapi.engines.Configuration( |
| 32 | + host = "https://api.factset.com" |
| 33 | +) |
| 34 | + |
| 35 | +# The client must configure the authentication and authorization parameters |
| 36 | +# in accordance with the API server security policy. |
| 37 | +# Examples for each auth method are provided below, use the example that |
| 38 | +# satisfies your auth use case. |
| 39 | + |
| 40 | +# Configure HTTP basic authorization: Basic |
| 41 | +configuration = fds.analyticsapi.engines.Configuration( |
| 42 | + username = 'YOUR_USERNAME', |
| 43 | + password = 'YOUR_PASSWORD' |
| 44 | +) |
| 45 | + |
| 46 | +# Configure Bearer authorization: Bearer |
| 47 | +configuration = fds.analyticsapi.engines.Configuration( |
| 48 | + access_token = 'YOUR_BEARER_TOKEN' |
| 49 | +) |
| 50 | + |
| 51 | +# Enter a context with an instance of the API client |
| 52 | +with fds.analyticsapi.engines.ApiClient(configuration) as api_client: |
| 53 | + # Create an instance of the API class |
| 54 | + api_instance = discount_curves_api.DiscountCurvesApi(api_client) |
| 55 | + currency = "currency_example" # str | (optional) |
| 56 | + |
| 57 | + # example passing only required values which don't have defaults set |
| 58 | + # and optional values |
| 59 | + try: |
| 60 | + # Get Discount Curves |
| 61 | + api_response = api_instance.get_all_fi_discount_curves(currency=currency) |
| 62 | + pprint(api_response) |
| 63 | + except fds.analyticsapi.engines.ApiException as e: |
| 64 | + print("Exception when calling DiscountCurvesApi->get_all_fi_discount_curves: %s\n" % e) |
| 65 | +``` |
| 66 | + |
| 67 | + |
| 68 | +### Parameters |
| 69 | + |
| 70 | +Name | Type | Description | Notes |
| 71 | +------------- | ------------- | ------------- | ------------- |
| 72 | + **currency** | **str**| | [optional] |
| 73 | + |
| 74 | +### Return type |
| 75 | + |
| 76 | + - A tuple with response data, HTTP status code and response headers. |
| 77 | + - **Response datatype**: [**FIDiscountCurveInfoRoot**](FIDiscountCurveInfoRoot.md) |
| 78 | + |
| 79 | +### Authorization |
| 80 | + |
| 81 | +[Basic](../README.md#Basic), [Bearer](../README.md#Bearer) |
| 82 | + |
| 83 | +### HTTP request headers |
| 84 | + |
| 85 | + - **Content-Type**: Not defined |
| 86 | + - **Accept**: application/json |
| 87 | + |
| 88 | + |
| 89 | +### HTTP response details |
| 90 | +| Status code | Description | Response headers | |
| 91 | +|-------------|-------------|------------------| |
| 92 | +**200** | Expected response, returns a list of FI discount curves. | * X-DataDirect-Request-Key - FactSet's request key header. <br> * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. <br> * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. <br> * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. <br> * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets. <br> | |
| 93 | +**404** | Not found | * X-DataDirect-Request-Key - FactSet's request key header. <br> * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. <br> * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. <br> * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. <br> * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets. <br> | |
| 94 | +**401** | Missing or invalid authentication. | * X-DataDirect-Request-Key - FactSet's request key header. <br> * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. <br> | |
| 95 | +**403** | User is forbidden with current credentials | * X-DataDirect-Request-Key - FactSet's request key header. <br> * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. <br> * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. <br> * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. <br> * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets. <br> | |
| 96 | +**406** | Unsupported Accept header. Header needs to be set to application/json. | * X-DataDirect-Request-Key - FactSet's request key header. <br> * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. <br> * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. <br> * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. <br> * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets. <br> | |
| 97 | +**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. <br> * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. <br> * Retry-After - Time to wait in seconds before making a new request as the rate limit has reached. <br> | |
| 98 | +**500** | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. | * X-DataDirect-Request-Key - FactSet's request key header. <br> * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. <br> | |
| 99 | +**503** | Request timed out. Retry the request in sometime. | * X-DataDirect-Request-Key - FactSet's request key header. <br> * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. <br> | |
| 100 | + |
| 101 | +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) |
| 102 | + |
0 commit comments