openapi: 3.0.3
externalDocs:
description: API Documentation
url: https://developer.factset.com/api-catalog/overview-report-builder-api
info:
title: FactSet Overview Report Builder API
description: >-
Get relevant industry-specific data for high level analysis of public and
private companies
license:
name: Apache License, Version 2.0
url: https://www.apache.org/licenses/LICENSE-2.0
version: 1.2.0
contact:
name: FactSet Research Systems
url: https://developer.factset.com/contact
email: [email protected]
servers:
- url: https://api.factset.com/report/overview/v1
tags:
- name: Current Cap
- name: Financial Highlights
- name: Key Stats
- name: Peer List
- name: Profile
- name: Transactions
paths:
/profile:
get:
tags:
- Profile
operationId: getProfileProfile
summary: Factset Overview Profile
parameters:
- name: id
in: query
description: Company ticker
required: true
schema:
type: string
example: FDS
responses:
'200':
$ref: '#/components/responses/200OKProfile'
'400':
$ref: '#/components/responses/400BadRequest'
'401':
$ref: '#/components/responses/401Unauthorized'
'404':
$ref: '#/components/responses/404NotFound'
'429':
$ref: '#/components/responses/429TooManyRequests'
'500':
$ref: '#/components/responses/500InternalServerError'
'503':
$ref: '#/components/responses/503ServiceUnavailable'
/peer-list:
get:
tags:
- Peer List
summary: Factset Peer List
parameters:
- name: id
in: query
description: Company ticker
required: true
schema:
type: string
example: FDS
- name: topn
in: query
description: Limits the number of peers returned.
required: false
schema:
type: number
example: 5
responses:
'200':
$ref: '#/components/responses/200OKPeerList'
'400':
$ref: '#/components/responses/400BadRequest'
'401':
$ref: '#/components/responses/401Unauthorized'
'404':
$ref: '#/components/responses/404NotFound'
'429':
$ref: '#/components/responses/429TooManyRequests'
'500':
$ref: '#/components/responses/500InternalServerError'
'503':
$ref: '#/components/responses/503ServiceUnavailable'
/current-cap:
get:
tags:
- Current Cap
summary: Factset Current Capitalization
parameters:
- name: id
in: query
description: Company ticker
required: true
schema:
type: string
example: FDS
responses:
'200':
$ref: '#/components/responses/200OKCurrentCapitalization'
'400':
$ref: '#/components/responses/400BadRequest'
'401':
$ref: '#/components/responses/401Unauthorized'
'404':
$ref: '#/components/responses/404NotFound'
'429':
$ref: '#/components/responses/429TooManyRequests'
'500':
$ref: '#/components/responses/500InternalServerError'
'503':
$ref: '#/components/responses/503ServiceUnavailable'
/financial-highlights:
get:
tags:
- Financial Highlights
summary: Factset Financial / Estimate Highlights
parameters:
- name: id
in: query
description: Company ticker
required: true
schema:
type: string
example: FDS
- name: actual
in: query
description: >-
The number of actual data periods to be returned. Must be greater
than 0
required: false
schema:
type: integer
example: 4
default: 4
- name: estimate
in: query
description: >-
The number of estimate data periods to be returned. Must be greater
than 0
required: false
schema:
type: integer
example: 1
default: 1
responses:
'200':
$ref: '#/components/responses/200OKFinancialHighlights'
'400':
$ref: '#/components/responses/400BadRequest'
'401':
$ref: '#/components/responses/401Unauthorized'
'404':
$ref: '#/components/responses/404NotFound'
'429':
$ref: '#/components/responses/429TooManyRequests'
'500':
$ref: '#/components/responses/500InternalServerError'
'503':
$ref: '#/components/responses/503ServiceUnavailable'
/transactions:
get:
tags:
- Transactions
summary: Factset Transactions
parameters:
- name: id
in: query
description: Company ticker
required: true
schema:
type: string
example: FDS
- name: transactionType
in: query
description: >-
Filters response to return only this type of transaction. If not
specified, returns all transactions. Values are not case sensitive.
required: false
schema:
type: string
enum:
- ACQUISITION_MERGER
- MAJORITY_STAKE
- MINORITY_STAKE
- SPINOFF
- IPO
- FOLLOW_ON
- ST_DEBT
- NOTES_BONDS
- REVOLVING_CREDIT
- TERM_LOANS
- PEVC_INVESTMENTS
- FUNDING
example: ACQUISITION_MERGER
- name: financingType
in: query
description: >-
Filters response to return transactions of this financing type. If
not specified, returns all transactions. Values are not case
sensitive
required: false
schema:
type: string
enum:
- DEBT
- EQUITY
example: EQUITY
responses:
'200':
$ref: '#/components/responses/200OKTransactions'
'400':
$ref: '#/components/responses/400BadRequest'
'401':
$ref: '#/components/responses/401Unauthorized'
'404':
$ref: '#/components/responses/404NotFound'
'429':
$ref: '#/components/responses/429TooManyRequests'
'500':
$ref: '#/components/responses/500InternalServerError'
'503':
$ref: '#/components/responses/503ServiceUnavailable'
/key-stats:
description: >-
Returns key financial metrics for private and public companies, as well as
ETFs and mutual funds. This endpoint provides a quick and easy way to
obtain fundamental financial data. These key statistics can be used to
evaluate a company's financial health, compare it to other companies in
the same industry, and make informed investment decisions.
get:
tags:
- Key Stats
summary: Factset Key Stats
parameters:
- name: id
in: query
description: Company ticker
required: true
schema:
type: string
example: FDS
responses:
'200':
$ref: '#/components/responses/200OKKeyStats'
'400':
$ref: '#/components/responses/400BadRequest'
'401':
$ref: '#/components/responses/401Unauthorized'
'404':
$ref: '#/components/responses/404NotFound'
'429':
$ref: '#/components/responses/429TooManyRequests'
'500':
$ref: '#/components/responses/500InternalServerError'
'503':
$ref: '#/components/responses/503ServiceUnavailable'
security:
- FactSetApiKey: []
- FactSetOAuth2: []
components:
securitySchemes:
FactSetOAuth2:
type: oauth2
flows:
clientCredentials:
tokenUrl: https://auth.factset.com/as/token.oauth2
scopes: {}
FactSetApiKey:
type: http
scheme: basic
responses:
200OKProfile:
description: Expected response; returns the JSON in a simple key-value format
headers:
X-DataDirect-Request-Key:
$ref: '#/components/headers/xDataDirectRequestKey'
Api-Supported-Versions:
$ref: '#/components/headers/apiSupportedVersions'
Api-Version:
$ref: '#/components/headers/apiVersion'
content:
application/json:
schema:
$ref: '#/components/schemas/ProfileResponse'
examples:
default200ResponseExample:
$ref: '#/components/examples/default200ProfileResponse'
200OKPeerList:
description: Expected response; returns JSON data containing key-value format
headers:
X-DataDirect-Request-Key:
$ref: '#/components/headers/xDataDirectRequestKey'
Api-Supported-Versions:
$ref: '#/components/headers/apiSupportedVersions'
Api-Version:
$ref: '#/components/headers/apiVersion'
content:
application/json:
schema:
$ref: '#/components/schemas/PeerListResponse'
examples:
default200ResponseExample:
$ref: '#/components/examples/default200PeerListResponse'
200OKCurrentCapitalization:
description: >-
Expected response; returns JSON data containing STACH 2.0 row organized
package format
headers:
X-DataDirect-Request-Key:
$ref: '#/components/headers/xDataDirectRequestKey'
Api-Supported-Versions:
$ref: '#/components/headers/apiSupportedVersions'
Api-Version:
$ref: '#/components/headers/apiVersion'
content:
application/json:
schema:
$ref: '#/components/schemas/StachTableResponse'
examples:
default200ResponseExample:
$ref: '#/components/examples/default200CurrentCapitalizationResponse'
200OKFinancialHighlights:
description: >-
Expected response; Returns JSON data containing STACH 2.0 row organized
package format
headers:
X-DataDirect-Request-Key:
$ref: '#/components/headers/xDataDirectRequestKey'
Api-Supported-Versions:
$ref: '#/components/headers/apiSupportedVersions'
Api-Version:
$ref: '#/components/headers/apiVersion'
content:
application/json:
schema:
$ref: '#/components/schemas/StachTableResponse'
examples:
default200ResponseExample:
$ref: '#/components/examples/default200FinancialHighlightsResponse'
noDataresponse:
$ref: '#/components/examples/noData200FinancialHighlightsResponse'
200OKTransactions:
description: >-
Expected response; Returns JSON data containing STACH 2.0 row organized
package format
headers:
X-DataDirect-Request-Key:
$ref: '#/components/headers/xDataDirectRequestKey'
Api-Supported-Versions:
$ref: '#/components/headers/apiSupportedVersions'
Api-Version:
$ref: '#/components/headers/apiVersion'
content:
application/json:
schema:
$ref: '#/components/schemas/StachTableResponse'
examples:
default200ResponseExample:
$ref: '#/components/examples/default200TransactionsResponse'
transactionType200ResponseExample:
$ref: '#/components/examples/transactionType200Response'
financingType200ResponseExample:
$ref: '#/components/examples/financingType200Response'
noDataresponse:
$ref: '#/components/examples/noData200TransactionsResponse'
200OKKeyStats:
description: Expected response; returns the JSON in a simple key-value format
headers:
X-DataDirect-Request-Key:
$ref: '#/components/headers/xDataDirectRequestKey'
Api-Supported-Versions:
$ref: '#/components/headers/apiSupportedVersions'
Api-Version:
$ref: '#/components/headers/apiVersion'
content:
application/json:
schema:
$ref: '#/components/schemas/KeyStatsResponse'
examples:
default200ResponseExample:
$ref: '#/components/examples/default200KeyStatsResponse'
noDataResponse:
$ref: '#/components/examples/noData200KeyStatsResponse'
400BadRequest:
description: >-
Bad Request. For further assistance, file an issue under "Workflow &
Throttling - 400 or 429 Response" using `Report Issue` at the top of
this page, including the X-DataDirect-Request-Key from the header to
assist in troubleshooting.
headers:
X-DataDirect-Request-Key:
$ref: '#/components/headers/xDataDirectRequestKey'
Api-Supported-Versions:
$ref: '#/components/headers/apiSupportedVersions'
Api-Version:
$ref: '#/components/headers/apiVersion'
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
idRequiredParameterError:
$ref: '#/components/examples/idRequiredParameterError'
idInvalidParameterError:
$ref: '#/components/examples/idInvalidParameterError'
unsupportedEntityParameterError:
$ref: '#/components/examples/unsupportedEntityParameterError'
parameterErrorActual:
$ref: '#/components/examples/parameterErrorActual'
parameterErrorEstimate:
$ref: '#/components/examples/parameterErrorEstimate'
parameterErrorTopn:
$ref: '#/components/examples/parameterErrorTopn'
parameterErrorView:
$ref: '#/components/examples/parameterErrorView'
401Unauthorized:
description: >-
Missing or invalid authentication. Ensure you are logged in and have
successfully generated an API KEY for the IP range you are connecting
from. For further assistance, file an issue under "Connectivty - 401 or
403 Responses" using `Report Issue` at the top of this page, including
the X-DataDirect-Request-Key from the header to assist in
troubleshooting.
headers:
X-DataDirect-Request-Key:
schema:
type: string
description: FactSet request ID
404NotFound:
description: >-
Not found. For further assistance, file an issue under "Performance -
404 and 500 Responses" using `Report Issue` at the top of this page,
including the X-DataDirect-Request-Key from the header to assist in
troubleshooting.
headers:
X-DataDirect-Request-Key:
schema:
type: string
description: FactSet request ID
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
endpointNotFound:
$ref: '#/components/examples/endpointNotFound'
429TooManyRequests:
description: >-
Too many requests - this API is rate-limited to 20 requests per second.
For further assistance, file an issue under "Workflow & Throttling - 400
or 429 Response" using `Report Issue` at the top of this page, including
the X-DataDirect-Request-Key from the header to assist in
troubleshooting.
headers:
X-DataDirect-Request-Key:
schema:
type: string
description: FactSet request ID
500InternalServerError:
description: >-
Server error. For further assistance, file an issue under "Performance -
404 and 500 Responses" using `Report Issue` at the top of this page,
including the X-DataDirect-Request-Key from the header to assist in
troubleshooting.
headers:
X-DataDirect-Request-Key:
schema:
type: string
description: FactSet request ID
503ServiceUnavailable:
description: >-
Service unavailable. Typically a timeout, or result of a rejected
request to prevent service overload. For further assistance, file an
issue under "Performance - 404 and 500 Responses" using `Report Issue`
at the top of this page, including the X-DataDirect-Request-Key from the
header to assist in troubleshooting.
headers:
X-DataDirect-Request-Key:
schema:
type: string
description: FactSet request ID
headers:
xDataDirectRequestKey:
description: FactSet request ID
schema:
type: string
apiSupportedVersions:
description: Supported API versions (semantic versioning)
schema:
type: string
apiVersion:
description: API version (semantic versioning)
schema:
type: string
examples:
default200CurrentCapitalizationResponse:
summary: (sample response)
value:
data:
version: '2.0'
tables:
main:
definition:
columns:
- id: lineItem
type: string
isDimension: true
- id: lineItemChild1
type: string
parentId: lineItem
isDimension: true
- id: lineItemValue
type: real
headersDefinition:
columns: []
data:
rows:
- cells:
- Price (As of 27 Jan '21)
-
- 312.690002
rowMetadata:
category:
value: DETAIL
scale:
value:
currencyCode:
value: USD
currencySymbol:
value: $
- cells:
- Basic Shares
-
- 37.978624
rowMetadata:
category:
value: DETAIL
scale:
value: 6
- cells:
- Basic Shares
- Common Stock
- 37.978624
rowMetadata:
category:
value: DETAIL
scale:
value:
- cells:
- Market Cap
-
- 11875.535939
rowMetadata:
category:
value: MAIN
scale:
value: 6
currencyCode:
value: USD
currencySymbol:
value: $
- cells:
- Enterprise Value
-
- 12241.212855
rowMetadata:
category:
value: MAIN
scale:
value:
currencyCode:
value: USD
currencySymbol:
value: $
tableMetadata:
sources:
value:
- FactSet ECS
- FactSet DCS
meta:
requestId: FDS-US
fsymId: SQFMK3-R
schema: table_parent_child_columns
default200FinancialHighlightsResponse:
summary: sample response
value:
data:
version: '2.0'
tables:
main:
definition:
columns:
- id: lineItem1
type: string
- id: lineItem2
type: string
- id: lineItem3
type: string
- id: lineItem4
type: string
- id: lineItem5
type: string
- id: lineItem6
type: string
- id: lineItem7
type: string
headersDefinition:
columns: []
data:
rows:
- cells:
-
- Aug '16
- Aug '17
- Aug '18
- Aug '19
- Aug '20
- Aug '21
rowType: Header
headerCellDetails:
'0':
source: PRIMARY
columnIndex: 0
'1':
source: PRIMARY
columnIndex: 1
'2':
source: PRIMARY
columnIndex: 2
'3':
source: PRIMARY
columnIndex: 3
'4':
source: PRIMARY
columnIndex: 4
'5':
source: PRIMARY
columnIndex: 5
'6':
source: PRIMARY
columnIndex: 6
- cells:
- Sales
- '1127.092000'
- '1221.179000'
- '1350.145000'
- '1435.351000'
- '1494.111000'
- '1591.445000'
rowMetadata:
metric:
value: FIN
scale:
value: 6
- cells:
- EBITDA
- '398.079000'
- '421.412000'
- '437.783000'
- '500.292000'
- '558.515000'
- '581.364000'
rowMetadata:
metric:
value: FIN
scale:
value: 6
tableMetadata:
currencyCode:
value: USD
currencySymbol:
value: $
sources:
value:
- FactSet Fundamentals
- FactSet Estimates
columnMetadata:
'1':
items:
category:
value: ACTUAL
'2':
items:
category:
value: ACTUAL
'3':
items:
category:
value: ACTUAL
'4':
items:
category:
value: ACTUAL
'5':
items:
category:
value: ACTUAL
'6':
items:
category:
value: ACTUAL
meta:
requestId: FDS-US
fsymId: SQFMK3-R
noData200FinancialHighlightsResponse:
summary: no coverage response
value:
data:
version: '2.0'
tables:
main:
definition:
columns:
- id: lineItem1
type: string
headersDefinition:
columns: []
data:
rows: []
tableMetadata:
currencyCode:
value: GBP
currencySymbol:
value: £
meta:
requestId: 0KJ0NJ-E
fsymId:
noCoverage: true
message: This identifier is not covered by this API.
default200PeerListResponse:
summary: (sample response)
value:
data:
peers:
- id: 000PLZ-E
name: S&P Global, Inc.
ticker: SPGI-US
- id: 05TYNB-E
name: Morningstar, Inc.
ticker: MORN-US
- id: 06JP5R-E
name: MSCI Inc. Class A
ticker: MSCI-US
- id: 002HJD-E
name: BlackRock, Inc.
ticker: BLK-US
- id: 0GCKWP-E
name: IHS Markit Ltd.
ticker: INFO-US
- id: 000HSZ-E
name: Moody's Corporation
ticker: MCO-US
- id: 06S1MZ-E
name: Nasdaq, Inc.
ticker: NDAQ-US
- id: 0G4Z2V-E
name: Donnelley Financial Solutions, Inc.
ticker: DFIN-US
meta:
sources:
value:
- FactSet Fundamentals
meta:
requestId: FDS-US
fsymId: SQFMK3-R
default200ProfileResponse:
summary: (sample response)
value:
data:
business:
description:
value: >-
FactSet Research Systems Inc. (the "Company" or "FactSet") is a
global provider of integrated financial information, analytical
applications and services for the investment and corporate
communities. Since inception, global financial professionals
have utilized the Company's content and multi-asset class
solutions across each stage of the investment process. FactSet's
goal is to provide a seamless user experience spanning idea
generation, research, portfolio construction, trade execution,
performance measurement, risk management, reporting, and
portfolio analysis, in which the Company serves the front,
middle, and back offices to drive productivity and improved
performance. FactSet's flexible, open data and technology
solutions can be implemented both across the investment
portfolio lifecycle or as standalone components serving
different workflows in the organization. FactSet is focused on
growing the business throughout each of its three segments, the
Americas, EMEA (formerly known as Europe), and Asia Pacific. The
Company primarily delivers insight and information through the
workflow solutions of Research, Analytics and Trading, Content
and Technology Solutions ("CTS") and Wealth. FactSet currently
serves financial professionals, which include portfolio
managers, investment research professionals, investment bankers,
risk and performance analysts, wealth advisors and corporate
clients. FactSet provides both insights on global market trends
and intelligence on companies and industries, as well as
capabilities to monitor portfolio risk and performance and to
execute trades. The Company combines dedicated client service
with open and flexible technology offerings, such as a
configurable desktop and mobile platform, comprehensive data
feeds, an open marketplace and digital portals and application
programming interfaces ("APIs"). The Company’s revenue is
primarily derived from subscriptions to products and services
such as workstations, analytics, enterprise data, and research
management. FactSet Research Systems was founded by Howard E.
Wille and Charles J. Snyder in September 1978 and is
headquartered in Norwalk, CT.
industry:
value: Professional Content Providers
name:
value: FactSet Research Systems Inc.
sector:
value: Software and Consulting
crunchbaseCategories:
value:
- Analytics
- Finance
- Financial Services
- Software
note: >-
Displaying the Crunchbase logo is required for displaying any
Crunchbase-sourced data
size:
revenue:
label: Sales
value: 1494.111
meta:
currencyCode: USD
currencySymbol: $
scale: 6
employeeNumber:
value:
ev:
value: 12783.238274
meta:
currencyCode: USD
currencySymbol: $
scale: 6
mcap:
value: 12814.061274
meta:
currencyCode: USD
currencySymbol: $
scale: 6
contact:
address:
value: 7th Floor 45 Glover Avenue
city:
value: Norwalk
phone:
value: +1.203.810.1000
zip:
value: '06850'
country:
value: UNITED STATES
email:
value: [email protected]
website:
value: http://www.factset.com
stateProvince:
value: Connecticut
stage:
tradeDateRange:
start:
value: '19960628'
end:
value: '20201001'
foundedYear:
value: '1978'
exchangePrimary:
value: NYSE
fundingDateRange:
first:
value:
last:
value:
pevcBacking:
value:
meta:
sources:
value:
- FactSet Fundamentals
- FactSet RBICS
- Crunchbase
meta:
requestId: FDS
fsymId: SQFMK3-R
default200TransactionsResponse:
summary: sample response
value:
data:
version: '2.0'
tables:
main:
definition:
columns:
- id: c_transaction_date
type: string
isDimension: true
- id: c_transaction_type
type: string
isDimension: true
- id: c_transaction_description
type: real
isDimension: true
- id: c_transaction_amount
type: string
isDimension: true
- id: c_transaction_status
type: string
isDimension: true
headersDefinition:
columns: []
data:
rows:
- cells:
- Date
- Type
- Description
- Amount
- Status
rowType: Header
headerCellDetails:
'0':
source: PRIMARY
columnIndex: 0
'1':
source: PRIMARY
columnIndex: 1
'2':
source: PRIMARY
columnIndex: 2
'3':
source: PRIMARY
columnIndex: 3
'4':
source: PRIMARY
columnIndex: 4
- cells:
- '20211013'
- Acquisition / Merger
- >-
FactSet Research Systems, Inc. acquires Cobalt Software,
Inc.
- 51
# --- truncated at 32 KB (107 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/factset/refs/heads/main/openapi/overview-report-builder-openapi-original.yml