Signals

Signals

Get the latest signal and sentiment for a ticker.

get/signals/{ticker}

Request

  • Base URL: https://api.falpha.ai
  • URL: https://api.falpha.ai/signals/{ticker}
  • Auth: one of:
    • API key in query parameter api_key
    • API key in header X-API-Key

Path parameters

tickerstring required

Query parameters

periodstring

Signal horizon: 5d, 15d, or 2m

regimestring

Market regime: neutral, bear, or bull

include_sentimentboolean

Include sentiment enrichment from daily sentiment data. Defaults to false; set to true to include sentiment lookups.

include_qualityboolean

Include signal quality metrics (Sharpe/Sortino/IIS). Defaults to false; when true the quality field is populated (individual metrics may still be null).

include_driversboolean

Include the model's top attribution drivers (which named factors moved the signal, as % of total attribution). Defaults to false.

Response

Successful Response

tickerstring required

Stock ticker symbol

periodstring required

Signal horizon: 5d, 15d, or 2m

regimestring required

Market regime: neutral, bear, or bull

signalstring required

Signal: buy or sell

confidencenumber required

Confidence level

sentimentnumber nullable

Average daily sentiment score (null when unavailable)

Example response

{
  "ticker": "AAPL",
  "period": "15d",
  "regime": "neutral",
  "signal": "buy",
  "confidence": 0.73,
  "sentiment": 0.42,
  "quality": {
    "iis_score": 0.18,
    "normalized_iis": 0.55,
    "percent_positive_pnl": 0.57,
    "sharpe_ratio": 0.42,
    "sortino_ratio": 0.61
  },
  "drivers": [
    {
      "name": "Sentiment",
      "weight_pct": 23.4,
      "direction": "buy"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.