Access AlphaIQ's generative insights, explainable investment signals, and the Corporate Transparency Score model
Project description
AlphaIQ Python SDK
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.
Installation
Requirements.
Python 3.9+
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
Getting Started
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
Documentation for API Endpoints
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 |
Documentation For Models
- CompanyInfoModel
- CompanyInfoModel1
- FileDownloadModel
- FileDownloadModel1
- FileDownloadModelData
- FileDownloadModelData1
- GenerativeSignalExplanationModel
- GenerativeCompanyCompassReportContentModel
- GenerativeCompanyCompassReportContentModelData
- GenerativeCompanyCompassReportContentModelDataCompassContent
- GenerativeCompanyQuestionAnswerModel
- GenerativeCompanyQuestionAnswerModelData
- GenerativeCompanyQuestionAnswerModelDataQuestionAnswerItems
- MappingCompanyIdentifierMappingModel
- MappingCompanyIdentifierMappingModelDataItems
- ModelsSpindexModel
- ModelsSpindexModelData
- ModelsSpindexModelItems
- SignalsQuantLinguisticsModelData
- SignalsQuantLinguisticsModelRoot
- SignalsQuantLinguisticsSignalsModel2
bearer
Authorization is a bearer token. That bearer token is your API key.
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.9-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 064314a1a287f5e46e428ca81cd5add70032eca4c19a207dfc43cf2fadd1d4aa |
|
MD5 | 982406b18a806d69013001d0b57e574d |
|
BLAKE2b-256 | 4c6200678f0109ff941e1a67032b444be4d9365cf18e4447d45d2716ecc6fb93 |