Package: alphaiq-sdk
AlphaIQ Python SDKTo get access to the API,sign up here.Welcome to the AlphaIQ API! We offer Quantitative Linguistic Risk Indicators that enable investors to uncover hidden risks in forward-looking statements from management.To learn more about AlphaIQ,read about us.Review thePrivacy PolicyandTerms of Serviceon our website.InstallationRequirements.Python 2.7 and 3.4+Installation via Pippipinstallalphaiq-sdkThen import the package:importalphaiq_sdkInstallation via GitHubpipinstallgit+https://github.com/alphaiq-ai/python-sdk.git(you may need to runpipwith root permission:sudo pip install git+https://github.com/alphaiq-ai/python-sdk.git)Then import the package:importalphaiq_sdkInstallation via SetuptoolsInstall viaSetuptools.pythonsetup.pyinstall--user(orsudo python setup.py installto install the package for all users)Then import the package:importalphaiq_sdkGetting StartedIt is advised to setup a.envfile the store credentials. Documentation can be foundhere. To use the.envfile to store credentials, install thepython-dotenvpackage with pip:pipinstallpython-dotenvAn example of the contents of the.envfile are shown below:EMAIL=example@emaildomain.com
PASSWORD=VGhpcyBpcyBteSBwYXNzd29yZCBlbmNvZGVkIHRvIEJhc2U2NCBmb3JtYXQ=Please follow theinstallation procedureand then run the following to retrieve your bearer token for authentication to other API routes:importosfromdotenvimportload_dotenvimportalphaiq_sdkfromalphaiq_sdk.restimportApiException# Load the environment variables from the .env fileload_dotenv()EMAIL=os.getenv('EMAIL')PASSWORD=os.getenv('PASSWORD')# Define the API configuration, client object and API instanceconfiguration=alphaiq_sdk.Configuration(host='https://data.app.alphaiq.ai/api/v1')withalphaiq_sdk.ApiClient(configuration)asapi_client:# Make an instance of the API classapi_instance=alphaiq_sdk.InvestmentResearchersApi(api_client)# Define the values needed to authenticate to the APIcontent_type='application/json'# str |inline_object=alphaiq_sdk.InlineObject(email=EMAIL,password=PASSWORD)try:# Authenticate using your credentialsapi_response=api_instance.auth_gettoken_post(content_type=content_type,inline_object=inline_object)exceptApiExceptionase:# Log an exception if it occursprint("Exception when calling the API:%s\n"%e)# Extract your bearer token for authentication to other API pathsid_token=api_response.data.id_token# Add the bearer token to the configuration for authenticating other routessetattr(configuration,'access_token',id_token)Documentation for API EndpointsAll URIs are relative tohttps://data.app.alphaiq.ai/api/v1ClassMethodHTTP requestDescriptionInvestmentResearchersApiauth_gettoken_postPOST/auth/gettokenGetTokenInvestmentResearchersApicompany_compass_report_ticker_getGET/company/compass/report/{ticker}CompassReportPDFInvestmentResearchersApicompany_mapping_company_to_security_getGET/company-mapping/company-to-securityCompanyToSecurityInvestmentResearchersApicompany_spindex_get_latest_spindex_factors_getGET/company-spindex/getLatestSpindexFactorsGetLatestSpindexFactorsInvestmentResearchersApicompany_spindex_get_latest_spindex_overall_risk_getGET/company-spindex/getLatestSpindexOverallRiskGetLatestSpindexOverallRiskInvestmentResearchersApicompany_spindex_get_timeseries_spindex_factors_getGET/company-spindex/getTimeseriesSpindexFactorsGetTimeseriesSpindexFactorsInvestmentResearchersApicompany_spindex_get_timeseries_spindex_overall_risk_getGET/company-spindex/getTimeseriesSpindexOverallRiskGetTimeseriesSpindexOverallRiskInvestmentResearchersApicompany_spinsights_report_ticker_getGET/company/spinsights/report/{ticker}SpinsightsReportPDFInvestmentResearchersApifactor_library_compass_questions_getGET/factor-library/compass-questionsGetCompassQuestionsInvestmentResearchersApifactor_library_spindex_factors_getGET/factor-library/spindex-factorsGetSpindexFactorsInvestmentResearchersApigenerative_company_compass_report_content_ticker_getGET/generative/company/compass/reportContent/{ticker}GetCompassReportContentInvestmentResearchersApigenerative_company_question_answer_ticker_getGET/generative/company/questionAnswer/{ticker}GetCompassExplorerQuestionAnswerInvestmentResearchersApigenerative_company_spinsights_explorer_ticker_getGET/generative/company/spinsights/explorer/{ticker}GetSpinsightsExplorerInvestmentResearchersApigenerative_company_spinsights_report_content_ticker_getGET/generative/company/spinsights/reportContent/{ticker}GetSpinsightsReportContentDocumentation For ModelsCategoryInlineObjectInlineObject1InlineObject2InlineObject3InlineObject4InlineResponse200InlineResponse2001InlineResponse20010InlineResponse20010DataInlineResponse20011InlineResponse20011DataInlineResponse20011DataLvl2IndustriesWithLatestAvgOverallriskInlineResponse20011DataLvl3IndustriesWithLatestAvgOverallriskInlineResponse20012InlineResponse20012ConsumerProductsAndServicesInlineResponse20012DataInlineResponse20012EnergyInlineResponse20012FinancialsInlineResponse20012FoodInlineResponse20012HealthcareInlineResponse20012IndustrialsInlineResponse20012InformationInlineResponse20012InformationToolsInlineResponse20013InlineResponse20013DataInlineResponse20014InlineResponse20014DataInlineResponse20015InlineResponse20015DataInlineResponse20016InlineResponse20016Company1InlineResponse20016DataInlineResponse20017InlineResponse20017DataInlineResponse20018InlineResponse20018DataInlineResponse20018DataChevronCorpCVXInlineResponse20019InlineResponse2001DataInlineResponse2002InlineResponse20020InlineResponse20020DataInlineResponse20021InlineResponse20021DataInlineResponse20022InlineResponse20022DataInlineResponse20023InlineResponse20023DataInlineResponse20024InlineResponse20024DataInlineResponse20024DataSpinsightsContentInlineResponse20025InlineResponse20025DataInlineResponse20025DataCompassContentInlineResponse20026InlineResponse20026DataInlineResponse20026DataQuestionAnswerInlineResponse20027InlineResponse20027DataInlineResponse20028InlineResponse20028DataInlineResponse20029InlineResponse20029DataInlineResponse2002DataInlineResponse2002DataQuestionContextInlineResponse2002DataQuestionsInlineResponse2003InlineResponse2003DataInlineResponse2003DataSpinsightsExplorerInlineResponse2004InlineResponse2005InlineResponse2005DataInlineResponse2006InlineResponse2007InlineResponse2007DataInlineResponse2007DataHighRiskCompaniesInlineResponse2008InlineResponse2008DataInlineResponse2008DataFinancialsInlineResponse2008DataFinancialsDrillDownIndustriesDetailsInlineResponse2008DataFinancialsRealEstateInlineResponse2008DataFinancialsRealEstateDrillDownIndustriesDetailsInlineResponse2008DataFinancialsRealEstateRealEstateRentalInlineResponse2008DataFinancialsRealEstateRealEstateRentalHighRiskCompaniesInlineResponse2008DataIndustriesDetailsInlineResponse2009InlineResponse2009DataInlineResponse2009DataHighriskIndustriesInlineResponse200DataInlineResponse405InlineResponse405ErrorsPetTag