API reference / Meta

Liveness

Written and maintained by The ProspectAPIs team

GET/health

GET /health is the ProspectAPIs operation getHealth, in the Meta group of the REST API. Liveness for uptime monitors. Never fails on the database. Free, no key. Cost: free, no key. It needs no API key.

The quickstart shows this call in context, next to the first requests most integrations make.

Parameters

This operation takes no path or query parameters.

Responses

200 response fields

The service is up. The body is a Health.

Code samples

Each sample sends the same request. No key is needed. Values come from the spec's examples; replace them with your own.

curl https://api.prospectapis.com/health

const res = await fetch("https://api.prospectapis.com/health");
if (!res.ok) throw new Error(`${res.status}: ${(await res.json().catch(() => ({}))).error ?? res.statusText}`);
const data = await res.json();
console.log(data);

import requests

res = requests.get(
    "https://api.prospectapis.com/health",
    timeout=30,
)
res.raise_for_status()
data = res.json()
print(data)

Billing

This call is free and needs no key: it never spends credits or free records, so you can call it as often as the rate limit allows. Metered calls on the same key report your balance after each response in X-Credits-Remaining, and GET /v1/account shows it at any time.

Related

Previous operation: Live price list. Every operation, grouped by area, is on the API reference index.

Create a free account to get a key, then run the samples above with your own values.