Gemini

https://docs.gemini.com/
Admin
Gemini is a regulated cryptocurrency exchange that provides developers with secure APIs for trading,...
Tokens:201,925
Snippets:1,051
Trust Score:9.9
Update:6 months ago
Show doc for...
Tokens:
Raw
### Node.js WebSocket-First Trading Example

Source: https://docs.gemini.com/changelog/revision-history

Example demonstrating WebSocket-first trading in Node.js for prediction markets. Requires initial setup for WebSocket connections.

```javascript
const gemini = require('gemini-node');

const client = gemini.ws({
  key: process.env.GEMINI_API_KEY,
  secret: process.env.GEMINI_API_SECRET,
  sandbox: true
});

client.on('open', () => {
  console.log('WebSocket connection opened');
  client.subscribe('orders');
});

client.on('order_update', (order) => {
  console.log('Order update:', order);
});

client.on('error', (error) => {
  console.error('WebSocket error:', error);
});

// Example: Place an order
client.newOrder({
  client_order_id: 'my_order_id_123',
  symbol: 'sym',
  amount: '10.00',
  price: '100.00',
  side: 'buy',
  type: 'exchange limit',
  options: {
    'maker-or-cancel': true
  }
}).then((order) => {
  console.log('New order placed:', order);
}).catch((error) => {
  console.error('Error placing order:', error);
});
```

--------------------------------

### Python WebSocket-First Trading Example

Source: https://docs.gemini.com/changelog/revision-history

Example demonstrating WebSocket-first trading in Python for prediction markets. Requires initial setup for WebSocket connections.

```python
import asyncio
import os

from gemini_python import GeminiWebSocketClient

async def main():
    client = GeminiWebSocketClient(
        api_key=os.environ.get('GEMINI_API_KEY'),
        api_secret=os.environ.get('GEMINI_API_SECRET'),
        sandbox=True
    )

    await client.connect()
    await client.subscribe('orders')

    while True:
        message = await client.get_message()
        print(f'Received message: {message}')

        if message['event'] == 'update' and message['type'] == 'order':
            print(f'Order update: {message}')

        # Example: Place an order
        if 'order_id' not in message:
            await client.new_order(
                client_order_id='my_order_id_123',
                symbol='sym',
                amount='10.00',
                price='100.00',
                side='buy',
                type='exchange limit',
                options={'maker-or-cancel': True}
            )

asyncio.run(main())

```

--------------------------------

### Get Open Positions Response Example

Source: https://docs.gemini.com/rest/derivatives

This is an example of a successful response (200 OK) from the /v1/positions endpoint, detailing open positions with their symbols, types, quantities, and PnL.

```json
[
  {
    "symbol": "btcgusdperp",
    "instrument_type": "perp",
    "quantity": "0.2",
    "notional_value": "4000.036",
    "realised_pnl": "1234.5678",
    "unrealised_pnl": "999.946",
    "average_cost": "15000.45",
    "mark_price": "20000.18"
  }
]
```

--------------------------------

### REST API - Get Notional Trading Volume Example

Source: https://docs.gemini.com/changelog/revision-history

Example of retrieving notional trading volume for a given time range.

```javascript
const volume = await client.getNotionalTradingVolume("2019-01-01", "2019-01-31");
```

--------------------------------

### Get Funding Amount Response Example

Source: https://docs.gemini.com/rest/market-data

Example response for the funding amount endpoint. It provides details on current and estimated funding amounts, along with relevant timestamps.

```json
{
  "symbol": "BTCGUSDPERP",
  "fundingDateTime": "2025-04-22T18:00:00.000Z",
  "fundingTimestampMilliSecs": 1745344800000,
  "nextFundingTimestamp": 1745348400000,
  "fundingAmount": -1.50991,
  "estimatedFundingAmount": -2.10595
}
```

--------------------------------

### Network Assets Response Example

Source: https://docs.gemini.com/rest/market-data

Example JSON response showing supported assets for the Ethereum network.

```json
{
  "network": "ethereum",
  "assets": [
    "AAVE",
    "BAT",
    "DAI",
    "ETH",
    "LINK",
    "MATIC",
    "UNI",
    "USDC",
    "USDT",
    "WBTC"
  ]
}
```

--------------------------------

### Example Fee Promos Response

Source: https://docs.gemini.com/rest/market-data

An example JSON response showing symbols with active fee promotions.

