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 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'
startDate='2023-03-01'
endDate='2023-05-01'
response = client.get_quant_linguistics_signals(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_quant_linguistics_signals | GET /signals/quantLinguistics | SignalsQuantLinguistics |
get_bulk_signals | GET /bulk/signals | BulkFileSignals |
get_bulk_signals_yearly | GET /bulk/signals/yearly | BulkFileSignalsYearly |
get_models_spindex | GET /models/spindex | ModelsSpindex |
get_bulk_model | GET /bulk/models | BulkFileModels |
get_company_identifiers | GET /mapping/companyIdentifierMapping | MappingCompanyIdentifiers |
get_compass_questions | GET /mapping/compassQuestions | MappingCompassQuestions |
get_spindex_factors | GET /mapping/spindexFactors | MappingSpindexFactors |
get_bulk_mapping | GET /bulk/mapping | BulkFileMapping |
get_spinsights_explorer_spindex_summary | GET /generative/company/spinsights/explorerContent/{ticker} | GetSpinsightsExplorerSpindexSummary |
get_spinsights_report_content | GET /generative/company/spinsights/reportContent/{ticker} | GetSpinsightsReportContent |
get_spinsights_report_pdf | GET /company/spinsights/reportPDF/{ticker} | SpinsightsReportPDF |
get_compass_explorer_question_answer | GET /generative/company/compass/questionContent/{ticker} | GetCompassExplorerQuestionAnswer |
get_compass_report_content | GET /generative/company/compass/reportContent/{ticker} | GetCompassReportContent |
get_compass_report_pdf | GET /company/compass/reportPDF/{ticker} | CompassReportPDF |
Documentation For Models
- CompanyInfoModel
- CompanyInfoModel1
- FactorLibrarySpindexFactorsDataItems
- FileDownloadModel
- FileDownloadModel1
- FileDownloadModelData
- FileDownloadModelData1
- GenerativeCompanyCompassReportContentModel
- GenerativeCompanyCompassReportContentModelData
- GenerativeCompanyCompassReportContentModelDataCompassContent
- GenerativeCompanyQuestionAnswerModel
- GenerativeCompanyQuestionAnswerModelData
- GenerativeCompanyQuestionAnswerModelDataQuestionAnswerItems
- GenerativeCompanySpinsightsExplorerModel
- GenerativeCompanySpinsightsExplorerModelData
- GenerativeCompanySpinsightsExplorerModelDataSpinsightsExplorerItems
- GenerativeCompanySpinsightsReportContentModel
- GenerativeCompanySpinsightsReportContentModelData
- GenerativeCompanySpinsightsReportContentModelDataSpinsightsContent
- MappingCompanyIdentifierMappingModel
- MappingCompanyIdentifierMappingModelDataItems
- MappingCompassQuestionsModel
- MappingCompassQuestionsModelDataItems
- MappingSpindexFactorsModel
- 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.7-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 26d5a1e6a84857c49889b4816baf081d448763d4b0ede53ec0aa7749409cb211 |
|
MD5 | e5e9ff3fff2d1c4f7eaa3ebcf46d8179 |
|
BLAKE2b-256 | 8bfecbef9bea25447594b7c7c2b5d21cae1d516bcd23088813153af934531863 |