Heartbeat

The heartbeat feed publishes a heartbeat message at timed intervals.

Authentication is not required.

Feed

Event Type

Perimissible API Keys
heartbeat
subscribe / unsubscribe
N/A
Sample Sent Message
{  
    "event":"subscribe",
    "feed":"heartbeat"
}

 

Sample Return if Successful.

{  
    "event":"subscribed",
    "feed":"heartbeat"
}

Field

Type Description
event
string The result, subscribed or subscribed_failed or
unsubscribed or unsubscribed_failed
feed string The requested subscription feed

 

Sample Subscription Data

{  
    "feed":"heartbeat",
    "time":1534262350627
}

Field

Type Description
feed string The subscribed feed
time positive integer

The UTC time of the server in milliseconds

 

Sample Return if Unsuccessful 
{  
    "event":"error",
    "message":"Json Error"
}

Field

Type Description
event string Always error
message string

An error message out of:

  • Invalid feed
  • Json Error