Get Volume Metrics

REST APIs Prediction Markets PositionsGet Volume Metrics

Get Volume Metrics

POSThttps://api.gemini.com/v1/prediction-markets/metrics/volume

Returns per-contract share volume metrics for an event, including total taker volume across all participants (totalQty) and the authenticated user's taker (userAggressorQty) and maker (userRestingQty) volumes. All volumes are in shares (number of contracts traded), not dollar amounts. An optional time range can filter trades within a specific window.

POSTv1/prediction-markets/metrics/volume

curl --request POST \
  --url https://api.gemini.com/v1/prediction-markets/metrics/volume \
  --header 'Content-Type: application/json' \
  --header 'X-GEMINI-APIKEY: <string>' \
  --header 'X-GEMINI-PAYLOAD: <string>' \
  --header 'X-GEMINI-SIGNATURE: <string>' \
  --data '
{
  "eventTicker": "FED260318",
  "startTime": 1772412364000,
  "endTime": 1772671564000
}
'

Roles

The API key you use to access this endpoint must have the Trader role assigned. See Roles for more information.

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

Request Body

eventTickerstring·required

The event ticker symbolExample: FED260318

startTimeinteger (int64)

Start of time range filter (epoch milliseconds). If omitted, defaults to the earliest contract creation time.

endTimeinteger (int64)

End of time range filter (epoch milliseconds). If omitted, includes all trades up to now.

Responses

Successful response

eventTickerstring

The event tickerExample: FED260318

contractsarray

contracts[].symbolstring

Contract instrument symbolExample: GEMI-FED260318-CUT25

contracts[].totalQtystring

Total taker volume across all participants (in shares)Example: 94625

contracts[].userAggressorQtystring

The authenticated user's taker (aggressor) volume (in shares)Example: 1

contracts[].userRestingQtystring

The authenticated user's maker (resting) volume (in shares)Example: 0

PreviousGet Settled Positions NextEvents

Last modified on May 23, 2026

curl --request POST \ --url https://api.gemini.com/v1/prediction-markets/metrics/volume \ --header 'Content-Type: application/json' \ --header 'X-GEMINI-APIKEY: <string>' \ --header 'X-GEMINI-PAYLOAD: <string>' \ --header 'X-GEMINI-SIGNATURE: <string>' \ --data ' { "eventTicker": "FED260318", "startTime": 1772412364000, "endTime": 1772671564000 } '