```json
{
  "symbols": [
    "PNUTGUSDPERP",
    "WIFGUSDPERP",
    "PYTHGUSDPERP",
    "MEWGUSDPERP",
    "BONKGUSDPERP",
    "BCHGUSDPERP",
    "BTCGUSDPERP",
    "BUSDUSD",
    "POLGUSDPERP",
    "FRAXUSD",
    "OPGUSDPERP",
    "DOTGUSDPERP",
    "TRUMPGUSDPERP",
    "GUSDGBP",
    "USDTUSD",
    "POPCATGUSDPERP",
    "FLOKIGUSDPERP",
    "MOODENGGUSDPERP",
    "LINKGUSDPERP",
    "ETHGUSDPERP",
    "UNIGUSDPERP",
    "MATICGUSDPERP",
    "USDTGUSD",
    "BNBGUSDPERP",
    "MIMUSD",
    "KSL2GUSDPERP",
    "LUSDUSD",
    "SHIBGUSDPERP",
    "AVAXGUSDPERP",
    "BOMEGUSDPERP",
    "USDCUSD",
    "HYPEGUSDPERP",
    "MOGGUSDPERP",
    "KT5GUSDPERP",
    "SOLGUSDPERP",
    "PEPEGUSDPERP",
    "DOGEGUSDPERP",
    "GUSDSGD",
    "INJGUSDPERP",
    "LTCGUSDPERP",
    "XRPGUSDPERP",
    "USTUSD",
    "GOATGUSDPERP",
    "DAIUSD"
  ]
}
```

--------------------------------

### Example Network Response (Multi)

Source: https://docs.gemini.com/rest/market-data

Example of a successful response for a token available on multiple networks.

```json
{
  "token": "USDC",
  "network": [
    "optimism",
    "solana",
    "base",
    "arbitrum",
    "monad",
    "avalanche",
    "ethereum"
  ]
}
```

--------------------------------

### Account Balances Response Example

Source: https://docs.gemini.com/rest/fund-management

Example JSON response containing a list of currency balances.

```json
[
  {
    "type": "exchange",
    "currency": "BTC",
    "amount": "5.0",
    "available": "4.5",
    "availableForWithdrawal": "4.5",
    "_timestamp": 1710547200000000000
  },
  {
    "type": "exchange",
    "currency": "USD",
    "amount": "15000.00",
    "available": "5000.00",
    "availableForWithdrawal": "5000.00",
    "_timestamp": 1710547200000000000
  },
  {
    "type": "exchange",
    "currency": "ETH",
    "amount": "10.0",
    "available": "10.0",
    "availableForWithdrawal": "10.0",
    "_timestamp": 1710547200000000000
  }
]
```

--------------------------------

### Example Network Response (Single)

Source: https://docs.gemini.com/rest/market-data

Example of a successful response for a token available on a single network.

```json
{
  "token": "BTC",
  "network": [
    "bitcoin"
  ]
}
```

--------------------------------

### Get Notional Trading Volume Response

Source: https://docs.gemini.com/rest/orders

Example response containing fee tiers and volume metrics.

```json
{
  "web_maker_fee_bps": 25,
  "web_taker_fee_bps": 35,
  "web_auction_fee_bps": 25,
  "api_maker_fee_bps": 10,
  "api_taker_fee_bps": 35,
  "api_auction_fee_bps": 20,
  "fix_maker_fee_bps": 10,
  "fix_taker_fee_bps": 35,
  "fix_auction_fee_bps": 20,
  "notional_30d_volume": 150,
  "last_updated_ms": 1551371446000,
  "date": "2019-02-28",
  "notional_1d_volume": [
    {
      "date": "2019-02-22",
      "notional_volume": 75
    },
    {
      "date": "2019-02-14",
      "notional_volume": 75
    }
  ]
}
```

--------------------------------

### Notional Balances Response Example

Source: https://docs.gemini.com/rest/fund-management

An example of the JSON array returned when successfully querying notional balances.

```json
[
  {
    "currency": "BTC",
    "amount": "1154.62034001",
    "amountNotional": "10386000.59",
    "available": "1129.10517279",
    "availableNotional": "10161000.71",
    "availableForWithdrawal": "1129.10517279",
    "availableForWithdrawalNotional": "10161000.71"
  },
  {
    "currency": "USD",
    "amount": "18722.79",
    "amountNotional": "18722.79",
    "available": "14481.62",
    "availableNotional": "14481.62",
    "availableForWithdrawal": "14481.62",
    "availableForWithdrawalNotional": "14481.62"
  },
  {
    "currency": "ETH",
    "amount": "20124.50369697",
    "amountNotional": "100621.31",
    "available": "20124.50369697",
    "availableNotional": "100621.31",
    "availableForWithdrawal": "20124.50369697",
    "availableForWithdrawalNotional": "100621.31"
  }
]
```

--------------------------------

### Symbol Details Response Example

Source: https://docs.gemini.com/rest/market-data

Example JSON response for a spot instrument symbol.

```json
{
  "symbol": "BTCUSD",
  "base_currency": "BTC",
  "quote_currency": "USD",
  "tick_size": 1e-8,
  "quote_increment": 0.01,
  "min_order_size": "0.00001",
  "status": "open",
  "wrap_enabled": false,
  "product_type": "spot",
  "contract_type": "vanilla",
  "contract_price_currency": "USD"
}
```

--------------------------------

### Get My Trades with Access Token

Source: https://docs.gemini.com/authentication/oauth

This example demonstrates how to retrieve a user's trade history using an access token.

