Skip to main content
POST
/
heartbeat
Register heartbeat
curl --request POST \
  --url https://api.sx.bet/heartbeat \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --data '
{
  "requestor": "<YOUR-ACCOUNT-ADDRESS>",
  "timeoutSeconds": 10
}
'
{
  "status": "success",
  "data": {
    "requestor": "<YOUR-ACCOUNT-ADDRESS>",
    "timeoutSeconds": 10,
    "expiresAt": "2024-11-12T14:35:06.614Z"
  }
}

Authorizations

​
X-Api-Key
string
header
required

API key for authenticated endpoints. See API Key for how to obtain one.

Body

application/json
​
requestor
string
required

The ethereum address associated with your account

​
timeoutSeconds
integer
required

The number of seconds before heartbeat service times out and cancels your open orders

Required range: 0 <= x <= 3600

Response

​
status
string

success or failure if the request succeeded or not

​
data
object