| Name | alphaiq-sdk JSON |
| Version |
0.2.7
JSON |
| download |
| home_page | None |
| Summary | Access AlphaIQ quantitative linguistics signals and generative content |
| upload_time | 2024-04-07 21:54:11 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.9 |
| license | None |
| keywords |
risk
ai
fintech
investing
nlp
genai
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# AlphaIQ Python SDK
To get access to the API, [sign up here](https://alphaiq.ai).
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](https://alphaiq.ai/about-faq).
Review the [Privacy Policy](https://alphaiq.ai/privacy-policy/) and [Terms of Service](https://alphaiq.ai/terms-of-service/) on our website.
# Installation
## Requirements.
Python 3.9+
## Installation via Pip
```sh
pip install alphaiq-sdk
```
Then import the package:
```python
import alphaiq_sdk
```
## Installation via GitHub
```sh
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:
```python
import alphaiq_sdk
```
# Getting Started
It is advised to setup a ```.env``` file the store API key. Documentation can be found [here](https://pypi.org/project/python-dotenv/). To use the ```.env``` file to store credentials, install the ```python-dotenv``` package with pip:
```python
pip install python-dotenv
```
An example of the contents of the ```.env``` file are shown below:
```
APIKEY=keytoken123
```
Please follow the [installation procedure](#installation) and then you are ready to get started.
```python
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**](docs/InvestmentResearchersApi.md#get_quant_linguistics_signals) | **GET** /signals/quantLinguistics | SignalsQuantLinguistics
[**get_bulk_signals**](docs/InvestmentResearchersApi.md#get_bulk_signals) | **GET** /bulk/signals | BulkFileSignals
[**get_bulk_signals_yearly**](docs/InvestmentResearchersApi.md#get_bulk_signals_yearly) | **GET** /bulk/signals/yearly | BulkFileSignalsYearly
[**get_models_spindex**](docs/InvestmentResearchersApi.md#get_models_spindex) | **GET** /models/spindex | ModelsSpindex
[**get_bulk_model**](docs/InvestmentResearchersApi.md#get_bulk_model) | **GET** /bulk/models | BulkFileModels
[**get_company_identifiers**](docs/InvestmentResearchersApi.md#get_company_identifiers) | **GET** /mapping/companyIdentifierMapping | MappingCompanyIdentifiers
[**get_compass_questions**](docs/InvestmentResearchersApi.md#get_compass_questions) | **GET** /mapping/compassQuestions | MappingCompassQuestions
[**get_spindex_factors**](docs/InvestmentResearchersApi.md#get_spindex_factors) | **GET** /mapping/spindexFactors | MappingSpindexFactors
[**get_bulk_mapping**](docs/InvestmentResearchersApi.md#get_bulk_mapping) | **GET** /bulk/mapping | BulkFileMapping
[**get_spinsights_explorer_spindex_summary**](docs/InvestmentResearchersApi.md#get_spinsights_explorer_spindex_summary) | **GET** /generative/company/spinsights/explorerContent/{ticker} | GetSpinsightsExplorerSpindexSummary
[**get_spinsights_report_content**](docs/InvestmentResearchersApi.md#get_spinsights_report_content) | **GET** /generative/company/spinsights/reportContent/{ticker} | GetSpinsightsReportContent
[**get_spinsights_report_pdf**](docs/InvestmentResearchersApi.md#get_spinsights_report_pdf) | **GET** /company/spinsights/reportPDF/{ticker} | SpinsightsReportPDF
[**get_compass_explorer_question_answer**](docs/InvestmentResearchersApi.md#get_compass_explorer_question_answer) | **GET** /generative/company/compass/questionContent/{ticker} | GetCompassExplorerQuestionAnswer
[**get_compass_report_content**](docs/InvestmentResearchersApi.md#get_compass_report_content) | **GET** /generative/company/compass/reportContent/{ticker} | GetCompassReportContent
[**get_compass_report_pdf**](docs/InvestmentResearchersApi.md#get_compass_report_pdf) | **GET** /company/compass/reportPDF/{ticker} | CompassReportPDF
## Documentation For Models
- [CompanyInfoModel](docs/CompanyInfoModel.md)
- [CompanyInfoModel1](docs/CompanyInfoModel1.md)
- [FactorLibrarySpindexFactorsDataItems](docs/FactorLibrarySpindexFactorsDataItems.md)
- [FileDownloadModel](docs/FileDownloadModel.md)
- [FileDownloadModel1](docs/FileDownloadModel1.md)
- [FileDownloadModelData](docs/FileDownloadModelData.md)
- [FileDownloadModelData1](docs/FileDownloadModelData1.md)
- [GenerativeCompanyCompassReportContentModel](docs/GenerativeCompanyCompassReportContentModel.md)
- [GenerativeCompanyCompassReportContentModelData](docs/GenerativeCompanyCompassReportContentModelData.md)
- [GenerativeCompanyCompassReportContentModelDataCompassContent](docs/GenerativeCompanyCompassReportContentModelDataCompassContent.md)
- [GenerativeCompanyQuestionAnswerModel](docs/GenerativeCompanyQuestionAnswerModel.md)
- [GenerativeCompanyQuestionAnswerModelData](docs/GenerativeCompanyQuestionAnswerModelData.md)
- [GenerativeCompanyQuestionAnswerModelDataQuestionAnswerItems](docs/GenerativeCompanyQuestionAnswerModelDataQuestionAnswerItems.md)
- [GenerativeCompanySpinsightsExplorerModel](docs/GenerativeCompanySpinsightsExplorerModel.md)
- [GenerativeCompanySpinsightsExplorerModelData](docs/GenerativeCompanySpinsightsExplorerModelData.md)
- [GenerativeCompanySpinsightsExplorerModelDataSpinsightsExplorerItems](docs/GenerativeCompanySpinsightsExplorerModelDataSpinsightsExplorerItems.md)
- [GenerativeCompanySpinsightsReportContentModel](docs/GenerativeCompanySpinsightsReportContentModel.md)
- [GenerativeCompanySpinsightsReportContentModelData](docs/GenerativeCompanySpinsightsReportContentModelData.md)
- [GenerativeCompanySpinsightsReportContentModelDataSpinsightsContent](docs/GenerativeCompanySpinsightsReportContentModelDataSpinsightsContent.md)
- [MappingCompanyIdentifierMappingModel](docs/MappingCompanyIdentifierMappingModel.md)
- [MappingCompanyIdentifierMappingModelDataItems](docs/MappingCompanyIdentifierMappingModelDataItems.md)
- [MappingCompassQuestionsModel](docs/MappingCompassQuestionsModel.md)
- [MappingCompassQuestionsModelDataItems](docs/MappingCompassQuestionsModelDataItems.md)
- [MappingSpindexFactorsModel](docs/MappingSpindexFactorsModel.md)
- [ModelsSpindexModel](docs/ModelsSpindexModel.md)
- [ModelsSpindexModelData](docs/ModelsSpindexModelData.md)
- [ModelsSpindexModelItems](docs/ModelsSpindexModelItems.md)
- [SignalsQuantLinguisticsModelData](docs/SignalsQuantLinguisticsModelData.md)
- [SignalsQuantLinguisticsModelRoot](docs/SignalsQuantLinguisticsModelRoot.md)
- [SignalsQuantLinguisticsSignalsModel2](docs/SignalsQuantLinguisticsSignalsModel2.md)
# bearer
Authorization is a bearer token. That bearer token is your API key.
Raw data
{
"_id": null,
"home_page": null,
"name": "alphaiq-sdk",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "risk, AI, fintech, investing, NLP, GenAI",
"author": null,
"author_email": "AlphaIQ <contact@alphaiq.ai>",
"download_url": "https://files.pythonhosted.org/packages/7d/70/72a62ee8ba770845be69b2c5617fa3359ee1d3e073f2812c2114df88beca/alphaiq-sdk-0.2.7.tar.gz",
"platform": null,
"description": "# AlphaIQ Python SDK\r\nTo get access to the API, [sign up here](https://alphaiq.ai).\r\n\r\nWelcome to the AlphaIQ API! We offer Quantitative Linguistic Risk Indicators that enable investors to uncover hidden risks in forward-looking statements from management.\r\n\r\nTo learn more about AlphaIQ, [read about us](https://alphaiq.ai/about-faq).\r\n\r\nReview the [Privacy Policy](https://alphaiq.ai/privacy-policy/) and [Terms of Service](https://alphaiq.ai/terms-of-service/) on our website.\r\n\r\n# Installation\r\n## Requirements.\r\n\r\nPython 3.9+\r\n\r\n## Installation via Pip\r\n\r\n```sh\r\npip install alphaiq-sdk\r\n```\r\n\r\nThen import the package:\r\n\r\n```python\r\nimport alphaiq_sdk \r\n```\r\n\r\n## Installation via GitHub\r\n\r\n```sh\r\npip install git+https://github.com/alphaiq-ai/python-sdk.git\r\n```\r\n(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/alphaiq-ai/python-sdk.git`)\r\n\r\nThen import the package:\r\n```python\r\nimport alphaiq_sdk\r\n```\r\n\r\n# Getting Started\r\n\r\nIt is advised to setup a ```.env``` file the store API key. Documentation can be found [here](https://pypi.org/project/python-dotenv/). To use the ```.env``` file to store credentials, install the ```python-dotenv``` package with pip:\r\n\r\n```python\r\npip install python-dotenv\r\n```\r\n\r\nAn example of the contents of the ```.env``` file are shown below:\r\n\r\n```\r\nAPIKEY=keytoken123\r\n```\r\n\r\nPlease follow the [installation procedure](#installation) and then you are ready to get started.\r\n\r\n```python\r\nimport os\r\nfrom dotenv import load_dotenv\r\nimport alphaiq_sdk\r\n\r\n# Load the environment variables from the .env file\r\nload_dotenv()\r\nAPIKEY = os.getenv('APIKEY')\r\nclient = alphaiq_sdk.client(APIKEY)\r\n\r\n## get_quant_linguistics_signals\r\ndef get_quant_linguistics_signals():\r\n client = alphaiq_sdk.client(APIKEY)\r\n ticker='TSLA'\r\n startDate='2023-03-01'\r\n endDate='2023-05-01'\r\n\r\n response = client.get_quant_linguistics_signals(startDate,endDate,ticker=ticker)\r\n\r\n return response\r\n```\r\n\r\n## Documentation for API Endpoints\r\n\r\nAll URIs are relative to *https://data.app.alphaiq.ai/api/v1/*\r\n\r\nMethod | HTTP request | Description\r\n------------- | ------------- | -------------\r\n[**get_quant_linguistics_signals**](docs/InvestmentResearchersApi.md#get_quant_linguistics_signals) | **GET** /signals/quantLinguistics | SignalsQuantLinguistics\r\n[**get_bulk_signals**](docs/InvestmentResearchersApi.md#get_bulk_signals) | **GET** /bulk/signals | BulkFileSignals\r\n[**get_bulk_signals_yearly**](docs/InvestmentResearchersApi.md#get_bulk_signals_yearly) | **GET** /bulk/signals/yearly | BulkFileSignalsYearly\r\n[**get_models_spindex**](docs/InvestmentResearchersApi.md#get_models_spindex) | **GET** /models/spindex | ModelsSpindex\r\n[**get_bulk_model**](docs/InvestmentResearchersApi.md#get_bulk_model) | **GET** /bulk/models | BulkFileModels\r\n[**get_company_identifiers**](docs/InvestmentResearchersApi.md#get_company_identifiers) | **GET** /mapping/companyIdentifierMapping | MappingCompanyIdentifiers\r\n[**get_compass_questions**](docs/InvestmentResearchersApi.md#get_compass_questions) | **GET** /mapping/compassQuestions | MappingCompassQuestions\r\n[**get_spindex_factors**](docs/InvestmentResearchersApi.md#get_spindex_factors) | **GET** /mapping/spindexFactors | MappingSpindexFactors\r\n[**get_bulk_mapping**](docs/InvestmentResearchersApi.md#get_bulk_mapping) | **GET** /bulk/mapping | BulkFileMapping\r\n[**get_spinsights_explorer_spindex_summary**](docs/InvestmentResearchersApi.md#get_spinsights_explorer_spindex_summary) | **GET** /generative/company/spinsights/explorerContent/{ticker} | GetSpinsightsExplorerSpindexSummary\r\n[**get_spinsights_report_content**](docs/InvestmentResearchersApi.md#get_spinsights_report_content) | **GET** /generative/company/spinsights/reportContent/{ticker} | GetSpinsightsReportContent\r\n[**get_spinsights_report_pdf**](docs/InvestmentResearchersApi.md#get_spinsights_report_pdf) | **GET** /company/spinsights/reportPDF/{ticker} | SpinsightsReportPDF\r\n[**get_compass_explorer_question_answer**](docs/InvestmentResearchersApi.md#get_compass_explorer_question_answer) | **GET** /generative/company/compass/questionContent/{ticker} | GetCompassExplorerQuestionAnswer\r\n[**get_compass_report_content**](docs/InvestmentResearchersApi.md#get_compass_report_content) | **GET** /generative/company/compass/reportContent/{ticker} | GetCompassReportContent\r\n[**get_compass_report_pdf**](docs/InvestmentResearchersApi.md#get_compass_report_pdf) | **GET** /company/compass/reportPDF/{ticker} | CompassReportPDF\r\n\r\n## Documentation For Models\r\n\r\n - [CompanyInfoModel](docs/CompanyInfoModel.md)\r\n - [CompanyInfoModel1](docs/CompanyInfoModel1.md)\r\n - [FactorLibrarySpindexFactorsDataItems](docs/FactorLibrarySpindexFactorsDataItems.md)\r\n - [FileDownloadModel](docs/FileDownloadModel.md)\r\n - [FileDownloadModel1](docs/FileDownloadModel1.md)\r\n - [FileDownloadModelData](docs/FileDownloadModelData.md)\r\n - [FileDownloadModelData1](docs/FileDownloadModelData1.md)\r\n - [GenerativeCompanyCompassReportContentModel](docs/GenerativeCompanyCompassReportContentModel.md)\r\n - [GenerativeCompanyCompassReportContentModelData](docs/GenerativeCompanyCompassReportContentModelData.md)\r\n - [GenerativeCompanyCompassReportContentModelDataCompassContent](docs/GenerativeCompanyCompassReportContentModelDataCompassContent.md)\r\n - [GenerativeCompanyQuestionAnswerModel](docs/GenerativeCompanyQuestionAnswerModel.md)\r\n - [GenerativeCompanyQuestionAnswerModelData](docs/GenerativeCompanyQuestionAnswerModelData.md)\r\n - [GenerativeCompanyQuestionAnswerModelDataQuestionAnswerItems](docs/GenerativeCompanyQuestionAnswerModelDataQuestionAnswerItems.md)\r\n - [GenerativeCompanySpinsightsExplorerModel](docs/GenerativeCompanySpinsightsExplorerModel.md)\r\n - [GenerativeCompanySpinsightsExplorerModelData](docs/GenerativeCompanySpinsightsExplorerModelData.md)\r\n - [GenerativeCompanySpinsightsExplorerModelDataSpinsightsExplorerItems](docs/GenerativeCompanySpinsightsExplorerModelDataSpinsightsExplorerItems.md)\r\n - [GenerativeCompanySpinsightsReportContentModel](docs/GenerativeCompanySpinsightsReportContentModel.md)\r\n - [GenerativeCompanySpinsightsReportContentModelData](docs/GenerativeCompanySpinsightsReportContentModelData.md)\r\n - [GenerativeCompanySpinsightsReportContentModelDataSpinsightsContent](docs/GenerativeCompanySpinsightsReportContentModelDataSpinsightsContent.md)\r\n - [MappingCompanyIdentifierMappingModel](docs/MappingCompanyIdentifierMappingModel.md)\r\n - [MappingCompanyIdentifierMappingModelDataItems](docs/MappingCompanyIdentifierMappingModelDataItems.md)\r\n - [MappingCompassQuestionsModel](docs/MappingCompassQuestionsModel.md)\r\n - [MappingCompassQuestionsModelDataItems](docs/MappingCompassQuestionsModelDataItems.md)\r\n - [MappingSpindexFactorsModel](docs/MappingSpindexFactorsModel.md)\r\n - [ModelsSpindexModel](docs/ModelsSpindexModel.md)\r\n - [ModelsSpindexModelData](docs/ModelsSpindexModelData.md)\r\n - [ModelsSpindexModelItems](docs/ModelsSpindexModelItems.md)\r\n - [SignalsQuantLinguisticsModelData](docs/SignalsQuantLinguisticsModelData.md)\r\n - [SignalsQuantLinguisticsModelRoot](docs/SignalsQuantLinguisticsModelRoot.md)\r\n - [SignalsQuantLinguisticsSignalsModel2](docs/SignalsQuantLinguisticsSignalsModel2.md)\r\n\r\n# bearer\r\n\r\nAuthorization is a bearer token. That bearer token is your API key.\r\n",
"bugtrack_url": null,
"license": null,
"summary": "Access AlphaIQ quantitative linguistics signals and generative content",
"version": "0.2.7",
"project_urls": {
"GitHub": "https://github.com/alphaiq-ai/python-sdk"
},
"split_keywords": [
"risk",
" ai",
" fintech",
" investing",
" nlp",
" genai"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "8bfecbef9bea25447594b7c7c2b5d21cae1d516bcd23088813153af934531863",
"md5": "e5e9ff3fff2d1c4f7eaa3ebcf46d8179",
"sha256": "26d5a1e6a84857c49889b4816baf081d448763d4b0ede53ec0aa7749409cb211"
},
"downloads": -1,
"filename": "alphaiq_sdk-0.2.7-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e5e9ff3fff2d1c4f7eaa3ebcf46d8179",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 6305,
"upload_time": "2024-04-07T21:54:09",
"upload_time_iso_8601": "2024-04-07T21:54:09.618148Z",
"url": "https://files.pythonhosted.org/packages/8b/fe/cbef9bea25447594b7c7c2b5d21cae1d516bcd23088813153af934531863/alphaiq_sdk-0.2.7-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "7d7072a62ee8ba770845be69b2c5617fa3359ee1d3e073f2812c2114df88beca",
"md5": "c4121c59e82632803ec8f6309c48c779",
"sha256": "79d335875c7316c23f31e6cfaa8c704062b26966cb9a9f866dcd891c7e5d5b07"
},
"downloads": -1,
"filename": "alphaiq-sdk-0.2.7.tar.gz",
"has_sig": false,
"md5_digest": "c4121c59e82632803ec8f6309c48c779",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 5484,
"upload_time": "2024-04-07T21:54:11",
"upload_time_iso_8601": "2024-04-07T21:54:11.168816Z",
"url": "https://files.pythonhosted.org/packages/7d/70/72a62ee8ba770845be69b2c5617fa3359ee1d3e073f2812c2114df88beca/alphaiq-sdk-0.2.7.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-07 21:54:11",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "alphaiq-ai",
"github_project": "python-sdk",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "alphaiq-sdk"
}