```APIDOC
## POST /v1/mytrades

### Description
Retrieves the authenticated user's trade history for a specified symbol.

### Method
POST

### Endpoint
https://api.gemini.com/v1/mytrades

### Parameters
#### Request Body
- **request** (string) - Required - The API endpoint path, e.g., "/v1/mytrades".
- **symbol** (string) - Required - The trading symbol (e.g., "btcusd").

### Request Example
```json
{
  "request": "/v1/mytrades",
  "symbol": "btcusd"
}
```

### Headers
- **Authorization** (string) - Required - The literal string "Bearer " concatenated to your temporary `access_token`.
- **X-GEMINI-PAYLOAD** (string) - Required - The base64-encoded JSON payload.

### Response
#### Success Response (200)
- **(object)** - Contains a list of trades.

#### Response Example
```json
{
  "symbol": "btcusd",
  "trades": [
    {
      "price": "10000.00",
      "amount": "0.1",
      "timestamp": 1577836800,
      "exchange": "gemini",
      "type": "buy",
      "aggressor": true
    }
  ]
}
```
```

--------------------------------

### GET /v1/balances

Source: https://docs.gemini.com/changelog/revision-history

Retrieves account balances. Examples now default to `showPendingBalances: false`. Setting `showPendingBalances` to `true` may increase response times. Includes a `_timestamp` field for detecting stale responses.

```APIDOC
## GET /v1/balances

### Description
Retrieves the user's account balances. Includes options to show pending balances and a timestamp for response validation.

### Method
GET

### Endpoint
/v1/balances

### Parameters
#### Query Parameters
- **showPendingBalances** (boolean) - Optional - Defaults to `false`. If `true`, pending balances are included, which may slow down response times.

### Request Body
(Not applicable for GET requests)

### Response
#### Success Response (200)
- **_timestamp** (integer) - A monotonically increasing server-side clock in nanoseconds, used to detect stale responses.
- **balances** (array) - Array of balance objects. (Schema for balance objects not provided in source text)
```

--------------------------------

### Get Order History with Access Token

Source: https://docs.gemini.com/authentication/oauth

This example shows how to fetch the order history for a user using an access token.

```APIDOC
## POST /v1/orders/history

### Description
Retrieves the authenticated user's order history for a specified symbol.

### Method
POST

### Endpoint
https://api.gemini.com/v1/orders/history

### Parameters
#### Request Body
- **request** (string) - Required - The API endpoint path, e.g., "/v1/orders/history".
- **symbol** (string) - Required - The trading symbol (e.g., "btcusd").

### Request Example
```json
{
  "request": "/v1/orders/history",
  "symbol": "btcusd"
}
```

### Headers
- **Authorization** (string) - Required - The literal string "Bearer " concatenated to your temporary `access_token`.
- **X-GEMINI-PAYLOAD** (string) - Required - The base64-encoded JSON payload.

### Response
#### Success Response (200)
- **(object)** - Contains a list of orders.

#### Response Example
```json
{
  "symbol": "btcusd",
  "orders": [
    {
      "order_id": "12345",
      "symbol": "btcusd",
      "side": "buy",
      "type": "limit",
      "price": "10000.00",
      "amount": "0.1",
      "timestamp": 1577836800,
      "is_live": false,
      "is_cancelled": false,
      "was_forced": false
    }
  ]
}
```
```

--------------------------------

### Get Margin Interest Rates Response

Source: https://docs.gemini.com/rest/margin-trading

Example response containing an array of interest rates for borrowable currencies.

```json
{
  "rates": [
    {
      "currency": "BTC",
      "borrowRate": "0.00001141552511",
      "borrowRateDaily": "0.00027397260264",
      "borrowRateAnnual": "0.1",
      "lastUpdated": 1700000000000
    },
    {
      "currency": "ETH",
      "borrowRate": "0.00001141552511",
      "borrowRateDaily": "0.00027397260264",
      "borrowRateAnnual": "0.1",
      "lastUpdated": 1700000000000
    },
    {
      "currency": "USD",
      "borrowRate": "0.00000913242009",
      "borrowRateDaily": "0.00021917808216",
      "borrowRateAnnual": "0.08",
      "lastUpdated": 1700000000000
    }
  ]
}
```

--------------------------------

### Example Order Book Response

Source: https://docs.gemini.com/rest/market-data

An example JSON response for the order book, showing bids and asks grouped by price.

```json
{
  "bids": [
    {
      "price": "3607.85",
      "amount": "6.643373",
      "timestamp": "1547147541"
    }
  ],
  "asks": [
    {
      "price": "3607.86",
      "amount": "14.68205084",
      "timestamp": "1547147541"
    }
  ]
}
```

--------------------------------

### Get Margin Account Summary Request

Source: https://docs.gemini.com/rest/margin-trading

Example request for retrieving margin account details using cURL.

```shell
curl --request POST \
  --url https://api.gemini.com/v1/margin/account \
  --header 'Content-Type: application/json' \
  --header 'X-GEMINI-APIKEY: <string>' \
  --header 'X-GEMINI-PAYLOAD: <string>' \
  --header 'X-GEMINI-SIGNATURE: <string>' \
  --data '
{
  "request": "/v1/margin/account",
  "nonce": "<nonce>"
}
'
```

