Gemini Crypto Exchange Logo
REST API

Session (1.0.0)

Endpoint

Heartbeat

POST
https://api.gemini.com
/v1/heartbeat

This will prevent a session from timing out and canceling orders if the require heartbeat flag has been set. Note that this is only required if no other private API requests have been made. The arrival of any message resets the heartbeat timer.

Heartbeat › Headers

  • X-GEMINI-APIKEYstring · required

    Your API key

  • X-GEMINI-SIGNATUREstring · required

    HEX-encoded HMAC-SHA384 of payload signed with API secret

  • X-GEMINI-PAYLOADstring · required

    Base64-encoded JSON payload

  • Content-Typestring
    Default: text/plain
  • Content-Lengthstring
    Default: 0
  • Cache-Controlstring
    Default: no-cache

Heartbeat › Request Body

  • requeststring

    The literal string /v1/heartbeat

  • nonce

    The nonce, as described in Private API Invocation

Heartbeat › Responses

The heartbeat was received successfully

  • resultstring

    ok

    Example: ok
Fund ManagementClearing