Relative Time FormatterRelative Time Formatter API

OnlineCredit Usage:1 per callRefreshed 1 month ago
avg: 176ms|p50: 170ms|p75: 180ms|p90: 193ms|p99: 218ms

Relative Time Formatter is a tool for converting timestamps and dates to human-readable relative time formats like '2 hours ago' or 'in 3 days'. It supports multiple styles and custom reference times for flexible time representation.

The Relative Time Formatter API provides reliable and fast access to relative time formatter data through a simple REST interface. Built for developers who need consistent, high-quality results with minimal setup time.

To use Relative Time Formatter, you need an API key. You can get one by creating a free account and visiting your dashboard.

GET Endpoint

URL
https://api.apiverve.com/v1/relativetimeformatter

Code Examples

Here are examples of how to call the Relative Time Formatter API in different programming languages:

cURL Request
curl -X GET \
  "https://api.apiverve.com/v1/relativetimeformatter?timestamp=1609459200&reference=2024-06-01T00%3A00%3A00Z&style=short" \
  -H "X-API-Key: your_api_key_here"
JavaScript (Fetch API)
const response = await fetch('https://api.apiverve.com/v1/relativetimeformatter?timestamp=1609459200&reference=2024-06-01T00%3A00%3A00Z&style=short', {
  method: 'GET',
  headers: {
    'X-API-Key': 'your_api_key_here',
    'Content-Type': 'application/json'
  }
});

const data = await response.json();
console.log(data);
Python (Requests)
import requests

headers = {
    'X-API-Key': 'your_api_key_here',
    'Content-Type': 'application/json'
}

response = requests.get('https://api.apiverve.com/v1/relativetimeformatter?timestamp=1609459200&reference=2024-06-01T00%3A00%3A00Z&style=short', headers=headers)

data = response.json()
print(data)
Node.js (Native HTTPS)
const https = require('https');
const url = require('url');

const options = {
  method: 'GET',
  headers: {
    'X-API-Key': 'your_api_key_here',
    'Content-Type': 'application/json'
  }
};

const req = https.request('https://api.apiverve.com/v1/relativetimeformatter?timestamp=1609459200&reference=2024-06-01T00%3A00%3A00Z&style=short', options, (res) => {
  let data = '';
  res.on('data', (chunk) => data += chunk);
  res.on('end', () => console.log(JSON.parse(data)));
});

req.end();
PHP (cURL)
<?php

$ch = curl_init();

curl_setopt($ch, CURLOPT_URL, 'https://api.apiverve.com/v1/relativetimeformatter?timestamp=1609459200&reference=2024-06-01T00%3A00%3A00Z&style=short');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'X-API-Key: your_api_key_here',
    'Content-Type: application/json'
]);

$response = curl_exec($ch);
curl_close($ch);

$data = json_decode($response, true);
print_r($data);

?>
Go (net/http)
package main

import (
    "fmt"
    "io"
    "net/http"

)

func main() {
    req, _ := http.NewRequest("GET", "https://api.apiverve.com/v1/relativetimeformatter?timestamp=1609459200&reference=2024-06-01T00%3A00%3A00Z&style=short", nil)

    req.Header.Set("X-API-Key", "your_api_key_here")
    req.Header.Set("Content-Type", "application/json")

    client := &http.Client{}
    resp, err := client.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()

    body, _ := io.ReadAll(resp.Body)
    fmt.Println(string(body))
}
Ruby (Net::HTTP)
require 'net/http'
require 'json'

uri = URI('https://api.apiverve.com/v1/relativetimeformatter?timestamp=1609459200&reference=2024-06-01T00%3A00%3A00Z&style=short')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

request = Net::HTTP::Get.new(uri)
request['X-API-Key'] = 'your_api_key_here'
request['Content-Type'] = 'application/json'

response = http.request(request)
puts JSON.pretty_generate(JSON.parse(response.body))
C# (HttpClient)
using System;
using System.Net.Http;
using System.Text;
using System.Threading.Tasks;

