Package: fds.sdk.IRNCustomSymbols
IRN Custom Symbols client library for PythonAllows users to extract, create, update and configure IRN data.This Python package is automatically generated by theOpenAPI Generatorproject:API version: 1Package version: 1.0.7Build package: org.openapitools.codegen.languages.PythonClientCodegenRequirementsPython >= 3.7InstallationPoetrypoetryaddfds.sdk.utilsfds.sdk.IRNCustomSymbols==1.0.7pippipinstallfds.sdk.utilsfds.sdk.IRNCustomSymbols==1.0.7UsageGenerate authentication credentials.Setup Python environment.Install and activate python 3.7+. If you're usingpyenv:pyenvinstall3.9.7
pyenvshell3.9.7(optional)Install poetry.Install dependencies.Run the following:fromfds.sdk.utils.authenticationimportConfidentialClientimportfds.sdk.IRNCustomSymbolsfromfds.sdk.IRNCustomSymbols.apiimportcustom_symbols_apifromfds.sdk.IRNCustomSymbols.modelsimport*fromdateutil.parserimportparseasdateutil_parserfrompprintimportpprint# See configuration.py for a list of all supported configuration parameters.# Examples for each supported authentication method are below,# choose one that satisfies your use case.# (Preferred) OAuth 2.0: FactSetOAuth2# See https://github.com/FactSet/enterprise-sdk#oauth-20# for information on how to create the app-config.json file## The confidential client instance should be reused in production environments.# See https://github.com/FactSet/enterprise-sdk-utils-python#authentication# for more information on using the ConfidentialClient classconfiguration=fds.sdk.IRNCustomSymbols.Configuration(fds_oauth_client=ConfidentialClient('/path/to/app-config.json'))# Basic authentication: FactSetApiKey# See https://github.com/FactSet/enterprise-sdk#api-key# for information how to create an API key# configuration = fds.sdk.IRNCustomSymbols.Configuration(#     username='USERNAME-SERIAL',#     password='API-KEY'# )# Enter a context with an instance of the API clientwithfds.sdk.IRNCustomSymbols.ApiClient(configuration)asapi_client:# Create an instance of the API classapi_instance=custom_symbols_api.CustomSymbolsApi(api_client)# NOTE: The parameter variable defined below is just an example and may potentially contain non valid values. So please replace this with valid values.create_custom_symbol_dto=CreateCustomSymbolDto(code="code_example",name="name_example",description="description_example",type_id="type_id_example",sub_type_id="sub_type_id_example",google_maps_place_id="google_maps_place_id_example",formatted_address="formatted_address_example",city="city_example",state_province="state_province_example",postal_code="postal_code_example",country="country_example",custom_field_values=[CreateCustomSymbolCustomFieldValueDto(code="code_example",text_value="text_value_example",numeric_value=3.14,date_value="date_value_example",extended_text_value="extended_text_value_example",option_values=["option_values_example",],contact_ids=["contact_ids_example",],),],)# CreateCustomSymbolDto | createCustomSymbolDto object to save (optional)try:# Create a custom symbol# example passing only required values which don't have defaults set# and optional valuesapi_response=api_instance.create_custom_symbol(create_custom_symbol_dto=create_custom_symbol_dto)pprint(api_response)exceptfds.sdk.IRNCustomSymbols.ApiExceptionase:print("Exception when calling CustomSymbolsApi->create_custom_symbol:%s\n"%e)# # Get response, http status code and response headers# try:#     # Create a custom symbol#     api_response, http_status_code, response_headers = api_instance.create_custom_symbol_with_http_info(create_custom_symbol_dto=create_custom_symbol_dto)#     pprint(api_response)#     pprint(http_status_code)#     pprint(response_headers)# except fds.sdk.IRNCustomSymbols.ApiException as e:#     print("Exception when calling CustomSymbolsApi->create_custom_symbol: %s\n" % e)# # Get response asynchronous# try:#     # Create a custom symbol#     async_result = api_instance.create_custom_symbol_async(create_custom_symbol_dto=create_custom_symbol_dto)#     api_response = async_result.get()#     pprint(api_response)# except fds.sdk.IRNCustomSymbols.ApiException as e:#     print("Exception when calling CustomSymbolsApi->create_custom_symbol: %s\n" % e)# # Get response, http status code and response headers asynchronous# try:#     # Create a custom symbol#     async_result = api_instance.create_custom_symbol_with_http_info_async(create_custom_symbol_dto=create_custom_symbol_dto)#     api_response, http_status_code, response_headers = async_result.get()#     pprint(api_response)#     pprint(http_status_code)#     pprint(response_headers)# except fds.sdk.IRNCustomSymbols.ApiException as e:#     print("Exception when calling CustomSymbolsApi->create_custom_symbol: %s\n" % e)Using PandasTo convert an API response to a Pandas DataFrame, it is necessary to transform it first to a dictionary.importpandasaspdresponse_dict=api_response.to_dict()['data']simple_json_response=pd.DataFrame(response_dict)nested_json_response=pd.json_normalize(response_dict)DebuggingThe SDK uses the standard libraryloggingmodule.SettingdebugtoTrueon an instance of theConfigurationclass sets the log-level of related packages toDEBUGand enables additional logging in PythonsHTTP Client.Note: This prints out sensitive information (e.g. the full request and response). Use with care.importloggingimportfds.sdk.IRNCustomSymbolslogging.basicConfig(level=logging.DEBUG)configuration=fds.sdk.IRNCustomSymbols.Configuration(...)configuration.debug=TrueConfigure a ProxyYou can pass proxy settings to the Configuration class:proxy: The URL of the proxy to use.proxy_headers: a dictionary to pass additional headers to the proxy (e.g.Proxy-Authorization).importfds.sdk.IRNCustomSymbolsconfiguration=fds.sdk.IRNCustomSymbols.Configuration(# ...proxy="http://secret:password@localhost:5050",proxy_headers={"Custom-Proxy-Header":"Custom-Proxy-Header-Value"})Custom SSL CertificateTLS/SSL certificate verification can be configured with the following Configuration parameters:ssl_ca_cert: a path to the certificate to use for verification inPEMformat.verify_ssl: setting this toFalsedisables the verification of certificates.
Disabling the verification is not recommended, but it might be useful during
local development or testing.importfds.sdk.IRNCustomSymbolsconfiguration=fds.sdk.IRNCustomSymbols.Configuration(# ...ssl_ca_cert='/path/to/ca.pem')Documentation for API EndpointsAll URIs are relative tohttps://api.factset.com/research/irnClassMethodHTTP requestDescriptionCustomSymbolsApicreate_custom_symbolPOST/v1/custom-symbolsCreate a custom symbolCustomSymbolsApidelete_custom_symbolDELETE/v1/custom-symbols/{customSymbolId}Delete a custom symbolCustomSymbolsApiget_custom_symbolGET/v1/custom-symbols/{customSymbolId}Get all custom field and standard field details on a specific custom symbolCustomSymbolsApiget_custom_symbol_recordsGET/v1/custom-symbols/{customSymbolId}/recordsGet all notes and meetings where a specific customSymbol was tagged as primary or related identifierCustomSymbolsApiget_custom_symbolsGET/v1/custom-symbolsGet list of all custom symbols in your group along with some of their standard field and custom fields dataCustomSymbolsApilink_custom_symbol_to_standard_symbolPOST/v1/custom-symbols/{customSymbolId}/link-standard-symbolLink custom symbol to standard symbolCustomSymbolsApipatch_custom_symbolPATCH/v1/custom-symbols/{customSymbolId}Edit a custom symbol’s standard field and custom field dataCustomSymbolsRelationshipsApicreate_symbol_relationshipPOST/v1/symbol-relationshipsCreate a symbol relationshipCustomSymbolsRelationshipsApidelete_symbol_relationshipDELETE/v1/symbol-relationships/{symbolRelationshipId}Delete a symbol relationshipCustomSymbolsRelationshipsApiedit_and_add_symbol_relationshipPUT/v1/symbol-relationships/{symbol}Edit a symbol relationshipCustomSymbolsRelationshipsApiget_symbol_relationshipGET/v1/symbol-relationships/{symbolRelationshipId}Get details on a specific symbol relationshipCustomSymbolsRelationshipsApiget_symbol_relationshipsGET/v1/symbol-relationships/{symbolId}/relationshipsReturns a list of a symbol’s relationshipsHybridSymbolsApicreate_standard_symbol_metadataPOST/v1/custom-symbols/standard-symbol-metadataCreate standard symbol metadataHybridSymbolsApiget_standard_symbol_metadata_guidGET/v1/custom-symbols/standard-symbol-metadata/{standardSymbol}Get all custom field and standard field details on a specific standard symbolHybridSymbolsApipatch_standard_symbolPATCH/v1/custom-symbols/standard-symbol-metadata/{standardSymbolId}Edit a standard symbol’s standard field and custom field dataDocumentation For ModelsCreateCustomSymbolCustomFieldValueDtoCreateCustomSymbolDtoCreateStandardSymbolMetadataDtoCustomSymbolAddressDtoCustomSymbolContactCustomSymbolCustomFieldValueDtoCustomSymbolDtoCustomSymbolSubTypeSummaryDtoCustomSymbolTypeSummaryDtoInstrumentDtoNewItemDtoOperationOperationTypeProblemDetailsRecordPreviewDtoStandardSymbolDtoSymbolIdNameDtoSymbolRelationshipDtoSymbolRelationshipSaveDtoSymbolRelationshipUpdateDtoSymbolsRelationshipIdNameDtoDocumentation For AuthorizationFactSetApiKeyType: HTTP basic authenticationFactSetOAuth2Type: OAuthFlow: applicationAuthorization URL:Scopes: N/ANotes for Large OpenAPI documentsIf the OpenAPI document is large, imports in fds.sdk.IRNCustomSymbols.apis and fds.sdk.IRNCustomSymbols.models may fail with a
RecursionError indicating the maximum recursion limit has been exceeded. In that case, there are a couple of solutions:Solution 1:
Use specific imports for apis and models like:from fds.sdk.IRNCustomSymbols.api.default_api import DefaultApifrom fds.sdk.IRNCustomSymbols.model.pet import PetSolution 2:
Before importing the package, adjust the maximum recursion limit as shown below:import sys
sys.setrecursionlimit(1500)
import fds.sdk.IRNCustomSymbols
from fds.sdk.IRNCustomSymbols.apis import *
from fds.sdk.IRNCustomSymbols.models import *ContributingPlease refer to thecontributing guide.CopyrightCopyright 2022 FactSet Research Systems IncLicensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License athttp://www.apache.org/licenses/LICENSE-2.0Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.