--------------------------------

### REST API - Create New Deposit Address Example

Source: https://docs.gemini.com/changelog/revision-history

Example for creating a new deposit address, including the legacy parameter for LTC.

```javascript
const address = await client.createDepositAddress("LTC", { legacy: true });
```

--------------------------------

### Websocket API - Market Data Example

Source: https://docs.gemini.com/changelog/revision-history

Example of subscribing to market data using the WebSocket API, including market depth and entry filtering.

```javascript
const socket = new WebSocket("wss://api.gemini.com/v1/marketdata/BTCUSD");
socket.onmessage = (event) => {
  console.log(event.data);
};
```

--------------------------------

### Websocket API - Order Events Example

Source: https://docs.gemini.com/changelog/revision-history

Example of subscribing to order events using the WebSocket API, including support for block trades.

```javascript
const socket = new WebSocket("wss://api.gemini.com/v1/order/events");
socket.onmessage = (event) => {
  console.log(event.data);
};
```

--------------------------------

### Example Request Body for Volume Metrics

Source: https://docs.gemini.com/prediction-markets/positions

This is an example of the JSON request body required to fetch volume metrics for a specific event ticker.

```json
{
  "eventTicker": "FED260318"
}
```

--------------------------------

### REST API - Get Ticker V2 Example

Source: https://docs.gemini.com/changelog/revision-history

Example of fetching ticker data for a specific symbol using the Get Ticker V2 endpoint.

```javascript
const ticker = await client.getTicker("BTC-USD");
```

--------------------------------

### Get Instant Quote Request

Source: https://docs.gemini.com/rest/instant

Example of a cURL request to the /v1/instant/quote endpoint.

```shell
curl --request POST \
  --url https://api.gemini.com/v1/instant/quote \
  --header 'Content-Type: application/json' \
  --header 'X-GEMINI-APIKEY: <string>' \
  --header 'X-GEMINI-PAYLOAD: <string>' \
  --header 'X-GEMINI-SIGNATURE: <string>' \
  --data '
{
  "request": "/v1/instant/quote",
  "nonce": "<nonce>",
  "symbol": "btcusd",
  "side": "buy",
  "totalSpend": "100"
}
'

```

--------------------------------

### Get Account Margin Response

Source: https://docs.gemini.com/rest/derivatives

Example JSON response for a successful account margin request.

```json
{
  "margin_assets_value": "9800",
  "initial_margin": "6000",
  "available_margin": "3800",
  "margin_maintenance_limit": "5800",
  "leverage": "12.34567",
  "notional_value": "1300",
  "estimated_liquidation_price": "1300",
  "initial_margin_positions": "3500",
  "reserved_margin": "2500",
  "reserved_margin_buys": "1800",
  "reserved_margin_sells": "700",
  "buying_power": "0.19",
  "selling_power": "0.19"
}
```

--------------------------------

### Order Event - New Example

Source: https://docs.gemini.com/websocket/streams

This is an example of a 'NEW' order event, indicating a newly placed order. This stream requires an authenticated session and provides real-time order activity.

```json
# Order Event - New
{
  "E":1759291847686856569,
  "s":"BTCUSD",
  "i":73797746498585286,
  "c":"my-order-1759291847503",
  "S":"BUY",
  "o":"LIMIT",
  "X":"NEW",
  "p":"1.00000",
  "q":"0.0000100000",
  "z":"0.0000100000",
  "T":1759291847686856569
}
```

--------------------------------

### List Prices Response Example

Source: https://docs.gemini.com/rest/market-data

Example response for the price feed endpoint. It includes the trading pair, current price, and the percentage change over the last 24 hours.

```json
[
  {
    "pair": "BTCUSD",
    "price": "9500.00",
    "percentChange24h": "5.23"
  },
  {
    "pair": "ETHUSD",
    "price": "257.54",
    "percentChange24h": "4.85"
  },
  {
    "pair": "BCHUSD",
    "price": "450.10",
    "percentChange24h": "-2.91"
  },
  {
    "pair": "LTCUSD",
    "price": "79.50",
    "percentChange24h": "7.63"
  }
]
```

--------------------------------

### List Event Categories (Swift)

Source: https://docs.gemini.com/prediction-markets/markets

Swift example for making a GET request to list event categories.

```swift
import Foundation

let url = URL(string: "https://api.gemini.com/v1/prediction-markets/categories")!
var request = URLRequest(url: url)
request.httpMethod = "GET"

let task = URLSession.shared.dataTask(with: request) { data, response, error in
    guard let data = data, error == nil else {
        print(error?.localizedDescription ?? "No data")
        return
    }
    let responseJSON = try? JSONSerialization.jsonObject(with: data, options: [])
    if let json = responseJSON {
        print(json)
    }
}

task.resume()
```

--------------------------------

### FX Rate Response Example

Source: https://docs.gemini.com/rest/market-data

A successful response returns the currency pair, exchange rate, timestamp, provider, and benchmark market.

```json
{
  "fxPair": "AUDUSD",
  "rate": "0.69",
  "asOf": 1594651859000,
  "provider": "bcb",
  "benchmark": "Spot"
}
```

