short_volume_daily
Pack: finra · Endpoint: https://gateway.pipeworx.io/finra/mcp
FINRA Reg SHO daily short-sale volume for one symbol, combined across the Nasdaq TRF (FNSQ) and NYSE TRF (FNYX). Returns short_volume, short_exempt_volume, total_volume, and short_ratio (short / total). Publishing lag is T+1; omit date to use the most recent published file.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
symbol | string | yes | Ticker (case-insensitive), e.g. “AAPL” |
date | string | no | YYYY-MM-DD or YYYYMMDD. Defaults to the most recent published trading day. |
Example call
Arguments
{
"symbol": "AAPL"
}
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_daily","arguments":{"symbol":"AAPL"}}}'
TypeScript (@pipeworx/sdk)
import { Pipeworx } from '@pipeworx/sdk';
const pipeworx = new Pipeworx();
const result = await pipeworx.call('short_volume_daily', {
"symbol": "AAPL"
});
More examples
{
"symbol": "TSLA",
"date": "2024-01-15"
}
Response shape
Full JSON Schema
{
"oneOf": [
{
"type": "object",
"properties": {
"found": {
"type": "boolean",
"enum": [
false
],
"description": "Symbol not found in file"
},
"symbol": {
"type": "string",
"description": "Requested ticker symbol"
},
"date": {
"type": "string",
"description": "Requested date in YYYY-MM-DD format"
},
"reason": {
"type": "string",
"enum": [
"symbol_not_in_file"
],
"description": "Reason symbol was not found"
},
"hint": {
"type": "string",
"description": "Guidance for the user"
}
},
"required": [
"found",
"symbol",
"date",
"reason",
"hint"
]
},
{
"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"
]
},
"description": "Breakdown by Trade Reporting Facility"
}
},
"required": [
"symbol",
"date",
"combined",
"by_trf"
]
}
]
}
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.