Access AlphaIQ's generative insights, explainable investment signals, and the Corporate Transparency Score model
To get access to the API, sign up here for a free Demo.
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 our blog.
Review the Privacy Policy and Terms of Service on our website.
Python 3.9+
pip install alphaiq-sdk
Then import the package:
import alphaiq_sdk
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
It is advised to setup a .env file the store API key. 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:
APIKEY=keytoken123
Please follow the installation procedure and then you are ready to get started.
import os
from dotenv import load_dotenv
import alphaiq_sdk
# Load the environment variables from the .env file
load_dotenv()
APIKEY = os.getenv('APIKEY')
client = alphaiq_sdk.client(APIKEY)
## get_quant_linguistics_signals
def get_quant_linguistics_signals():
client = alphaiq_sdk.client(APIKEY)
ticker='TSLA'
signalVariation='CHANGE'
startDate='2023-03-01'
endDate='2023-05-01'
response = client.get_quant_linguistics_signals(signalVariation,startDate,endDate,ticker=ticker)
return response
All URIs are relative to https://data.app.alphaiq.ai/api/v1
| Method | HTTP request | Description |
|---|---|---|
| get_signal_explanations | GET /generative/company/signal_explanation/{ticker} | GetSignalExplanations |
| get_trending_content | GET /generative/company/compass/reportContent/{ticker} | GetTrendingGenerative |
| get_question_answer | GET /generative/company/compass/questionContent/{ticker} | GetQuestionAnswer |
| get_compass_report_pdf | GET /pdf/compass/{ticker} | CompassReportPDF |
| get_quant_linguistics_signals | GET /signals/quantLinguistics | SignalsQuantLinguistics |
| get_bulk_signals_all | GET /bulk/signals/all | BulkFileSignalsAll |
| get_bulk_signals_top_level | GET /bulk/signals/topLevel | BulkFileSignalsTopLevel |
| get_models_corporate_transparency | GET /models/corporateTransparency | ModelsCorporateTransparency |
| get_bulk_model | GET /bulk/models | BulkFileModels |
| get_company_identifiers_map | GET /mapping/companyIdentifierMapping | MappingCompanyIdentifiers |
| get_bulk_mapping | GET /bulk/mapping | BulkFileMapping |
Authorization is a bearer token. That bearer token is your API key.
FAQs
Access AlphaIQ's generative insights, explainable investment signals, and the Corporate Transparency Score model
We found that alphaiq-sdk demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
The Socket Research Team breaks down a malicious wrapper package that uses obfuscation to harvest credentials and exfiltrate sensitive data.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.
Security News
The Ultralytics' PyPI Package was compromised four times in one weekend through GitHub Actions cache poisoning and failure to rotate previously compromised API tokens.