API docs
Call the API with your workspace ID in the path. Unknown IDs return HTTP 404. Requests need a known origin/IP, or a valid signature if they come from your backend.
Backend request signing
For backend calls, sign requests with the signing key from your workspace settings.
Signature formula: base64(hmac_sha256(full_path + timestamp_ms))
full_path is the path starting with /api, including querytimestamp_ms is current Unix time in milliseconds (max 5 min skew)Send these headers with your request:
X-Signature is the result of the formula aboveX-Signature-Timestamp is timestamp_msUnsigned calls must come from your allowed domains or IPs.
GET
Return the current date/time value for the entity in the requested format.
Path params
| tenant | Your Workspace ID in the path. |
| entity | One of date, time, datetime, timestamp, iso. |
| format | Optional. Defaults to text. One of json, text, yaml, xml, png*, svg*. |
Query params
| tz | Hour offset, e.g. -5 or 2. Defaults to request geolocation. |
| locale | BCP 47 locale, e.g. en-GB or uk-UA. Defaults to request locale. |
| precision | One of year, month, day, hour, minute, second (entity-dependent). |
| custom | Custom pattern using YYYY, MM, DD, HH, mm, ss. Overrides precision. |
| cache | off/none/false/0 to bypass edge cache (still consumes quota). |
Response
{
"date": "2025-02-01",
"timezoneOffset": 2,
"locale": "en-GB"
}* SVG responses available on the Unlimited plan. † PNG responses are planned.
Error codes
GET
Convert the provided value (e.g. ISO datetime) using the requested precision/format.
Path params
| tenant | Your Workspace ID in the path. |
| entity | date, time, datetime, timestamp, iso. |
| value | Input value to convert (e.g. ISO datetime). |
| format | Optional. Defaults to text. json, text, yaml, xml, png*, svg*. |
Query params
| precision | One of year, month, day, hour, minute, second. |
| custom | Custom pattern (YYYY, MM, DD, HH, mm, ss). |
| tz | Hour offset for the output. If input lacks timezone, we fall back to request locale or this override. |
| cache | off/none/false/0 to bypass edge cache. |
Response
{
"datetime": "2025-01-01T12:00:00Z",
"precision": "minute"
}* SVG responses available on the Unlimited plan. † PNG responses are planned.
Error codes
GET
Signed countdown/countup (SVG*, PNG† roadmap) for the target datetime (Unlimited plan, no per-timer cap). Images are fixed-size today. Sizing params will arrive with minimum aspect-ratio guards.
Path params
| tenant | Your Workspace ID in the path. |
| target | ISO datetime or epoch (ms/s) to count toward. |
| format | Optional. Defaults to text. json, text, yaml, xml, png†, svg*. |
Query params
| label | Optional label above the timer (max 40 chars). |
| textColor | Hex or transparent. Default #ffffff. |
| bgColor | Hex or transparent. Default #111827. |
| fontSize | 16-120 px. Default 48. |
| countup | 1/true/yes/on to count up after the target. |
| tz | Hour offset to evaluate the target. Defaults to request geolocation. |
Response
{
"timer": "2025-12-31T23:59:00Z",
"mode": "countdown"
}* SVG responses available on the Unlimited plan. † PNG responses are planned.
Error codes