Docs / Rule language
Rule language
Earnings, dividends and splits facts
Planned: named facts about corporate events that rules can compare, alongside prices and indicators.
Not live yet
These facts are being built and are not available today. This page will list each one, with its unit and a real example, once it can be called. Until then a fact name is read as an unknown state field. A real call on AAPL with days_to_earnings <= 5 returned:
{
"detail": [
{
"loc": [
"body",
"questions",
"e",
"ask"
],
"type": "rule_error",
"msg": "No field \"days_to_earnings\" — this request has no named state, only price bars (O, H, L, C, V and the functions)."
}
]
}In the meantime, the forecast model already reads earnings timing for a symbol, so a forecast question can ask about an earnings window in English.
Create an account Open the Playground
Everything here also lives in the console, next to your keys and usage.