class Program
{
    static async Task Main(string[] args)
    {
        using var client = new HttpClient();
        client.DefaultRequestHeaders.Add("X-API-Key", "your_api_key_here");

        var response = await client.GetAsync("https://api.apiverve.com/v1/relativetimeformatter?timestamp=1609459200&reference=2024-06-01T00%3A00%3A00Z&style=short");
        response.EnsureSuccessStatusCode();

        var responseBody = await response.Content.ReadAsStringAsync();
        Console.WriteLine(responseBody);
    }
}

Authentication

The Relative Time Formatter API requires authentication via API key. Include your API key in the request header:

Required Header
X-API-Key: your_api_key_here

Learn more about authentication →

Interactive API Playground

Test the Relative Time Formatter API directly in your browser with live requests and responses.

Parameters

The Relative Time Formatter API supports multiple query options. Use one of the following:

Option 1: Format from Timestamp

ParameterTypeRequiredDescriptionDefaultExample
timestampstringrequired
Unix timestamp in seconds or milliseconds
Format: timestamp (e.g., 1609459200)
-1609459200
referencestringoptional
Reference time to compare against (default: current time)
Format: date (e.g., 2024-06-01T00:00:00Z)
-2024-06-01T00:00:00Z
stylestringoptional
Output style
Supported values: shortlongabbreviated
shortshort

Option 2: Format from Date

ParameterTypeRequiredDescriptionDefaultExample
datestringrequired
ISO date string
-2024-01-01T00:00:00Z
referencestringoptional
Reference time to compare against (default: current time)
Format: date (e.g., 2024-06-01T00:00:00Z)
-2024-06-01T00:00:00Z
stylestringoptional
Output style
Supported values: shortlongabbreviated
shortshort

Response

The Relative Time Formatter API returns responses in JSON, XML, YAML, and CSV formats:

Example Responses

JSON Response
200 OK
{
  "status": "ok",
  "error": null,
  "data": {
    "target_date": "2021-01-01T00:00:00Z",
    "reference_date": "2025-12-16T22:28:24.459Z",
    "relative_time": "4 years ago",
    "is_past": true,
    "is_future": false,
    "difference_ms": -156464904459,
    "primary_unit": "year",
    "primary_value": 4,
    "all_units": {
      "years": 4,
      "months": 59,
      "weeks": 258,
      "days": 1810,
      "hours": 43462,
      "minutes": 2607748,
      "seconds": 156464904,
      "milliseconds": 156464904459
    },
    "style": "short"
  }
}
XML Response
200 OK
<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>ok</status>
  <error xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
  <data>
    <target_date>2021-01-01T00:00:00Z</target_date>
    <reference_date>2025-12-16T22:28:24.459Z</reference_date>
    <relative_time>4 years ago</relative_time>
    <is_past>true</is_past>
    <is_future>false</is_future>
    <difference_ms>-156464904459</difference_ms>
    <primary_unit>year</primary_unit>
    <primary_value>4</primary_value>
    <all_units>
      <years>4</years>
      <months>59</months>
      <weeks>258</weeks>
      <days>1810</days>
      <hours>43462</hours>
      <minutes>2607748</minutes>
      <seconds>156464904</seconds>
      <milliseconds>156464904459</milliseconds>
    </all_units>
    <style>short</style>
  </data>
</response>
YAML Response
200 OK
status: ok
error: null
data:
  target_date: '2021-01-01T00:00:00Z'
  reference_date: '2025-12-16T22:28:24.459Z'
  relative_time: 4 years ago
  is_past: true
  is_future: false
  difference_ms: -156464904459
  primary_unit: year
  primary_value: 4
  all_units:
    years: 4
    months: 59
    weeks: 258
    days: 1810
    hours: 43462
    minutes: 2607748
    seconds: 156464904
    milliseconds: 156464904459
  style: short
