Skip to main content
GET
/
getEarningsMarket
Get Earnings Market
curl --request GET \
  --url https://us-central1-mentionmarket-dddf0.cloudfunctions.net/getEarningsMarket
{
  "fiscal_year": 123,
  "fiscal_quarter": 123,
  "report_date": "<string>",
  "speaker_type": "<string>",
  "company_ticker": "<string>",
  "paragraph": "<string>",
  "strike_word": "<string>",
  "error": "<string>"
}
This endpoint requires an API key. See Quickstart for details.

Query Parameters

apiKey
string
required
Your API key for authentication
market_ticker
string
required
Kalshi market ticker

Response

fiscal_year
number
Fiscal year of the earnings report
fiscal_quarter
number
Fiscal quarter of the earnings report
report_date
string
Date of the earnings report
speaker_type
string
Speaker type (either “Executive” or “Operator”)
company_ticker
string
Company ticker
paragraph
string
The paragraph content where the strike word was found
strike_word
string
The strike word associated with the market ticker
error
string
Optional error message explaining the result

Error Responses

404 - Market Ticker Not Found

If the market ticker doesn’t exist in the data and the event ticker also doesn’t exist:
{
  "error": "Invalid market ticker: {market_ticker}. Event ticker {event_ticker} not found in data."
}

404 - Strike Word Not Found

If the market ticker doesn’t exist in the data but the event ticker exists, and the market resolved to “yes”:
{
  "fiscal_year": 2024,
  "fiscal_quarter": 3,
  "report_date": "2024-10-17",
  "company_ticker": "AAL",
  "error": "Could not find strike word {strike_word} for market ticker {market_ticker} in transcript"
}

Notes

  1. Market ticker found in data: Returns the paragraph where the strike word was found along with transcript metadata.
  2. Market ticker not found, event ticker exists:
    • If market resolved to “yes”: Returns 404 error indicating the strike word couldn’t be found in the transcript.
    • If market resolved to “no”: Returns success with null paragraph, indicating the word wasn’t said (which is expected).
    • If market result is unknown: Returns event metadata with null paragraph.
  3. Market ticker not found, event ticker doesn’t exist: Returns 404 error indicating the market ticker is invalid.