`short_volume_top`

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

Ranks symbols on a given trading day by short_ratio (short_volume / total_volume), aggregated across both TRFs. Useful for spotting heavily-shorted names; combine with a min_volume filter to exclude thinly-traded micros.

Parameters

Name	Type	Required	Description
`date`	string	no	YYYY-MM-DD or YYYYMMDD; defaults to most recent published file
`limit`	number	no	1–100 (default 25)
`min_total_volume`	number	no	Skip symbols below this combined-TRF total volume (default 100000)

Example call

Arguments

{
  "limit": 25,
  "min_total_volume": 500000
}

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_top","arguments":{"limit":25,"min_total_volume":500000}}}'

TypeScript (@pipeworx/sdk)

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

const result = await pipeworx.call('short_volume_top', {
  "limit": 25,
  "min_total_volume": 500000
});

More examples

{
  "date": "2024-01-15",
  "limit": 50
}

Response shape

Full JSON Schema

{
  "oneOf": [
    {
      "type": "object",
      "properties": {
        "found": {
          "type": "boolean",
          "enum": [
            false
          ],
          "description": "No data available"
        },
        "reason": {
          "type": "string",
          "enum": [
            "invalid_date",
            "no_recent_data"
          ],
          "description": "Reason for failure"
        },
        "hint": {
          "type": "string",
          "description": "Guidance for the user"
        }
      },
      "required": [
        "found",
        "reason",
        "hint"
      ]
    },
    {
      "type": "object",
      "properties": {
        "date": {
          "type": "string",
          "description": "Date in YYYY-MM-DD format"
        },
        "min_total_volume": {
          "type": "number",
          "description": "Minimum total volume filter applied"
        },
        "symbols_considered": {
          "type": "number",
          "description": "Total symbols in the file"
        },
        "symbols_returned": {
          "type": "number",
          "description": "Number of symbols returned"
        },
        "top": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "symbol": {
                "type": "string",
                "description": "Ticker symbol"
              },
              "short_volume": {
                "type": "number",
                "description": "Combined short volume"
              },
              "short_exempt_volume": {
                "type": "number",
                "description": "Combined short exempt volume"
              },
              "total_volume": {
                "type": "number",
                "description": "Combined total volume"
              },
              "short_ratio": {
                "type": "number",
                "description": "Short volume / total volume ratio"
              }
            },
            "required": [
              "symbol",
              "short_volume",
              "short_exempt_volume",
              "total_volume",
              "short_ratio"
            ]
          },
          "description": "Ranked symbols by short_ratio, descending"
        }
      },
      "required": [
        "date",
        "min_total_volume",
        "symbols_considered",
        "symbols_returned",
        "top"
      ]
    }
  ]
}

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_top