FactSets Entity API provides access to FactSet's complete security and entity level symbology, comprehensive entity reference data, and all of the necessary relationships and connections to create a foundation that tightly correlates disparate sources.
openapi: 3.0.0
info:
version: 1.4.0
title: FactSet Entity API
contact:
name: FactSet Research Systems
email: [email protected]
description: >
Using an entity centric data model, FactSet's Entity API provides access to
FactSet's complete security and entity level symbology, comprehensive entity
reference data, and all of the
necessary relationships and connections to create a foundation that tightly
correlates disparate sources of
information to a master entity identifier. Use this API to quickly
understand the full entity structure and related securities.
servers:
- url: https://api.factset.com/content
description: Production
security:
- BasicAuth: []
tags:
- name: Factset Entity
paths:
/factset-entity/v1/entity-references:
get:
summary: Factset Returns an entity reference profiles for an individual entity
description: >
Returns an Entity reference profile for the requested Entity Id(s). Data
points include - Ultimate Parent Id, Credit Parent Id, Headquarters
location details, Website URL, and Business Description.
tags:
- Factset Entity
operationId: getEntityReferences
parameters:
- $ref: '#/components/parameters/ids'
responses:
'200':
description: Fetches Entity Reference data for a list of ids.
content:
application/json:
schema:
$ref: '#/components/schemas/entityReferenceResponse'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'415':
$ref: '#/components/responses/415'
'500':
$ref: '#/components/responses/500'
post:
summary: Factset Returns an entity reference data for a list of ids.
description: >
Returns an entity reference object for the requested entity ids. Data
points include - ultimate parent id, headquarters location details,
credit parent id, website, and business description.
tags:
- Factset Entity
operationId: postEntityReferences
requestBody:
required: true
description: Request Body to request a list of Entity Reference objects.
content:
application/json:
schema:
$ref: '#/components/schemas/entityReferenceRequest'
responses:
'200':
description: Entity Reference data items
content:
application/json:
schema:
$ref: '#/components/schemas/entityReferenceResponse'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'415':
$ref: '#/components/responses/415'
'500':
$ref: '#/components/responses/500'
/factset-entity/v1/entity-securities:
get:
summary: >-
Factset Returns all Equity Exchange Listings and all debt instruments issued for the requested entity.
description: >
Returns all Equity Exchange Listings (ticker-exchange) and all debt
instruments (cusips) issued for the requested entity.
tags:
- Factset Entity
operationId: getEntitySecurities
parameters:
- $ref: '#/components/parameters/ids'
- $ref: '#/components/parameters/securityType'
responses:
'200':
description: Entity Security data items
content:
application/json:
schema:
$ref: '#/components/schemas/entitySecuritiesResponse'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'415':
$ref: '#/components/responses/415'
'500':
$ref: '#/components/responses/500'
post:
summary: >-
Factset Returns all Equity Exchange Listings and all debt instruments issued for the requested entity.
description: >
Returns all Equity Exchange Listings (ticker-exchange) and all debt
instruments (cusips) issued for the requested entity.
tags:
- Factset Entity
operationId: postEntitySecurities
requestBody:
required: true
description: Request Body to request a list of Entity Security objects.
content:
application/json:
schema:
$ref: '#/components/schemas/entitySecuritiesRequest'
responses:
'200':
description: Successful Response producing an array of Entity Security Objects
content:
application/json:
schema:
$ref: '#/components/schemas/entitySecuritiesResponse'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'415':
$ref: '#/components/responses/415'
'500':
$ref: '#/components/responses/500'
/factset-entity/v1/entity-structures:
get:
summary: >-
Factset Returns all active or inactive entities and respective levels below the requested entity id.
description: |
Returns all active or inactive entities below the requested entity id.
tags:
- Factset Entity
operationId: getEntityStructure
parameters:
- $ref: '#/components/parameters/structureIds'
- $ref: '#/components/parameters/level'
- $ref: '#/components/parameters/active'
responses:
'200':
description: Fetches Entity Structure
content:
application/json:
schema:
$ref: '#/components/schemas/entityStructureResponse'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'415':
$ref: '#/components/responses/415'
'500':
$ref: '#/components/responses/500'
post:
summary: Factset Returns all active or inactive entities below the requested entity id.
description: >
Returns all active or inactive entities and respective levels below the
requested entity id.
tags:
- Factset Entity
operationId: postEntityStructure
requestBody:
required: true
description: Request Body to request a list of Entity Structure objects.
content:
application/json:
schema:
$ref: '#/components/schemas/entityStructureRequest'
responses:
'200':
description: Entity Structure data items
content:
application/json:
schema:
$ref: '#/components/schemas/entityStructureResponse'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'415':
$ref: '#/components/responses/415'
'500':
$ref: '#/components/responses/500'
/factset-entity/v1/ultimate-entity-structures:
get:
summary: >-
Factset Returns the full ultimate parent entity hiearachy. Control levels and active status of underlying entities.
description: >
Returns full ultimate entity structure including ultimate parent and all
subordinates. Will accept entity from any level of entity structure or
active vs. inactive status of entity.
tags:
- Factset Entity
operationId: getUltimateEntityStructure
parameters:
- $ref: '#/components/parameters/structureIds'
- $ref: '#/components/parameters/level'
- $ref: '#/components/parameters/active'
responses:
'200':
description: Fetches Ultimate Entity Structure data for a list of ids.
content:
application/json:
schema:
$ref: '#/components/schemas/ultimateEntityStructureResponse'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'415':
$ref: '#/components/responses/415'
'500':
$ref: '#/components/responses/500'
post:
summary: >-
Factset Returns all active or inactive entities and respective levels below the requested entity id.
description: >
Returns all active or inactive entities and respective levels below the
requested entity id.
tags:
- Factset Entity
operationId: postUltimateEntityStructure
requestBody:
required: true
description: Request Body to request a list of Ultimate Entity Structure objects.
content:
application/json:
schema:
$ref: '#/components/schemas/ultimateEntityStructureRequest'
responses:
'200':
description: Ultimate Entity Structure data items
content:
application/json:
schema:
$ref: '#/components/schemas/ultimateEntityStructureResponse'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'415':
$ref: '#/components/responses/415'
'500':
$ref: '#/components/responses/500'
/factset-entity/v1/entity-reference-chi:
get:
summary: Factset Returns entity reference data in Chinese for an individual entity.
description: >
Returns entity reference data in Chinese for the requested Id(s). Data
points include Business Description and Entity Name in both simplified
and traditional Chinese.
tags:
- Factset Entity
operationId: getEntityReferenceChi
parameters:
- $ref: '#/components/parameters/idsChi'
responses:
'200':
description: Fetches Entity Reference data in Chinese for a list of ids.
content:
application/json:
schema:
$ref: '#/components/schemas/entityReferenceChiResponse'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'415':
$ref: '#/components/responses/415'
'500':
$ref: '#/components/responses/500'
post:
summary: Factset Returns entity reference data in Chinese for an individual entity.
description: >
Returns entity reference data in Chinese for the requested Id(s). Data
points include Business Description and Entity Name in both simplified
and traditional Chinese.
tags:
- Factset Entity
operationId: getEntityReferenceChiForList
requestBody:
required: true
description: Request Body to request a list of Entity Reference Chinese objects.
content:
application/json:
schema:
$ref: '#/components/schemas/entityReferenceChiRequest'
responses:
'200':
description: Fetches Entity Reference data in Chinese for a list of ids.
content:
application/json:
schema:
$ref: '#/components/schemas/entityReferenceChiResponse'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'415':
$ref: '#/components/responses/415'
'500':
$ref: '#/components/responses/500'
/factset-entity/v1/hist-credit-parent:
get:
summary: Factset Returns historical credit parents for the requested id(s).
description: >
Returns the credit parent for requested fixed income ids. Point in time
credit parent retrieval is
also available if an asOfDate is provided. The full credit parent
history of a security is returned if
no asOfDate is provided.
This endpoint uses a seven day calendar to account for changes that
occur on all seven days of the week.
tags:
- Factset Entity
operationId: getHistCredParent
parameters:
- $ref: '#/components/parameters/hcpIds'
- $ref: '#/components/parameters/asOfDate'
responses:
'200':
description: Fetches Credit Parents
content:
application/json:
schema:
$ref: '#/components/schemas/creditParentResponse'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'415':
$ref: '#/components/responses/415'
'500':
$ref: '#/components/responses/500'
post:
summary: Factset Returns historical credit parents for the requested id(s).
description: >
Returns the credit parent for requested fixed income ids. Point in time
credit parent retrieval is
also available if an asOfDate is provided. The full credit parent
history of a security is returned if
no asOfDate is provided.
This endpoint uses a seven day calendar to account for changes that
occur on all seven days of the week.
tags:
- Factset Entity
operationId: postHistCredParent
requestBody:
required: true
description: Request Body to request a list of credit parent objects.
content:
application/json:
schema:
$ref: '#/components/schemas/creditParentRequest'
responses:
'200':
description: Credit parent data items
content:
application/json:
schema:
$ref: '#/components/schemas/creditParentResponse'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'415':
$ref: '#/components/responses/415'
'500':
$ref: '#/components/responses/500'
components:
securitySchemes:
BasicAuth:
type: http
scheme: basic
parameters:
ids:
name: ids
in: query
description: >
The requested Market Identifier. Accepted input identifiers include
Ticker-Exchange, Ticker-Regions, CUSIPs, ISINs, SEDOLs, or FactSet
Permanent Ids, such as -R, -L, or -E.<p>**Max Ids Limit set to 3000 in a
single request**</p>
*<p>Make note, GET Method URL request lines are also limited to a total length of 8192 bytes (8KB). In cases where the service allows for thousands of ids,
which may lead to exceeding this request line limit of 8KB, its
advised for any requests with large request lines to be requested through
the respective \"POST\" method.</p>*
required: true
schema:
type: array
items:
type: string
example: IBM-US
minItems: 1
maxItems: 3000
explode: false
example:
- AAPL-US
- 0FPWZZ-E
- TSLA-US
hcpIds:
name: ids
in: query
description: >
The requested security level Market Identifiers. Accepted input
identifiers include Ticker-Exchange, Ticker-Regions, CUSIPs, ISINs,
SEDOLs, or FactSet -S Permanent Ids.<p>**Max Ids Limit set to 50 in a
single request**</p>
*<p>Make note, GET Method URL request lines are also limited to a total length of 8192 bytes (8KB). In cases where the service allows for thousands of ids,
which may lead to exceeding this request line limit of 8KB, its
advised for any requests with large request lines to be requested through
the respective \"POST\" method.</p>*
required: true
schema:
type: array
items:
type: string
example: IBM-US
minItems: 1
maxItems: 50
explode: false
example:
- CYQYNL-S
- G17920AA0
- US40434YTB38
asOfDate:
name: asOfDate
in: query
required: false
schema:
type: string
description: >
The date requested for credit parent calculation. Represented in
**YYYY-MM-DD** format. If left blank or not specified, the full credit
parent history will be returned.
example: '2020-01-01'
structureIds:
name: ids
in: query
description: >
The requested Market Identifier. Accepted input identifiers include
Ticker-Exchange, Ticker-Regions, CUSIPs, ISINs, SEDOLs, or FactSet
Permanent Ids, such as -R, -L, or -E.<p>**Max Ids Limit set to 100 in a
single request**</p>
*<p>Make note, GET Method URL request lines are also limited to a total length of 8192 bytes (8KB). In cases where the service allows for thousands of ids,
which may lead to exceeding this request line limit of 8KB, its
advised for any requests with large request lines to be requested through
the respective \"POST\" method.</p>*
required: true
schema:
type: array
items:
type: string
example: IBM-US
minItems: 1
maxItems: 100
explode: false
example:
- AAPL-US
- 0FPWZZ-E
- TSLA-US
securityType:
name: securityType
in: query
description: >-
Controls the response to return all related equity listings (EQ), all
debt instruments (FI), or both all equity and all debt (ALL).
required: false
schema:
type: string
enum:
- EQ
- FI
- ALL
default: EQ
example: EQ
level:
name: level
in: query
description: >-
Controls the levels returned in the hierarchy. Use -1 to return all
levels, or 1-n for a specific level.
required: false
schema:
type: integer
default: -1
example: -1
active:
name: active
in: query
description: >-
Controls active or inactive securities returned in the hierarchy. Enter
1 to return only active entities, 0 for inactive entities, and -1 for
all active and inactive.
required: false
schema:
type: integer
default: -1
minimum: -1
maximum: 1
example: -1
idsChi:
name: ids
in: query
description: >
The requested Market Identifier. Accepted input identifiers include
Ticker-Exchange, Ticker-Regions, CUSIPs, ISINs, SEDOLs, BBGs or FactSet
Permanent Ids, such as -R, -L, or -E.<p>**Max Ids Limit set to 1500 in a
single request**</p>
*<p>Make note, GET Method URL request lines are also limited to a total length of 8192 bytes (8KB). In cases where the service allows for thousands of ids,
which may lead to exceeding this request line limit of 8KB, its
advised for any requests with large request lines to be requested through
the respective \"POST\" method.</p>*
required: true
schema:
type: array
items:
type: string
example: IBM-US
minItems: 1
maxItems: 1500
explode: false
example:
- 05X6LC-E
- 062T6N-E
schemas:
entityReferenceRequest:
title: Entity Reference Request
description: Entity Reference Request Body
type: object
properties:
ids:
$ref: '#/components/schemas/ids'
required:
- ids
entityReferenceResponse:
type: object
title: Entity Reference Response
properties:
data:
description: Array of Entity Reference objects.
type: array
items:
$ref: '#/components/schemas/entityReference'
entityReference:
title: Entity Profile
type: object
properties:
fsymId:
type: string
description: >-
Unique FactSet-generated identifier representing an entity for the
current entity identifier (-E)
example: 001MF1-E
nullable: true
entityProperName:
type: string
description: >-
Name that the entity is commonly referred to as, normalized and in
proper case.
example: Amazon.com, Inc.
nullable: true
fsymEntityId:
type: string
description: Unique FactSet-generated identifier representing an entity
example: 001MF1-E
nullable: true
ultimateParentId:
type: string
description: The ultimate parent id of the entity.
example: 001MF1-E
nullable: true
ultimateParentName:
type: string
description: >-
Name that the ultimate parent entity is commonly referred to as,
normalized and in proper case."
example: Amazon.com, Inc.
nullable: true
creditParentId:
type: string
description: >
The credit parent id in which issues debt instruments. The credit
parent differs from the ultimate parent if the ultimate parent does
not inherit the credit risk associated with an issuer's debt
offerings.
Credit Parent's are not Assigned to the Extinct Issues, Governments,
Asset-Backed Securities, Trusts, Foundations, Private Equity,
Venture Capital, Hedge Funds, or Mutual Funds. FactSet assigns
credit parents based on the following methodology -
* If an issuer (entity A) is considered a direct subsidiary of
another entity (entity B), where the parent entity (entity B) has a
100% controlling interest in the issuer (entity A), then the parent
entity (entity B) is considered the credit parent.
* If an operating business is purchased as a portfolio
company/operating company (entity A) by a group of private equity
firms that establish a holding company (entity B) structure to
reflect the collective ownership, and the portfolio
company/operating company (entity A) issues debt as part of
acquisition financing, then the portfolio company/operating company
(entity A) is deemed to be the credit parent, not the holding
company (entity B).
* An issuer must have active debt.
example: 001MF1-E
nullable: true
parentEquityId:
type: string
description: The regional parent equity listing id.
example: MCNYYL-R
nullable: true
privateEntityFlag:
type: integer
description: Returns 1 if the entity is a Private Company, otherwise, 0.
example: 0
nullable: true
publicEntityFlag:
type: integer
description: Returns 1 if the entity is a Public Company, otherwise, 0.
example: 1
nullable: true
securityType:
type: string
description: >-
Security type of the identifier, For descriptions of the each
security type, visit [OA
15776](https://my.apps.factset.com/oa/pages/15776)
example: SHARE
nullable: true
website:
type: string
description: Web page address for the entity
example: http://www.amazon.com
nullable: true
incorporationDate:
type: string
format: date
description: Year the entity was incorporated in YYYY-MM-DD format.
example: '1996-05-28'
nullable: true
countryOfRisk:
type: string
description: >
Entity's Country of Risk. FactSet has a determined methodology for
assigning a country of risk to public and private entities, based on
the following -
* Country of Headquarters
* Country of Incorporation
* Country of Primary Exchange (the country where most liquid equity
listings trade)
example: US
nullable: true
incorporationCountry:
type: string
description: ISO Country code where the entity is incorporated
example: US
nullable: true
businessDescription:
type: string
description: Extended business description for the requested entity.
example: >-
Amazon.com, Inc. engages in the provision of Online retail shopping
services. It operates through the following business segments: North
America, International, and Amazon Web Services (AWS). The North
America segment includes retail sales of consumer products and
subscriptions through North America-focused websites such as
www.amazon.com and www.amazon.ca. The International segment offers
retail sales of consumer products and subscriptions through
internationally-focused websites. The Amazon Web Services segment
involves in the global sales of compute, storage, database, and AWS
service offerings for start-ups, enterprises, government agencies,
and academic institutions. The company was founded by Jeffrey P.
Bezos in July 1994 and is headquartered in Seattle, WA.
nullable: true
phone:
type: string
description: The entity's international phone number.
example: +1.206.266.1000
nullable: true
headquartersStreet:
type: string
description: The entity's headquarters street address.
example: 410 Terry Avenue North
nullable: true
headquartersCity:
type: string
description: The entity's headquarters street address.
example: Seattle
nullable: true
headquartersState:
type: string
description: Abbreviated State of company headquarters.
example: WA
nullable: true
headquartersZip:
type: string
description: Zip/Postal Code for entity's headquarters.
example: 98109-5210
nullable: true
headquartersCountry:
type: string
description: Abbreviated (ISO) Country of headquarters.
example: US
nullable: true
emailIR:
type: string
description: Email Address of the Investor Relations Contact
example: [email protected]
nullable: true
websiteIR:
type: string
description: Website or Page for the Entity's Investor Relations team.
example: https://ir.aboutamazon.com/overview/default.aspx
nullable: true
requestId:
type: string
description: >-
Identifier used in "ids" parameter. When list of identifiers used,
they will be parsed and resolved individually.
example: AMZN-US
entitySecuritiesRequest:
title: Entity Securities Request
description: Entity Securities Request Body
type: object
properties:
ids:
$ref: '#/components/schemas/ids'
securityType:
$ref: '#/components/schemas/securityType'
required:
- ids
entitySecuritiesResponse:
type: object
title: Entity Securities Response
properties:
data:
description: Array of securities objects.
type: array
items:
$ref: '#/components/schemas/entitySecurities'
entitySecurities:
title: Entity Securities
type: object
properties:
fsymId:
type: string
description: FactSet Ultimate Parent ID of the Requested Security ID
example: 001MF1-E
nullable: true
fsymSecurityId:
type: string
description: FactSet Security ID (-S).
example: F3PS31-S
nullable: true
fsymListingId:
type: string
description: >-
FactSet Listing ID (-L). Corresponds to the listing exchange for the
requested security. Not applicable for FI instruments.
example: LVR478-L
nullable: true
securityType:
type: string
description: >-
The Security Type Code. Security Type Code details and mapping are
described on Online Assistant Page 15776 for Equity and Page 16014
for Fixed Income.
example: BDNT
enum:
- SHARE
- PREFEQ
- MF_C
- MF_O
- ETF_ETF
- ETF_UVI
- ETF_NAV
- ADR
- GDR
- NVDR
- DR
- ALIEN
- PREF
- WARRANT
- RIGHT
- UNIT
- STRUCT
- TEMP
- CONV
- BDNT
- PFD
- PASS
- MM
- RMBS
- ABS
- COVR
- LKS
- LAUTH
- BLDN
- CMBS
nullable: true
listingExchange:
type: string
description: The securities primary listing exchange.
example: NAS
nullable: true
securityName:
type: string
description: Security name
example: Amazon.com, Inc. 1.9% 21-AUG-2020
nullable: true
fsymEntityId:
type: string
description: Unique FactSet-generated identifier representing an entity.
example: 001MF1-E
nullable: true
fsymTickerExchange:
type: string
description: >-
The security's ticker-exchange, representing the listing exchange
symbol.
example: AMZN-NAS
nullable: true
fsymTickerRegion:
type: string
description: The security's regional ticker.
example: AMZN-US
nullable: true
activeFlag:
type: integer
description: Indicates if security is active. 1 = Active; 0 = Inactive.
example: 1
enum:
- 0
- 1
nullable: true
requestId:
type: string
description: >-
Identifier used in `ids` parameter. When list of identifiers used,
they will be parsed and resolved individually.
example: AMZN-US
entityStructureRequest:
title: Entity Structure Request
description: Entity Structure Request Body
type: object
properties:
ids:
$ref: '#/components/schemas/structureIds'
level:
$ref: '#/components/schemas/level'
active:
$ref: '#/components/schemas/active'
required:
- ids
entityStructureResponse:
type: object
title: Entity Structure Response
properties:
data:
description: Array of Entity Structure objects.
type: array
items:
$ref: '#/components/schemas/entityStructure'
entityStructure:
title: Entity Structure
type: object
properties:
fsymId:
type: string
description: >-
Unique FactSet-generated identifier representing an entity for the
current entity identifier (-E)
example: 001MF1-E
nullable: true
fsymEntityId:
type: string
description: Unique FactSet-generated identifier representing an entity
example: 001MF1-E
nullable: true
ultimateParentId:
type: string
description: The ultimate parent id of the entity.
example: 001MF1-E
nullable: true
parentEntityId:
type: string
description: >-
Within the hierarchy, this id represen
# --- truncated at 32 KB (51 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/factset/refs/heads/main/openapi/entity-openapi-original.yml