Skip to main content

Python interface for Quill Express API - AI-powered financial data processing

Project description

QuillAI Python Package

A Python package for interfacing with the Quill Express API, providing AI-powered financial data processing capabilities using SEC filings and earnings transcripts.

Installation

pip install quillai

Quick Start

import pandas as pd
from quillai import fillDfModel

# Real example using BOK Financial Corporation (BOKF) data
# Historical quarterly data from 2021 Q3 to 2023 Q2
financial_data = {
    '3Q21': [191206, 1274, 38941, 2580],    # As of 9/30/21
    '4Q21': [186736, 1242, 44471, 2516],    # As of 12/31/21
    '1Q22': [178373, 1394, 40975, 2354],    # As of 3/31/22
    '2Q22': [204015, 1559, 22958, 3485],    # As of 6/30/22
    '3Q22': [264350, 1684, 22720, 9108],    # As of 9/30/22
    '4Q22': [329915, 1390, 28395, 9125],    # As of 12/31/22
    '1Q23': [367870, 979, 34009, 8928],     # As of 3/31/23
    '2Q23': [399182, 1092, 47821, 8586],    # As of 6/30/23
}

# Create DataFrame with line items as index
line_items = [
    'Loans',
    'Residential mortgage loans held for sale',
    'Trading securities',
    'Investment securities'
]

df = pd.DataFrame(financial_data, index=line_items)

# Get AI predictions for the next quarter
updated_df = fillDfModel(df, company="BOKF")
print(updated_df)

# Shows predictions for 3Q23:
# Loans: $447,114
# Residential mortgage loans held for sale: $1,348
# Trading securities: $74,801
# Investment securities: $7,564

Expected Output

The function returns an updated DataFrame with your original data plus AI predictions for the next period:

                                            3Q21    4Q21    1Q22    2Q22    3Q22    4Q22    1Q23    2Q23    3Q23
Loans                                     191206  186736  178373  204015  264350  329915  367870  399182  447114
Residential mortgage loans held for sale    1274    1242    1394    1559    1684    1390     979    1092    1348
Trading securities                         38941   44471   40975   22958   22720   28395   34009   47821   74801
Investment securities                       2580    2516    2354    3485    9108    9125    8928    8586    7564

Example Script

For a complete working example, see the included test script:

python test_bokf.py

This demonstrates the full workflow with real BOK Financial Corporation data.

Features

  • AI-Powered Predictions: Uses machine learning to predict financial values based on SEC filings and earnings transcripts
  • Easy DataFrame Integration: Works seamlessly with pandas DataFrames
  • Automatic Period Detection: Handles quarterly and fiscal year periods automatically
  • Company-Specific Analysis: Tailored predictions based on individual company data

Setup

Before using QuillAI, you'll need to set up your API key:

  1. Get your API key from Quill AI
  2. Set environment variable:
    export QUILL_API_KEY='your_api_key_here'
    
    Or add it to your .env file:
    QUILL_API_KEY=your_api_key_here
    

Environment Variables

  • QUILL_API_KEY: Your Quill API token (required)
  • QUILL_EXPRESS_BASE: Base URL for the API (default: "express.quillai.com")

License

MIT License

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

quillai-0.1.1.tar.gz (7.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

quillai-0.1.1-py3-none-any.whl (7.5 kB view details)

Uploaded Python 3

File details

Details for the file quillai-0.1.1.tar.gz.

File metadata

  • Download URL: quillai-0.1.1.tar.gz
  • Upload date:
  • Size: 7.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.10.18

File hashes

Hashes for quillai-0.1.1.tar.gz
Algorithm Hash digest
SHA256 e3fad4c7ec10feff20293be9a74194267999e2fc97bab52b73998ae6d1e7e978
MD5 3effe33ca9c4e9ed96c6940cb108a43d
BLAKE2b-256 2cc38dd20b6d5f1d066d33dc6f453b04992316b03b1d74288aea42724bb2273e

See more details on using hashes here.

File details

Details for the file quillai-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: quillai-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 7.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.10.18

File hashes

Hashes for quillai-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 dc52ce221d7a06e0d804a9d7adef483c58e55582732912c3b0b6c332856da8b6
MD5 b1af8b99dda084c556b775283af346a1
BLAKE2b-256 7ffebb962bc9acb9a5130db5f148b96a19d695d263ec1fbd008a0e1ddf340430

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page