Skip to Content
ELK Developers

GET /v1/heartbeat

Account connectivity

Download .md
GET
/v1/heartbeat

Requires a valid key, approved source IP, active enrolled account, ViewQuotes and current KYC for linked desk clients. No body, query parameters or Content-Encoding is accepted. No Content-Type or Idempotency-Key is needed. Returns API and account-authority connectivity checks. Poll every 15 seconds; use backoff and jitter after failures.

Authorization

ApiKey
headerAuthorizationBearer <token>

Send Authorization: Bearer over HTTPS. Each key is associated with an account and environment. Invalid, expired or revoked keys return 401.

Response Body

API and current account-authority checks succeeded

application/json
  1. response
status*string
as_of*UtcTimestamp

UTC ISO 8601, exactly millisecond precision; server/database authority.

Formatdate-time
checks*
Example Request
curl -X GET 'https://api.elkcrypto.com/sandbox/v1/heartbeat'
Example Response
{  "status": "ok",  "as_of": "2019-08-24T14:15:22Z",  "checks": {    "api": "ok",    "account_authority": "ok"  }}