API & MCP
Everix API and MCP: read your risk results from your own systems
Last reviewed
REST API v1
For your own systems: reports, data platforms and scheduled jobs.
- Base path
/api/public/v1- Reference
/api/public/docsandopenapi.json, served by your instance- Limit
- 600 requests per minute per key (default)
- Where
- On-site and Private Cloud
MCP server
For AI assistants: read-only tools over capital, K-factors, risk results, runs and reports.
- Endpoint
/api/mcpin Everix Cloud;/api/public/mcpinstalled- Reference
- MCP server docs
- Limit
- 120 requests per minute per key; 500 rows or 256 KB per result
- Where
- Everix Cloud IFR, Everix Cloud Risk, On-site and Private Cloud
In one minute
- Read access. Results, runs, reports and audit events. Every MCP tool is read-only: an agent cannot change data or start a calculation.
- Scoped keys. Keys that expire, read only what they were created for, and leave every call in the audit trail.
- Where. Everix Cloud IFR and Cloud Risk serve read-only MCP; an org admin creates the agent keys under Organization › AI agents. On On-site and Private Cloud, the MCP server and the REST API run on your own Everix host.
- Data in. People upload trades and data: in the Everix Cloud portal, or through your data feeds on an installed platform. Neither interface accepts uploads.
What you can read
| Data | REST endpoint | Scope |
|---|---|---|
| The calling service account and its scopes | GET /me | any |
| Calculation results (universes), filterable by date and type | GET /universes | read:results |
| Aggregation views and trees, e.g. XVA by counterparty and netting set | GET /universes/{id}/aggregations/… | read:results |
| Workflow templates and runs, with their status | GET /workflows… | read:workflows |
| Audit events by time range and type | GET /audit/events | read:audit |
Paths are relative to /api/public/v1. The full list, with parameters and response schemas, is in your instance's OpenAPI reference.
- REST endpoint
GET /me- Scope
- any
- REST endpoint
GET /universes- Scope
read:results
- REST endpoint
GET /universes/{id}/aggregations/…- Scope
read:results
- REST endpoint
GET /workflows…- Scope
read:workflows
- REST endpoint
GET /audit/events- Scope
read:audit
Keys, scopes and access
- An Everix administrator creates a service account in Admin › API access and chooses its scopes. An administrator can grant only scopes whose permissions they hold.
- They create an API key. It starts with
evx_, is shown once, expires after 90 days by default (365 at most) and can be rotated with an overlap period or revoked at any time. - For AI assistants, they switch on Allow MCP access for that service account. It is off by default, so a key made for a report cannot simply be pasted into an agent.
Send the key as Authorization: Bearer evx_…. The public API accepts keys only, never a browser session cookie.
Quick start
# 1. Your administrator creates a read-only service account and key
# (Admin › API access). The key starts with evx_ and is shown once.
export EVERIX_API_KEY="evx_…"
export EVERIX="https://<your-everix-host>/api/public/v1"
# 2. Check the key and its scopes
curl -s -H "Authorization: Bearer $EVERIX_API_KEY" "$EVERIX/me"
# 3. List calculation results (universes); long lists come with a cursor
curl -s -H "Authorization: Bearer $EVERIX_API_KEY" "$EVERIX/universes"
# 4. Read an aggregation tree, e.g. XVA by counterparty and netting set
curl -s -H "Authorization: Bearer $EVERIX_API_KEY" \
"$EVERIX/universes/{id}/aggregations/{agg}/tree"To connect an AI assistant instead, add the MCP endpoint and the same kind of key to your client; the MCP reference has a configuration example.
Limits
| Limit | Default | Behaviour |
|---|---|---|
| REST requests | 600 per minute per key | HTTP 429 with Retry-After |
| MCP tool calls | 120 per minute per key | HTTP 429 with Retry-After |
| MCP result size | 500 rows or 256 KB | Lists over 500 rows return truncated: true and a cursor; a result over 256 KB is a tool error asking to narrow the query |
| Failed authentication | 20 per minute per client IP | HTTP 429; other clients' failures never block a valid key |
An administrator can change the defaults per installation.
- Default
- 600 per minute per key
- Behaviour
- HTTP 429 with
Retry-After
- Default
- 120 per minute per key
- Behaviour
- HTTP 429 with
Retry-After
- Default
- 500 rows or 256 KB
- Behaviour
- Lists over 500 rows return
truncated: trueand a cursor; a result over 256 KB is a tool error asking to narrow the query
- Default
- 20 per minute per client IP
- Behaviour
- HTTP 429; other clients' failures never block a valid key
How to get access
- Book a 30-min call and tell us which results your systems or agents should read.
- We enable the API module on your installed Everix instance.
- Your administrator creates a read-only service account and key, and you connect your first client.
In Everix Cloud IFR and Cloud Risk there is nothing to enable: an admin of your organization creates an agent key under Organization › AI agents. The MCP reference shows how to connect.
Related on everix.io