`short_volume_history`

Pack: finra · Endpoint: https://gateway.pipeworx.io/finra/mcp

FINRA Reg SHO daily short-sale volume time series for one symbol. Returns up to 30 days of records ending at end_date (default: most recent published file).

Parameters

Name	Type	Required	Description
`symbol`	string	yes	Ticker (case-insensitive)
`days`	number	no	1–30 (default 10)
`end_date`	string	no	YYYY-MM-DD or YYYYMMDD; defaults to most recent published file

Example call

Arguments

{
  "symbol": "GME",
  "days": 10
}

curl

curl -X POST https://gateway.pipeworx.io/finra/mcp \
  -H 'Content-Type: application/json' \
  -d '{"jsonrpc":"2.0","id":1,"method":"tools/call","params":{"name":"short_volume_history","arguments":{"symbol":"GME","days":10}}}'

TypeScript (@pipeworx/sdk)

import { Pipeworx } from '@pipeworx/sdk';
const pipeworx = new Pipeworx();

const result = await pipeworx.call('short_volume_history', {
  "symbol": "GME",
  "days": 10
});

More examples

{
  "symbol": "NVDA",
  "days": 30,
  "end_date": "2024-01-15"
}

Response shape

Always returns: symbol, end_date, days_returned, days_requested, series

Field	Type	Description
`symbol`	string	Ticker symbol
`end_date`	string	End date in YYYY-MM-DD format
`days_returned`	number	Number of records returned
`days_requested`	number	Number of days requested
`series`	array	Time series of daily short volume records

Full JSON Schema

{
  "type": "object",
  "properties": {
    "symbol": {
      "type": "string",
      "description": "Ticker symbol"
    },
    "end_date": {
      "type": "string",
      "description": "End date in YYYY-MM-DD format"
    },
    "days_returned": {
      "type": "number",
      "description": "Number of records returned"
    },
    "days_requested": {
      "type": "number",
      "description": "Number of days requested"
    },
    "series": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "symbol": {
            "type": "string",
            "description": "Ticker symbol"
          },
          "date": {
            "type": "string",
            "description": "Date in YYYY-MM-DD format"
          },
          "combined": {
            "type": "object",
            "properties": {
              "short_volume": {
                "type": "number",
                "description": "Total short volume across both TRFs"
              },
              "short_exempt_volume": {
                "type": "number",
                "description": "Total short exempt volume"
              },
              "total_volume": {
                "type": "number",
                "description": "Total volume across both TRFs"
              },
              "short_ratio": {
                "type": "number",
                "description": "Short volume / total volume ratio"
              }
            },
            "required": [
              "short_volume",
              "short_exempt_volume",
              "total_volume",
              "short_ratio"
            ]
          },
          "by_trf": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "trf_code": {
                  "type": "string",
                  "description": "TRF code (FNSQ or FNYX)"
                },
                "trf_label": {
                  "type": "string",
                  "description": "TRF label"
                },
                "short_volume": {
                  "type": "number",
                  "description": "Short volume for this TRF"
                },
                "short_exempt_volume": {
                  "type": "number",
                  "description": "Short exempt volume for this TRF"
                },
                "total_volume": {
                  "type": "number",
                  "description": "Total volume for this TRF"
                }
              },
              "required": [
                "trf_code",
                "trf_label",
                "short_volume",
                "short_exempt_volume",
                "total_volume"
              ]
            }
          }
        },
        "required": [
          "symbol",
          "date",
          "combined",
          "by_trf"
        ]
      },
      "description": "Time series of daily short volume records"
    }
  },
  "required": [
    "symbol",
    "end_date",
    "days_returned",
    "days_requested",
    "series"
  ]
}

Connect

Add this to your MCP client config, or use one-click install buttons:

{
  "mcpServers": {
    "finra": {
      "url": "https://gateway.pipeworx.io/finra/mcp"
    }
  }
}

See Getting Started for client-specific install steps.

short_volume_history