How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Factset Surprise API

The Surprise Events reflecting the company's reported financials against the broker's estimates.

Factset Surprise API is one of 460 APIs that Factset publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 1 JSON Schema definition.

Tagged areas include Surprise. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, code examples, a changelog, and 1 JSON Schema.

This API exposes 2 operations across 1 path, and defines 12 schemas. It is described by OpenAPI 3.0.3, at version 1.0.0.

Requests are made against 2 base URLs: https://api.factset.com, https://api-sandbox.factset.com.

2 operations 1 paths 12 schemas 1 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0.0
Base URL
https://api.factset.com
Authentication
HTTP Basic
Resource Areas
1

Authentication & Security 1

Factset Surprise API declares 1 security scheme for authenticating requests. It accepts HTTP basic authentication (basicAuth). By default, every request must be authenticated.

Paths & Operations 2

Across 1 path, the API surfaces 2 operations — 1 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Surprise 2

The Surprise Events reflecting the company's reported financials against the broker's estimates.

GET
/factset-estimates/v2/surprise
Factset Surprise Estimates for Rolling Fiscal Periods
getSurprise 8 params → 200400401403415500
POST
/factset-estimates/v2/surprise
Factset Surprise Estimates for Rolling Fiscal Periods
getSurpriseForList body → 200400401403415500

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are surprise (18 properties), surpriseRequest (8 properties), errorResponse (5 properties), surpriseResponse (1 property). Each schema is shown below with its type and property counts.

surpriseRequest
object
Request object for requesting surprise estimates.
8 properties 2 required
surprise
object
18 properties
ids
array
The requested list of security identifiers. Accepted ID types include Market Tickers, SEDOL, ISINs, CUSIPs, or FactSet Permanent Ids. Make Note - id limit of 3…
endDate
string
The end date requested for a given date range in YYYY-MM-DD format. If left blank, the API will default to previous close. Future dates (T+1) are not accepted…
metrics
array
Requested metrics. Use the metrics endpoint for a list of estimate items. Note, the number of metrics you are allowed to supply is limited to 1 for now. For mo…
errorResponse
object
5 properties
statistic
string
Statistic for consensus calculation.
currency
string
Currency code for adjusting the data. Use input as 'ESTIMATE' for values in Estimate currency. For a list of currency ISO codes, visit [Online Assistant Page 1…
startDate
string
The start date requested for a given date range in YYYY-MM-DD format. If left blank, the API will default to previous close. Future dates (T+1) are not accepte…
surpriseResponse
object
1 property
frequency
string
Controls the display frequency of the data returned. D = Daily W = Weekly, based on the last day of the week of the start date. AM = Monthly, based on the star…
periodicitySurprise
string
The periodicity for the estimates, reflecting Annual, Semi-Annual and Quarterly Estimates.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

factset-surprise-api-openapi.yml Raw ↑

Other APIs Factset publishes across the network.

FactSet Recommendation List API for Digital Portals
FactSet Bonds API for Digital Portals
FactSet Virtual Portfolio API for Digital Portals
FactSet Stocks API for Digital Portals
FactSet Securitized Derivatives API for Digital Portals
FactSet Watchlist API for Digital Portals
FactSet Funds API for Digital Portals
FactSet Data Monitor API
FactSet Mergers and Acquisitions API
FactSet News API
News API for Digital Portals
FactSet Real-Time Options API
Where this information came from

This is an independent, third-party profile of Factset Surprise API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.