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-APIKEY

string · required

Your API key

X-GEMINI-SIGNATURE

string · required

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

X-GEMINI-PAYLOAD

string · required

Base64-encoded JSON payload

Content-Type

string

Default: text/plain

Content-Length

string

Default: 0

Cache-Control

string

Default: no-cache

Heartbeat › Request Body

request

string

The literal string /v1/heartbeat

The nonce, as described in Private API Invocation

Heartbeat › Responses

The heartbeat was received successfully

result

string

Example: ok

POST/v1/heartbeat

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>"
}
'

shell

Example Request Body

{
  "request": "/v1/heartbeat",
  "nonce": "<nonce>"
}

json

application/json

Example Responses

{
  "result": "ok"
}

json

application/json

Margin Trading Clearing

REST API

Session (1.0.0)

Endpoint

Heartbeat

POST

https://api.gemini.com

/v1/heartbeat

Heartbeat › Headers

X-GEMINI-APIKEY

string · required

Your API key

X-GEMINI-SIGNATURE

string · required

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

X-GEMINI-PAYLOAD

string · required

Base64-encoded JSON payload

Content-Type

string

Default: text/plain

Content-Length

string

Default: 0

Cache-Control

string

Default: no-cache

Heartbeat › Request Body

request

string

The literal string /v1/heartbeat

The nonce, as described in Private API Invocation

Heartbeat › Responses

The heartbeat was received successfully

result

string

Example: ok

POST/v1/heartbeat

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>"
}
'

shell

Example Request Body

{
  "request": "/v1/heartbeat",
  "nonce": "<nonce>"
}

json

application/json

Example Responses

{
  "result": "ok"
}

json

application/json

Margin Trading Clearing