1. Health
Graph Swiss API
  • Introduction
  • Quickstart
  • Authentication
  • Base URL
  • Errors
  • Request ID
  • Conventions
  • API
    • Health
      • Liveness probe
        GET
    • Companies
      • Search companies
      • AI-powered company search
      • Get company by ID
      • Get company journal summaries
      • Get full SHAB journal texts
      • Get detailed company report
    • Persons
      • Search persons
      • Get person by ID
    • Stocks
      • List active Swiss stock symbols
      • Get real-time stock quote
      • Get current stock price
      • Get historical OHLCV data
      • Get latest end-of-day data
      • Get company profile and statistics
      • Get income statement, balance sheet, and cash flow
      • Get key executives for a stock
  • Schemas
    • StockSymbol
    • Error
    • StockQuote
    • Company
    • StockPrice
    • CompanyDetail
    • StockHistoryValue
    • Code
    • StockHistory
    • CompanyWithRelations
    • StockEod
    • CompanyListPage
    • StockProfile
    • Person
    • StockIncomeStatement
    • ShabJournal
    • StockBalanceSheet
    • PersonCompanyLink
    • StockCashFlow
    • PersonWithCompanies
    • StockFinancials
    • PersonListPage
    • StockKeyExecutive
  1. Health

Liveness probe

GET
/api/health
Open endpoint that confirms the gateway process is up and serving HTTP.
No API key required. Does not consume credits.

Request

Authorization
API Key
Add parameter in header
X-API-Key
Example:
X-API-Key: ********************
or

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/api/health' \
--header 'X-API-Key: <api-key>'

Responses

🟢200
application/json
Gateway is up.
Body

Example
{
    "success": true,
    "data": {
        "status": "ok",
        "uptime": 1287.42,
        "timestamp": "2026-05-01T12:34:56.789Z"
    }
}
Modified at 2026-05-01 06:16:37
Previous
Conventions
Next
Search companies
Built with