canonical: https://jentic.com/apis/hedgr.app/hedgr

# Hedgr App HEDGR public API

The HEDGR public API exposes public foreign-exchange reference rates and the OAuth-protected, read-only agent surface for Hedgr's FX dashboard. Unauthenticated endpoints return current public rates, a health probe, and OAuth and service discovery metadata, while the protected agent endpoint grants read-only access to FX exposure, cash position, hedge portfolio, P&L, and policy data under the fx:read scope. Hedgr is an FX tool for SME finance teams, and this public document covers only the genuinely public surface plus the agent endpoint.

## For AI agents

Fetch public FX reference rates and, with an OAuth token, read-only FX dashboard data such as exposure, cash position, hedge portfolio, and P&L. Built for agents serving SME finance teams.

## Scope

Does not execute FX trades, place hedges, or expose the authenticated web dashboard namespace. Use for public FX reference rates and read-only agent access to Hedgr dashboard data only.

## Capabilities

- Fetch current public foreign-exchange reference rates without authentication
- Read FX exposure, cash position, hedge portfolio, P&L, and policy data under the fx:read scope through the protected agent endpoint
- Discover the OAuth authorization server and protected-resource metadata for agent access
- Probe public API liveness with a health check
- Retrieve service and OAuth discovery metadata, including the API catalog

## Use cases

### Agent Read-Only FX Monitoring

An AI agent assisting an SME finance team connects to the HEDGR public API through Jentic to read live FX posture: it authenticates with an OAuth 2.1 token carrying the fx:read scope and pulls FX exposure, cash position, hedge portfolio, P&L, and policy data from the protected agent endpoint. Because the scope is read-only, the agent can report and analyze the treasury position without being able to change any hedge or policy. Public reference rates are available on the same host without a credential for quick lookups.

Example prompt: Authenticate with the fx:read scope, read the current FX exposure and hedge portfolio, and summarize the open P&L

### Public FX Reference Rates

A developer needs current foreign-exchange reference rates without managing credentials. The HEDGR public API serves public rates from an unauthenticated endpoint, so an application or agent can fetch a rate for a currency pair directly. This suits quick conversions or display alongside a treasury view.

Example prompt: Fetch the public FX reference rates and extract the rate for a given currency pair

### Agent OAuth Discovery

Before an agent can reach Hedgr's protected data, it needs the OAuth endpoints and resource metadata. The HEDGR public API publishes authorization-server and protected-resource metadata at well-known paths, so a client can register dynamically and run the authorization-code flow with PKCE without hardcoded URLs. This lets an agent bootstrap access from discovery alone.

Example prompt: Read the authorization-server metadata, register a client, and complete the PKCE authorization-code flow for the fx:read scope

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | `/api/rates/public` | Public FX reference rates |
| GET | `/api/health` | Public API liveness probe |
| POST | `/mcp` | OAuth-protected JSON-RPC agent endpoint for read-only FX tools |
| GET | `/.well-known/oauth-authorization-server` | Authorization-server metadata for the OAuth flow |
| GET | `/.well-known/oauth-protected-resource` | Protected-resource metadata for the agent endpoint |

## Key resources

- **Public rates** — Unauthenticated FX reference rates and a liveness health probe
- **OAuth discovery** — Authorization-server, protected-resource, and API catalog metadata for agent access
- **Agent endpoint** — OAuth-protected read-only access to FX exposure, cash, hedge portfolio, P&L, and policy under fx:read

## AI readiness

This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use.

- **Score:** 66 / 100
- **Maturity:** AI-Aware
- **Dimensions:**
  - Foundational Compliance: 67 / 100
  - Developer Experience & Jentic Compatibility: 62 / 100
  - AI-Readiness & Agent Experience: 47 / 100
  - Agent Usability: 94 / 100
  - Security: 90 / 100
  - AI Discoverability: 79 / 100