--------------------------------

### Get Account Margin Request

Source: https://docs.gemini.com/rest/derivatives

Example request for retrieving account margin details using cURL.

```shell
curl --request POST \
  --url https://api.gemini.com/v1/margin \
  --header 'Content-Type: application/json' \
  --header 'X-GEMINI-APIKEY: <string>' \
  --header 'X-GEMINI-PAYLOAD: <string>' \
  --header 'X-GEMINI-SIGNATURE: <string>' \
  --data '
{
  "request": "/v1/margin",
  "nonce": "<nonce>",
  "symbol": "BTC-GUSD-PERP"
}
'
```

--------------------------------

### FIX Order Entry - New Order Single Example with IOI

Source: https://docs.gemini.com/changelog/revision-history

Demonstrates placing a New Order Single (MsgType <35> = D) with options for placing an IOI (Indication of Interest) and responding to an IOI.

```fix
8=FIX.4.2|9=123|35=D|11=O-12345|55=BTC/USD|54=1|38=100|40=2|44=10000|59=0|60=20180406-12:00:00.000|9002=1|9003=Y|10=12345678|
```

--------------------------------

### GET /v1/prediction-markets/events/upcoming

Source: https://docs.gemini.com/prediction-markets/markets

Retrieves a list of approved prediction market events that are not yet active, sorted by start time.

```APIDOC
## GET /v1/prediction-markets/events/upcoming

### Description
Returns a list of approved prediction market events that are not yet active (pre-launch), sorted by start time (soonest first).

### Method
GET

### Endpoint
https://api.gemini.com/v1/prediction-markets/events/upcoming

### Parameters
#### Query Parameters
- **category** (string[]) - Optional - Filter by category (can specify multiple).
- **limit** (integer) - Optional - Maximum number of results to return (max 500). Default: 50.
- **offset** (integer) - Optional - Number of results to skip for pagination. Default: 0.

### Response
#### Success Response (200)
- **data** (object[]) - List of upcoming events
- **pagination** (object) - Pagination metadata
```

--------------------------------

### FIX Market Data - Snapshot / Full Refresh Example

Source: https://docs.gemini.com/changelog/revision-history

Provides an example of a Market Data - Snapshot / Full Refresh message (MsgType <35> = W) for FIX Market Data.

```fix
8=FIX.4.2|9=123|35=W|48=GEMINI|107=GEMINI|262=1|268=2|269=0|270=BTC/USD|17=MSGID1|271=100|272=10000|269=1|270=ETH/USD|17=MSGID2|271=50|272=500|126=20180122-12:00:00.000|10=12345678|
```

--------------------------------

### Get Risk Stats Response Example

Source: https://docs.gemini.com/rest/derivatives

This JSON object shows an example of a successful response (200 OK) from the /v1/riskstats/{symbol} endpoint, providing contract type, mark price, index price, and open interest details.

```json
{
  "product_type": "PerpetualSwapContract",
  "mark_price": "30080.00",
  "index_price": "30079.046",
  "open_interest": "14.439",
  "open_interest_notional": "434325.12"
}
```

--------------------------------

### Example Request Body for Margin Order Preview

Source: https://docs.gemini.com/rest/margin-trading

This is an example JSON request body for previewing a margin order. It includes essential parameters such as symbol, side, type, amount, and price.

```json
{
  "request": "/v1/margin/order/preview",
  "nonce": "<nonce>",
  "symbol": "btcusd",
  "side": "buy",
  "type": "limit",
  "amount": "0.5",
  "price": "50000.00"
}
```

--------------------------------

### Empty Method Placeholder

Source: https://docs.gemini.com/websocket/playground

Placeholder for undefined methods.

```JSON
{ "id": "1", "method": "", "params": {} }
```

```JSON
{ "id": "1", "method": "", "params": {} }
```

--------------------------------

### Get Open Positions Request Body Example

Source: https://docs.gemini.com/rest/derivatives

This JSON object represents the request body for the /v1/positions endpoint. It includes the request path, a nonce, and optionally an account identifier.

```json
{
  "request": "/v1/positions",
  "nonce": "<nonce>",
  "account": "primary"
}
```

--------------------------------

### Get Positions - Example Response

Source: https://docs.gemini.com/prediction-markets/positions

This JSON object represents a successful response when fetching prediction market positions. It includes details about each position and the total number of positions available.

