Documentation navigation

Health API

API health and status

Authentication: X-API-Key header on every request. Get a key.

Health check

GET/v1/status

Quota cost: 1 unit Try it

Returns the API health status and database connectivity. No authentication required.

Parameters

This endpoint takes no parameters.

Code samples

curl Go Python TypeScript Ruby PHP

# /v1/status needs no API key; every other endpoint requires -H "X-API-Key: YOUR_KEY"
curl https://geosearch.dev/v1/status

// go get github.com/geosearch-dev/geosearch-go
client := geosearch.NewAPIClient(geosearch.NewConfiguration())
ctx := context.WithValue(context.Background(), geosearch.ContextAPIKeys,
    map[string]geosearch.APIKey{"apiKeyAuth": {Key: "YOUR_KEY"}})
status, _, err := client.HealthAPI.GetStatus(ctx).Execute()

# pip install git+https://github.com/geosearch-dev/geosearch-python.git
import geosearch

cfg = geosearch.Configuration(api_key={"apiKeyAuth": "YOUR_KEY"})
with geosearch.ApiClient(cfg) as client:
    status = geosearch.HealthApi(client).get_status().data

// npm install github:geosearch-dev/geosearch-typescript
import { Configuration, HealthApi } from "@geosearch/client";

const api = new HealthApi(new Configuration({ apiKey: "YOUR_KEY" }));
const status = (await api.getStatus()).data;

# gem 'geosearch', git: 'https://github.com/geosearch-dev/geosearch-ruby.git'
require "geosearch"

GeoSearch.configure { |c| c.api_key["X-API-Key"] = "YOUR_KEY" }
status = GeoSearch::HealthApi.new.get_status.data

// composer config repositories.geosearch vcs https://github.com/geosearch-dev/geosearch-php.git
// composer require geosearch-dev/geosearch-php
$cfg = GeoSearch\Configuration::getDefaultConfiguration()
    ->setApiKey("X-API-Key", "YOUR_KEY");
$status = (new GeoSearch\Api\HealthApi(null, $cfg))->getStatus()->getData();

Response

{
  "data": {
    "status": "healthy",
    "database": "connected"
  }
}