Welcome to Graph Swiss API — a single REST gateway for Swiss companies, persons, and stocks data, with built-in metering and end-to-end tracing.Every endpoint speaks JSON, returns a consistent { success, data } envelope, and carries a request ID so any failure can be traced from your client through to the upstream that produced it.What you can query#
| Domain | Highlights |
|---|
| Health | Open liveness probe — confirms the gateway is up. No API key required. |
| Companies | Search by query / canton / legal form, lookup by ID, journal summaries, full SHAB journal text, detailed reports. |
| Persons | Search and lookup, including each person's company associations and SHAB journal history. |
| Stocks | Active Swiss symbols, real-time quotes and prices, OHLCV history, end-of-day data, company profiles, financial statements, key executives. |
The full endpoint reference — request and response schemas for every route — lives alongside these pages.How it works#
1.
You authenticate with an X-API-Key header on every /api/... request.
2.
The gateway meters the call: it validates the key, checks your plan and rate limit, and atomically deducts the per-endpoint credit cost from your wallet.
3.
The gateway forwards the request to the right upstream service.
4.
You get back a JSON envelope plus headers that tell you the request ID, credit cost, remaining balance, and rate-limit window.
5.
If the upstream fails (5xx), the credits are automatically refunded.
Three things to know#
One key, one header. X-API-Key is the only credential you ever send.
Credits per call. Every metered request costs a small number of credits. Headers on the response tell you exactly what was charged and what's left.
Trace anything. Every response carries X-Request-Id. Quote it in support tickets and we can pinpoint the call instantly.
Read these in order#
| # | Page | What it covers |
|---|
| 1 | Quickstart | Make your first call in three steps |
| 2 | Authentication | The X-API-Key header and how credits are deducted |
| 3 | Base URL | Production URL, path layout, TLS, CORS |
| 4 | Errors | Error envelope and the full code reference |
| 5 | Request ID | How tracing works end-to-end |
| 6 | Conventions | Envelope shape, status codes, headers, versioning |
Versioning#
The current API version is v0.1.0. Endpoints follow a flat path layout (/api/companies/..., /api/persons/..., /api/stocks/...); breaking changes to a resource will land under a versioned path (/api/v2/...) while the old version stays available during the deprecation window. Modified at 2026-05-01 06:35:05