alphaiq-sdk


Namealphaiq-sdk JSON
Version 0.2.9 PyPI version JSON
download
home_pageNone
SummaryAccess AlphaIQ's generative insights, explainable investment signals, and the Corporate Transparency Score model
upload_time2024-06-04 02:41:30
maintainerNone
docs_urlNone
authorNone
requires_python>=3.9
licenseNone
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 for a free Demo](https://consilience.ai/get-started).

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](https://consilience.ai/blog).

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'
    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**](docs/InvestmentResearchersApi.md#get_signal_explanations) | **GET** /generative/company/signal_explanation/{ticker} | GetSignalExplanations
[**get_trending_content**](docs/InvestmentResearchersApi.md#get_trending_content) | **GET** /generative/company/compass/reportContent/{ticker} | GetTrendingGenerative
[**get_question_answer**](docs/InvestmentResearchersApi.md#get_question_answer) | **GET** /generative/company/compass/questionContent/{ticker} | GetQuestionAnswer
[**get_compass_report_pdf**](docs/InvestmentResearchersApi.md#get_compass_report_pdf) | **GET** /pdf/compass/{ticker} | CompassReportPDF
[**get_quant_linguistics_signals**](docs/InvestmentResearchersApi.md#get_quant_linguistics_signals) | **GET** /signals/quantLinguistics | SignalsQuantLinguistics
[**get_bulk_signals_all**](docs/InvestmentResearchersApi.md#get_bulk_signals_all) | **GET** /bulk/signals/all | BulkFileSignalsAll
[**get_bulk_signals_top_level**](docs/InvestmentResearchersApi.md#get_bulk_signals_top_level) | **GET** /bulk/signals/topLevel | BulkFileSignalsTopLevel
[**get_models_corporate_transparency**](docs/InvestmentResearchersApi.md#get_models_corporate_transparency) | **GET** /models/corporateTransparency | ModelsCorporateTransparency
[**get_bulk_model**](docs/InvestmentResearchersApi.md#get_bulk_model) | **GET** /bulk/models | BulkFileModels
[**get_company_identifiers_map**](docs/InvestmentResearchersApi.md#get_company_identifiers_map) | **GET** /mapping/companyIdentifierMapping | MappingCompanyIdentifiers
[**get_bulk_mapping**](docs/InvestmentResearchersApi.md#get_bulk_mapping) | **GET** /bulk/mapping | BulkFileMapping


## Documentation For Models

 - [CompanyInfoModel](docs/CompanyInfoModel.md)
 - [CompanyInfoModel1](docs/CompanyInfoModel1.md)
 - [FileDownloadModel](docs/FileDownloadModel.md)
 - [FileDownloadModel1](docs/FileDownloadModel1.md)
 - [FileDownloadModelData](docs/FileDownloadModelData.md)
 - [FileDownloadModelData1](docs/FileDownloadModelData1.md)
 - [GenerativeSignalExplanationModel](docs/GenerativeSignalExplanationModel.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)
 - [MappingCompanyIdentifierMappingModel](docs/MappingCompanyIdentifierMappingModel.md)
 - [MappingCompanyIdentifierMappingModelDataItems](docs/MappingCompanyIdentifierMappingModelDataItems.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/c8/89/4d4aba6f8d758dbf8e081dc7d5a71e3ed8f11bb16b7e05828b13aa93c7bd/alphaiq_sdk-0.2.9.tar.gz",
    "platform": null,
    "description": "# AlphaIQ Python SDK\r\nTo get access to the API, [sign up here for a free Demo](https://consilience.ai/get-started).\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 our blog](https://consilience.ai/blog).\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    signalVariation='CHANGE'\r\n    startDate='2023-03-01'\r\n    endDate='2023-05-01'\r\n\r\n    response = client.get_quant_linguistics_signals(signalVariation,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_signal_explanations**](docs/InvestmentResearchersApi.md#get_signal_explanations) | **GET** /generative/company/signal_explanation/{ticker} | GetSignalExplanations\r\n[**get_trending_content**](docs/InvestmentResearchersApi.md#get_trending_content) | **GET** /generative/company/compass/reportContent/{ticker} | GetTrendingGenerative\r\n[**get_question_answer**](docs/InvestmentResearchersApi.md#get_question_answer) | **GET** /generative/company/compass/questionContent/{ticker} | GetQuestionAnswer\r\n[**get_compass_report_pdf**](docs/InvestmentResearchersApi.md#get_compass_report_pdf) | **GET** /pdf/compass/{ticker} | CompassReportPDF\r\n[**get_quant_linguistics_signals**](docs/InvestmentResearchersApi.md#get_quant_linguistics_signals) | **GET** /signals/quantLinguistics | SignalsQuantLinguistics\r\n[**get_bulk_signals_all**](docs/InvestmentResearchersApi.md#get_bulk_signals_all) | **GET** /bulk/signals/all | BulkFileSignalsAll\r\n[**get_bulk_signals_top_level**](docs/InvestmentResearchersApi.md#get_bulk_signals_top_level) | **GET** /bulk/signals/topLevel | BulkFileSignalsTopLevel\r\n[**get_models_corporate_transparency**](docs/InvestmentResearchersApi.md#get_models_corporate_transparency) | **GET** /models/corporateTransparency | ModelsCorporateTransparency\r\n[**get_bulk_model**](docs/InvestmentResearchersApi.md#get_bulk_model) | **GET** /bulk/models | BulkFileModels\r\n[**get_company_identifiers_map**](docs/InvestmentResearchersApi.md#get_company_identifiers_map) | **GET** /mapping/companyIdentifierMapping | MappingCompanyIdentifiers\r\n[**get_bulk_mapping**](docs/InvestmentResearchersApi.md#get_bulk_mapping) | **GET** /bulk/mapping | BulkFileMapping\r\n\r\n\r\n## Documentation For Models\r\n\r\n - [CompanyInfoModel](docs/CompanyInfoModel.md)\r\n - [CompanyInfoModel1](docs/CompanyInfoModel1.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 - [GenerativeSignalExplanationModel](docs/GenerativeSignalExplanationModel.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 - [MappingCompanyIdentifierMappingModel](docs/MappingCompanyIdentifierMappingModel.md)\r\n - [MappingCompanyIdentifierMappingModelDataItems](docs/MappingCompanyIdentifierMappingModelDataItems.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's generative insights, explainable investment signals, and the Corporate Transparency Score model",
    "version": "0.2.9",
    "project_urls": {
        "GitHub": "https://github.com/alphaiq-ai/python-sdk"
    },
    "split_keywords": [
        "risk",
        " ai",
        " fintech",
        " investing",
        " nlp",
        " genai"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "4c6200678f0109ff941e1a67032b444be4d9365cf18e4447d45d2716ecc6fb93",
                "md5": "982406b18a806d69013001d0b57e574d",
                "sha256": "064314a1a287f5e46e428ca81cd5add70032eca4c19a207dfc43cf2fadd1d4aa"
            },
            "downloads": -1,
            "filename": "alphaiq_sdk-0.2.9-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "982406b18a806d69013001d0b57e574d",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9",
            "size": 6081,
            "upload_time": "2024-06-04T02:41:28",
            "upload_time_iso_8601": "2024-06-04T02:41:28.187392Z",
            "url": "https://files.pythonhosted.org/packages/4c/62/00678f0109ff941e1a67032b444be4d9365cf18e4447d45d2716ecc6fb93/alphaiq_sdk-0.2.9-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "c8894d4aba6f8d758dbf8e081dc7d5a71e3ed8f11bb16b7e05828b13aa93c7bd",
                "md5": "4d6a4ee979953f986e6e4406a7c9809f",
                "sha256": "c1a264862ac73ddcbcf5915a933d917ec9f8a43465a0c4c3fea74741f8120a83"
            },
            "downloads": -1,
            "filename": "alphaiq_sdk-0.2.9.tar.gz",
            "has_sig": false,
            "md5_digest": "4d6a4ee979953f986e6e4406a7c9809f",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 5321,
            "upload_time": "2024-06-04T02:41:30",
            "upload_time_iso_8601": "2024-06-04T02:41:30.159166Z",
            "url": "https://files.pythonhosted.org/packages/c8/89/4d4aba6f8d758dbf8e081dc7d5a71e3ed8f11bb16b7e05828b13aa93c7bd/alphaiq_sdk-0.2.9.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-06-04 02:41:30",
    "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"
}
        
Elapsed time: 0.24223s