Access AlphaIQ quantitative linguistics signals and generative content
Project description
AlphaIQ Python SDK
To 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 the Privacy Policy and Terms of Service on our website.
Installation
Requirements.
Python 2.7 and 3.4+
Installation via Pip
pip install alphaiq-sdk
Then import the package:
import alphaiq_sdk
Installation via GitHub
pip install git+https://github.com/alphaiq-ai/python-sdk.git
(you may need to run pip
with root permission: sudo pip install git+https://github.com/alphaiq-ai/python-sdk.git
)
Then import the package:
import alphaiq_sdk
Installation via Setuptools
Install via Setuptools.
python setup.py install --user
(or sudo python setup.py install
to install the package for all users)
Then import the package:
import alphaiq_sdk
Getting Started
It is advised to setup a .env
file the store credentials. Documentation can be found here. To use the .env
file to store credentials, install the python-dotenv
package with pip:
pip install python-dotenv
An example of the contents of the .env
file are shown below:
EMAIL=example@emaildomain.com
PASSWORD=VGhpcyBpcyBteSBwYXNzd29yZCBlbmNvZGVkIHRvIEJhc2U2NCBmb3JtYXQ=
Please follow the installation procedure and then run the following to retrieve your bearer token for authentication to other API routes:
import os
from dotenv import load_dotenv
import alphaiq_sdk
from alphaiq_sdk.rest import ApiException
# Load the environment variables from the .env file
load_dotenv()
EMAIL = os.getenv('EMAIL')
PASSWORD = os.getenv('PASSWORD')
# Define the API configuration, client object and API instance
configuration = alphaiq_sdk.Configuration(
host = 'https://data.app.alphaiq.ai/api/v1'
)
with alphaiq_sdk.ApiClient(configuration) as api_client:
# Make an instance of the API class
api_instance = alphaiq_sdk.InvestmentResearchersApi(api_client)
# Define the values needed to authenticate to the API
content_type = 'application/json' # str |
inline_object = alphaiq_sdk.InlineObject(
email = EMAIL,
password = PASSWORD
)
try:
# Authenticate using your credentials
api_response = api_instance.auth_gettoken_post(
content_type = content_type,
inline_object=inline_object
)
except ApiException as e:
# Log an exception if it occurs
print("Exception when calling the API: %s\n" % e)
# Extract your bearer token for authentication to other API paths
id_token = api_response.data.id_token
# Add the bearer token to the configuration for authenticating other routes
setattr(configuration, 'access_token', id_token)
Documentation for API Endpoints
All URIs are relative to https://data.app.alphaiq.ai/api/v1
Class | Method | HTTP request | Description |
---|---|---|---|
InvestmentResearchersApi | auth_gettoken_post | POST /auth/gettoken | GetToken |
InvestmentResearchersApi | company_compass_report_ticker_get | GET /company/compass/report/{ticker} | CompassReportPDF |
InvestmentResearchersApi | company_mapping_company_to_security_get | GET /company-mapping/company-to-security | CompanyToSecurity |
InvestmentResearchersApi | company_spindex_get_latest_spindex_factors_get | GET /company-spindex/getLatestSpindexFactors | GetLatestSpindexFactors |
InvestmentResearchersApi | company_spindex_get_latest_spindex_overall_risk_get | GET /company-spindex/getLatestSpindexOverallRisk | GetLatestSpindexOverallRisk |
InvestmentResearchersApi | company_spindex_get_timeseries_spindex_factors_get | GET /company-spindex/getTimeseriesSpindexFactors | GetTimeseriesSpindexFactors |
InvestmentResearchersApi | company_spindex_get_timeseries_spindex_overall_risk_get | GET /company-spindex/getTimeseriesSpindexOverallRisk | GetTimeseriesSpindexOverallRisk |
InvestmentResearchersApi | company_spinsights_report_ticker_get | GET /company/spinsights/report/{ticker} | SpinsightsReportPDF |
InvestmentResearchersApi | factor_library_compass_questions_get | GET /factor-library/compass-questions | GetCompassQuestions |
InvestmentResearchersApi | factor_library_spindex_factors_get | GET /factor-library/spindex-factors | GetSpindexFactors |
InvestmentResearchersApi | generative_company_compass_report_content_ticker_get | GET /generative/company/compass/reportContent/{ticker} | GetCompassReportContent |
InvestmentResearchersApi | generative_company_question_answer_ticker_get | GET /generative/company/questionAnswer/{ticker} | GetCompassExplorerQuestionAnswer |
InvestmentResearchersApi | generative_company_spinsights_explorer_ticker_get | GET /generative/company/spinsights/explorer/{ticker} | GetSpinsightsExplorer |
InvestmentResearchersApi | generative_company_spinsights_report_content_ticker_get | GET /generative/company/spinsights/reportContent/{ticker} | GetSpinsightsReportContent |
Documentation For Models
- Category
- InlineObject
- InlineObject1
- InlineObject2
- InlineObject3
- InlineObject4
- InlineResponse200
- InlineResponse2001
- InlineResponse20010
- InlineResponse20010Data
- InlineResponse20011
- InlineResponse20011Data
- InlineResponse20011DataLvl2IndustriesWithLatestAvgOverallrisk
- InlineResponse20011DataLvl3IndustriesWithLatestAvgOverallrisk
- InlineResponse20012
- InlineResponse20012ConsumerProductsAndServices
- InlineResponse20012Data
- InlineResponse20012Energy
- InlineResponse20012Financials
- InlineResponse20012Food
- InlineResponse20012Healthcare
- InlineResponse20012Industrials
- InlineResponse20012Information
- InlineResponse20012InformationTools
- InlineResponse20013
- InlineResponse20013Data
- InlineResponse20014
- InlineResponse20014Data
- InlineResponse20015
- InlineResponse20015Data
- InlineResponse20016
- InlineResponse20016Company1
- InlineResponse20016Data
- InlineResponse20017
- InlineResponse20017Data
- InlineResponse20018
- InlineResponse20018Data
- InlineResponse20018DataChevronCorpCVX
- InlineResponse20019
- InlineResponse2001Data
- InlineResponse2002
- InlineResponse20020
- InlineResponse20020Data
- InlineResponse20021
- InlineResponse20021Data
- InlineResponse20022
- InlineResponse20022Data
- InlineResponse20023
- InlineResponse20023Data
- InlineResponse20024
- InlineResponse20024Data
- InlineResponse20024DataSpinsightsContent
- InlineResponse20025
- InlineResponse20025Data
- InlineResponse20025DataCompassContent
- InlineResponse20026
- InlineResponse20026Data
- InlineResponse20026DataQuestionAnswer
- InlineResponse20027
- InlineResponse20027Data
- InlineResponse20028
- InlineResponse20028Data
- InlineResponse20029
- InlineResponse20029Data
- InlineResponse2002Data
- InlineResponse2002DataQuestionContext
- InlineResponse2002DataQuestions
- InlineResponse2003
- InlineResponse2003Data
- InlineResponse2003DataSpinsightsExplorer
- InlineResponse2004
- InlineResponse2005
- InlineResponse2005Data
- InlineResponse2006
- InlineResponse2007
- InlineResponse2007Data
- InlineResponse2007DataHighRiskCompanies
- InlineResponse2008
- InlineResponse2008Data
- InlineResponse2008DataFinancials
- InlineResponse2008DataFinancialsDrillDownIndustriesDetails
- InlineResponse2008DataFinancialsRealEstate
- InlineResponse2008DataFinancialsRealEstateDrillDownIndustriesDetails
- InlineResponse2008DataFinancialsRealEstateRealEstateRental
- InlineResponse2008DataFinancialsRealEstateRealEstateRentalHighRiskCompanies
- InlineResponse2008DataIndustriesDetails
- InlineResponse2009
- InlineResponse2009Data
- InlineResponse2009DataHighriskIndustries
- InlineResponse200Data
- InlineResponse405
- InlineResponse405Errors
- Pet
- Tag
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for alphaiq_sdk-0.2.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0e26ac6dcd7375ea71257221f32285ae68523daf612d7f157f837891a2765c4e |
|
MD5 | 86216099457038fd25269de2dafc8019 |
|
BLAKE2b-256 | e0bb0a882aa583a0d0be7cd0ca46ea58372d6f77cdca24bef00a172f6fbbbb86 |