Heartbeat
Heartbeat
POSThttps://api.gemini.com/v1/heartbeat
Prevents a session from timing out and canceling active orders when the require-heartbeat flag is set on the API key. Only required if no other private API requests have been made — the arrival of any message resets the heartbeat timer.
POST
curl --request POST \
--url https://api.gemini.com/v1/heartbeat \
--header 'Content-Type: application/json' \
--header 'X-GEMINI-APIKEY: <string>' \
--header 'X-GEMINI-PAYLOAD: <string>' \
--header 'X-GEMINI-SIGNATURE: <string>' \
--data '
{
"request": "/v1/heartbeat",
"nonce": "<nonce>"
}
'Roles
Any authenticated API key may call this endpoint. See Require Heartbeat for background on the heartbeat flag and session behavior.
Headers
Request Body
Responses
The heartbeat was received successfully
Last modified on