technical_analysis / wire operation
Describe one technical indicator
totalfinance.technical_analysis.describe
Return the full card for a single indicator (alias-aware): category, input kind, parameters, defaults, which parameters are required, its warmup (leading bars before the first real value), and its cross-library aliases. The token-lean way to learn one indicator without listing all ~335. Discover names with `totalfinance.technical_analysis.list`; compute with `totalfinance.technical_analysis.calculate`.
| Pack / profiles | technical_analysis / default, full |
|---|---|
| Default discovery | Included |
| Required capabilities | None |
| Effects / authorization | none / none |
| Cost / cancellation | small / Do not assume inline interruption |
| Handle-eligible inputs | None |
| Idempotency | not-applicable |
Input schema
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Indicator name or a TA-Lib/pandas/TradingView alias (e.g. \"rsi\", \"RSI\", \"STOCH\")"
}
},
"additionalProperties": false,
"required": [
"name"
]
}Output schema
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Canonical indicator name"
},
"category": {
"type": "string"
},
"inputs": {
"type": "string",
"enum": [
"series",
"bars",
"pair"
]
},
"parameters": {
"type": "array",
"items": {
"type": "string"
}
},
"defaults": {
"type": "object",
"description": "Default per optional parameter ('(derived)' when computed from another parameter)"
},
"required": {
"type": "array",
"items": {
"type": "string"
}
},
"warmup": {
"type": [
"integer",
"null"
],
"description": "Leading bars before the first real value (null = warmup exceeds the probe window)"
},
"conventions": {
"type": "object",
"description": "The choices this indicator made that its parameters do not reveal — smoothing method, what a flat/degenerate window resolves to, how the first value is seeded. Present only where such a choice exists, and the field to read when this indicator disagrees with another library (e.g. RSI on a flat series: TotalFinance 100, TA-Lib 0, pandas-ta NaN)."
},
"aliases": {
"type": "object",
"description": "Cross-library names (TA-Lib / pandas-ta / TradingView), when known"
}
},
"required": [
"name",
"category",
"inputs",
"parameters",
"defaults",
"required",
"warmup"
]
}