```json
{
  "positions": [
    {
      "symbol": "GEMI-FEDJAN26-DN25",
      "instrumentId": 1001,
      "totalQuantity": "125",
      "quantityOnHold": "10",
      "avgPrice": "0.63",
      "outcome": "yes",
      "contractMetadata": {
        "contractId": "contract_123",
        "contractName": "FEDJAN26-DN25",
        "contractTicker": "FEDJAN26-DN25",
        "eventTicker": "FEDJAN26",
        "eventName": "Will Fed Funds Rate drop at least 0.25% at January 2026 meeting?",
        "category": "economics",
        "contractStatus": "active",
        "imageUrl": "https://example.com/fed.png",
        "eventImageUrl": "https://example.com/fed-event.png",
        "eventType": "binary",
        "expiryDate": "2026-01-31T23:59:59.000Z",
        "resolvedAt": null,
        "resolutionSide": null,
        "description": "Resolves YES if Federal Reserve lowers the target rate by 0.25% or more at the January 2026 FOMC meeting",
        "sortOrder": null,
        "parentEventTicker": null,
        "template": "binary",
        "color": null,
        "startTime": null
      },
      "prices": {
        "buy": {
          "yes": "0.63",
          "no": "0.37"
        },
        "sell": {
          "yes": "0.61",
          "no": "0.35"
        },
        "bestBid": "0.61",
        "bestAsk": "0.63",
        "lastTradePrice": "0.62"
      },
      "resolutionSide": null,
      "isAboveAutoStartThreshold": false,
      "isLive": true,
      "realizedPl": "0"
    },
    {
      "symbol": "GEMI-FEDJAN26-DN25",
      "instrumentId": 1001,
      "totalQuantity": "200",
      "quantityOnHold": "0",
      "avgPrice": "0.36",
      "outcome": "no",
      "contractMetadata": {
        "contractId": "contract_123",
        "contractName": "FEDJAN26-DN25",
        "contractTicker": "FEDJAN26-DN25",
        "eventTicker": "FEDJAN26",
        "eventName": "Will Fed Funds Rate drop at least 0.25% at January 2026 meeting?",
        "category": "economics",
        "contractStatus": "active",
        "imageUrl": "https://example.com/fed.png",
        "eventImageUrl": "https://example.com/fed-event.png",
        "eventType": "binary",
        "expiryDate": "2026-01-31T23:59:59.000Z",
        "resolvedAt": null,
        "resolutionSide": null,
        "description": "Resolves YES if Federal Reserve lowers the target rate by 0.25% or more at the January 2026 FOMC meeting",
        "sortOrder": null,
        "parentEventTicker": null,
        "template": "binary",
        "color": null,
        "startTime": null
      },
      "prices": {
        "buy": {
          "yes": "0.37",
          "no": "0.63"
        },
        "sell": {
          "yes": "0.35",
          "no": "0.61"
        },
        "bestBid": "0.35",
        "bestAsk": "0.37",
        "lastTradePrice": "0.36"
      },
      "resolutionSide": null,
      "isAboveAutoStartThreshold": false,
      "isLive": true,
      "realizedPl": "0"
    }
  ],
  "total": 2
}
```

--------------------------------

### Get Order Status 200 OK Response Example

Source: https://docs.gemini.com/rest/orders

A successful response (200 OK) from the /v1/order/status endpoint, detailing the order's status, execution price, amounts, and other relevant information.

```json
{
  "order_id": "123456789012345",
  "id": "123456789012345",
  "symbol": "btcusd",
  "exchange": "gemini",
  "avg_execution_price": "400.00",
  "side": "buy",
  "type": "exchange limit",
  "timestamp": "1494870642",
  "timestampms": 1494870642156,
  "is_live": false,
  "is_cancelled": false,
  "is_hidden": false,
  "was_forced": false,
  "executed_amount": "3",
  "remaining_amount": "0",
  "options": [],
  "price": "400.00",
  "original_amount": "3"
}
```

--------------------------------

### List Trades Response Example

Source: https://docs.gemini.com/rest/market-data

Example of a successful response when listing trades. Each object contains trade details like timestamp, price, amount, and exchange.

```json
{
  "timestamp": 1547146811,
  "timestampms": 1547146811357,
  "tid": 5335307668,
  "price": "3610.85",
  "amount": "0.27413495",
  "exchange": "gemini",
  "type": "buy",
  "broken": true
}
```

--------------------------------

### Get Order Status Request Body Example

Source: https://docs.gemini.com/rest/orders

This JSON object represents the payload for the /v1/order/status request. It includes the request path, a nonce, the order ID, and an option to include trade details.

```json
{
  "request": "/v1/order/status",
  "nonce": "<nonce>",
  "order_id": 123456789012345,
  "include_trades": true
}
```

--------------------------------

### Connect to Gemini WebSocket API with Multiple Parameters

Source: https://docs.gemini.com/websocket/introduction

This example illustrates how to combine multiple connection parameters in the WebSocket URL for the Gemini API. It shows how to use both 'snapshot' for orderbook initialization and 'cancelOnDisconnect' for managing open orders upon disconnection, separated by an ampersand '&'.

```url
wss://ws.gemini.com?snapshot=-1&cancelOnDisconnect=true
```

--------------------------------

### Futures Examples

Source: https://docs.gemini.com/prediction-markets/tickers-sports

Examples of futures tickers for various leagues and types.

```text
GEMI-NBAF-2526CHAMP-LAL
```

```text
GEMI-NFLF-2526DIV-AFCW-KC
```

```text
GEMI-NCAAMF-2526CHAMP-DUKE
```

--------------------------------

### Full Ticker Example - Moneyline

