**Max Ids Limit set to 3000 in a single request**
*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.
* 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.**Max Ids Limit set to 50 in a single request**
*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.
* 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.**Max Ids Limit set to 100 in a single request**
*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.
* 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.**Max Ids Limit set to 1500 in a single request**
*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.
* 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: amazon-ir@amazon.com 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 represents the immediate parent entity id for the level directly above. Ultimate parent id will return a blank string. example: 001MF1-E nullable: true level: type: integer description: >- Controls the levels returned in the hierarchy. Use -1 to return all levels, or 1-n for a specific level. example: 2 nullable: true inactive: type: integer description: A flag for inactive securities; whereby 1 = inactive and 0 = active. example: 0 nullable: true description: type: string description: The proper name and entity type for the entity. example: Whole Foods Market, Inc. (Subsidiary) nullable: true requestId: type: string description: Identifier used in `ids`. example: AMZN-US ultimateEntityStructureRequest: title: Ultimate Entity Structure Request description: Ultimate Entity Structure Request Body type: object properties: ids: $ref: '#/components/schemas/structureIds' level: $ref: '#/components/schemas/level' active: $ref: '#/components/schemas/active' required: - ids ultimateEntityStructureResponse: type: object title: Entity Structure Response properties: data: description: Array of Entity Structure objects. type: array items: $ref: '#/components/schemas/utlimateEntityStructure' utlimateEntityStructure: title: Ultimate 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 represents the immediate parent entity id for the level directly above. Ultimate parent id will return a blank string. example: 001MF1-E nullable: true level: type: integer description: >- Level within the ultimate entity structure. This is taken from the perspective of the ultimate parent id and the full entity hierarchy. example: 3 nullable: true inactive: type: integer description: A flag for inactive securities; whereby 1 = inactive and 0 = active. example: 0 nullable: true description: type: string description: The proper name and entity type for the entity. example: Whole Foods Market, Inc. (Subsidiary) nullable: true requestId: type: string description: Identifier used in `ids`. example: AMZN-US entityReferenceChiRequest: title: Entity Reference Chinese Request description: Entity Reference Request Body type: object properties: ids: $ref: '#/components/schemas/idsChi' required: - ids entityReferenceChiResponse: type: object title: Entity Reference Chinese Response properties: data: description: Array of Entity Reference objects. type: array items: $ref: '#/components/schemas/entityReferenceChi' entityReferenceChi: title: Entity Profile type: object properties: fsymId: type: string description: >- Unique FactSet-generated identifier representing an entity for the current entity identifier (-E) example: 062T6N-E nullable: true fsymEntityId: type: string description: Unique FactSet-generated identifier representing an entity example: 062T6N-E nullable: true simplifiedChineseName: type: string description: The entity name in Simplified Chinese. example: 百川能源股份有限公司 nullable: true traditionalChineseName: type: string description: The entity name in Traditional Chinese. example: 百川能源股份有限公司 nullable: true entityProperName: type: string description: >- Name that the entity is commonly referred to as, normalized and in proper case. example: Bestsun Energy Co., Ltd. nullable: true simplifiedChineseDescription: type: string description: >- Extended business description for the requested entity in Simplified Chinese. example: >- 百川能源股份有限公司前身为武汉长江印刷股份有限(集团)公司,系由原武汉印刷厂、北京京华信托投资公司、深圳万科企业股份有限公司联合发起组建,于1992年3月18日正式成立。公司主营业务为城市管道燃气销售、燃气工程安装、燃气具销售。 nullable: true traditionalChineseDescription: type: string description: >- Extended business description for the requested entity in Traditional Chinese. example: >- 百川能源股份有限公司前身為武漢長江印刷股份有限(集團)公司,系由原武漢印刷廠、北京京華信託投資公司、深圳萬科企業股份有限公司聯合發起組建,於1992年3月18日正式成立。公司主營業務為城市管道燃氣銷售、燃氣工程安裝、燃氣具銷售。 nullable: true requestId: type: string description: >- Identifier used in "ids" parameter. When list of identifiers used, they will be parsed and resolved individually. example: 062T6N-E creditParentRequest: title: Historical Credit Parent Request description: Historical Credit Parent Request Body type: object properties: ids: $ref: '#/components/schemas/hcpIds' asOfDate: $ref: '#/components/schemas/asOfDate' required: - ids creditParentResponse: type: object title: Historical Credit Parent Response properties: data: description: Array of Credit Parent objects. type: array items: $ref: '#/components/schemas/creditParent' creditParent: title: Credit Parent type: object properties: fsymId: type: string description: >- Unique FactSet-generated identifier representing an entity for the current entity identifier (-E) example: 0028BD-E nullable: true requestId: type: string description: Identifier used in `ids`. example: CYQYNL-S entityProperName: type: string description: The proper name for the credit parent entity. example: BNP Paribas S.A. Class A nullable: true factsetCreditParentId: type: string description: This id represents the credit parent entity id. example: 0028BD-E nullable: true asOfDate: type: string format: date description: >- The effective date of this record in YYYY-MM-DD format. If an asOfDate is not specified in the request, this field will be null in the response. example: '2020-01-01' nullable: true effectiveStartDate: type: string format: date description: The initial effective date of this record in YYYY-MM-DD format. example: '1996-05-28' nullable: true effectiveEndDate: type: string format: date description: >- The last day on which this record is effective date in YYYY-MM-DD format. example: '2001-05-28' nullable: true ids: title: ids description: > Security or Entity identifiers. FactSet Identifiers, tickers, CUSIP and SEDOL are accepted input. type: array items: type: string minItems: 1 maxItems: 3000 example: - FDS-US - 0FPWZZ-E - TSLA-US structureIds: title: ids description: > Security or Entity identifiers. FactSet Identifiers, tickers, CUSIP and SEDOL are accepted input. type: array items: type: string minItems: 1 maxItems: 100 example: - FDS-US - 0FPWZZ-E - TSLA-US hcpIds: title: ids description: > Security identifiers. FactSet Identifiers, tickers, CUSIP and SEDOL are accepted input. type: array items: type: string minItems: 1 maxItems: 50 example: - CYQYNL-S - G17920AA0 - US40434YTB38 asOfDate: title: asOfDate 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-06-30' securityType: title: securityType description: > Controls the response to return all related equity listings (EQ), all debt instruments (FI), or both all equity and all debt (ALL). type: string enum: - EQ - FI - ALL default: EQ example: EQ level: title: level description: >- Controls the levels returned in the hierarchy. Use -1 to return all levels, or 1-n for a specific level. type: integer default: -1 example: -1 active: title: active 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. type: integer default: -1 example: 1 maximum: 1 minimum: -1 idsChi: title: ids description: > Security or Entity identifiers. FactSet Identifiers, tickers, CUSIP, BBG and SEDOL are accepted input. type: array items: type: string minItems: 1 maxItems: 1500 example: - 05X6LC-E - 062T6N-E errorResponse: type: object description: error description title: Error Response properties: status: description: status type: string example: Bad Request timestamp: description: timestamp in YYYY-MM-DD HH:MM:SS.SSS type: string example: '2019-11-01 11:09:41.918' format: date-time path: description: The Endpoint path {package}/version/{endpoint} type: string example: /factset-entity/v1/{end-point} message: description: The plain text error message type: string example: Validation Error subErrors: description: subErrors related to the error message. Null if not applicable. type: object properties: object: description: the operation ID type: string field: description: Parameter Field Name type: string message: description: Error message type: string rejectedValue: description: Rejected Values in an Array type: array items: type: string responses: '400': description: >- Bad Request. This can occur for several reasons. Please review the "message" for more details. content: application/json: schema: $ref: '#/components/schemas/errorResponse' examples: Bad Request - Date Format: $ref: '#/components/examples/badRequestDateFormat' Bad Request - Missing Required Parameter: $ref: '#/components/examples/badRequestRequiredParameter' Bad Request - Invalid Parameter: $ref: '#/components/examples/badRequestInvalidParameters' Bad Request - Malformed JSON: $ref: '#/components/examples/badRequestMalformedJSON' Bad Request - Read Timeout: $ref: '#/components/examples/badRequestReadTimeout' '401': description: >- Unauthenticated USERNAME-SERIAL. Ensure you are logged in and have successfully generated an API KEY for the IP range you are connecting from. For more help, select the **Report Issue** in the top right corner of this Developer Portal specification card and choose Connectivity 401 or 403 Responses. content: application/json: schema: $ref: '#/components/schemas/errorResponse' examples: Bad Request - Date Format: $ref: '#/components/examples/unauthenticated' '403': description: >- The USERNAME-SERIAL attempted to request the endpoint is not authorized to access. The request was a legal request, but the server is refusing to respond. Please reach out to FactSet Account Team for assistance with authorization. For more help, select the **Report Issue** in the top right corner of this Developer Portal specification card and choose Connectivity 401 or 403 Responses. content: application/json: schema: $ref: '#/components/schemas/errorResponse' examples: Bad Request - Forbidden: $ref: '#/components/examples/forbidden' '415': description: >- Unsupported Media Type. This error may be returned when the caller sends a resource in a format that is not accepted by the server. This can be fixed by ensuring that Content-Type header is set to the correct value. In this instance, "application/json" would be the appropriate value. content: application/json: schema: $ref: '#/components/schemas/errorResponse' examples: Bad Request - Unsupported Media Type: $ref: '#/components/examples/unsupportedMediaType' '500': description: Internal Server Error. content: application/json: schema: $ref: '#/components/schemas/errorResponse' examples: Internal Server Error - Not Writable: $ref: '#/components/examples/notWritable' Internal Server Error - General Exception: $ref: '#/components/examples/generalException' examples: badRequestDateFormat: summary: Bad Request - Date Format description: >- This bad request occurs when a request doesn't use the YYYY-MM-DD in the date parameters. To resolve, convert your date to YYYY-MM-DD. value: status: Bad Request timestamp: '2020-07-02 11:52:36.464' path: /factset-entity/v1/{endpoint} message: 'The date parameter must be in the following date format: YYYY-MM-DD' subErrors: badRequestRequiredParameter: summary: Bad Request - Required Parameter Missing description: >- This error message occurs when the request does not include the required parameters. Required parameters are indicated with a red asterisks symbol in the specification file. value: status: Bad Request timestamp: '2020-06-30 13:22:09.053' path: /factset-entity/v1/{endpoint} message: The parameter 'ids' is required and may not be empty. subErrors: badRequestInvalidParameters: summary: Bad Request - Passing Invalid Parameter description: This error message occurs when user is passing an Invalid Parameter value: status: Bad Request timestamp: '2020-07-23 11:03:40.765' path: /factset-entity/v1/{endpoint} message: >- Invalid Parameter (s): fakeParameter. Please modify your request to use parameters outlined in the specification for this endpoint. subErrors: badRequestMalformedJSON: summary: Bad Request - Malformed JSON Request description: >- This error may be returned when the request body is specified as JSON, but is not in proper JSON format. value: status: Bad Request timestamp: '2020-07-02 11:59:09.649' path: /factset-entity/v1/{endpoint} message: Malformed JSON Request subErrors: badRequestReadTimeout: summary: Bad Request - Read Timeout description: >- This error may be returned if it takes more than 29 seconds to hear back from the data fetch service. value: status: Bad Request timestamp: '2020-07-02 16:18:38.949' path: /factset-entity/v1/{endpoint} message: The request took too long. Try again with a smaller request. subErrors: unauthenticated: summary: User Authentication Failed description: >- This occurs when a user is not properly authenticated or recognized by the service. Please double check the USERNAME-SERIAL and API-Key used to request and ensure you are within the IP range specified for the Key. Report Issue under 401 error for help with troubleshooting. value: status: User Authentication Failed timestamp: '2020-07-02 16:08:07.945' path: /factset-entity/v1/{endpoint} message: User Authentication Failed. subErrors: forbidden: summary: Forbidden description: >- The USERNAME-SERIAL attempted to request the endpoint is not authorized to access. The request was a legal request, but the server is refusing to respond. Please reach out to FactSet Account Team for assistance with authorization. value: status: Forbidden timestamp: '2020-07-02 17:21:52.197' path: /factset-entity/v1/{endpoint} message: >- USERNAME-SERIAL does not have permission to use /factset-entity/v1/{endpoint} subErrors: unsupportedMediaType: summary: Unsupported Media Type description: >- This bad request occurs when the media type passed in the request is not supported. Currently the APIs only support 'application/json'. value: status: Unsupported Media Type timestamp: '2020-07-02 09:42:27.237' path: /factset-entity/v1/{endpoint} message: >- text/html media type is not supported. Supported media types are application/json. subErrors: notWritable: summary: Internal Server Error - Not Writable description: >- This error may be returned when the server encounters an error writing the JSON response. value: status: Internal Server Error timestamp: '2020-07-02 09:48:29.18' path: /factset-entity/v1/{endpoint} message: Error writing JSON output subErrors: generalException: summary: Internal Server Error - General Exception description: >- This is the most general error that can be returned to by the service. Please `Report Issue` to FactSet. value: status: Internal Server Error timestamp: '2020-07-02 10:36:01.944' path: /factset-entity/v1/{endpoint} message: Unexpected error subErrors: