list_short_interest
Retrieve short interest data for stocks by specifying ticker, settlement date, and other parameters to analyze market trends and positions.
Instructions
Retrieve short interest data for stocks.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | ||
| order | No | ||
| params | No | ||
| settlement_date | No | ||
| settlement_date_gt | No | ||
| settlement_date_gte | No | ||
| settlement_date_lt | No | ||
| settlement_date_lte | No | ||
| sort | No | ||
| ticker | No |
Input Schema (JSON Schema)
{
"properties": {
"limit": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Limit"
},
"order": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Order"
},
"params": {
"anyOf": [
{
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Params"
},
"settlement_date": {
"anyOf": [
{
"type": "string"
},
{
"format": "date-time",
"type": "string"
},
{
"format": "date",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Settlement Date"
},
"settlement_date_gt": {
"anyOf": [
{
"type": "string"
},
{
"format": "date-time",
"type": "string"
},
{
"format": "date",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Settlement Date Gt"
},
"settlement_date_gte": {
"anyOf": [
{
"type": "string"
},
{
"format": "date-time",
"type": "string"
},
{
"format": "date",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Settlement Date Gte"
},
"settlement_date_lt": {
"anyOf": [
{
"type": "string"
},
{
"format": "date-time",
"type": "string"
},
{
"format": "date",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Settlement Date Lt"
},
"settlement_date_lte": {
"anyOf": [
{
"type": "string"
},
{
"format": "date-time",
"type": "string"
},
{
"format": "date",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Settlement Date Lte"
},
"sort": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Sort"
},
"ticker": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Ticker"
}
},
"title": "list_short_interestArguments",
"type": "object"
}