# HEDGR Partner API

**Canonical:** https://apis.io/apis/hedgr-app/hedgr-app-partner-api-api/  
**Provider:** HEDGR — https://apis.io/providers/hedgr-app/  
**Base URL:** https://hedgr.app  
**Documentation:** https://hedgr.app/developer-docs

HEDGR Partner API is one of 5 APIs that [HEDGR](https://apis.io/providers/hedgr-app/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 6 JSON Schema definitions. Tagged areas include Partner API. The published artifact set on APIs.io includes an OpenAPI specification and 6 JSON Schemas.

REST API for broker and FX dealing firms: clients that share their portfolio, deal reporting, signed webhooks. Docs: https://hedgr.app/partner-api.

## Operations (12)

| Method | Path | Summary |
|---|---|---|
| GET | `/api/partner/v1/me` | The calling key |
| GET | `/api/partner/v1/clients` | Clients that share their portfolio with this key |
| GET | `/api/partner/v1/clients/{clientId}` | One client |
| GET | `/api/partner/v1/clients/{clientId}/limits` | A client's limit breaches |
| GET | `/api/partner/v1/clients/{clientId}/deals` | Deals this key reported for the client |
| POST | `/api/partner/v1/clients/{clientId}/deals` | Report a booked deal |
| POST | `/api/partner/v1/clients/{clientId}/deals/{dealId}/cancel` | Cancel a reported deal |
| GET | `/api/partner/v1/webhook` | Current webhook URL |
| PUT | `/api/partner/v1/webhook` | Set the webhook URL |
| DELETE | `/api/partner/v1/webhook` | Remove the webhook |
| POST | `/api/partner/v1/webhook/test` | Send a signed ping now |
| GET | `/api/partner/v1/webhook/events` | Recent webhook events |

## Machine-readable artifacts (7)

- **OpenAPI** — https://artifacts.apis.io/hedgr-app/openapi/hedgr-app-partner-api-api-openapi.yml
- **JSONSchema** — https://artifacts.apis.io/hedgr-app/json-schema/hedgr-app-mcp-discovery-schema.json
- **JSONSchema** — https://artifacts.apis.io/hedgr-app/json-schema/hedgr-app-mcp-server-card-schema.json
- **JSONSchema** — https://artifacts.apis.io/hedgr-app/json-schema/hedgr-app-api-catalog-schema.json
- **JSONSchema** — https://artifacts.apis.io/hedgr-app/json-schema/hedgr-app-json-rpc-request-schema.json
- **JSONSchema** — https://artifacts.apis.io/hedgr-app/json-schema/hedgr-app-authorization-server-metadata-schema.json
- **JSONSchema** — https://artifacts.apis.io/hedgr-app/json-schema/hedgr-app-protected-resource-metadata-schema.json

## Other HEDGR APIs (4)

- [HEDGR Health API](https://apis.io/apis/hedgr-app/hedgr-app-health-api/)
- [HEDGR MCP API](https://apis.io/apis/hedgr-app/hedgr-app-mcp-api/)
- [HEDGR OAuth discovery API](https://apis.io/apis/hedgr-app/hedgr-app-oauth-discovery-api/)
- [HEDGR Rates API](https://apis.io/apis/hedgr-app/hedgr-app-rates-api/)

## Tags

Partner API

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/hedgr-app/hedgr-app-partner-api-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/hedgr-app/.