Health check
curl --request GET \
--url https://www.sharpe.ai/api/v1/healthconst options = {method: 'GET'};
fetch('https://www.sharpe.ai/api/v1/health', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://www.sharpe.ai/api/v1/health"
response = requests.get(url)
print(response.text){
"status": "healthy",
"version": "v1",
"checks": {
"database": true,
"news": {
"status": "fresh",
"latest_published_at": "2023-11-07T05:31:56Z",
"age_seconds": 1,
"freshness_sla_seconds": 21600,
"future_tolerance_seconds": 300,
"unknown_reason": "missing"
}
},
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"datasets": {
"items": [
{
"dataset_id": "funding_rates_current",
"store": "serve_snapshot",
"scope": "<string>",
"as_of": "2023-11-07T05:31:56Z",
"stale_after": "2023-11-07T05:31:56Z",
"freshness_sla_seconds": 123,
"freshness_status": "fresh",
"unknown_reason": "missing"
}
],
"warnings": [
"<string>"
]
}
}{
"status": "healthy",
"version": "v1",
"checks": {
"database": true,
"news": {
"status": "fresh",
"latest_published_at": "2023-11-07T05:31:56Z",
"age_seconds": 1,
"freshness_sla_seconds": 21600,
"future_tolerance_seconds": 300,
"unknown_reason": "missing"
}
},
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"datasets": {
"items": [
{
"dataset_id": "funding_rates_current",
"store": "serve_snapshot",
"scope": "<string>",
"as_of": "2023-11-07T05:31:56Z",
"stale_after": "2023-11-07T05:31:56Z",
"freshness_sla_seconds": 123,
"freshness_status": "fresh",
"unknown_reason": "missing"
}
],
"warnings": [
"<string>"
]
}
}System
Health check
Returns database reachability and News article freshness. The service is degraded when the database is unavailable or the newest News article is stale or has unknown freshness. It also lists per-dataset freshness (datasets) read from the snapshot index and the cache rows; a stale dataset does not make the service degraded. No authentication required.
GET
/
v1
/
health
Health check
curl --request GET \
--url https://www.sharpe.ai/api/v1/healthconst options = {method: 'GET'};
fetch('https://www.sharpe.ai/api/v1/health', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://www.sharpe.ai/api/v1/health"
response = requests.get(url)
print(response.text){
"status": "healthy",
"version": "v1",
"checks": {
"database": true,
"news": {
"status": "fresh",
"latest_published_at": "2023-11-07T05:31:56Z",
"age_seconds": 1,
"freshness_sla_seconds": 21600,
"future_tolerance_seconds": 300,
"unknown_reason": "missing"
}
},
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"datasets": {
"items": [
{
"dataset_id": "funding_rates_current",
"store": "serve_snapshot",
"scope": "<string>",
"as_of": "2023-11-07T05:31:56Z",
"stale_after": "2023-11-07T05:31:56Z",
"freshness_sla_seconds": 123,
"freshness_status": "fresh",
"unknown_reason": "missing"
}
],
"warnings": [
"<string>"
]
}
}{
"status": "healthy",
"version": "v1",
"checks": {
"database": true,
"news": {
"status": "fresh",
"latest_published_at": "2023-11-07T05:31:56Z",
"age_seconds": 1,
"freshness_sla_seconds": 21600,
"future_tolerance_seconds": 300,
"unknown_reason": "missing"
}
},
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"datasets": {
"items": [
{
"dataset_id": "funding_rates_current",
"store": "serve_snapshot",
"scope": "<string>",
"as_of": "2023-11-07T05:31:56Z",
"stale_after": "2023-11-07T05:31:56Z",
"freshness_sla_seconds": 123,
"freshness_status": "fresh",
"unknown_reason": "missing"
}
],
"warnings": [
"<string>"
]
}
}Response
Service is healthy.