Source: https://docs.gemini.com/prediction-markets/tickers-sports

Example of a complete moneyline contract ticker.

```text
GEMI-NBA-2602121800-HOU-DAL-M-DAL
```

--------------------------------

### POST /v1/instant/execute

Source: https://docs.gemini.com/authentication/oauth

Executes an instant order at the current market price.

```APIDOC
## POST /v1/instant/execute

### Description
Performs an immediate execution of an order.

### Method
POST

### Endpoint
/v1/instant/execute

### Parameters
- **Scope** (string) - Required - orders:create

### Request Body
- **symbol** (string) - Required - The trading pair symbol.
- **amount** (decimal) - Required - The quantity to trade.

### Response
#### Success Response (200)
- **order_id** (string) - The ID of the executed order.
```

--------------------------------

### Example Ticker Response

Source: https://docs.gemini.com/rest/market-data

Example of a successful response containing ticker information for a symbol.

```json
{
  "bid": "977.59",
  "ask": "977.35",
  "last": "977.65",
  "volume": {
    "BTC": "2210.505328803",
    "USD": "2135477.463379586263",
    "timestamp": 1483018200000
  }
}
```

--------------------------------

### Example Response for Limit Buy Order Preview

Source: https://docs.gemini.com/rest/margin-trading

This JSON response shows the pre-order and post-order margin risk statistics for a limit buy order. It details margin asset value, available collateral, notional value, borrowed amounts, and leverage.

```json
{
  "preorder": {
    "marginAssetValue": {
      "currency": "USD",
      "value": "10000.00"
    },
    "availableCollateral": {
      "currency": "USD",
      "value": "8500.00"
    },
    "notionalValue": {
      "currency": "USD",
      "value": "15000.00"
    },
    "totalBorrowed": {
      "currency": "USD",
      "value": "5000.00"
    },
    "leverage": "1.5",
    "reservedBuyOrders": {
      "currency": "USD",
      "value": "0.00"
    },
    "reservedSellOrders": {
      "currency": "USD",
      "value": "0.00"
    },
    "buyingPower": {
      "currency": "USD",
      "value": "8500.00"
    },
    "sellingPower": {
      "currency": "USD",
      "value": "8500.00"
    }
  },
  "postorder": {
    "marginAssetValue": {
      "currency": "USD",
      "value": "10000.00"
    },
    "availableCollateral": {
      "currency": "USD",
      "value": "6000.00"
    },
    "notionalValue": {
      "currency": "USD",
      "value": "40000.00"
    },
    "totalBorrowed": {
      "currency": "USD",
      "value": "30000.00"
    },
    "leverage": "4.0",
    "reservedBuyOrders": {
      "currency": "USD",
      "value": "0.00"
    },
    "reservedSellOrders": {
      "currency": "USD",
      "value": "0.00"
    },
    "buyingPower": {
      "currency": "USD",
      "value": "6000.00"
    },
    "sellingPower": {
      "currency": "USD",
      "value": "6000.00"
    },
    "liquidationRisk": {
      "lossPercentage": "0.6000",
      "liquidationPrice": {
        "currency": "USD",
        "value": "30000.00"
      }
    }
  }
}
```

--------------------------------

### Example response for event details

Source: https://docs.gemini.com/prediction-markets/markets

A sample JSON response structure for a successful prediction market event query.

```json
{
  "id": "id",
  "title": "Will Bitcoin reach $100k by end of 2025?",
  "slug": "bitcoin-100k-2025",
  "description": {},
  "imageUrl": {},
  "type": "binary",
  "category": "crypto",
  "series": {},
  "ticker": "BTC100K2025",
  "status": "approved",
  "resolvedAt": "2024-08-25T15:00:00Z",
  "createdAt": "2024-08-25T15:00:00Z",
  "contracts": [
    {
      "id": "id",
      "label": "label",
      "abbreviatedName": {},
      "description": {},
      "prices": {},
      "totalShares": {},
      "color": {},
      "status": "approved",
      "imageUrl": {},
      "priceHistory": {},
      "createdAt": "2024-08-25T15:00:00Z",
      "expiryDate": "2024-08-25T15:00:00Z",
      "resolutionSide": "yes",
      "resolvedAt": "2024-08-25T15:00:00Z",
      "termsAndConditionsUrl": "termsAndConditionsUrl",
      "ticker": "ticker",
      "instrumentSymbol": "instrumentSymbol",
      "effectiveDate": "2024-08-25T15:00:00Z",
      "marketState": "open",
      "sortOrder": {},
      "strike": {
        "value": "87500.00",
        "type": "reference",
        "availableAt": "2024-08-25T15:00:00Z"
      },
      "source": "GRR-KAIKO_BTCUSD_60S",
      "settlementValue": "87654.32"
    }
  ],
  "contractOrderbooks": {},
  "volume": "125000.00",
  "liquidity": "50000.00",
  "tags": {},
  "effectiveDate": "2024-08-25T15:00:00Z",
  "expiryDate": "2024-08-25T15:00:00Z",
  "subcategory": {},
  "source": "GRR-KAIKO_BTCUSD_60S",
  "settlement": {
    "value": "87654.32"
  }
}
```

