Get Volume Metrics POST https://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.
POST v1/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-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 Request Body eventTicker string · required
The event ticker symbol Example: FED260318 startTime integer (int64)
Start of time range filter (epoch milliseconds). If omitted, defaults to the earliest contract creation time. endTime integer (int64)
End of time range filter (epoch milliseconds). If omitted, includes all trades up to now. {
"eventTicker": "FED260318"
}Responses Properties Example
Successful response
eventTicker string
The event ticker Example: FED260318 contracts[].symbol string
Contract instrument symbol Example: GEMI-FED260318-CUT25 contracts[].totalQty string
Total taker volume across all participants (in shares) Example: 94625 contracts[].userAggressorQty string
The authenticated user's taker (aggressor) volume (in shares) Example: 1 contracts[].userRestingQty string
The authenticated user's maker (resting) volume (in shares) Example: 0 {
"eventTicker": "FED260318",
"contracts": [
{
"symbol": "GEMI-FED260318-CUT25",
"totalQty": "94625",
"userAggressorQty": "1",
"userRestingQty": "0"
},
{
"symbol": "GEMI-FED260318-CUTGT25",
"totalQty": "68666",
"userAggressorQty": "0",
"userRestingQty": "0"
},
{
"symbol": "GEMI-FED260318-HIKE",
"totalQty": "15397",
"userAggressorQty": "0",
"userRestingQty": "0"
},
{
"symbol": "GEMI-FED260318-MAINTAIN",
"totalQty": "20400",
"userAggressorQty": "5",
"userRestingQty": "0"
}
]
}