Skip to main content

Python CLI for kFinance

Project description

kFinance

The kFinance Python library provides a simple interface for the LLM-ready API, streamlining API requests and response handling. It can be used on its own, with LLMs, or integrated into applications.

For a complete overview of the functions, usage, and features of the kFinance Python library, please refer to documentation here.

Any questions or suggestions can be sent to the kFinance Maintainers.

Setup

You can install kFinance on PyPI via

pip install kensho-kfinance

Getting started

To receive access, please email S&P Global Market Intelligence for information on free trials and pricing.

Once access is obtained, get started using the Authentication Guide and Usage Guide.

To get started, we provide some notebooks:

  • The LLM-ready API Basic Usage notebook demonstrates how fetch data with the kFinance client.
  • The tool_calling notebooks show how the kFinance library can be used for tool calling. We provide notebooks for OpenAI (GPT), Anthropic (Claude), and Google (Gemini). Each of these integrations comes in a langchain version, which uses langchain as a wrapper to simplify the integration, and as a lower level non-langchain version.

We also provide an interactive notebook that demonstrates some usage examples.

MCP (Model Context Protocol)

To run the kFinance MCP server use:

python -m kfinance.mcp

This function initializes and starts an MCP server that exposes the kFinance tools. The server supports multiple authentication methods and transport protocols to accommodate different deployment scenarios.

The server's full signature is as follows:

kfinance.mcp [--stdio,-s]/[--sse, ] --refresh-token <refresh-token> --client-id <client-id> --private-key <private-key>

Authentication Methods (in order of precedence):

  1. Refresh Token: Uses an existing refresh token for authentication. The --refresh-token <refresh-token> argument must be provided.
  2. Key Pair: Uses client ID and private key for authentication. Both the --client-id <client-id> and --private-key <private-key> arguments must be provided.
  3. Browser: Falls back to browser-based authentication flow. This occurs if no auth arguments are provided.

Transport Layers:

  • stdio can be set by passing either --stdio or -s
  • sse can be set by passing --sse or no other transport related flag

Versioning

The kFinance uses semantic versioning (major, minor, patch). To bump the version, add a new entry in CHANGELOG.md. This will generate a new version of the library as part of the release process.

License

Use is solely in accordance with the signed agreement between your entity and S&P.

Copyright 2025-present Kensho Technologies, LLC. The present date is determined by the timestamp of the most recent commit in the repository.

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

kensho_kfinance-2.6.1.tar.gz (90.7 kB view details)

Uploaded Source

Built Distribution

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

kensho_kfinance-2.6.1-py3-none-any.whl (87.3 kB view details)

Uploaded Python 3

File details

Details for the file kensho_kfinance-2.6.1.tar.gz.

File metadata

  • Download URL: kensho_kfinance-2.6.1.tar.gz
  • Upload date:
  • Size: 90.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for kensho_kfinance-2.6.1.tar.gz
Algorithm Hash digest
SHA256 131986014941a0d02d190d59be7ed0db3699ec0572e4ae726c052f8551503c0c
MD5 f18ee4211a7fb7dba39af949c8bda67a
BLAKE2b-256 c5ea318e9052254ade4c43b0dda65e2a7efff09d086f5b041911ec4edb7c269d

See more details on using hashes here.

Provenance

The following attestation bundles were made for kensho_kfinance-2.6.1.tar.gz:

Publisher: python-publish.yml on kensho-technologies/kfinance

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file kensho_kfinance-2.6.1-py3-none-any.whl.

File metadata

File hashes

Hashes for kensho_kfinance-2.6.1-py3-none-any.whl
Algorithm Hash digest
SHA256 e101048b1c17c53b133d49074ef532bb42ee94054137dd08f3016bb5e914ba3a
MD5 af6983d6f67b80a89468e6bf60462e71
BLAKE2b-256 0404bf86914b525353fb9ca9eb20ad452ff5a4aa9dab831f387b5bd80ca61a00

See more details on using hashes here.

Provenance

The following attestation bundles were made for kensho_kfinance-2.6.1-py3-none-any.whl:

Publisher: python-publish.yml on kensho-technologies/kfinance

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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