finance

Analyst consensus for a company — EPS / revenue estimates per horizon and the buy / hold / sell split. Returns a normalized Estimates object.

Symbol forms as in finance.quote. yfinance fills both the recommendation counts and the per-horizon estimates; Finnhub (US fallback) fills only the recommendation counts, so periods is null there.

Fixed price: 0.1 credits per successful call, whichever provider serves it.

post/v2/ops/finance.estimates

Request

  • Base URL
    https://api.agentkey.app
  • URL
    https://api.agentkey.app/v2/ops/finance.estimates
  • Auth
    HTTP bearer

Request body

fieldsstring[]

Projection: keep only these dotted paths of data, e.g. ["items.id", "items.text"].

include_rawboolean

Attach the raw upstream payload as raw (not a stable contract; truncated above 256 KB).

providerstring

Shorthand for routing.only = [provider].

symbolstring required

Ticker: AAPL, 0700.HK.

Response

Success envelope

credits_chargednumber required

Credits charged for this call (the method's fixed price).

opstring required

Method name.

op_versioninteger required

Method version that served the call.

providerstring required

Provider that actually served the call.

rawunknown
raw_truncatedboolean
request_idstring required

Correlation id; quote it in support requests.

took_msinteger required
unsupported_fieldsstring[] required

Output paths this provider structurally does not supply; such fields are null for a different reason than 'missing on this record'.

Changes

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