CSV Response
200 OK
keyvalue
target_date2021-01-01T00:00:00Z
reference_date2025-12-16T22:28:24.459Z
relative_time4 years ago
is_pasttrue
is_futurefalse
difference_ms-156464904459
primary_unityear
primary_value4
all_units{years:4,months:59,weeks:258,days:1810,hours:43462,minutes:2607748,seconds:156464904,milliseconds:156464904459}
styleshort

Response Structure

All API responses follow a consistent structure with the following fields:

FieldTypeDescriptionExample
statusstringIndicates whether the request was successful ("ok") or failed ("error")ok
errorstring | nullContains error message if status is "error", otherwise nullnull
dataobject | nullContains the API response data if successful, otherwise null{...}

Learn more about response formats →

Response Data Fields

When the request is successful, the data object contains the following fields:

FieldTypeSample ValueDescription
target_datestring"2021-01-01T00:00:00Z"-
reference_datestring"2025-12-16T22:28:24.459Z"-
relative_timestring"4 years ago"-
is_pastbooleantrue-
is_futurebooleanfalse-
difference_msnumber-156464904459-
primary_unitstring"year"-
primary_valuenumber4-
all_unitsobject{...}-
â”” yearsnumber4-
â”” monthsnumber59-
â”” weeksnumber258-
â”” daysnumber1810-
â”” hoursnumber43462-
â”” minutesnumber2607748-
â”” secondsnumber156464904-
â”” millisecondsnumber156464904459-
stylestring"short"-

Headers

Required and optional headers for Relative Time Formatter API requests:

Header NameRequiredExample ValueDescription
X-API-Keyrequiredyour_api_key_hereYour APIVerve API key. Found in your dashboard under API Keys.
Acceptoptionalapplication/jsonSpecify response format: application/json (default), application/xml, or application/yaml
User-AgentoptionalMyApp/1.0Identifies your application for analytics and debugging purposes
X-Request-IDoptionalreq_123456789Custom request identifier for tracking and debugging requests
Cache-Controloptionalno-cacheControl caching behavior for the request and response

Learn more about request headers →

GraphQL AccessALPHA

Access Relative Time Formatter through GraphQL to combine it with other API calls in a single request. Query only the relative time formatter data you need with precise field selection, and orchestrate complex data fetching workflows.

Test Relative Time Formatter in the GraphQL Explorer to confirm availability and experiment with queries.

Credit Cost: Each API called in your GraphQL query consumes its standard credit cost.

GraphQL Endpoint
POST https://api.apiverve.com/v1/graphql
GraphQL Query Example
query {
  relativetimeformatter(
    input: {
      timestamp: "1609459200"
      reference: "2024-06-01T00:00:00Z"
      style: "short"
    }
  ) {
    target_date
    reference_date
    relative_time
    is_past
    is_future
    difference_ms
    primary_unit
    primary_value
    all_units {
      years
      months
      weeks
      days
      hours
      minutes
      seconds
      milliseconds
    }
    style
  }
}

Note: Authentication is handled via the x-api-key header in your GraphQL request, not as a query parameter.

CORS Support

The Relative Time Formatter API supports Cross-Origin Resource Sharing (CORS) with wildcard configuration, allowing you to call Relative Time Formatter directly from browser-based applications without proxy servers.

CORS HeaderValueDescription
Access-Control-Allow-Origin*Accepts requests from any origin
Access-Control-Allow-Methods*Accepts any HTTP method
Access-Control-Allow-Headers*Accepts any request headers

Browser Usage: You can call Relative Time Formatter directly from JavaScript running in the browser without encountering CORS errors. No proxy server or additional configuration needed.

Learn more about CORS support →

Rate Limiting

Relative Time Formatter API requests are subject to rate limiting based on your subscription plan. These limits ensure fair usage and maintain service quality for all Relative Time Formatter users.

PlanRate LimitDescription
Free5 requests/minHard rate limit enforced - exceeding will return 429 errors
StarterNo LimitProduction ready - standard traffic priority
ProNo LimitProduction ready - preferred traffic priority
MegaNo LimitProduction ready - highest traffic priority

