canonical: https://jentic.com/apis/portfoliopilot.com/portfoliopilot

# Portfoliopilot Global Predictions API

Jentic publishes the only available OpenAPI specification for Global Predictions API, keeping it validated and agent-ready. Global Predictions API provides economic forecasting, time series analysis, and portfolio management capabilities through 13 endpoints. It covers macroeconomic data series with historical values and 2-12 month forecasts, a knowledge graph of influential economic drivers, anomaly detection for economic indicators, and portfolio-level services including scoring, recommendations, performance statistics, assessments, and insights.

## For AI agents

Retrieve economic forecasts, detect market anomalies, score investment portfolios, and generate diversification recommendations based on macroeconomic knowledge graph data.

## Scope

Does not handle trade execution, real-time market data feeds, or accounting - use for economic forecasting and portfolio analysis only.

## Capabilities

- Forecast economic time series 2-12 months ahead with confidence intervals
- Identify the top 10 most influential drivers for any tracked economic series
- Detect economic anomalies that occurred in the last 3 months across all monitored indicators
- Score portfolios on risk match, Sharpe ratio, and downside protection metrics
- Generate actionable diversification and factor exposure recommendations for a given portfolio
- Compute portfolio performance statistics including returns, risk, and Sharpe ratio

## Use cases

### Economic Forecasting for Investment Decisions

Retrieve 2-12 month forecasts for macroeconomic indicators such as GDP, CPI, and sector indices. Each forecast includes point estimates with high and low confidence bounds, enabling quantitative models to factor in economic outlook when making allocation decisions. The API covers financial markets, macroeconomics, and sector-specific data series.

Example prompt: Retrieve the 6-month forecast for 'United States CPI' using the `/v1/forecast` endpoint and extract the point estimate and confidence bounds

### Portfolio Health Assessment

Submit a portfolio of ticker-amount pairs and receive a composite score (0-1000) with sub-scores for risk match, Sharpe ratio, and downside protection. The scoring algorithm compares portfolio characteristics against optimal allocations for the stated investor preference level, providing a percentile rank relative to other portfolios.

Example prompt: Compute the portfolio score for a portfolio containing VOO at 50000 and BND at 30000 using the `/v1/get_portfolio_score` endpoint

### Anomaly-Driven Alert Systems

Monitor the global economy for statistical anomalies by polling the anomalies endpoint, which returns all series exhibiting unusual behavior in the past 3 months. This enables alert systems that notify portfolio managers when economic indicators like interbank rates, GDP figures, or sector indices deviate significantly from expected patterns.

Example prompt: Call the `/v1/anomalies` endpoint to retrieve all economic series with detected anomalies in the last 3 months and report any affecting US markets

### AI Agent Portfolio Analysis via Jentic

AI agents use Jentic to discover Global Predictions operations by intent, such as 'score my portfolio' or 'forecast an economic series'. Jentic returns the operation schema with required parameters like portfolio_dict or series_name, then handles API key injection so agents deliver investment insights without managing credentials directly.

Example prompt: Search Jentic for 'get portfolio recommendations', load the computeRecommendations schema, and execute with portfolio_id 101 to retrieve diversification suggestions

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | `/v1/forecast` | Get 2-12 month forecast for a named series |
| GET | `/v1/history` | Retrieve full historical data for a series |
| GET | `/v1/anomalies` | List economic series with recent anomalies |
| GET | `/v1/influential_drivers` | Get top 10 influential drivers for a series |
| GET | `/v1/get_portfolio_score` | Compute portfolio score and sub-scores |
| GET | `/v1/get_recommendations` | Generate portfolio recommendations |
| POST | `/v1/update_portfolio` | Create or update a portfolio with tickers and amounts |
| GET | `/v1/get_portfolio_performance_stats` | Compute returns, risk, and Sharpe ratio |

## Key resources

- **Data Series** — Historical data, forecasts, series types, and series names for macroeconomic indicators
- **Knowledge Graph** — Influential drivers and causal relationships between economic series
- **World Monitoring** — Anomaly detection across all monitored economic indicators
- **Portfolio Management** — Portfolio scoring, recommendations, performance stats, assessments, and insights

## Why Jentic

- **Setup:** Wiring the Global Predictions API by hand means handling its query-parameter API key auth and appending the key to every forecast and portfolio request yourself. Through Jentic you install once, import the Global Predictions API from the API Directory, store the key once, and your agent calls it.
- **Permission scoping:** The Global Predictions API takes its series and portfolio inputs in query parameters and the request body, so you limit the agent to the operations it needs, such as fetching a forecast or scoring a portfolio. Writes like updating a portfolio are included only if you add them.
- **Credential handling:** Your Global Predictions API key is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'forecast an economic indicator' or 'score my portfolio', and Jentic returns the matching Global Predictions operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Portfolio Optimizer** — Quantitative portfolio optimization with mean-variance analysis and risk parity methods
- **Polygon.io API** — Real-time and historical market data for stocks, options, and crypto
- **Alpaca Trading API** — Commission-free stock trading with order execution

## FAQ

### Why is there no official OpenAPI spec for Global Predictions API?

Global Predictions does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call Global Predictions API via structured tooling. It is validated against the live API and kept up to date. Get started with Jentic One, the self-hosted execution layer.

### What authentication does the Global Predictions API use?

The Global Predictions API uses an API key passed as a query parameter named api_key on each request. Through Jentic, this key is stored in the encrypted credential vault and appended to requests automatically, so agents never handle the raw key.

### Can I get economic forecasts with confidence intervals from the Global Predictions API?

Yes. The `/v1/forecast` endpoint returns a 2-12 month forecast for any named series, with each data point including a central value (val), high bound, and low bound representing the confidence interval around the prediction.

### What are the rate limits for the Global Predictions API?

Rate limit details are not published in the Global Predictions API specification. The API requires an api_key parameter for all requests. Contact Global Predictions support for account-specific usage limits.

### How do I score a portfolio through the Global Predictions API with Jentic?

Install the SDK with pip install jentic, then search for 'score my investment portfolio'. Jentic returns the computePortfolioScore operation schema requiring a portfolio_dict parameter (JSON string of ticker-amount pairs). Execute the call to receive a portfolio score with risk match, Sharpe ratio, and downside protection sub-scores.

### What types of economic data series are available?

The API covers multiple series types including Financial Market (currencies, sector indices, ETFs), Macroeconomics (GDP, CPI, building permits, interbank rates), and country-specific indicators. Use the `/v1/all_series_types` endpoint to retrieve all categories, and `/v1/all_series_names` to list available series within a type.

### Can I limit what my agent is allowed to do with the Global Predictions API?

Yes. Because you run Jentic One yourself, your own rules decide which Global Predictions operations the agent can call and which credentials it may use. You can allow only read operations such as `/v1/forecast`, `/v1/anomalies`, or `/v1/get_portfolio_score` while withholding write operations like `/v1/update_portfolio`, since those are included only if you add them. Your API key stays stored and injected by your own instance, so the agent reaches exactly the endpoints you permit and nothing more.