# API Reference

- [API Overview](https://docs.sov.ai/api-reference/api-reference.md): Complete API reference for the SovAI Python SDK, auto-generated from source code.
- [sovai (Package)](https://docs.sov.ai/api-reference/sovai.md): Main SovAI SDK Tool Kit package
- [Data Retrieval](https://docs.sov.ai/api-reference/data.md): API reference for sovai.get\_data
- [Plotting](https://docs.sov.ai/api-reference/plots.md): API reference for sovai.get\_plots
- [Reports](https://docs.sov.ai/api-reference/reports.md): API reference for sovai.get\_reports
- [Compute](https://docs.sov.ai/api-reference/compute.md): API reference for sovai.get\_compute
- [Tools (SEC, Explain)](https://docs.sov.ai/api-reference/tools.md): API reference for sovai.get\_tools
- [API Config](https://docs.sov.ai/api-reference/api-config.md): API reference for sovai.api\_config
- [Basic Auth](https://docs.sov.ai/api-reference/basic-auth.md): API reference for sovai.basic\_auth
- [Token Auth](https://docs.sov.ai/api-reference/token-auth.md): API reference for sovai.token\_auth
- [Error Classes](https://docs.sov.ai/api-reference/errors.md): API reference for sovai.errors.sovai\_errors
- [Extensions](https://docs.sov.ai/api-reference/extensions.md): DataFrame extensions for analytics, feature engineering, and signal evaluation.
- [Anomalies](https://docs.sov.ai/api-reference/extensions/anomalies.md): API reference for sovai.extensions.anomalies
- [Ask Df Llm](https://docs.sov.ai/api-reference/extensions/ask-df-llm.md): API reference for sovai.extensions.ask\_df\_llm
- [Change Point Generator](https://docs.sov.ai/api-reference/extensions/change-point-generator.md): API reference for sovai.extensions.change\_point\_generator
- [Chart Explainer](https://docs.sov.ai/api-reference/extensions/chart-explainer.md): Chart Explanation Module using Gemini via Ephemeral Token Broker
- [Clustering](https://docs.sov.ai/api-reference/extensions/clustering.md): API reference for sovai.extensions.clustering
- [Core Kshape](https://docs.sov.ai/api-reference/extensions/core-kshape.md): API reference for sovai.extensions.core\_kshape
- [Cusum](https://docs.sov.ai/api-reference/extensions/cusum.md): API reference for sovai.extensions.cusum
- [Dimensionality Reduction](https://docs.sov.ai/api-reference/extensions/dimensionality-reduction.md): API reference for sovai.extensions.dimensionality\_reduction
- [Feature Extraction](https://docs.sov.ai/api-reference/extensions/feature-extraction.md): API reference for sovai.extensions.feature\_extraction
- [Feature Importance](https://docs.sov.ai/api-reference/extensions/feature-importance.md): API reference for sovai.extensions.feature\_importance
- [Feature Neutralizer](https://docs.sov.ai/api-reference/extensions/feature-neutralizer.md): API reference for sovai.extensions.feature\_neutralizer
- [Filter Df](https://docs.sov.ai/api-reference/extensions/filter-df.md): API reference for sovai.extensions.filter\_df
- [Fractional Differencing](https://docs.sov.ai/api-reference/extensions/fractional-differencing.md): API reference for sovai.extensions.fractional\_differencing
- [Nowcasting](https://docs.sov.ai/api-reference/extensions/nowcasting.md): API reference for sovai.extensions.nowcasting
- [Overall Explainers](https://docs.sov.ai/api-reference/extensions/overall-explainers.md): Overall Explainers Module
- [Pairwise](https://docs.sov.ai/api-reference/extensions/pairwise.md): API reference for sovai.extensions.pairwise
- [Pandas Extensions](https://docs.sov.ai/api-reference/extensions/pandas-extensions.md): API reference for sovai.extensions.pandas\_extensions
- [Parallel Functions](https://docs.sov.ai/api-reference/extensions/parallel-functions.md): API reference for sovai.extensions.parallel\_functions
- [Pfa Feature Selector](https://docs.sov.ai/api-reference/extensions/pfa-feature-selector.md): API reference for sovai.extensions.pfa\_feature\_selector
- [Regime Change](https://docs.sov.ai/api-reference/extensions/regime-change.md): API reference for sovai.extensions.regime\_change
- [Regime Change Pca](https://docs.sov.ai/api-reference/extensions/regime-change-pca.md): API reference for sovai.extensions.regime\_change\_pca
- [Shapley Global Importance](https://docs.sov.ai/api-reference/extensions/shapley-global-importance.md): API reference for sovai.extensions.shapley\_global\_importance
- [Shapley Importance](https://docs.sov.ai/api-reference/extensions/shapley-importance.md): API reference for sovai.extensions.shapley\_importance
- [Signal Evaluation](https://docs.sov.ai/api-reference/extensions/signal-evaluation.md): API reference for sovai.extensions.signal\_evaluation
- [Table Explainer](https://docs.sov.ai/api-reference/extensions/table-explainer.md): Table Explanation Module using Gemini via Ephemeral Token Broker
- [Technical Indicators](https://docs.sov.ai/api-reference/extensions/technical-indicators.md): API reference for sovai.extensions.technical\_indicators
- [Time Decomposition](https://docs.sov.ai/api-reference/extensions/time-decomposition.md): API reference for sovai.extensions.time\_decomposition
- [Plot Library](https://docs.sov.ai/api-reference/plots-1.md): Pre-built visualization functions organized by dataset category.
- [Accounting Plots](https://docs.sov.ai/api-reference/plots-1/accounting-plots.md): API reference for sovai.plots.accounting.accounting\_plots
- [Bankruptcy Plots](https://docs.sov.ai/api-reference/plots-1/bankruptcy-plots.md): API reference for sovai.plots.bankruptcy.bankruptcy\_plots
- [Breakout Plots](https://docs.sov.ai/api-reference/plots-1/breakout-plots.md): API reference for sovai.plots.breakout.breakout\_plots
- [Corp Risk Plots](https://docs.sov.ai/api-reference/plots-1/corp-risk-plots.md): API reference for sovai.plots.corp\_risk.corp\_risk\_plots
- [Insider Plots](https://docs.sov.ai/api-reference/plots-1/insider-plots.md): API reference for sovai.plots.insider.insider\_plots
- [Institutional Plots](https://docs.sov.ai/api-reference/plots-1/institutional-plots.md): API reference for sovai.plots.institutional.institutional\_plots
- [News Plots](https://docs.sov.ai/api-reference/plots-1/news-plots.md): API reference for sovai.plots.news.news\_plots
- [Ratios Plots](https://docs.sov.ai/api-reference/plots-1/ratios-plots.md): API reference for sovai.plots.ratios.ratios\_plots
- [Utilities](https://docs.sov.ai/api-reference/utils.md): Internal utility functions for data loading, caching, and format conversion.
- [Client Side](https://docs.sov.ai/api-reference/utils/client-side.md): API reference for sovai.utils.client\_side
- [Client Side S3](https://docs.sov.ai/api-reference/utils/client-side-s3.md): API reference for sovai.utils.client\_side\_s3
- [Client Side S3 Part High](https://docs.sov.ai/api-reference/utils/client-side-s3-part-high.md): Advanced S3 Partitioned Data Loader
- [Converter](https://docs.sov.ai/api-reference/utils/converter.md): API reference for sovai.utils.converter
- [File Management](https://docs.sov.ai/api-reference/utils/file-management.md): API reference for sovai.utils.file\_management
- [Get Tickers](https://docs.sov.ai/api-reference/utils/get-tickers.md): API reference for sovai.utils.get\_tickers
- [Helpers](https://docs.sov.ai/api-reference/utils/helpers.md): API reference for sovai.utils.helpers
- [Plot](https://docs.sov.ai/api-reference/utils/plot.md): API reference for sovai.utils.plot
- [Port Manager](https://docs.sov.ai/api-reference/utils/port-manager.md): API reference for sovai.utils.port\_manager
- [Stream](https://docs.sov.ai/api-reference/utils/stream.md): API reference for sovai.utils.stream
- [Verbose Utils](https://docs.sov.ai/api-reference/utils/verbose-utils.md): API reference for sovai.utils.verbose\_utils


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.sov.ai/api-reference.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
