Retrieve Server Time

curl --request GET \
  --url https://api.getmelody.io/device/server-time \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Device-Key: <x-device-key>'

import requests

url = "https://api.getmelody.io/device/server-time"

headers = {
    "X-Device-Key": "<x-device-key>",
    "Authorization": "Bearer <token>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'X-Device-Key': '<x-device-key>', Authorization: 'Bearer <token>'}
};

fetch('https://api.getmelody.io/device/server-time', 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.getmelody.io/device/server-time",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "X-Device-Key: <x-device-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.getmelody.io/device/server-time"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-Device-Key", "<x-device-key>")
	req.Header.Add("Authorization", "Bearer <token>")

	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.getmelody.io/device/server-time")
  .header("X-Device-Key", "<x-device-key>")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.getmelody.io/device/server-time")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-Device-Key"] = '<x-device-key>'
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "epoch_ms": 123
}

Device Information

Retrieve Server Time

Retrieve Server Time in milliseconds

Guide for Server Time Synchronization (Using EWMA)

To ensure accurate synchronization with the server time, follow these steps:

Call the API endpoint /device/server-time multiple times and get server time in ms(epoch_ms). A higher number of requests improves accuracy but increases synchronization time. At least 10 times could be a good start.
For each request, note the time when the request is sent (sent_at) and when the response is received (received_at).
Calculate RTD (Round Trip Delay): RTD = received_at - sent_at.
Adjust for network delay by adding half of RTD to the received server time: server_time_estimated = epoch_ms + RTD / 2
Calculate the time difference between the server_time_estimated and the client’s current time (client_ts): time_diff = server_time_estimated - client_ts.
Instead of a simple average, use Exponentially Weighted Moving Average (EWMA) to smooth out variations:

  alpha = 0.3 # Smoothing factor, 0.1 to 0.3 (recommended for balancing stability and responsiveness).
  ewma = alpha * time_diff + (1 - alpha) * ewma

Use the EWMA-adjusted offset to compute the synchronized server time when sending data:

  synchronized_server_time_ms = client_ts + ewma

Use the synchronized server time to send data to the device in the corresponding API endpoints.

GET

device

server-time

Retrieve Server Time

curl --request GET \
  --url https://api.getmelody.io/device/server-time \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Device-Key: <x-device-key>'

import requests

url = "https://api.getmelody.io/device/server-time"

headers = {
    "X-Device-Key": "<x-device-key>",
    "Authorization": "Bearer <token>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'X-Device-Key': '<x-device-key>', Authorization: 'Bearer <token>'}
};

fetch('https://api.getmelody.io/device/server-time', 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.getmelody.io/device/server-time",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "X-Device-Key: <x-device-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.getmelody.io/device/server-time"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-Device-Key", "<x-device-key>")
	req.Header.Add("Authorization", "Bearer <token>")

	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.getmelody.io/device/server-time")
  .header("X-Device-Key", "<x-device-key>")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.getmelody.io/device/server-time")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-Device-Key"] = '<x-device-key>'
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "epoch_ms": 123
}

Authorizations

Authorization

string

header

required

Short-lived session token obtained from POST /api/sessions/v2. Send it as Authorization: Bearer <session_token> together with the X-Device-Key: <device-key> header identifying the target device.

Headers

X-Device-Key

string

required

Device Key (4 BIP39 words) identifying the target device. Obtain it from POST /device/otp/confirm/v2.

Pattern: ^[a-z]+-[a-z]+-[a-z]+-[a-z]+$

Example:

"alpha-bravo-charlie-delta"

Response

200 - application/json

epoch_ms

integer<int64>

The current server time in milliseconds.

Retrieve Device Session

Retrieve Device Mode