Learn more about rate limiting →

Rate Limit Headers

When rate limits apply, each Relative Time Formatter response includes headers to help you track your usage:

HeaderDescription
X-RateLimit-LimitMaximum number of requests allowed per time window
X-RateLimit-RemainingNumber of requests remaining in the current window
X-RateLimit-ResetUnix timestamp when the rate limit window resets

Handling Rate Limits

Free Plan: When you exceed your rate limit, Relative Time Formatter returns a 429 Too Many Requests status code. Your application should implement appropriate backoff logic to handle this gracefully.

Paid Plans: No rate limiting or throttling applied. All paid plans (Starter, Pro, Mega) are production-ready.

Best Practices for Relative Time Formatter:

  • Monitor the rate limit headers to track your Relative Time Formatter usage (Free plan only)
  • Cache relative time formatter responses where appropriate to reduce API calls
  • Upgrade to Pro or Mega for guaranteed no-throttle Relative Time Formatter performance

Note: Relative Time Formatter rate limits are separate from credit consumption. You may have credits remaining but still hit rate limits when using Relative Time Formatter on Free tier.

Error Codes

The Relative Time Formatter API uses standard HTTP status codes to indicate success or failure:

CodeMessageDescriptionSolution
200OKRequest successful, data returnedNo action needed - request was successful
400Bad RequestInvalid request parameters or malformed requestCheck required parameters and ensure values match expected formats
401UnauthorizedMissing or invalid API keyInclude x-api-key header with valid API key from dashboard
403ForbiddenAPI key lacks permission or insufficient creditsCheck credit balance in dashboard or upgrade plan
429Too Many RequestsRate limit exceeded (Free: 5 req/min)Implement request throttling or upgrade to paid plan
500Internal Server ErrorServer error occurredRetry request after a few seconds, contact support if persists
503Service UnavailableAPI temporarily unavailableWait and retry, check status page for maintenance updates

Learn more about error handling →

Need help? Contact support with your X-Request-ID for assistance.

Integrate Relative Time Formatter with SDKs

Get started quickly with official Relative Time Formatter SDKs for your preferred language. Each library handles authentication, request formatting, and error handling automatically.

Available for Node.js, Python, C#/.NET, and Android/Java. All SDKs are open source and regularly updated.

Integrate Relative Time Formatter with No-Code API Tools

Connect the Relative Time Formatter API to your favorite automation platform without writing code. Build workflows that leverage relative time formatter data across thousands of apps.

All platforms use your same API key to access Relative Time Formatter. Visit our integrations hub for step-by-step setup guides.

Frequently Asked Questions

How do I get an API key for Relative Time Formatter?
Sign up for a free account at dashboard.apiverve.com. Your API key will be automatically generated and available in your dashboard. The same key works for Relative Time Formatter and all other APIVerve APIs. The free plan includes 1,000 credits plus a 500 credit bonus.
How many credits does Relative Time Formatter cost?

Each successful Relative Time Formatter API call consumes credits based on plan tier. Check the pricing section above for the exact credit cost. Failed requests and errors don't consume credits, so you only pay for successful relative time formatter lookups.

Can I use Relative Time Formatter in production?

The free plan is for testing and development only. For production use of Relative Time Formatter, upgrade to a paid plan (Starter, Pro, or Mega) which includes commercial use rights, no attribution requirements, and guaranteed uptime SLAs. All paid plans are production-ready.

Can I use Relative Time Formatter from a browser?
Yes! The Relative Time Formatter API supports CORS with wildcard configuration, so you can call it directly from browser-based JavaScript without needing a proxy server. See the CORS section above for details.
What happens if I exceed my Relative Time Formatter credit limit?

When you reach your monthly credit limit, Relative Time Formatter API requests will return an error until you upgrade your plan or wait for the next billing cycle. You'll receive notifications at 80% and 95% usage to give you time to upgrade if needed.

What's Next?

Continue your journey with these recommended resources

Was this page helpful?