GET
/
free
/
health
Health
curl --request GET \
  --url https://api.tic.io/free/health \
  --header 'x-api-key: <api-key>'
{
  "ok": true,
  "upcomingServiceWindows": [
    {
      "startDateUtc": "2023-11-07T05:31:56Z",
      "endDateUtc": "2023-11-07T05:31:56Z",
      "notes": "<string>",
      "lastUpdatedAtUtc": "2023-11-07T05:31:56Z"
    }
  ],
  "limits": {
    "rateLimitReset": 123,
    "rateLimit": 123,
    "rateLimitRemaining": 123,
    "rateLimitMinute": 123,
    "rateLimitIP": 123
  }
}
This endpoint allows you to get our status health. It doesn’t require any token or authentication. If you provide your authentication with your x-api-key or included in the querystring we will respond back also with the current limits for the API key equals the header data you receive for X-RateLimit-*. Response also includes information about any upcoming service windows. Example:
Response for health with upcoming service window
{
  "ok": true,
  "upcomingServiceWindows": [
    {
      "startDateUtc": "2025-02-02T06:00:00",
      "endDateUtc": "2025-02-02T06:05:00",
      "notes": "Just for demonstration",
      "lastUpdatedAtUtc": "2025-02-01T08:52:43"
    }
  ],
  "limits": {
    "rateLimitReset": 2435948,
    "rateLimit": 3000,
    "rateLimitRemaining": 2965,
    "rateLimitMinute": 960,
    "rateLimitIP": 200
  }
}

Authorizations

​
x-api-key
string
header
required

Response

200 - application/json

The health response

​
ok
boolean
​
upcomingServiceWindows
object[] | null
​
limits
object