Session
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.
post/v1/heartbeat
Request
- Base URLhttps://api.gemini.com
- URLhttps://api.gemini.com/v1/heartbeat
- AuthAPI key in header X-GEMINI-APIKEY and API key in header X-GEMINI-SIGNATURE and API key in header X-GEMINI-PAYLOAD
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
Content-Lengthstring
Cache-Controlstring
Request body
Response
The heartbeat was received successfully
Example response
{
"result": "ok"
}Changes
No recorded changes to this operation across all 1 revision of this API.