--------------------------------

### POST /v1/instant/execute

Source: https://docs.gemini.com/rest/instant

Executes an instant order for a given symbol, side, quantity, and quote details. Requires authentication headers.

```APIDOC
## POST /v1/instant/execute

### Description
Executes an instant order for a given symbol, side, quantity, and quote details. Requires authentication headers.

### Method
POST

### Endpoint
/v1/instant/execute

### 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) - Optional - Default: text/plain
- **Content-Length** (string) - Optional - Default: 0
- **Cache-Control** (string) - Optional - Default: no-cache

### Request Body
- **request** (string) - Required - The literal string "/v1/instant/execute"
- **nonce** (string) - Required - The nonce, as described in Private API Invocation
- **symbol** (string) - Required - The symbol for the order.
- **side** (string) - Required - Enum: "buy" or "sell"
- **quantity** (string) - Required - The quantity of the asset bought or sold. Must match quantity returned in the quote.
- **fee** (string) - Required - The fee for the order. Must match fee returned in the quote.
- **quoteId** (integer) - Required - Unique ID for the quote. Must match quoteId returned in the quote.
- **account** (string) - Optional - Required for Master API keys. The name of the account within the subaccount group.

### Request Example
```json
{
  "request": "/v1/instant/execute",
  "nonce": "<nonce>",
  "symbol": "BTCUSD",
  "side": "buy",
  "quantity": "0.01505181",
  "price": "6445.07",
  "fee": "2.9900309233",
  "quoteId": 1328
}
```

### Response
#### Success Response (200)
- **orderId** (integer) - The ID for the executed order
- **pair** (string) - The symbol for the order.
- **price** (string) - The price at which the order was executed
- **priceCurrency** (string) - The currency in which the order is priced.
- **side** (string) - Either "buy" or "sell"
- **quantity** (string) - The quantity of the asset bought or sold
- **quantityCurrency** (string) - The currency label for the `quantity` field.
- **totalSpend** (string) - Total quantity to spend for the order.
- **totalSpendCurrency** (string) - Currency of the `totalSpend`.
- **fee** (string) - The fee quantity charged for the order
- **feeCurrency** (string) - The currency label for the fee.
- **depositFee** (string) - The deposit fee quantity.
- **depositFeeCurrency** (string) - Currency in which `depositFee` is taken.

#### Response Example
```json
{
  "orderId": 375089415,
  "pair": "BTCUSD",
  "price": "6445.07",
  "priceCurrency": "USD",
  "side": "buy",
  "quantity": "0.01505181",
  "quantityCurrency": "BTC",
  "totalSpend": "100",
  "totalSpendCurrency": "USD",
  "fee": "2.9900309233",
  "feeCurrency": "USD",
  "depositFee": "0",
  "depositFeeCurrency": "USD"
}
```
```

--------------------------------

### List Staking Balances Request

Source: https://docs.gemini.com/rest/staking

Example request for retrieving staking balances using cURL.

```shell
curl --request POST \
  --url https://api.gemini.com/v1/balances/staking \
  --header 'Content-Type: application/json' \
  --header 'X-GEMINI-APIKEY: <string>' \
  --header 'X-GEMINI-PAYLOAD: <string>' \
  --header 'X-GEMINI-SIGNATURE: <string>' \
  --data '
{
  "request": "/v1/balances/staking",
  "nonce": "<nonce>",
  "account": "primary"
}
'

```

--------------------------------

### Order History Response Example

Source: https://docs.gemini.com/rest/orders

A sample JSON response showing details for a cancelled order.

```json
[
  {
    "order_id": "73751560172006688",
    "id": "73751560172006688",
    "symbol": "ethgusd",
    "exchange": "gemini",
    "avg_execution_price": "0.00",
    "side": "buy",
    "type": "exchange limit",
    "timestamp": "1695629298",
    "timestampms": 1695629298505,
    "is_live": false,
    "is_cancelled": true,
    "is_hidden": false,
    "was_forced": false,
    "executed_amount": "0",
    "client_order_id": "fb5321b0-2114-47fd-8cca-531a66d7feaf",
    "options": [],
    "price": "420.00",
    "original_amount": "0.69",
    "remaining_amount": "0.69",
    "trades": []
  }
]
```

--------------------------------

### List Payment Methods Success Response Example

Source: https://docs.gemini.com/rest/fund-management

A successful response for listing payment methods includes 'balances' and 'banks' arrays. The 'balances' array details fiat currency amounts, while the 'banks' array provides information on linked bank accounts.

```json
{
  "balances": [
    {
      "type": "exchange",
      "currency": "USD",
      "amount": "50893484.26",
      "available": "50889972.01",
      "availableForWithdrawal": "50889972.01"
    }
  ],
  "banks": [
    {
      "bank": "Jpmorgan Chase Bank Checking  - 1111",
      "bankId": "97631a24-ca40-4277-b3d5-38c37673d029"
    }
  ]
}
```
Tokens:
Raw