Generated by API Evangelist
Written by API Evangelist tooling for S&P Global's API. It is a proposal applied on top of the contract, not a document S&P Global publishes.
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for LLM-ready Estimates API
version: 1.0.0
extends: openapi/sp-global-estimates-api-openapi.yml
actions:
- target: $.info
update:
x-apievangelist-phrasing:
method: generated
generated: '2026-10-01'
generator: build-phrasing.py
label: Generated by API Evangelist
operations: 3
- target: $.paths['/api/v1/estimates/'].post
update:
x-apievangelist-phrasing:
intent: Get consensus estimates or company guidance
effect: read
questions:
- What do analysts expect a company to earn next year?
- Can I pull management guidance instead of analyst consensus estimates?
- How many future quarters of consensus estimates can I request at once?
instructions:
- text: Get consensus estimates for company {company_id}.
slots:
company_id: requestBody.company_id
- text: Get {estimate_type} estimates for company {company_id} for the next {num_periods_forward} periods.
slots:
estimate_type: requestBody.estimate_type
company_id: requestBody.company_id
num_periods_forward: requestBody.num_periods_forward
- text: Pull {period_type} estimates for company {company_id} from fiscal {fiscal_start_year} to {fiscal_end_year}.
slots:
period_type: requestBody.period_type
company_id: requestBody.company_id
fiscal_start_year: requestBody.fiscal_start_year
fiscal_end_year: requestBody.fiscal_end_year
method: generated
generated: '2026-10-01'
- target: $.paths['/api/v1/estimates/analyst_recommendations/{company_id}'].get
update:
x-apievangelist-phrasing:
intent: Get analyst buy/hold/sell recommendations
effect: read
questions:
- How many analysts rate this stock a buy versus a sell?
- What is the aggregate analyst consensus score for a company?
instructions:
- text: Get analyst recommendations for company {company_id}.
slots:
company_id: path.company_id
- text: Show the buy, hold and sell rating counts for company {company_id}.
slots:
company_id: path.company_id
method: generated
generated: '2026-10-01'
- target: $.paths['/api/v1/estimates/consensus_target_price/{company_id}'].get
update:
x-apievangelist-phrasing:
intent: Get the consensus analyst price target
effect: read
questions:
- What is the analysts' consensus target price for this company?
- Where do analysts think the share price is headed?
instructions:
- text: Get the consensus target price for company {company_id}.
slots:
company_id: path.company_id
- text: Show analyst price target estimates for company {company_id}.
slots:
company_id: path.company_id
method: generated
generated: '2026-10-01'
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.