Health — Service connectivity and data freshness
curl --request GET \
--url https://api.fieldfunded.com/v1/health \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.fieldfunded.com/v1/health"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.fieldfunded.com/v1/health', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.fieldfunded.com/v1/health",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.fieldfunded.com/v1/health"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.fieldfunded.com/v1/health")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.fieldfunded.com/v1/health")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"status": "healthy",
"version": "1.0.0",
"uptime_seconds": 86400,
"timestamp": "2026-04-14T18:00:00.000Z",
"services": {
"redis": {
"status": "connected",
"latency_ms": 9
},
"data_pipeline": {
"status": "active",
"last_update_seconds_ago": 12,
"total_events": 1847
}
}
}{
"error": "server_error",
"message": "Internal server error"
}System
Health Check
Reports the health of the API, including service connectivity, data freshness, and uptime. Returns HTTP 200 when healthy, HTTP 503 when degraded. Use this for monitoring dashboards.
This endpoint does not count against your monthly quota. Fixed rate limit: 2 req/s, 120 req/h (equal for all plans).
GET
/
v1
/
health
Health — Service connectivity and data freshness
curl --request GET \
--url https://api.fieldfunded.com/v1/health \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.fieldfunded.com/v1/health"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.fieldfunded.com/v1/health', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.fieldfunded.com/v1/health",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.fieldfunded.com/v1/health"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.fieldfunded.com/v1/health")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.fieldfunded.com/v1/health")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"status": "healthy",
"version": "1.0.0",
"uptime_seconds": 86400,
"timestamp": "2026-04-14T18:00:00.000Z",
"services": {
"redis": {
"status": "connected",
"latency_ms": 9
},
"data_pipeline": {
"status": "active",
"last_update_seconds_ago": 12,
"total_events": 1847
}
}
}{
"error": "server_error",
"message": "Internal server error"
}Authorizations
Your FieldFunded API Key
Response
Real-time system health metrics, latency data, and active event counts.