- **View full report:** https://jentic.com/apis/hedgr.app/hedgr/scorecard
- **How the score is calculated:** https://docs.jentic.com/reference/api-readiness-framework/overview/
- **More about the dimensions:** https://docs.jentic.com/reference/api-readiness-framework/specification/#dimensional-model-overview

### Score it yourself

Every API in the directory is allowlisted, so you can re-score it with no key required.

- **Score your own API:** https://jentic.com/scorecard.md
- **Scoring CLI agent skill:** https://github.com/jentic/jentic-api-scorecard/blob/main/skills/jentic-api-scorecard/SKILL.md

```sh
npx @jentic/api-scorecard-cli score <openapi-url>
```

## Why Jentic

- **Setup:** Wiring the HEDGR public API by hand means running the OAuth 2.1 authorization-code flow with PKCE and dynamic client registration to reach the protected agent endpoint, while the public rates and health endpoints need no credential. Through Jentic you install once, import it from the API Directory, store the credential once, and your agent calls it.
- **Permission scoping:** Hedgr issues tokens with a single read-only scope, fx:read, so an agent can read FX exposure, cash, and portfolio data but cannot change anything. A Jentic rule can further limit your agent to just the operations it needs, such as reading public rates and the protected agent endpoint, and leave the rest out.
- **Credential handling:** Your Hedgr OAuth credential 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 'get public FX rates' or 'read my FX exposure', and Jentic returns the matching Hedgr operation with its input schema so the agent calls the right endpoint without reading the discovery metadata by hand.

## Related APIs

- **1Forge** — A real-time foreign-exchange rate feed, versus Hedgr's public rates plus its own treasury exposure view.
- **CurrencyAPI** — Currency conversion and exchange-rate lookups, versus Hedgr's FX reference rates and hedging posture.
- **Open Exchange Rates** — Historical and reference FX rate series that pair with Hedgr's live exposure data.

## FAQ

### What authentication does the HEDGR public API use?

Most endpoints need no credential, including the health probe, public FX reference rates, and the OAuth and service discovery metadata. The protected agent endpoint uses OAuth 2.1 with an authorization-code flow, PKCE, and dynamic client registration, issuing a token with the read-only fx:read scope, per its OpenAPI spec. Through Jentic the credential is stored encrypted by your own Jentic One instance and injected at call time.

### Can I read FX exposure and hedge data with the HEDGR public API?

Yes, through the OAuth-protected agent endpoint with a token carrying the fx:read scope. It grants read-only access to FX exposure, cash position, hedge portfolio, P&L, and policy data; it does not let an agent place or change a hedge. Public reference rates are available separately without any credential.

### What are the rate limits for the HEDGR public API?

The OpenAPI spec does not specify rate limits. For current limits and details on the authenticated dashboard namespace, see the Hedgr developer documentation at https://hedgr.app/developer-docs.

### How do I read Hedgr FX data through Jentic?

Search Jentic with a query like 'read my FX exposure', add the HEDGR public API from the directory, and store your OAuth credential once. Your agent completes the authorization-code flow for the fx:read scope and reads FX exposure, cash, and portfolio data from the protected agent endpoint, or fetches public rates with no credential. To run it on your own infrastructure, install Jentic One from its GitHub repo.

### Can I limit what my agent is allowed to do with the HEDGR public API?

Yes, and the surface is read-only to begin with: the fx:read scope grants no write access, so an agent cannot change a hedge or policy. A Jentic rule can narrow it further to just the operations you want, such as public rates and the protected read endpoint, and every call it makes is logged.

### Is there a Hedgr MCP server?

Yes, Hedgr publishes an agent endpoint that speaks the Model Context Protocol for its read-only FX tools. You can also connect the HEDGR public API directly through Jentic: your agent gets the published endpoints from the spec without loading another server's tool definitions into its context, your OAuth credential is injected at call time by your self-hosted instance, and your rules decide which operations the agent may call.