# List Stock Snapshots

Retrieves real-time market snapshot data for a security. Returns key market indicators such as latest price, price change, volume, turnover rate, etc. Supports querying various security types including US stocks, etc., with optional inclusion of pre-market, after-hours, and overnight trading data.

# OpenAPI definition

```json
{
  "info": {
    "title": "Webull Open API Reference",
    "description": "application.yml\\ncom\\ni18n\\nMETA-INF\\nstatic\\n\\r\\n",
    "contact": {
      "name": "",
      "url": "",
      "email": ""
    },
    "version": "2.0",
    "x-logo": {
      "url": "static/png/logo.png"
    }
  },
  "servers": [
    {
      "url": "https://hk-co-branding-openapi.uat.webullbroker.com"
    }
  ],
  "path": "/market-data/stocks/snapshots/list",
  "method": "post",
  "tags": [
    "Market Data"
  ],
  "description": "Retrieves real-time market snapshot data for a security. Returns key market indicators such as latest price, price change, volume, turnover rate, etc. Supports querying various security types including US stocks, etc., with optional inclusion of pre-market, after-hours, and overnight trading data.",
  "operationId": "snapshotUsingGET",
  "parameters": [
    {
      "name": "access_token",
      "in": "header",
      "description": "User's authenticated token.",
      "required": true,
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "reqid",
      "in": "header",
      "description": "The unique ID for this request. Suggest using UUID.",
      "schema": {
        "type": "string"
      },
      "example": "2e46d5a4-bef9-4507-8cda-98f85d2f770c"
    }
  ],
  "requestBody": {
    "content": {
      "application/json": {
        "schema": {
          "required": [
            "category_symbols"
          ],
          "type": "object",
          "properties": {
            "category_symbols": {
              "type": "array",
              "description": "List of security symbols by category; maximum 100 symbols per query.",
              "items": {
                "required": [
                  "category",
                  "symbols"
                ],
                "type": "object",
                "properties": {
                  "category": {
                    "type": "string",
                    "description": "Security type. Category values are as shown in the enum.",
                    "example": "US_STOCK",
                    "enum": [
                      "US_STOCK"
                    ]
                  },
                  "symbols": {
                    "type": "array",
                    "description": "List of security symbols, supports JSON array format.",
                    "example": [
                      "AAPL",
                      "GOOG"
                    ],
                    "items": {
                      "type": "string",
                      "description": "List of security symbols, supports JSON array format.",
                      "example": "[\"AAPL\",\"GOOG\"]"
                    }
                  }
                },
                "description": "List of security symbols by security type",
                "title": "MultiCategory"
              }
            },
            "extend_hour_required": {
              "type": "string",
              "description": "Whether to include extend hour trading data.",
              "example": "false",
              "default": "false"
            },
            "overnight_required": {
              "type": "string",
              "description": "Whether to include overnight trading data.",
              "example": "false",
              "default": "false"
            }
          },
          "title": "SnapshotQuery"
        }
      }
    },
    "required": true
  },
  "responses": {
    "200": {
      "description": "OK",
      "content": {
        "application/json": {
          "schema": {
            "required": [
              "symbol"
            ],
            "type": "object",
            "properties": {
              "symbol": {
                "type": "string",
                "description": "Security symbol",
                "example": "AAPL"
              },
              "pre_close": {
                "type": "string",
                "description": "Previous close price",
                "example": "101"
              },
              "change_ratio": {
                "type": "string",
                "description": "Price change ratio relative to previous close. Expressed as a decimal (e.g., 0.0111 = 1.11%)",
                "example": "0.05"
              },
              "last_trade_time": {
                "type": "integer",
                "description": "Last trade time",
                "format": "int64",
                "example": 1640688000000
              },
              "price": {
                "type": "string",
                "description": "Current price",
                "example": "100"
              },
              "open": {
                "type": "string",
                "description": "Open price, for US stocks it's intraday open price, excluding pre/post market data. No return value if no trading occurred on the day",
                "example": "100"
              },
              "high": {
                "type": "string",
                "description": "Today's high price, for US stocks it's intraday high, excluding pre/post market data. No return value if no trading occurred on the day",
                "example": "105"
              },
              "low": {
                "type": "string",
                "description": "Today's low price, for US stocks it's intraday low, excluding pre/post market data. No return value if no trading occurred on the day",
                "example": "99"
              },
              "volume": {
                "type": "string",
                "description": "Volume. No return value if no trading occurred on the day",
                "example": "1000"
              },
              "change": {
                "type": "string",
                "description": "Change amount. No return value if no trading occurred on the day",
                "example": "1.0"
              },
              "close": {
                "type": "string",
                "description": "Intraday close price",
                "example": "101"
              },
              "ask": {
                "type": "string",
                "description": "Ask Price",
                "example": "13.99"
              },
              "ask_size": {
                "type": "string",
                "description": "Ask Size (Quantity)",
                "example": "50"
              },
              "bid": {
                "type": "string",
                "description": "Bid Price",
                "example": "13.91"
              },
              "bid_size": {
                "type": "string",
                "description": "Bid Size (Quantity)",
                "example": "100"
              },
              "extend_hour_last_price": {
                "type": "string",
                "description": "Pre/post market latest price",
                "example": "100.5"
              },
              "extend_hour_change": {
                "type": "string",
                "description": "Pre/post market change amount",
                "example": "0.5"
              },
              "extend_hour_change_ratio": {
                "type": "string",
                "description": "Pre/post market change ratio",
                "example": "0.005"
              },
              "extend_hour_volume": {
                "type": "string",
                "description": "Pre/post market volume",
                "example": "200"
              },
              "extend_hour_last_trade_time": {
                "type": "integer",
                "description": "Current pre/post market trade time",
                "format": "int64",
                "example": 1640688000000
              },
              "extend_hour_high": {
                "type": "string",
                "description": "Pre/post market high price",
                "example": "188.1"
              },
              "extend_hour_low": {
                "type": "string",
                "description": "Pre/post market low price",
                "example": "180.1"
              },
              "ovn_price": {
                "type": "string",
                "description": "Overnight price",
                "example": "100.25"
              },
              "ovn_high": {
                "type": "string",
                "description": "Overnight high price",
                "example": "101.0"
              },
              "ovn_low": {
                "type": "string",
                "description": "Overnight low price",
                "example": "99.5"
              },
              "ovn_volume": {
                "type": "string",
                "description": "Overnight volume",
                "example": "500"
              },
              "ovn_change": {
                "type": "string",
                "description": "Overnight change amount",
                "example": "0.25"
              },
              "ovn_change_ratio": {
                "type": "string",
                "description": "Overnight change ratio",
                "example": "0.0025"
              },
              "ovn_last_trade_time": {
                "type": "integer",
                "description": "Overnight trade time",
                "format": "int64",
                "example": 1640688000000
              },
              "ovn_ask": {
                "type": "string",
                "description": "Overnight Ask Price",
                "example": "13.91"
              },
              "ovn_ask_size": {
                "type": "string",
                "description": "Overnight Ask Size (Quantity)",
                "example": "50"
              },
              "ovn_bid": {
                "type": "string",
                "description": "Overnight Bid Price",
                "example": "13.9"
              },
              "ovn_bid_size": {
                "type": "string",
                "description": "Overnight Bid Size (Quantity)",
                "example": "100"
              },
              "pb_ratio": {
                "type": "string",
                "description": "Price to Book Ratio",
                "example": "54.47"
              },
              "ps_ratio": {
                "type": "string",
                "description": "Price to Sales Ratio",
                "example": "9.65"
              },
              "pe_ratio": {
                "type": "string",
                "description": "Price to Earnings Ratio",
                "example": "36.42"
              },
              "market_value": {
                "type": "string",
                "description": "Total market value",
                "example": "40200000000000"
              },
              "neg_market_value": {
                "type": "string",
                "description": "Free-Float market value",
                "example": "39500000000000"
              },
              "yield": {
                "type": "string",
                "description": "Dividend yield",
                "example": "1.04"
              },
              "total_shares": {
                "type": "string",
                "description": "Total shares outstanding",
                "example": "147760000000"
              },
              "out_standing_shares": {
                "type": "string",
                "description": "Free-Float shares outstanding,",
                "example": "145260000000"
              },
              "fifty_two_wk_high": {
                "type": "string",
                "description": "52 weeks high",
                "example": "288.62"
              },
              "fifty_two_wk_low": {
                "type": "string",
                "description": "52 weeks low",
                "example": "168.63"
              }
            },
            "description": "Market snapshot data response object",
            "title": "SnapshotVo"
          }
        }
      }
    }
  },
  "jsonRequestBodyExample": {
    "category_symbols": [
      {
        "category": "US_STOCK",
        "symbols": [
          "AAPL",
          "GOOG"
        ]
      }
    ],
    "extend_hour_required": "false",
    "overnight_required": "false"
  },
  "postman": {
    "name": "List Stock Snapshots",
    "description": {
      "content": "Retrieves real-time market snapshot data for a security. Returns key market indicators such as latest price, price change, volume, turnover rate, etc. Supports querying various security types including US stocks, etc., with optional inclusion of pre-market, after-hours, and overnight trading data.",
      "type": "text/plain"
    },
    "url": {
      "path": [
        "market-data",
        "stocks",
        "snapshots",
        "list"
      ],
      "host": [
        "{{baseUrl}}"
      ],
      "query": [],
      "variable": []
    },
    "header": [
      {
        "disabled": false,
        "description": {
          "content": "(Required) User's authenticated token.",
          "type": "text/plain"
        },
        "key": "access_token",
        "value": ""
      },
      {
        "disabled": false,
        "description": {
          "content": "The unique ID for this request. Suggest using UUID.",
          "type": "text/plain"
        },
        "key": "reqid",
        "value": ""
      },
      {
        "key": "Content-Type",
        "value": "application/json"
      },
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "method": "POST",
    "body": {
      "mode": "raw",
      "raw": "",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    }
  }
}
```