openapi: 3.0.3 info: title: Analytics Datastore About Factset API description: Allow clients to fetch precalculated Analytics through predeterministic URLs. contact: name: FactSet Research Systems url: https://developer.factset.com/contact email: api@factset.com license: name: Apache License, Version 2.0 url: https://www.apache.org/licenses/LICENSE-2.0 version: 1.0.0 servers: - url: https://api.factset.com description: Production - url: https://api-sandbox.factset.com description: Sandbox security: - basicAuth: [] tags: - name: Factset description: factset endpoints paths: /factset/etf/getBySymbol: get: tags: - Factset operationId: get/factset/etf/getBySymbol x-supportsOffsetBasedPaging: false x-supportsOffsetBasedPagingWithoutTotal: false x-supportsCursorBasedPaging: false x-supportsCursorBasedPagingWithoutTotal: false x-supportsPush: false x-requiresUser: false x-requiresInternalClient: false x-disallowUser: false x-no-merge: false x-maxSortParameterCount: 10 x-supportsPermissionDeniedResponse: false description: An ETP can be profiled by defining several common attributes such as issuer, fund description, and benchmark. summary: Factset Retrieve basic profile information for a specified ETP. parameters: - name: symbol in: query type: string maxLength: 10 exclusiveMaximum: false required: true description: Market symbol of ETP defined by FactSet. - name: _attributes in: query type: array items: type: string maxLength: 100 exclusiveMaximum: false uniqueItems: true maxItems: 50 collectionFormat: csv description: Limit the attributes returned in the response to the specified set. responses: '200': description: Successful Response schema: type: object properties: data: description: Profile. type: object x-property-sort: - asOfDate - holdingsDate - symbol - exchange - name - issuer - brand - launchDate - description - website - domicile - status - currency - index - financialReport - createRedeem - aum - trading - documentation - insight properties: asOfDate: type: string format: date description: Date data was published. This data is available only for US region. holdingsDate: type: string format: date description: The as of data for holdings statistics. This data available only for US region symbol: type: string description: Ticker of the ETP. This data is available for all region. exchange: type: object x-property-sort: - code - name - country - region description: Exchange. properties: code: type: string description: Short Code of the exchange. This data is available for all the regions. name: type: string description: Name of the exchance where ETP is listed. This data is available for all the regions. country: type: string description: Short country code where ETP exchange is located. This data is available for all the regions and country code is in format ISO 3166-1 alpha-2. region: type: string description: Short region code where ETP exchange is located. This data is available for all the regions. x-enum-description: - Europe region. - North America region. - Asia-Pacific region. - Middle East & Africa. enum: - Europe - North America - Asia-Pacific - Middle East & Africa name: type: string description: Name of the ETP. This data is available for all the regions. issuer: type: object x-property-sort: - name description: Issuer. properties: name: type: string description: Name of the issuer of the ETP. This data is available for all the regions. brand: type: object x-property-sort: - name description: Brand. properties: name: type: string description: Name of the brand of the ETP. This data is available for all the regions. launchDate: type: string format: date description: Launch date of the ETP. This data is available for all the regions. description: type: string description: A brief description of the ETP. This data is available for all the regions. website: type: string description: Link to the ETP's homepage. This data is available for the US and Canada region. domicile: type: string description: ETP country of domicile. This data is available for all the regions and country code is in format ISO 3166-1 alpha-2. status: type: string description: Staus of the ETP. This data is available for all the regions. x-enum-description: - Active. - Delisted. - Not trading yet. enum: - Active - Delisted - Not trading yet currency: type: object x-property-sort: - listing - fund description: Currency. properties: listing: type: string description: Currency of exchange specific listing. This data is available for all the regions and currency code is in the format ISO 4217. fund: type: string description: Base calculation currency of the ETP. This data is available for all the regions and currency code is in the format ISO 4217. index: type: object x-property-sort: - name - family - website - distributionTreatment - rebalancingFrequency - currency description: The index the ETP is replicating, if applicable. properties: name: type: string description: The name of the underlying index of the ETP. This data is available for all the regions. family: type: string description: The name of the index provider for the underlying index of the ETP. This data is available for all the regions. website: type: string description: The link to the underlying index's homepage. This data is available for all the regions. distributionTreatment: type: string description: Describes the treatment of constituent cash flows by the index, whether capitalized (reinvested) or ignored, as well as tax withholding by foreign countries. Text and standardized value available for this data item. This data is available for Europe only. rebalancingFrequency: type: string description: Period of time between reweighting underlying index constituents. x-enum-description: - Monthly. - Annually. - Quarterly. - Semi-annual. - Daily. - As Needed. - Bi-Monthly. - Weekly. enum: - Monthly - Annually - Quarterly - Semi-annual - Daily - As Needed - Bi-Monthly - Weekly currency: type: string description: Base calculation currency of underlying index. This data is available for all the regions and currency code is in the format ISO 4217. financialReport: type: object x-property-sort: - annual - semiAnnual description: Financial report. properties: annual: type: object x-property-sort: - isAvailable - date description: Annual. properties: isAvailable: type: boolean description: States whether or not the current annual financial report is available on the issuer's website. This data is available for all the regions. date: type: string format: date description: Date of the last annual report available on issuer's site. This data is available for all the regions. semiAnnual: type: object x-property-sort: - isAvailable - date description: Semi annual. properties: isAvailable: type: boolean description: States whether or not the semi-annual financial report is available on the issuer's website. This data is available for all the regions. date: type: string format: date description: Date of the last semi-annual report available on the issuer's website. This data is available for all the regions. createRedeem: type: object x-property-sort: - unitCost - unitSize description: Create or redeem properties: unitCost: type: number format: real description: The standard fee in the ETP currency to create or redeem one unit of an ETP. This data is available for the US regions.. unitSize: type: number format: real description: The minimum ETP share block at which issuers are willing to perform creations or redemptions per prospectus or other filing documents. This data is available for the US regions. aum: type: number format: real description: The market value of the total assets that a individual ETP manages on behalf of it's investors. This data is available for all the regions. trading: type: object x-property-sort: - average - median description: Trading. properties: average: type: object x-property-sort: - volume - value description: Average. properties: volume: type: number format: real description: The average daily number of shares traded over the past 45 trading days. This data is available for the US regions. value: type: number format: real description: The average daily value traded over the past 45-trading day period in ETP's listing currency. This data is available for the US regions. median: type: object x-property-sort: - volume - value description: Median. properties: volume: type: number format: real description: Median daily number of shares traded over the past 45 trading days. This data is available for the regions. value: type: number format: real description: Median daily value traded over the past 45 trading days in ETP's listing currency. This data is available for the US regions. documentation: type: object x-property-sort: - isProspectusPosted - isSaiPosted description: Documentation. properties: isProspectusPosted: type: boolean description: Complete prospectus is available on issuer website. This data is available for all the regions. isSaiPosted: type: boolean description: Statement of Additional Information (SAI) is available on issuer website. This data is available for the US regions. insight: type: object x-property-sort: - overview - quote description: Insight. properties: overview: type: string description: In-depth ETP overview from FactSet ETP Analytics. This data is available for the US regions. quote: type: string description: Abbreviated ETP overview from the FactSet ETP Analytics. This data is available for the US regions. meta: type: object description: The meta member contains the meta information of the response. properties: status: $ref: '#/definitions/StatusObject' x-property-sort: - status /factset/etf/allocation/asset/listBySymbol: get: tags: - Factset operationId: get/factset/etf/allocation/asset/listBySymbol x-supportsOffsetBasedPaging: true x-supportsOffsetBasedPagingWithoutTotal: false x-supportsCursorBasedPaging: false x-supportsCursorBasedPagingWithoutTotal: false x-supportsPush: false x-requiresUser: false x-requiresInternalClient: false x-disallowUser: false x-no-merge: false x-maxSortParameterCount: 10 x-supportsPermissionDeniedResponse: false description: This endpoint returns selected ETP's allocations grouped by asset class. The response will be sorted by weight in descending order. summary: Factset This endpoint returns selected ETP's asset allocations. parameters: - name: symbol in: query type: string maxLength: 10 exclusiveMaximum: false required: true description: Market symbol of ETP defined by FactSet. - name: _attributes in: query type: array items: type: string maxLength: 100 exclusiveMaximum: false uniqueItems: true maxItems: 50 collectionFormat: csv description: Limit the attributes returned in the response to the specified set. - type: number format: int32 minimum: 0 exclusiveMinimum: false default: 0 description: Non-negative number of entries to skip, or 0 (default). name: _paginationOffset in: query - type: number format: int32 minimum: 0 exclusiveMinimum: false maximum: 500 exclusiveMaximum: false default: 20 description: Non-negative maximum number of entries to return. name: _paginationLimit in: query responses: '200': description: Successful Response schema: type: object properties: data: description: ETP asset allocation data. type: object x-property-sort: - reportDate - assets properties: reportDate: type: string format: date description: Reporting date for the allocations. assets: type: array items: type: object x-property-sort: - assetClass - weight properties: assetClass: type: string description: Name of the asset class. weight: type: number format: real description: Consolidate weight of the position within the ETP by asset class(es). uniqueItems: true description: List of allocations by asset class. meta: type: object description: The meta member contains the meta information of the response. properties: status: $ref: '#/definitions/StatusObject' pagination: $ref: '#/definitions/OffsetBasedPaginationOutputObject' x-property-sort: - status - pagination /factset/etf/allocation/country/listBySymbol: get: tags: - Factset operationId: get/factset/etf/allocation/country/listBySymbol x-supportsOffsetBasedPaging: true x-supportsOffsetBasedPagingWithoutTotal: false x-supportsCursorBasedPaging: false x-supportsCursorBasedPagingWithoutTotal: false x-supportsPush: false x-requiresUser: false x-requiresInternalClient: false x-disallowUser: false x-no-merge: false x-maxSortParameterCount: 10 x-supportsPermissionDeniedResponse: false description: This endpoint returns selected ETP's allocations grouped by country names. The response will be sorted by weight in descending order. summary: Factset This endpoint returns selected ETP's country allocations. parameters: - name: symbol in: query type: string maxLength: 10 exclusiveMaximum: false required: true description: Market symbol of ETP defined by FactSet. - name: _attributes in: query type: array items: type: string maxLength: 100 exclusiveMaximum: false uniqueItems: true maxItems: 50 collectionFormat: csv description: Limit the attributes returned in the response to the specified set. - type: number format: int32 minimum: 0 exclusiveMinimum: false default: 0 description: Non-negative number of entries to skip, or 0 (default). name: _paginationOffset in: query - type: number format: int32 minimum: 0 exclusiveMinimum: false maximum: 500 exclusiveMaximum: false default: 20 description: Non-negative maximum number of entries to return. name: _paginationLimit in: query responses: '200': description: Successful Response schema: type: object properties: data: description: ETP country allocation data. type: object x-property-sort: - reportDate - countries properties: reportDate: type: string format: date description: Reporting date for the allocations. countries: type: array items: type: object x-property-sort: - country - weight properties: country: type: string description: Name of the country. weight: type: number format: real description: Consolidate weight of the position within the ETP by country(s).. uniqueItems: true description: List of allocations by country. meta: type: object description: The meta member contains the meta information of the response. properties: status: $ref: '#/definitions/StatusObject' pagination: $ref: '#/definitions/OffsetBasedPaginationOutputObject' x-property-sort: - status - pagination /factset/etf/allocation/currency/listBySymbol: get: tags: - Factset operationId: get/factset/etf/allocation/currency/listBySymbol x-supportsOffsetBasedPaging: true x-supportsOffsetBasedPagingWithoutTotal: false x-supportsCursorBasedPaging: false x-supportsCursorBasedPagingWithoutTotal: false x-supportsPush: false x-requiresUser: false x-requiresInternalClient: false x-disallowUser: false x-no-merge: false x-maxSortParameterCount: 10 x-supportsPermissionDeniedResponse: false description: This endpoint returns selected ETP's allocations grouped by currency. The response will be sorted by weight in descending order. summary: Factset This endpoint returns selected ETP's currency allocations. parameters: - name: symbol in: query type: string maxLength: 10 exclusiveMaximum: false required: true description: Market symbol of ETP defined by FactSet. - name: _attributes in: query type: array items: type: string maxLength: 100 exclusiveMaximum: false uniqueItems: true maxItems: 50 collectionFormat: csv description: Limit the attributes returned in the response to the specified set. - type: number format: int32 minimum: 0 exclusiveMinimum: false default: 0 description: Non-negative number of entries to skip, or 0 (default). name: _paginationOffset in: query - type: number format: int32 minimum: 0 exclusiveMinimum: false maximum: 500 exclusiveMaximum: false default: 20 description: Non-negative maximum number of entries to return. name: _paginationLimit in: query responses: '200': description: Successful Response schema: type: object properties: data: description: ETP currency allocation data. type: object x-property-sort: - reportDate - currencies properties: reportDate: type: string format: date description: Reporting date for the allocations. currencies: type: array items: type: object x-property-sort: - currency - weight properties: currency: type: string description: Name of the currency. weight: type: number format: real description: Consolidate weight of the position within the ETP by currency allocation(s). uniqueItems: true description: List of allocations by currency. meta: type: object description: The meta member contains the meta information of the response. properties: status: $ref: '#/definitions/StatusObject' pagination: $ref: '#/definitions/OffsetBasedPaginationOutputObject' x-property-sort: - status - pagination /factset/etf/allocation/economicDevelopment/listBySymbol: get: tags: - Factset operationId: get/factset/etf/allocation/economicDevelopment/listBySymbol x-supportsOffsetBasedPaging: true x-supportsOffsetBasedPagingWithoutTotal: false x-supportsCursorBasedPaging: false x-supportsCursorBasedPagingWithoutTotal: false x-supportsPush: false x-requiresUser: false x-requiresInternalClient: false x-disallowUser: false x-no-merge: false x-maxSortParameterCount: 10 x-supportsPermissionDeniedResponse: false description: List of allocations classified by a holding's economic development status (e.g. developed market, frontier market, emerging market). summary: Factset List of allocations classified by a holding's economic development status. parameters: - name: symbol in: query type: string maxLength: 10 exclusiveMaximum: false required: true description: Market symbol of ETP defined by FactSet. - name: _attributes in: query type: array items: type: string maxLength: 100 exclusiveMaximum: false uniqueItems: true maxItems: 50 collectionFormat: csv description: Limit the attributes returned in the response to the specified set. - type: number format: int32 minimum: 0 exclusiveMinimum: false default: 0 description: Non-negative number of entries to skip, or 0 (default). name: _paginationOffset in: query - type: number format: int32 minimum: 0 exclusiveMinimum: false maximum: 500 exclusiveMaximum: false default: 20 description: Non-negative maximum number of entries to return. name: _paginationLimit in: query responses: '200': description: Successful Response schema: type: object properties: data: description: List of allocations. type: object x-property-sort: - reportDate - classifications properties: reportDate: type: string format: date description: Reporting date for the allocations. classifications: type: array items: type: object x-property-sort: - name - weight properties: name: type: string description: 'Name of the classification. Possible values: "Developed Market", "Frontier Market", "Emerging Market", "Rest of World Market"' weight: type: number format: percentage x-convertToRelative: false description: Weight (net) of the classification. description: List of allocations classified by a holding's economic development status, sorted by weight in descending order. meta: type: object description: The meta member contains the meta information of the response. properties: status: $ref: '#/definitions/StatusObject' pagination: $ref: '#/definitions/OffsetBasedPaginationOutputObject' x-property-sort: - status - pagination /factset/etf/allocation/exchange/listBySymbol: get: tags: - Factset operationId: get/factset/etf/allocation/exchange/listBySymbol x-supportsOffsetBasedPaging: true x-supportsOffsetBasedPagingWithoutTotal: false x-supportsCursorBasedPaging: false x-supportsCursorBasedPagingWithoutTotal: false x-supportsPush: false x-requiresUser: false x-requiresInternalClient: false x-disallowUser: false x-no-merge: false x-maxSortParameterCount: 10 x-supportsPermissionDeniedResponse: false description: This endpoint returns selected ETP's allocations grouped by exchanges. The response will be sorted by weight in descending order. summary: Factset This endpoint returns selected ETP's exchange allocations. parameters: - name: symbol in: query type: string maxLength: 10 exclusiveMaximum: false required: true description: Market symbol of ETP defined by FactSet. - name: _attributes in: query type: array items: type: string maxLength: 100 exclusiveMaximum: false uniqueItems: true maxItems: 50 collectionFormat: csv description: Limit the attributes returned in the response to the specified set. - type: number format: int32 minimum: 0 exclusiveMinimum: false default: 0 description: Non-negative number of entries to skip, or 0 (default). name: _paginationOffset in: query - type: number format: int32 minimum: 0 exclusiveMinimum: false maximum: 500 exclusiveMaximum: false default: 20 description: Non-negative maximum number of entries to return. name: _paginationLimit in: query responses: '200': description: Successful Response schema: type: object properties: data: description: ETP exchange allocation data. type: object x-property-sort: - reportDate - exchanges properties: reportDate: type: string format: date description: Reporting date for the allocations. exchanges: type: array items: type: object x-property-sort: - exchange - weight properties: exchange: type: string description: Name of the exchange. weight: type: number format: real description: Consolidate weight of the position within the ETP by exchange(s). uniqueItems: true description: List of allocations by exchange. meta: type: object description: The meta member contains the meta information of the response. properties: status: $ref: '#/definitions/StatusObject' pagination: $ref: '#/definitions/OffsetBasedPaginationOutputObject' x-property-sort: - status - pagination /factset/etf/allocation/industry/listBySymbol: get: tags: - Factset operationId: get/factset/etf/allocation/industry/listBySymbol x-supportsOffsetBasedPaging: true x-supportsOffsetBasedPagingWithoutTotal: false x-supportsCursorBasedPaging: false x-supportsCursorBasedPagingWithoutTotal: false x-supportsPush: false x-requiresUser: false x-requiresInternalClient: false x-disallowUser: false x-no-merge: false x-maxSortParameterCount: 10 x-supportsPermissionDeniedResponse: false description: This endpoint returns selected ETP's allocations grouped by industry. The response will be sorted by weight in descending order. summary: Factset This endpoint returns selected ETP's industry allocations. parameters: - name: symbol in: query type: string maxLength: 10 exclusiveMaximum: false required: true description: Market symbol of ETP defined by FactSet. - name: _attributes in: query type: array items: type: string maxLength: 100 exclusiveMaximum: false uniqueItems: true maxItems: 50 collectionFormat: csv description: Limit the attributes returned in the response to the specified set. - type: number format: int32 minimum: 0 exclusiveMinimum: false default: 0 description: Non-negative number of entries to skip, or 0 (default). name: _paginationOffset in: query - type: number format: int32 minimum: 0 exclusiveMinimum: false maximum: 500 exclusiveMaximum: false default: 20 description: Non-negative maximum number of entries to return. name: _paginationLimit in: query responses: '200': description: Successful Response schema: type: object properties: data: description: ETP industry allocation data. type: object x-property-sort: - reportDate - industries properties: reportDate: type: string format: date description: Reporting date for the allocations. industries: type: array items: type: object x-property-sort: - industry - weight properties: industry: type: string description: Name of the industry. weight: type: number format: real description: Consolidate weight of the position within the ETP by industry(s). uniqueItems: true description: List of allocations by industry. meta: type: object description: The meta member contains the meta information of the response. properties: status: $ref: '#/definitions/StatusObject' pagination: $ref: '#/definitions/OffsetBasedPaginationOutputObject' x-property-sort: - status - pagination /factset/etf/allocation/marketCapitalization/listBySymbol: get: tags: - Factset operationId: get/factset/etf/allocation/marketCapitalization/listBySymbol x-supportsOffsetBasedPaging: true x-supportsOffsetBasedPagingWithoutTotal: false x-supportsCursorBasedPaging: false x-supportsCursorBasedPagingWithoutTotal: false x-supportsPush: false x-requiresUser: false x-requiresInternalClient: false x-disallowUser: false x-no-merge: false x-maxSortParameterCount: 10 x-supportsPermissionDeniedResponse: false description: List of allocations classified by a holding's total market capitalization (e.g. Small Cap, Mid Cap, Large Cap). Response will be sorted by weight in descending order. summary: Factset List of allocations classified by a holding's total market capitalization. parameters: - name: symbol in: query type: string maxLength: 10 exclusiveMaximum: false required: true description: Market symbol of ETP defined by FactSet. - name: _attributes in: query type: array items: type: string maxLength: 100 exclusiveMaximum: false uniqueItems: true maxItems: 50 collectionFormat: csv description: Limit the attributes returned in the response to the specified set. - type: number format: int32 minimum: 0 exclusiveMinimum: false default: 0 description: Non-negative number of entries to skip, or 0 (default). name: _paginationOffset in: query - type: number format: int32 minimum: 0 exclusiveMinimum: false maximum: 500 exclusiveMaximum: false default: 20 description: Non-negative maximum number of entries to return. name: _paginationLimit in: query responses: '200': description: Successful Response schema: type: object properties: data: description: List of allocations. type: object x-property-sort: - reportDate - classifications properties: reportDate: type: string format: date description: Reporting date for the allocations. classifications: type: array items: type: object x-property-sort: - classification - weight properties: classification: type: string description: Name of the classification. weight: type: number format: real description: Weight (net) of the classification. uniqueItems: true description: List of allocations classified by a holding's total market capitalization (e.g. small caps, large caps). meta: type: object description: The meta member contains the meta information of the response. properties: status: $ref: '#/definitions/StatusObject' pagination: $ref: '#/definitions/OffsetBasedPaginationOutputObject' x-property-sort: - status - pagination /factset/etf/allocation/region/listBySymbol: get: tags: - Factset operationId: get/factset/etf/allocation/region/listBySymbol x-supportsOffsetBasedPaging: true x-supportsOffsetBasedPagingWithoutTotal: false x-supportsCursorBasedPaging: false x-supportsCursorBasedPagingWithoutTotal: false x-supportsPush: false x-requiresUser: false x-requiresInternalClient: false x-disallowUser: false x-no-merge: false x-maxSortParameterCount: 10 x-supportsPermissionDeniedResponse: false description: This endpoint returns selected ETP's allocations grouped by region names. The response will be sorted by weight in descending order. summary: Factset This endpoint returns selected ETP's region allocations. parameters: - name: symbol in: query type: string maxLength: 10 exclusiveMaximum: false required: true description: Market symbol of ETP defined by FactSet. - name: _attributes in: query type: array items: type: string maxLength: 100 exclusiveMaximum: false uniqueItems: true maxItems: 50 collectionFormat: csv description: Limit the attributes returned in the response to the specified set. - type: number format: int32 minimum: 0 exclusiveMinimum: false default: 0 description: Non-negative number of entries to skip, or 0 (default). name: _paginationOffset in: query - type: number format: int32 minimum: 0 exclusiveMinimum: false maximum: 500 exclusiveMaximum: false default: 20 description: Non-negative maximum number of entries to return. name: _paginationLimit in: query responses: '200': description: Successful Response schema: type: object properties: data: description: ETP region allocation data. type: object x-property-sort: - reportDate - regions properties: reportDate: type: string format: date description: Reporting date for the allocations. regions: type: array items: type: object x-property-sort: - region - weight properties: region: type: string description: Name of the region. weight: type: number format: real description: Consolidate weight of the position within the ETP by region(s).. uniqueItems: true description: List of allocations by region. meta: type: object description: The meta member contains the meta information of the response. properties: status: $ref: '#/definitions/StatusObject' pagination: $ref: '#/definitions/OffsetBasedPaginationOutputObject' x-property-sort: - status - pagination /factset/etf/allocation/sector/listBySymbol: get: tags: - Factset operationId: get/factset/etf/allocation/sector/listBySymbol x-supportsOffsetBasedPaging: true x-supportsOffsetBasedPagingWithoutTotal: false x-supportsCursorBasedPaging: false x-supportsCursorBasedPagingWithoutTotal: false x-supportsPush: false x-requiresUser: false x-requiresInternalClient: false x-disallowUser: false x-no-merge: false x-maxSortParameterCount: 10 x-supportsPermissionDeniedResponse: false description: This endpoint returns selected ETP's allocations grouped by sector names. The response will be sorted by weight in descending order. summary: Factset This endpoint returns selected ETP's sector allocations. parameters: - name: symbol in: query type: string maxLength: 10 exclusiveMaximum: false required: true description: Market symbol of ETP defined by FactSet. - name: _attributes in: query type: array items: type: string maxLength: 100 exclusiveMaximum: false uniqueItems: true maxItems: 50 collectionFormat: csv description: Limit the attributes returned in the response to the specified set. - type: number format: int32 minimum: 0 exclusiveMinimum: false default: 0 description: Non-negative number of entries to skip, or 0 (default). name: _paginationOffset in: query - type: number format: int32 minimum: 0 exclusiveMinimum: false maximum: 500 exclusiveMaximum: false default: 20 description: Non-negative maximum number of entries to return. name: _paginationLimit in: query responses: '200': description: Successful Response schema: type: object properties: data: description: ETP sector allocation data. type: object x-property-sort: - reportDate - sectors properties: reportDate: type: string format: date description: Reporting date for the allocations. sectors: type: array items: type: object x-property-sort: - sector - weight properties: sector: type: string description: Name of the sector. weight: type: number format: real description: Consolidate weight of the position within the ETP by sector(s). uniqueItems: true description: List of allocations by sector. meta: type: object description: The meta member contains the meta information of the response. properties: status: $ref: '#/definitions/StatusObject' pagination: $ref: '#/definitions/OffsetBasedPaginationOutputObject' x-property-sort: - status - pagination /factset/etf/analytics/getBySymbol: get: tags: - Factset operationId: get/factset/etf/analytics/getBySymbol x-supportsOffsetBasedPaging: false x-supportsOffsetBasedPagingWithoutTotal: false x-supportsCursorBasedPaging: false x-supportsCursorBasedPagingWithoutTotal: false x-supportsPush: false x-requiresUser: false x-requiresInternalClient: false x-disallowUser: false x-no-merge: false x-maxSortParameterCount: 10 x-supportsPermissionDeniedResponse: false description: FactSet's proprietary analytical datapoints include ETP attributes specific to lending, corporate actions, and benchmarks. summary: FactSet proprietary analytics datapoints for ETPs. parameters: - name: symbol in: query type: string maxLength: 10 exclusiveMaximum: false required: true description: Ticker-region of a security as defined by FactSet. - name: _attributes in: query type: array items: type: string maxLength: 100 exclusiveMaximum: false uniqueItems: true maxItems: 50 collectionFormat: csv description: Limit the attributes returned in the response to the specified set. responses: '200': description: Successful Response schema: type: object properties: data: description: Profile analytics. type: object x-property-sort: - asOfDate - securityLending - risk - benchmarkName - indexChange - medianBidAskSpread properties: asOfDate: type: string format: date description: 'Date the analytics data was published. Available for the regions: US, Europe, and Canada.' securityLending: description: Security lending. type: object x-property-sort: - isAllowed - isActive - revenue - revenuePolicy properties: isAllowed: type: boolean description: 'Indicates whether a fund is permitted to lend securities based on their legal structure. Available for the regions: US, Europe, and Canada.' isActive: type: boolean description: 'Indicates that revenue from lending securities was reported on the most recent annual or semi-annual report. Available for the regions: US, Europe, and Canada.' revenue: type: number format: real description: 'The fraction of securities lending revenue that is rebated to the fund rather than kept by the issuer. Available for the regions: US, Europe, and Canada.' revenuePolicy: type: string description: 'English description of the securities lending revenue policy, if any. Available for the regions: US, Europe, and Canada.' risk: description: Risk. type: object x-property-sort: - isCorporateActionPending - counterParty - fundClosure properties: isCorporateActionPending: type: boolean description: 'Indicates a fund whose issuer has any corporate actions pending (e.g. merger, purchase, and closing). Available for the regions: US.' counterParty: type: string description: 'Score predicting the likelihood that an ETN counterparty will default, as measured by 1-year credit default swap rates. Possible values are Low, Medium, or High. Empty for non-ETNs. Available for the regions: US.' fundClosure: type: string description: 'Score estimating the likelihood that a fund will close. Based on a quantitative model. Outputs are Low, Medium, or High. Available for the regions: US.' benchmarkName: type: string description: 'FactSet provides a neutral, broad market index that best represents an ETP segment, giving investors a measuring stick against which to compare a specific ETP. The fund''s performance (for example, R2, beta, and standard deviation) and holdings are measured against it. Available for the regions: US and Europe.' indexChange: type: object x-property-sort: - hasChanged - date description: Index change. properties: hasChanged: type: boolean description: 'States whether an index change has occurred. Available for the regions: US.' date: type: string format: date description: 'Date of the most recent index change, if applicable. Available for the regions: US.' medianBidAskSpread: type: number format: percentage x-convertToRelative: false description: 'The exchange-traded fund’s median bid-ask spread, expressed as a percentage rounded to the nearest hundredth, computed by: (A) Identifying the exchange-traded fund’s national best bid and national best offer as of the end of each 10 second interval during each trading day of the last 30 calendar days; (B) Dividing the ifference between each such bid and offer by the midpoint of the national best bid and national best offer; and (C) Identifying the median of those values. Available for the regions: US.' meta: type: object description: The meta member contains the meta information of the response. properties: status: $ref: '#/definitions/StatusObject' x-property-sort: - status /factset/etf/analytics/holdings/statistics/getBySymbol: get: tags: - Factset operationId: get/factset/etf/analytics/holdings/statistics/getBySymbol x-supportsOffsetBasedPaging: false x-supportsOffsetBasedPagingWithoutTotal: false x-supportsCursorBasedPaging: false x-supportsCursorBasedPagingWithoutTotal: false x-supportsPush: false x-requiresUser: false x-requiresInternalClient: false x-disallowUser: false x-no-merge: false x-maxSortParameterCount: 10 x-supportsPermissionDeniedResponse: false description: FactSet calculates several proprietary portfolio statistics for ETPs including average maturity, credit quality, price/book ratio, price/earnings ratio, and dividend yield. summary: FactSet's portfolio statistics for ETPs. parameters: - name: symbol in: query type: string maxLength: 10 exclusiveMaximum: false required: true description: Ticker-region of a security as defined by FactSet. - name: _attributes in: query type: array items: type: string maxLength: 100 exclusiveMaximum: false uniqueItems: true maxItems: 50 collectionFormat: csv description: Limit the attributes returned in the response to the specified set. responses: '200': description: Successful Response schema: type: object properties: data: description: Portfolio statistics. type: object x-property-sort: - asOfDate - numberHoldings - concentration - dividendYield - priceEarningsRatio - priceBookRatio - marketCapitalization - timeToMaturity - creditRating properties: asOfDate: type: string format: date description: 'Date the analytics data was published. Available for the regions: US, Europe, and Canada.' numberHoldings: type: number format: int32 description: 'A measure of portfolio diversification, calculated by summing the squared weights of each fund constituent. Low concentration implies high diversification, and vice versa. Outputs are Low, Medium or High. Available for regions: US.' concentration: type: string description: 'A measure of portfolio diversification, calculated by summing the squared weights of each fund constituent. Low concentration implies high diversification, and vice versa. Possible values are Low, Medium or High. Available for regions: US.' dividendYield: type: number format: percentage x-convertToRelative: false description: 'The annualized weighted average of the current dividend yield of the portfolio''s holdings, gross of fees. Available for the regions: US.' priceEarningsRatio: type: number format: real description: 'Weighted average ratio of prices of a fund’s stocks values to their trailing earnings of underlying stocks. Aggregate prices are scaled by the sum of individual earnings, including negative earnings. Available for the regions: US.' priceBookRatio: type: number format: real description: 'Weighted average ratio of prices of a fund’s stocks to the book value of underlying stocks. Aggregate prices are scaled by the sum of individual book values. Available for the regions: US.' marketCapitalization: type: number format: real description: 'The weighted average market capitalization of the stocks in the fund''s portfolio (USD). Available for regions: US.' timeToMaturity: type: number format: real description: 'The weighted average of remaining time until maturity for all bonds in the portfolio, measured in (possibly fractional) years. Available for the regions: US.' creditRating: type: string description: 'Average credit rating for the portfolio, determined by mapping ratings from credit agencies (Fitch, Moody''s and Standard & Poor''s) to numerical likelihood of default for each bond in the portfolio and then finding the weighted average default probability, then mapping back to an agency credit rating. Accounts for the nonlinear probability of default when aggregating agency ratings. FactSet has developed a numeric equivalent system that allows math functions such as averaging and comparisons across sources (using greater than, equal to, or less than operators), to facilitate easier evaluation. Available for the regions: US.' meta: type: object description: The meta member contains the meta information of the response. properties: status: $ref: '#/definitions/StatusObject' x-property-sort: - status /factset/etf/analytics/score/getBySymbol: get: tags: - Factset operationId: get/factset/etf/analytics/score/getBySymbol x-supportsOffsetBasedPaging: false x-supportsOffsetBasedPagingWithoutTotal: false x-supportsCursorBasedPaging: false x-supportsCursorBasedPagingWithoutTotal: false x-supportsPush: false x-requiresUser: false x-requiresInternalClient: false x-disallowUser: false x-no-merge: false x-maxSortParameterCount: 10 x-supportsPermissionDeniedResponse: false description: FactSet calculates various proprietary fund rankings including unique scores, fund grades, segment averages, and recommendations. summary: FactSet proprietary ETP rankings. parameters: - name: symbol in: query type: string maxLength: 10 exclusiveMaximum: false required: true description: Ticker-region of a security as defined by FactSet. - name: _attributes in: query type: array items: type: string maxLength: 100 exclusiveMaximum: false uniqueItems: true maxItems: 50 collectionFormat: csv description: Limit the attributes returned in the response to the specified set. responses: '200': description: Successful Response schema: type: object properties: data: description: Score analytics. type: object x-property-sort: - efficiency - tradability - fit - grade - analystPick - onOpportunitiesList - fitRsquared - beta - standardDeviationDown properties: efficiency: type: object x-property-sort: - value - average description: Efficiency. properties: value: type: number format: real description: 'A measure of how well a fund delivers on its core promise of delivering the returns of an underlying index, taking into account the expense ratio, tracking error, tax risk, fund closure risk and structural risk. In the range 0 (low) to 100 (high). Available for the regions: US.' average: type: number format: real description: 'The average efficiency score for all funds in the segment. Available for the regions: US.' tradability: type: object x-property-sort: - value - average description: Tradability. properties: value: type: number format: real description: 'A total view of the liquidity of a fund taking into account share-level liquidity as well as the underlying liquidity of a fund''s portfolio of securities. In the range 0 (low) to 100 (high). Available for the regions: US.' average: type: number format: real description: 'The average tradability score for all funds in the segment. Available for the regions: US.' fit: type: object x-property-sort: - value - average description: Fit. properties: value: type: number format: real description: 'A measure of the exposure a fund provides relative to its FactSet designated ''Segment Benchmark''. Scored in the range 0 (low) to 100 (high), with higher scores indicating better alignment with the performance and holdings of the Segment Benchmark. Available for the regions: US.' average: type: number format: real description: 'The average Fit score for all funds in the segment. Available for the regions: US.' grade: type: string description: 'Combining the efficiency and tradability scores, FactSet assigns a letter grade (A-F) that provides a concise view on how efficient and tradable each ETP is. Available for the regions: US.' analystPick: type: boolean description: 'If true, this fund has been chosen by the FactSet ETP Analytics Team to provide comprehensive, market-like exposure to an area of the market/segment, keeping costs and liquidity in mind. Available for the regions: US.' onOpportunitiesList: type: boolean description: 'If true, this fund has been chosen by the FactSet ETP Analytics Team as providing potentially valuable but alternative exposure to the market/segment, keeping costs and liquidity in mind. Available for the regions: US.' fitRsquared: type: number format: real description: 'The degree to which the daily returns of fund NAV and its FactSet designated segment benchmark move up and down in unison, ranging from 1.0 (perfect co-movement) to zero (no relation). Available for the regions: US.' beta: type: object x-property-sort: - value - up - down description: Beta. properties: value: type: number format: real description: 'The sensitivity of the returns of the fund to the movement of the FactSet designated ''segment benchmark''. Beta of 1.0 means magnitude of fund returns equals that of segment benchmark returns. Available for the regions: US.' up: type: number format: real description: 'A comparison of a fund''s return to the FactSet-designated benchmark''s for days when the benchmark is up. Ideally down beta is less than or equal to overall beta. Available for the regions: US.' down: type: number format: real description: 'A comparison of a fund''s return to the FactSet-designated benchmark''s for days when the benchmark is down. Ideally down beta is less than or equal to overall beta. Available for the regions: US.' standardDeviationDown: type: number format: real description: 'A measure of the variability between the fund''s returns and the FactSet designated segment benchmark returns on days when the fund underperforms the benchmark. Available for the regions: US.' meta: type: object description: The meta member contains the meta information of the response. properties: status: $ref: '#/definitions/StatusObject' x-property-sort: - status /factset/etf/analytics/trade/getBySymbol: get: tags: - Factset operationId: get/factset/etf/analytics/trade/getBySymbol x-supportsOffsetBasedPaging: false x-supportsOffsetBasedPagingWithoutTotal: false x-supportsCursorBasedPaging: false x-supportsCursorBasedPagingWithoutTotal: false x-supportsPush: false x-requiresUser: false x-requiresInternalClient: false x-disallowUser: false x-no-merge: false x-maxSortParameterCount: 10 x-supportsPermissionDeniedResponse: false description: Various metrics of an ETP's liquidity including creation metrics, premium/discount, spread, and tracking error statistics. summary: Factset Trade statistics for specific ETP. parameters: - name: symbol in: query type: string maxLength: 10 exclusiveMaximum: false required: true description: Ticker-region of a security as defined by FactSet. - name: _attributes in: query type: array items: type: string maxLength: 100 exclusiveMaximum: false uniqueItems: true maxItems: 50 collectionFormat: csv description: Limit the attributes returned in the response to the specified set. responses: '200': description: Successful Response schema: type: object properties: data: description: Trade analytics. type: object x-property-sort: - impedimentsToCreation - premiumDiscount - blockTrade - spread - trackingDifference properties: impedimentsToCreation: type: object x-property-sort: - value - reason description: Impediments to creation. properties: value: type: string description: 'Indicates whether a fund is fully or partially closed to creations, or is likely to become fully or partially closed to creations. Values are None, Potential, Partial, Full. Available for the regions: US.' reason: type: string description: 'States the reason why there is an impediment to creations. Available for the regions: US.' premiumDiscount: type: object x-property-sort: - median - max description: The difference between the last share price of the ETF and its end-of-day net asset value (NAV). A positive difference is called premium and a negative difference is called discount. properties: median: type: number format: real description: 'The median premium or discount over the last 12 months. Available for the regions: US.' max: type: number format: real description: 'The greatest absolute amount that the market price exceeded (premium) and lagged (discount) its net asset value (NAV) over a 12-month period. Available for the regions: US.' blockTrade: description: Properties of the ETP with respect to large trades. type: object x-property-sort: - overlapHours - underlyingVolumePerUnit - liquidity - creationUnitPerDay properties: overlapHours: type: number format: real description: 'A measurement of the overlap between the hours of trading for the ETF and that of its underlying portfolio. Available for the regions: US.' underlyingVolumePerUnit: type: number format: percentage x-convertToRelative: false description: 'Weighted average of the ratios of each underlying''s number of shares, represented in one creation unit of the ETP, relative to the median daily trading volume of the underlying over 45 trading days, expressed as a percentage. This is a measure of the liquidity available in the underlying portfolio of the ETP, whereby larger numbers indicate greater likelihood of adverse price impact on underlying securities from ETF creations/redemptions. Only applicable for ETF. Available for the regions: US.' liquidity: type: number format: int32 description: 'A measurement of the liquidity available in an ETF for a hypothetical 1,000,000 USD trade. Measured on a scale of 0 to 5 -- 5 being very liquid and easy to execute, 1 being expensive and difficult to execute, and 0 indicating a closed or restricted creation window. Available for the regions: US.' creationUnitPerDay: type: number format: real description: 'The median 45 day share volume divided by the creation unit size of the fund. The higher the number, the more likely that liquidity providers will trade the fund in size, or in odd lots. Available for the regions: US.' spread: description: The 45-day median of daily time-weighted dollar or percentage difference between the highest posted price a market participant is willing to pay to buy an ETF and the lowest posted price at which a market participant is willing to sell an ETF. type: object x-property-sort: - absolute - relative properties: absolute: type: number format: real description: 'Dollar spread difference. Available for the regions: US.' relative: type: number format: percentage x-convertToRelative: false description: 'Percentage spread difference. Available for the regions: US.' trackingDifference: type: object x-property-sort: - median - maxUpside - maxDownside description: Tracking difference. properties: median: type: number format: percentage x-convertToRelative: false description: 'The median difference between NAV and fund index returns over a one-year set of rolling 12 month holding periods. This statistic captures all inputs to tracking difference: expense ratio, optimization, securities lending income, and tax recapture. Available for the regions: US.' maxUpside: type: number format: percentage x-convertToRelative: false description: 'Greatest, or least negative 12-month difference between NAV and index returns over a rolling 12 month period. Available for the regions: US.' maxDownside: type: number format: percentage x-convertToRelative: false description: 'Most negative or least positive 12-month difference between NAV and index returns over a rolling 12 month period. Available for the regions: US.' meta: type: object description: The meta member contains the meta information of the response. properties: status: $ref: '#/definitions/StatusObject' x-property-sort: - status /factset/etf/characteristics/getBySymbol: get: tags: - Factset operationId: get/factset/etf/characteristics/getBySymbol x-supportsOffsetBasedPaging: false x-supportsOffsetBasedPagingWithoutTotal: false x-supportsCursorBasedPaging: false x-supportsCursorBasedPagingWithoutTotal: false x-supportsPush: false x-requiresUser: false x-requiresInternalClient: false x-disallowUser: false x-no-merge: false x-maxSortParameterCount: 10 x-supportsPermissionDeniedResponse: false description: An ETP has many unique characteristics specific to its composition that differentiate it from other products. This includes details on leverage, hedging, derivatives, and service providers. summary: Factset Retrieve basic characteristic information for a specified ETP. parameters: - name: symbol in: query type: string maxLength: 10 exclusiveMaximum: false required: true description: Market symbol of ETF defined by FactSet. - name: _attributes in: query type: array items: type: string maxLength: 100 exclusiveMaximum: false uniqueItems: true maxItems: 50 collectionFormat: csv description: Limit the attributes returned in the response to the specified set. responses: '200': description: Successful Response schema: type: object properties: data: description: Characteristics. type: object x-property-sort: - gearing - hedge - counterParty - serviceProvider properties: gearing: description: Gearing. type: object x-property-sort: - isInverseFund - leverage - exposureResetPeriod properties: isInverseFund: type: boolean description: Flags ETPs that deliver short exposure to an index, including leveraged short exposure. This data is available for all the regions. leverage: description: Leverage. type: object x-property-sort: - isLeverageFund - factor - type properties: isLeverageFund: type: boolean description: Flags ETPs that deliver leveraged long exposure to an index. This data is available for all the regions. factor: type: number format: real description: Leverage factor of leveraged and inverse ETPs (2x, 3x, 1.5x, -1.5x, -2x, -3x, variable). This data is available for all the regions. type: type: string description: Determines if leverage factor is fixed or variable. This data is available for all the regions. exposureResetPeriod: type: string description: Exposure reset frequency of leveraged and inverse ETPs, text and standardized value available. This data is available for all the regions. x-enum-description: - Daily. - Variable. - None. - Monthly. - Quarterly. enum: - Daily - Variable - None - Monthly - Quarterly hedge: description: Hedge. type: object x-property-sort: - isHedged - sourceCurrency - targetCurrency properties: isHedged: type: boolean description: Flags ETPs that are hedged to eliminate or reduce foreign currency exposure for US investors. This data is available for all the regions. sourceCurrency: type: string description: For currency-hedged funds, the values shows foreign currency the ETP is hedged against. Currency code is in ISO 4217 format. This data is available for all the regions. targetCurrency: type: string description: For currency-hedged funds, the currency the ETP is exposed to after hedging. Currency code is in ISO 4217 format. This data is available for all the regions. counterParty: description: Counter Party. type: object x-property-sort: - credit - swap - holdsDerivatives properties: credit: type: string description: Name of the ETP's credit counterparty. This data is available for all the regions. swap: type: string description: Name of the ETP's swap counterparty. This data is available for all the regions. holdsDerivatives: type: boolean description: Flags ETPs that are expected to hold OTC derivatives in the course of normal fund operations. This data is available for the US and Canada regions. serviceProvider: description: Service Provider. type: object x-property-sort: - primaryAdvisor - subAdvisor - distributor - isIssuerAffiliate properties: primaryAdvisor: type: string description: The name of the primary advisor of the ETP. This data is available for the US and Canada regions. subAdvisor: type: string description: The name of the sub-advisor of the ETP. This data is available for the US and Canada regions. distributor: type: string description: The name of the distributor of the ETP. This data is available for the US region. isIssuerAffiliate: type: boolean description: Describes whether the swap counterparty is affiliated with the issuer. This data is available for the Europe regions. meta: type: object description: The meta member contains the meta information of the response. properties: status: $ref: '#/definitions/StatusObject' x-property-sort: - status /factset/etf/class/getBySymbol: get: tags: - Factset operationId: get/factset/etf/class/getBySymbol x-supportsOffsetBasedPaging: false x-supportsOffsetBasedPagingWithoutTotal: false x-supportsCursorBasedPaging: false x-supportsCursorBasedPagingWithoutTotal: false x-supportsPush: false x-requiresUser: false x-requiresInternalClient: false x-disallowUser: false x-no-merge: false x-maxSortParameterCount: 10 x-supportsPermissionDeniedResponse: false description: 'ETP classification is divided into three categories: Asset Class, Geography, and Investment Strategy. Asset class is determined based on the various asset types held by the fund, A fund''s geography can be classified by region (e.g. Asia-Pac), specific geography (e.g. China) or economic development (e.g. BRIC). An ETP''s investment strategy is classified in broad categories (e.g. Large Cap) and more granular categorizations.' summary: Factset Retrieve an ETP's classification specific to asset class, geography, or investment strategy. parameters: - name: symbol in: query type: string maxLength: 10 exclusiveMaximum: false required: true description: Market symbol of ETP defined by FactSet. - name: _attributes in: query type: array items: type: string maxLength: 100 exclusiveMaximum: false uniqueItems: true maxItems: 50 collectionFormat: csv description: Limit the attributes returned in the response to the specified set. responses: '200': description: Successful Response schema: type: object properties: data: description: Class information of given ETP. type: object x-property-sort: - asset - economicDevelopment - geography - category properties: asset: type: string description: Asset class of ETP holdings (Equity, Fixed Income, Currency, Commodities, Asset Allocation, or Alternatives), text and standardized value available. This data is available for all the regions. x-enum-description: - Equity. - Alternatives. - Fixed Income. - Commodities. - Currency. - Asset Allocation. enum: - Equity - Alternatives - Fixed Income - Commodities - Currency - Asset Allocation economicDevelopment: type: string description: The country development level of the ETP's holdings (Developed, Emerging, Frontier, or Blended), text and standardized value available. This data is available for all the regions. x-enum-description: - Developed Markets. - Blended Development. - Emerging Markets. - Frontier Markets. enum: - Developed Markets - Blended Development - Emerging Markets - Frontier Markets geography: description: geography. type: object x-property-sort: - region - specific properties: region: type: string description: The broad regional exposure of the ETP's holdings (e.g., Latin America, Asia-Pacific, Global), text and standardized value available. This data is available for all the regions. x-enum-description: - Europe. - North America. - Global. - Developed Markets. - Asia-Pacific. - Global Ex-U.S. - Emerging Markets. - Latin America. - Middle East & Africa. - Frontier Markets. enum: - Europe - North America - Global - Developed Markets - Asia-Pacific - Global Ex-U.S. - Emerging Markets - Latin America - Middle East & Africa - Frontier Markets specific: type: string description: The specific geographic exposure of the ETP's holdings (e.g., BRICs, Chile, Asia-Pacific Ex-Japan), text and standardized value available. This data is available for all the regions. See endpoint /factset/etf/class/geography/list for possible values category: description: category. type: object x-property-sort: - broad - focus - niche properties: broad: type: string description: The 1st of 3 asset-class-specific, hierarchical exposure tiers; the broadest category the ETP falls under within its asset class (e.g., Size & Style, Sector, Precious Metals, Absolute Returns), text and standardized value available. This data is available for all the regions. Please refer /factset/etf/class/category/broad/list for possible values. focus: type: string description: The 2nd of 3 asset-class-specific, hierarchical exposure tiers; the ETP's classification within its category (e.g., Small Cap, Energy, Palladium, Long/Short), text and standardized value available. This data is available for all the regions. Please refer /factset/etf/class/category/focus/list for possible values. niche: type: string description: The 3rd of 3 asset-class-specific, hierarchical exposure tiers; The ETP's classification within its Focus. Most granular tier of exposure sort (e.g., Growth, Coal, Physically held, Merger Arbitrage), text and standardized value available. This data is available for all the regions. Please refer /factset/etf/class/category/niche/list for possible values. meta: type: object description: The meta member contains the meta information of the response. properties: status: $ref: '#/definitions/StatusObject' x-property-sort: - status /factset/etf/class/category/broad/list: get: tags: - Factset operationId: get/factset/etf/class/category/broad/list x-supportsOffsetBasedPaging: false x-supportsOffsetBasedPagingWithoutTotal: false x-supportsCursorBasedPaging: false x-supportsCursorBasedPagingWithoutTotal: false x-supportsPush: false x-requiresUser: false x-requiresInternalClient: false x-disallowUser: false x-no-merge: false x-maxSortParameterCount: 10 x-supportsPermissionDeniedResponse: false description: List of ETP class broad categories. summary: Factset List of ETP class broad categories. responses: '200': description: Successful Response schema: type: object properties: data: type: array items: type: object x-property-sort: - broadCategory properties: broadCategory: type: string description: ETP class broad category. uniqueItems: true description: List of ETP class broad categories. meta: type: object description: The meta member contains the meta information of the response. properties: status: $ref: '#/definitions/StatusObject' x-property-sort: - status parameters: - name: _attributes in: query type: array items: type: string maxLength: 100 exclusiveMaximum: false uniqueItems: true maxItems: 50 collectionFormat: csv description: Limit the attributes returned in the response to the specified set. /factset/etf/class/category/focus/list: get: tags: - Factset operationId: get/factset/etf/class/category/focus/list x-supportsOffsetBasedPaging: true x-supportsOffsetBasedPagingWithoutTotal: false x-supportsCursorBasedPaging: false x-supportsCursorBasedPagingWithoutTotal: false x-supportsPush: false x-requiresUser: false x-requiresInternalClient: false x-disallowUser: false x-no-merge: false x-maxSortParameterCount: 10 x-supportsPermissionDeniedResponse: false description: List of ETP class focus categories. summary: Factset List of ETP class focus categories. responses: '200': description: Successful Response schema: type: object properties: data: type: array items: type: object x-property-sort: - focusCategory properties: focusCategory: type: string description: ETP class focus category. uniqueItems: true description: List of focus categories. meta: type: object description: The meta member contains the meta information of the response. properties: status: $ref: '#/definitions/StatusObject' pagination: $ref: '#/definitions/OffsetBasedPaginationOutputObject' x-property-sort: - status - pagination parameters: - name: _attributes in: query type: array items: type: string maxLength: 100 exclusiveMaximum: false uniqueItems: true maxItems: 50 collectionFormat: csv description: Limit the attributes returned in the response to the specified set. - type: number format: int32 minimum: 0 exclusiveMinimum: false default: 0 description: Non-negative number of entries to skip, or 0 (default). name: _paginationOffset in: query - type: number format: int32 minimum: 0 exclusiveMinimum: false maximum: 500 exclusiveMaximum: false default: 20 description: Non-negative maximum number of entries to return. name: _paginationLimit in: query /factset/etf/class/category/niche/list: get: tags: - Factset operationId: get/factset/etf/class/category/niche/list x-supportsOffsetBasedPaging: true x-supportsOffsetBasedPagingWithoutTotal: false x-supportsCursorBasedPaging: false x-supportsCursorBasedPagingWithoutTotal: false x-supportsPush: false x-requiresUser: false x-requiresInternalClient: false x-disallowUser: false x-no-merge: false x-maxSortParameterCount: 10 x-supportsPermissionDeniedResponse: false description: List of ETP class niche categories. summary: Factset List of ETP class niche categories. responses: '200': description: Successful Response schema: type: object properties: data: type: array items: type: object x-property-sort: - nicheCategory properties: nicheCategory: type: string description: ETP class niche category. uniqueItems: true description: List of niche categories. meta: type: object description: The meta member contains the meta information of the response. properties: status: $ref: '#/definitions/StatusObject' pagination: $ref: '#/definitions/OffsetBasedPaginationOutputObject' x-property-sort: - status - pagination parameters: - name: _attributes in: query type: array items: type: string maxLength: 100 exclusiveMaximum: false uniqueItems: true maxItems: 50 collectionFormat: csv description: Limit the attributes returned in the response to the specified set. - type: number format: int32 minimum: 0 exclusiveMinimum: false default: 0 description: Non-negative number of entries to skip, or 0 (default). name: _paginationOffset in: query - type: number format: int32 minimum: 0 exclusiveMinimum: false maximum: 500 exclusiveMaximum: false default: 20 description: Non-negative maximum number of entries to return. name: _paginationLimit in: query /factset/etf/class/geography/list: get: tags: - Factset operationId: get/factset/etf/class/geography/list x-supportsOffsetBasedPaging: false x-supportsOffsetBasedPagingWithoutTotal: false x-supportsCursorBasedPaging: false x-supportsCursorBasedPagingWithoutTotal: false x-supportsPush: false x-requiresUser: false x-requiresInternalClient: false x-disallowUser: false x-no-merge: false x-maxSortParameterCount: 10 x-supportsPermissionDeniedResponse: false description: List of ETP class geographies. summary: Factset List of ETP class geographies. responses: '200': description: Successful Response schema: type: object properties: data: type: array items: type: object x-property-sort: - name properties: name: type: string description: Name of the geography. uniqueItems: true description: List of class geographies. meta: type: object description: The meta member contains the meta information of the response. properties: status: $ref: '#/definitions/StatusObject' x-property-sort: - status parameters: - name: _attributes in: query type: array items: type: string maxLength: 100 exclusiveMaximum: false uniqueItems: true maxItems: 50 collectionFormat: csv description: Limit the attributes returned in the response to the specified set. /factset/etf/competitors/listBySymbol: get: tags: - Factset operationId: get/factset/etf/competitors/listBySymbol x-supportsOffsetBasedPaging: false x-supportsOffsetBasedPagingWithoutTotal: false x-supportsCursorBasedPaging: false x-supportsCursorBasedPagingWithoutTotal: false x-supportsPush: false x-requiresUser: false x-requiresInternalClient: false x-disallowUser: false x-no-merge: false x-maxSortParameterCount: 10 x-supportsPermissionDeniedResponse: false description: FactSet defines and maintains a proprietary list of competing companies based on a number of attributes specific to a fund. summary: FactSet's proprietary list of competing companies. parameters: - name: symbol in: query type: string maxLength: 10 exclusiveMaximum: false required: true description: Ticker-region of a security as defined by FactSet. - name: _attributes in: query type: array items: type: string maxLength: 100 exclusiveMaximum: false uniqueItems: true maxItems: 50 collectionFormat: csv description: Limit the attributes returned in the response to the specified set. responses: '200': description: Successful Response schema: type: object properties: data: type: array items: type: object x-property-sort: - symbol - name properties: symbol: type: string description: Ticker-region as defined by FactSet. name: type: string description: Name of the competitor. uniqueItems: true description: Competitor's data. meta: type: object description: The meta member contains the meta information of the response. properties: status: $ref: '#/definitions/StatusObject' x-property-sort: - status /factset/etf/distribution/getBySymbol: get: tags: - Factset operationId: get/factset/etf/distribution/getBySymbol x-supportsOffsetBasedPaging: false x-supportsOffsetBasedPagingWithoutTotal: false x-supportsCursorBasedPaging: false x-supportsCursorBasedPagingWithoutTotal: false x-supportsPush: false x-requiresUser: false x-requiresInternalClient: false x-disallowUser: false x-no-merge: false x-maxSortParameterCount: 10 x-supportsPermissionDeniedResponse: false description: Retrieve distribution-related details for a specific ETP including dividend and capital gain distribution details. summary: Factset Retrieve an ETP's current distribution details. parameters: - name: symbol in: query type: string maxLength: 10 exclusiveMaximum: false required: true description: Market symbol of ETP defined by FactSet. - name: _attributes in: query type: array items: type: string maxLength: 100 exclusiveMaximum: false uniqueItems: true maxItems: 50 collectionFormat: csv description: Limit the attributes returned in the response to the specified set. responses: '200': description: Successful Response schema: type: object properties: data: description: Distribution. type: object x-property-sort: - dividend - capitalGains - totalDistribution - distributionYield properties: dividend: description: Dividend information for the next dividend. type: object x-property-sort: - isReported - exDividendDate - qualified - nonQualified - returnOfCapital properties: isReported: type: boolean description: States whether the ETP's next ex-dividend date is posted on the issuer's website. This data is available for all the regions. exDividendDate: type: string format: date description: The ex-dividend date of the ETP's next distribution. This data is available for all the regions. qualified: type: number format: real description: Qualified dividend payment on ex-dividend-date indicates the amount of distribution considered to have a more favorable tax treatment. This data is available for all regions. nonQualified: type: number format: real description: Non-Qualified dividend payment on ex-dividend-date indicates the amount of distribution that is taxed as ordinary income. This data is available for all regions. returnOfCapital: type: number format: real description: Return of Capital available on ex-dividend-date. This data is available for all regions. capitalGains: description: Capital Gains. type: object x-property-sort: - shortTerm - longTerm properties: shortTerm: type: number format: real description: Total short term capital gains on ex-date indicates the amount of the distribution that is subject to short term tax rates.This data is available for all the regions. longTerm: type: number format: real description: Total long term capital gains on ex-date indicates the amount of the distribution that is subject to long term tax rates. This data is available for all the regions. totalDistribution: type: number format: real description: Total Distribution on exDividend-date. Values are in the ETP's listing currency in the ISO 4217 format. This data is available for all regions. Please refer currency.listing in /factset/etf/getBySymbol for currency value. distributionYield: type: number format: real description: Total 12-month distribution of the ETP multiplied by split factor then divided by its net asset value. Data is split adjusted. This data is available for the US regions. meta: type: object description: The meta member contains the meta information of the response. properties: status: $ref: '#/definitions/StatusObject' x-property-sort: - status /factset/etf/fundFlows/getBySymbol: get: tags: - Factset operationId: get/factset/etf/fundFlows/getBySymbol x-supportsOffsetBasedPaging: false x-supportsOffsetBasedPagingWithoutTotal: false x-supportsCursorBasedPaging: false x-supportsCursorBasedPagingWithoutTotal: false x-supportsPush: false x-requiresUser: false x-requiresInternalClient: false x-disallowUser: false x-no-merge: false x-maxSortParameterCount: 10 x-supportsPermissionDeniedResponse: false description: Retrieve the amount invested or divested in a specific ETP over various time periods including one-day, one-week, one-month, one-year, and YTD. summary: Factset Retrieve an ETP's cash inflow/outflows for various time periods. parameters: - name: symbol in: query type: string maxLength: 10 exclusiveMaximum: false required: true description: Market symbol of ETP defined by FactSet. - name: _attributes in: query type: array items: type: string maxLength: 100 exclusiveMaximum: false uniqueItems: true maxItems: 50 collectionFormat: csv description: Limit the attributes returned in the response to the specified set. responses: '200': description: Successful Response schema: type: object properties: data: description: Fund flows (i.e., the amount invested or divested from a fund) based on the creation/redemption process. The data returned may not be related to overall volume or price movement. All fund flow inputs use transaction-day values to ensure that all assets under management (AUM) and flows are fully comparable and reflective of the same, verified market conditions. This data is available for all the regions. type: object x-property-sort: - flows1D - flows1W - flows1M - flowsYTD - flows1Y properties: flows1D: type: number format: real description: One-day fund flows. This data is available for all the regions. flows1W: type: number format: real description: One-week fund flows. This data is available for all the regions. flows1M: type: number format: real description: One-month fund flows. This data is available for all the regions. flowsYTD: type: number format: real description: Year-to-date fund flows. This data is available for all the regions. flows1Y: type: number format: real description: One-year fund flows. This data is available for all the regions. meta: type: object description: The meta member contains the meta information of the response. properties: status: $ref: '#/definitions/StatusObject' x-property-sort: - status /factset/etf/growthOfTenK/listBySymbol: get: tags: - Factset operationId: get/factset/etf/growthOfTenK/listBySymbol x-supportsOffsetBasedPaging: true x-supportsOffsetBasedPagingWithoutTotal: false x-supportsCursorBasedPaging: false x-supportsCursorBasedPagingWithoutTotal: false x-supportsPush: false x-requiresUser: false x-requiresInternalClient: false x-disallowUser: false x-no-merge: false x-maxSortParameterCount: 10 x-supportsPermissionDeniedResponse: false description: Growth of 10K (or growth of 10,000) is a commonly used chart that highlights the change in the value of an initial 10,000 investment in the ETP during a given period of time. Often, this period of time is either since inception or the calculation between the pre-defined range. summary: Factset This endpoint returns selected ETP's Growth of 10K calculated values. parameters: - name: symbol in: query type: string maxLength: 10 exclusiveMaximum: false required: true description: Market symbol of ETP defined by FactSet. - name: timePeriod in: query type: string required: false description: Historice NAV date value. x-enum-description: - One month. - Three months. - Six months. - Year to date. - One year. - Three year. - Five years. - Ten years. - Since Inception. enum: - 1M - 3M - 6M - YTD - 1Y - 3Y - 5Y - 10Y - SI - name: calculationType in: query type: string required: false description: Historice NAV date value. x-enum-description: - Interval - Growth of 10000 calculated based on pre-defined time Period. - Since Inception - Growth of 10000 calculation starts from the inception. enum: - I - SI - name: alignment in: query type: string required: false description: Indicates the reference point for growth of 10k data. x-enum-description: - Growth of 10k data is shown relative to the most recent (usually daily) end-of-day 10k value, NAV change percent. - Growth of 10k data is shown relative to the 10k value, NAV change percent at the most recent end-of-week. - Growth of 10k data is shown relative to the 10k value, NAV change percent at the most recent end-of-month. enum: - day - week-end - month-end - name: _attributes in: query type: array items: type: string maxLength: 100 exclusiveMaximum: false uniqueItems: true maxItems: 50 collectionFormat: csv description: Limit the attributes returned in the response to the specified set. - type: number format: int32 minimum: 0 exclusiveMinimum: false default: 0 description: Non-negative number of entries to skip, or 0 (default). name: _paginationOffset in: query - type: number format: int32 minimum: 0 exclusiveMinimum: false maximum: 500 exclusiveMaximum: false default: 20 description: Non-negative maximum number of entries to return. name: _paginationLimit in: query responses: '200': description: Successful Response schema: type: object properties: data: type: array items: type: object x-property-sort: - navDate - tenkValue - tenkPercentChange properties: navDate: type: string format: date description: Growth of the 10k calculation date tenkValue: type: number format: real description: Growth of the 10k calculation value. tenkPercentChange: type: number format: real description: Growth of the 10k calculation percent change. uniqueItems: true description: Growth of TenK data. meta: type: object description: The meta member contains the meta information of the response. properties: status: $ref: '#/definitions/StatusObject' pagination: $ref: '#/definitions/OffsetBasedPaginationOutputObject' x-property-sort: - status - pagination /factset/etf/holdings/listBySymbol: get: tags: - Factset operationId: get/factset/etf/holdings/listBySymbol x-supportsOffsetBasedPaging: true x-supportsOffsetBasedPagingWithoutTotal: false x-supportsCursorBasedPaging: false x-supportsCursorBasedPagingWithoutTotal: false x-supportsPush: false x-requiresUser: false x-requiresInternalClient: false x-disallowUser: false x-no-merge: false x-maxSortParameterCount: 10 x-supportsPermissionDeniedResponse: false description: Retrieve an ETP's holdings information including security, shares held, and weight. summary: Factset Holdings details for an individual ETP. parameters: - name: symbol in: query type: string maxLength: 10 exclusiveMaximum: false required: true description: Market symbol of ETP defined by FactSet. - name: _attributes in: query type: array items: type: string maxLength: 100 exclusiveMaximum: false uniqueItems: true maxItems: 50 collectionFormat: csv description: Limit the attributes returned in the response to the specified set. - type: number format: int32 minimum: 0 exclusiveMinimum: false default: 0 description: Non-negative number of entries to skip, or 0 (default). name: _paginationOffset in: query - type: number format: int32 minimum: 0 exclusiveMinimum: false maximum: 500 exclusiveMaximum: false default: 20 description: Non-negative maximum number of entries to return. name: _paginationLimit in: query responses: '200': description: Successful Response schema: type: object properties: data: type: array items: type: object x-property-sort: - symbol - name - securityType - exchange - reportDate - shares - marketValue - currencyCode - weight properties: symbol: type: string description: Identifier of the holding. (when available). name: type: string description: Name of the holding. securityType: type: string description: Financial instrument type of the holding. exchange: type: object x-property-sort: - code - name description: Exchange. properties: code: type: string description: Short Code of the exchange where holding is listed. This data is available for all the regions. name: type: string description: Name of the exchange where holding is listed. This data is available for all the regions. reportDate: type: string format: date description: Reporting date of the holding. shares: type: number format: real description: Number of shares held, unadjusted for corporate actions. marketValue: type: number format: real description: Market value of the holding, unadjusted for corporate actions. currencyCode: type: string description: Code representing the currency of the holding and it's in format ISO 4217 weight: type: number format: real description: Weight of the holding within the ETP. uniqueItems: true description: ETP holdings data. meta: type: object description: The meta member contains the meta information of the response. properties: status: $ref: '#/definitions/StatusObject' pagination: $ref: '#/definitions/OffsetBasedPaginationOutputObject' x-property-sort: - status - pagination /factset/etf/marketAggregates/getBySymbol: get: tags: - Factset operationId: get/factset/etf/marketAggregates/getBySymbol x-supportsOffsetBasedPaging: false x-supportsOffsetBasedPagingWithoutTotal: false x-supportsCursorBasedPaging: false x-supportsCursorBasedPagingWithoutTotal: false x-supportsPush: false x-requiresUser: false x-requiresInternalClient: false x-disallowUser: false x-no-merge: false x-maxSortParameterCount: 10 x-supportsPermissionDeniedResponse: false description: Market Aggregates combines FactSet Estimates, FactSet Fundamentals, and FactSet Prices data to derive ratios and per share values on an aggregate level. The resulting index values can be used to identify market trends and compare a combination of portfolios, benchmarks, and individual securities. summary: Factset Market aggregate data for ETPs. parameters: - name: symbol in: query type: string maxLength: 10 exclusiveMaximum: false required: true description: Ticker-region of an ETP as defined by FactSet. - name: _attributes in: query type: array items: type: string maxLength: 100 exclusiveMaximum: false uniqueItems: true maxItems: 50 collectionFormat: csv description: Limit the attributes returned in the response to the specified set. responses: '200': description: Successful Response schema: type: object properties: data: description: Market Aggregates type: object x-property-sort: - asOfDate - optionAdjustedSpread - averageLife properties: asOfDate: type: string format: date description: 'Date the analytics data was published. Available for the regions: US, Europe,and Canada.' optionAdjustedSpread: description: Option-adjusted spread (OAS) value of the ETP; measurement of the yield spread calculated after removing any embedded options providing users with a spread of an option-free bond. type: object x-property-sort: - range0 - range0To100 - range100To200 - range200To300 - range300To400 - range400To500 - range500To600 - range600To700 - range700To800 - range800To900 - range900To1000 - range1000Plus properties: range0: type: number format: percentage x-convertToRelative: false description: OAS value of the ETP. range0To100: type: number format: percentage x-convertToRelative: false description: OAS weight of the ETP ranges between 0 to 99.9. range100To200: type: number format: percentage x-convertToRelative: false description: OAS weight of the ETP ranges between 100 to 199.99. range200To300: type: number format: percentage x-convertToRelative: false description: OAS weight of the ETP ranges between 200 to 299.99. range300To400: type: number format: percentage x-convertToRelative: false description: OAS weight of the ETF ranges between 300 to 399.99. range400To500: type: number format: percentage x-convertToRelative: false description: OAS weight of the ETF ranges between 400 to 499.99. range500To600: type: number format: percentage x-convertToRelative: false description: OAS weight of the ETF ranges between 500 to 599.99. range600To700: type: number format: percentage x-convertToRelative: false description: OAS weight of the ETF ranges between 600 to 699.99. range700To800: type: number format: percentage x-convertToRelative: false description: OAS weight of the ETF ranges between 700 to 799.99. range800To900: type: number format: percentage x-convertToRelative: false description: OAS weight of the ETF ranges between 800 to 899.99. range900To1000: type: number format: percentage x-convertToRelative: false description: OAS weight of the ETF ranges between 900 to 999.99. range1000Plus: type: number format: percentage x-convertToRelative: false description: OAS weight of the ETF ranges above 1000. averageLife: description: Average life type: object x-property-sort: - span - span0To1 - span1To2 - span2To3 - span3To5 - span5To7 - span7To10 - span10To15 - span15To20 - span20Plus properties: span: type: number format: percentage x-convertToRelative: false description: Average life value of the ETP. span0To1: type: number format: percentage x-convertToRelative: false description: Average life value of the ETP ranges between 0 and 1 years. span1To2: type: number format: percentage x-convertToRelative: false description: Average life value of the ETP ranges between 1 and 2 years. span2To3: type: number format: percentage x-convertToRelative: false description: Average life value of the ETP ranges between 2 and 3 years. span3To5: type: number format: percentage x-convertToRelative: false description: Average life value of the ETP ranges between 3 and 5 years. span5To7: type: number format: percentage x-convertToRelative: false description: Average life value of the ETP ranges between 5 and 7 years. span7To10: type: number format: percentage x-convertToRelative: false description: Average life value of the ETP ranges between 7 and 10 years. span10To15: type: number format: percentage x-convertToRelative: false description: Average life value of the ETP ranges between 10 and 15 years. span15To20: type: number format: percentage x-convertToRelative: false description: Average life value of the ETP ranges between 15 and 20 years. span20Plus: type: number format: percentage x-convertToRelative: false description: Average life value of the ETP ranges above 20 years. meta: type: object description: The meta member contains the meta information of the response. properties: status: $ref: '#/definitions/StatusObject' x-property-sort: - status /factset/etf/premiumDiscount/summary/listBySymbol: get: tags: - Factset operationId: get/factset/etf/premiumDiscount/summary/listBySymbol x-supportsOffsetBasedPaging: true x-supportsOffsetBasedPagingWithoutTotal: false x-supportsCursorBasedPaging: false x-supportsCursorBasedPagingWithoutTotal: false x-supportsPush: false x-requiresUser: false x-requiresInternalClient: false x-disallowUser: false x-no-merge: false x-maxSortParameterCount: 10 x-supportsPermissionDeniedResponse: false description: Summary of ETP premium discount data. summary: Factset Summary of ETP premium discount data. parameters: - name: symbol in: query type: string maxLength: 10 exclusiveMaximum: false required: true description: Market symbol of ETP defined by FactSet. - name: timePeriod in: query type: string required: false default: YTD description: Time frame of the data. x-enum-description: - Year to date. - Two year. - Three year. - Five years. enum: - YTD - 2Y - 3Y - 5Y - name: alignment in: query type: string required: false default: quarter-end description: Indicates the reference point for the historical NAV and price values. x-enum-description: - Premium/discount/neutral data is shown relative to ETP's NAV and price at the most recent end-of-month. - Premium/discount/neutral data is shown relative to ETP's NAV and price at the most recent end-of-quarter. - Premium/discount/neutral data is shown relative to ETP's NAV and price at the most recent end-of-year. enum: - month-end - quarter-end - year-end - name: _attributes in: query type: array items: type: string maxLength: 100 exclusiveMaximum: false uniqueItems: true maxItems: 50 collectionFormat: csv description: Limit the attributes returned in the response to the specified set. - type: number format: int32 minimum: 0 exclusiveMinimum: false default: 0 description: Non-negative number of entries to skip, or 0 (default). name: _paginationOffset in: query - type: number format: int32 minimum: 0 exclusiveMinimum: false maximum: 500 exclusiveMaximum: false default: 20 description: Non-negative maximum number of entries to return. name: _paginationLimit in: query responses: '200': description: Successful Response schema: type: object properties: data: description: ETP's premium discount summary data. type: object x-property-sort: - asOfDate - summary properties: asOfDate: type: string format: date description: As of date of the premium discount summary data. summary: type: array items: type: object x-property-sort: - reportDate - count properties: reportDate: type: string format: date description: Report date of premium/discount/neutral count. count: type: object x-property-sort: - premium - discount - neutral description: Count of premium, disount and neutral. properties: premium: type: number format: int32 description: Number of days ETP is traded at premium. discount: type: number format: int32 description: Number of days ETP is traded at discount. neutral: type: number format: int32 description: Number of days ETP is neither traded at discount nor at premium. uniqueItems: true description: Summary of premium/discout/neutral data. meta: type: object description: The meta member contains the meta information of the response. properties: status: $ref: '#/definitions/StatusObject' pagination: $ref: '#/definitions/OffsetBasedPaginationOutputObject' x-property-sort: - status - pagination /factset/etf/price/getBySymbol: get: tags: - Factset operationId: get/factset/etf/price/getBySymbol x-supportsOffsetBasedPaging: false x-supportsOffsetBasedPagingWithoutTotal: false x-supportsCursorBasedPaging: false x-supportsCursorBasedPagingWithoutTotal: false x-supportsPush: false x-requiresUser: false x-requiresInternalClient: false x-disallowUser: false x-no-merge: false x-maxSortParameterCount: 10 x-supportsPermissionDeniedResponse: false description: Retrieve an ETP's historical NAV and shares outstanding for a specified time range. summary: Factset Retrieve historical ETP NAV values. parameters: - name: symbol in: query type: string maxLength: 10 exclusiveMaximum: false required: true description: Market symbol of ETP defined by FactSet. - name: _attributes in: query type: array items: type: string maxLength: 100 exclusiveMaximum: false uniqueItems: true maxItems: 50 collectionFormat: csv description: Limit the attributes returned in the response to the specified set. responses: '200': description: Successful Response schema: type: object properties: data: description: Price. type: object x-property-sort: - nav - sharesOutstanding properties: nav: description: Nav. type: object x-property-sort: - value - currency - startDate - last - totalReturn properties: value: type: number format: real description: Daily net asset value (NAV) of the ETP. This data is available for all the regions. currency: type: string description: Currency of the ETP's NAV in ISO 4217 format. This data is available for all the regions. x-enum-description: - Swiss franc. - Canadian dollar. - United States dollar. - Euro. - Mexican peso. - Pound sterling. - Penny sterling. - Swedish krona/kronor. - Japanese yen. enum: - CHF - CAD - USD - EUR - MXN - GBP - GBX - SEK - JPY startDate: type: string format: date description: Date of first available NAV ex-date. This data is available for all the regions. last: description: Last. type: object x-property-sort: - value - date properties: value: type: number format: real description: Last available NAV value, in case of the daily NAV value is missing. This data is available for all the regions. date: type: string format: date description: Date of last available NAV. This data is available for all the regions. totalReturn: type: number format: real description: ETP NAV calculated by reinvesting dividends and compounding returns. This data is available for all the regions. sharesOutstanding: description: Shares outstanding. type: object x-property-sort: - value - lastValue - earliestDate properties: value: type: number format: real description: Daily shares outstanding (i.e., actual values) for a ETP. This data is available for all the regions. lastValue: type: number format: real description: Last available shares outstanding for a ETP. This data is available for all the regions. earliestDate: type: string format: date description: Returns the earliest date for which a shares outstanding figure is available. This data is available for all the regions. meta: type: object description: The meta member contains the meta information of the response. properties: status: $ref: '#/definitions/StatusObject' x-property-sort: - status /factset/etf/returns/getBySymbol: get: tags: - Factset operationId: get/factset/etf/returns/getBySymbol x-supportsOffsetBasedPaging: false x-supportsOffsetBasedPagingWithoutTotal: false x-supportsCursorBasedPaging: false x-supportsCursorBasedPagingWithoutTotal: false x-supportsPush: false x-requiresUser: false x-requiresInternalClient: false x-disallowUser: false x-no-merge: false x-maxSortParameterCount: 10 x-supportsPermissionDeniedResponse: false description: An ETP's total return data can be returned for various time frames including 1-month, 3-month, YTD, 1-year, 3-year, and 5-year. Total return calculations include price performance plus reinvested and compounded distributions. Market price is used to calcualte market returns. Portfolio nav is used to calcualte nav returns. summary: Factset Retrieve total return data for a specified ETP. parameters: - name: symbol in: query type: string maxLength: 10 exclusiveMaximum: false required: true description: Market symbol of ETP defined by FactSet. - name: returnType in: query type: string maxLength: 5 exclusiveMaximum: false required: false default: price description: Return type. x-enum-description: - Price Returns. - NAV Returns. enum: - price - nav - name: _attributes in: query type: array items: type: string maxLength: 100 exclusiveMaximum: false uniqueItems: true maxItems: 50 collectionFormat: csv description: Limit the attributes returned in the response to the specified set. responses: '200': description: Successful Response schema: type: object properties: data: description: Returns. type: object x-property-sort: - return1M - return3M - returnYTD - return1Y - return3Y - return5Y properties: return1M: type: number format: real description: 1 month performance. This data is available for the US regions. return3M: type: number format: real description: 3 month performance. This data is available for the US regions. returnYTD: type: number format: real description: YTD performance. This data is available for the US regions. return1Y: type: number format: real description: 1 year performance. This data is available for the US regions. return3Y: type: number format: real description: 3 year performance. This data is available for the US regions. return5Y: type: number format: real description: 5 year performance. This data is available for the US regions. meta: type: object description: The meta member contains the meta information of the response. properties: status: $ref: '#/definitions/StatusObject' x-property-sort: - status /factset/etf/strategy/getBySymbol: get: tags: - Factset operationId: get/factset/etf/strategy/getBySymbol x-supportsOffsetBasedPaging: false x-supportsOffsetBasedPagingWithoutTotal: false x-supportsCursorBasedPaging: false x-supportsCursorBasedPagingWithoutTotal: false x-supportsPush: false x-requiresUser: false x-requiresInternalClient: false x-disallowUser: false x-no-merge: false x-maxSortParameterCount: 10 x-supportsPermissionDeniedResponse: false description: ETP's can be classified in many different ways including investment strategy, security weightings, and fund composition. summary: Factset Retrieve various classification details for a specified ETP. parameters: - name: symbol in: query type: string maxLength: 10 exclusiveMaximum: false required: true description: Market symbol of ETP defined by FactSet. - name: _attributes in: query type: array items: type: string maxLength: 100 exclusiveMaximum: false uniqueItems: true maxItems: 50 collectionFormat: csv description: Limit the attributes returned in the response to the specified set. responses: '200': description: Successful Response schema: type: object properties: data: description: Strategy. type: object x-property-sort: - description - group - cluster - selectCriteria - weighting - segment - isTransparent - fundOfFunds properties: description: type: string description: Descriptive Summary of the methods used by a ETP or its index in selection and weighting of its holdings, text and standardized value available. This data is available for the US and Canada regions. group: type: string description: Factset's strategy group is the broadest way sort ETPs with a similar investment strategy. This data is available for the US and Canada regions. cluster: type: string description: Factset's strategy cluster is a collection of ETPs with a similar investment strategy, yet smaller than strategy group. This data item is more granular and narrow than the strategy group yet bigger than strategy group. This data is available for the US and Canada regions. selectCriteria: type: string description: Description of the security selection criteria used by the ETP or its index (e.g., Market Cap, Earnings, Dividends), text and standardized value available. This data is available for all the regions. weighting: type: string description: Text that specifies the weighting selection criteria used by the ETP or its index (e.g., Market Cap, Equal, Momentum, Fundamental) , text and standardized value available. This data is available for all the regions. segment: type: string description: Determines the unique segment the ETP falls into, based on FactSet ETP Analytics rules-based classification system determined by geography, category, focus, and niche. Text and standardized value available for this data item. This data is available for the US regions. See endpoint /factset/etf/strategy/segment/list for possible values. isTransparent: type: boolean description: Description that States whether or not the methodology behind the underlying index can be clearly understood from offering documents. This data is available for the US and Canada regions. fundOfFunds: type: string description: Description of the ETP that holds a portfolio of other ETPs. This data is available for the Canada regions. meta: type: object description: The meta member contains the meta information of the response. properties: status: $ref: '#/definitions/StatusObject' x-property-sort: - status /factset/etf/strategy/segment/list: get: tags: - Factset operationId: get/factset/etf/strategy/segment/list x-supportsOffsetBasedPaging: true x-supportsOffsetBasedPagingWithoutTotal: false x-supportsCursorBasedPaging: false x-supportsCursorBasedPagingWithoutTotal: false x-supportsPush: false x-requiresUser: false x-requiresInternalClient: false x-disallowUser: false x-no-merge: false x-maxSortParameterCount: 10 x-supportsPermissionDeniedResponse: false description: Retrieve the various segments assigned to a specific ETP. Segment data is used to group funds for comparison and relative performance analyses. summary: Factset Retrieve a list of ETP strategy segments. responses: '200': description: Successful Response schema: type: object properties: data: type: array items: type: object x-property-sort: - name properties: name: type: string description: Name of the segment. uniqueItems: true description: List of strategy segments. meta: type: object description: The meta member contains the meta information of the response. properties: status: $ref: '#/definitions/StatusObject' pagination: $ref: '#/definitions/OffsetBasedPaginationOutputObject' x-property-sort: - status - pagination parameters: - name: _attributes in: query type: array items: type: string maxLength: 100 exclusiveMaximum: false uniqueItems: true maxItems: 50 collectionFormat: csv description: Limit the attributes returned in the response to the specified set. - type: number format: int32 minimum: 0 exclusiveMinimum: false default: 0 description: Non-negative number of entries to skip, or 0 (default). name: _paginationOffset in: query - type: number format: int32 minimum: 0 exclusiveMinimum: false maximum: 500 exclusiveMaximum: false default: 20 description: Non-negative maximum number of entries to return. name: _paginationLimit in: query /factset/etf/structure/getBySymbol: get: tags: - Factset operationId: get/factset/etf/structure/getBySymbol x-supportsOffsetBasedPaging: false x-supportsOffsetBasedPagingWithoutTotal: false x-supportsCursorBasedPaging: false x-supportsCursorBasedPagingWithoutTotal: false x-supportsPush: false x-requiresUser: false x-requiresInternalClient: false x-disallowUser: false x-no-merge: false x-maxSortParameterCount: 10 x-supportsPermissionDeniedResponse: false description: Retrieve details on a fund's structure including its type, investment style (active/passive), and legal structure. summary: Factset Retrieve the basic structure information for a specified ETP. parameters: - name: symbol in: query type: string maxLength: 10 exclusiveMaximum: false required: true description: Market symbol of ETP defined by FactSet. - name: _attributes in: query type: array items: type: string maxLength: 100 exclusiveMaximum: false uniqueItems: true maxItems: 50 collectionFormat: csv description: Limit the attributes returned in the response to the specified set. responses: '200': description: Successful Response schema: type: object properties: data: description: Structure. type: object x-property-sort: - isEtn - type - isActivelyManaged - backing - syntheticType - legalStructure - isUcitsCompliant - isHoldingsTransparent - portfolioDisclosure - cashFlowFrequency - isEligibleForRegisteredAccounts - isDripEligible properties: isEtn: type: boolean description: Flags exchange-traded notes. This data is available for all the regions. type: type: string description: Describes the legal structure of the ETP, text and standardized value available. This data is available for all the regions. isActivelyManaged: type: boolean description: Flags ETPs that are actively managed as per SEC guidelines. This data is available for all the regions. backing: type: string description: Describes whether the ETP holds underlying securities or uses derivatives to gain its desired exposure, text and standardized value available. This data is available for all the regions. syntheticType: type: string description: Indicates whether the synthetic ETP is “unfunded” (collateral or substitute basket of securities for the swap agreement is owned by ETP), or “funded” (collateral for swap agreement is held by a custodian in the name of the ETP or in the name of the counterparty, pledged to the ETP issuer), text and standardized value available. This data is available for Europe only. legalStructure: type: string description: The organizational structure of the ETP, text and standardized value available. This data is available for all the regions. isUcitsCompliant: type: boolean description: The counterparty for derivative exposure for synthetic ETPs. This data is available for all the regions. isHoldingsTransparent: type: boolean description: States whether or not the ETP's issuer discloses its positions on its website daily. This data is available for all the regions. portfolioDisclosure: type: string description: The frequency of an issuer's disclosure of all ETP holdings on its website, text and standardized value available. This data is available for all the regions. cashFlowFrequency: type: string description: States how often the ETP makes regular distributions, text and standardized value available. This data is available only for US and Europe. isEligibleForRegisteredAccounts: type: boolean description: Product can be held in tax-advantaged investment accounts. This data is available for Canada only. isDripEligible: type: boolean description: Ability to have dividends reinvested. This data is available for Canada only. meta: type: object description: The meta member contains the meta information of the response. properties: status: $ref: '#/definitions/StatusObject' x-property-sort: - status /factset/etf/taxesAndFees/us/getBySymbol: get: tags: - Factset operationId: get/factset/etf/taxesAndFees/us/getBySymbol x-supportsOffsetBasedPaging: false x-supportsOffsetBasedPagingWithoutTotal: false x-supportsCursorBasedPaging: false x-supportsCursorBasedPagingWithoutTotal: false x-supportsPush: false x-requiresUser: false x-requiresInternalClient: false x-disallowUser: false x-no-merge: false x-maxSortParameterCount: 10 x-supportsPermissionDeniedResponse: false description: Retrieve various fee and tax related details on a specified ETP including expense ratio and tax treatment for dividends and capital gains. summary: Factset Retrieve the tax and fee related information for a specified ETP. parameters: - name: symbol in: query type: string maxLength: 10 exclusiveMaximum: false required: true description: Market symbol of ETP defined by FactSet. - name: _attributes in: query type: array items: type: string maxLength: 100 exclusiveMaximum: false uniqueItems: true maxItems: 50 collectionFormat: csv description: Limit the attributes returned in the response to the specified set. responses: '200': description: Successful Response schema: type: object properties: data: description: Taxes and fees. type: object x-property-sort: - maxCapitalGainsRate - dividendTreatment - distributeK1 - taxType - taxOnDistributions - expenseRatio - potentialCostIncreaseDate - contractAdvisoryFee - capitalGains - capitalGainsDistirbutions3Y - managementExpenseRatio - managementFee - tradingExpenseRatio - feeWaiver properties: maxCapitalGainsRate: description: Max capital gains rate. type: object x-property-sort: - longTerm - shortTerm properties: longTerm: type: number format: real description: The maximum US federal personal income tax rate that applies to long-term capital gains associated with the ETP. This data is available for the US regions. shortTerm: type: number format: real description: The maximum US federal personal income tax rate that applies to short-term capital gains associated with the ETP. This data is available for the US regions. dividendTreatment: type: string description: Describes whether dividend income received by the ETP is distributed to ETP shareholders or capitalised (reinvested) into the ETP, text and standardized value available. This data is available for all the Canada and Europe regions. distributeK1: type: string description: Flags ETPs that distribute K-1 tax forms. This data is available for the US regions. taxType: type: string description: Type of the tax applicable on the distribution. This data is available for the US regions. taxOnDistributions: type: string description: Tax treatment of the ETP's regular distributions. This data is available for the US regions. expenseRatio: description: Expense ratio. type: object x-property-sort: - value - potential properties: value: type: number format: real description: Typically the net total annual fee the issuer deducts from ETP assets as a management fee. Also can include where applicable acquired ETP fees, short interest expense, index fees, and financing fees. Breakeven rate is reported for commodity pools. This data is available for all the regions. potential: type: number format: real description: The full expense ratio before any fee waivers. This data is available fo the US and Canada regions. potentialCostIncreaseDate: type: string format: date description: Expiration date of any fee waivers. This data is available for the US and Canada regions. contractAdvisoryFee: type: number format: real description: The advisors fee excluding any additional costs or fees; A subset of the total expense ratio. This data is available for the Canada regions. capitalGains: type: number format: real description: Realized capital gains or losses reported on the ETP's most recent annual or semi-annual report. Gains must generally be paid out as a distribution at year-end, while losses can be banked to offset future gains. This data is available only for the US regions. capitalGainsDistirbutions3Y: type: number format: real description: The average annual capital gains paid out to shareholders over the past 3 calendar years, measured as a percent of net asset value (NAV) on the final trading day of each previous year. This data is available for the US region only. managementExpenseRatio: type: number format: real description: Total net annual cost associated with holding the ETP, expressed as a percentage. This data is available for the Canada regions. managementFee: type: number format: real description: Annual fee collected by fund manager, expressed as a percentage. This data is available for the Canada region. tradingExpenseRatio: type: number format: real description: Estimated annual costs associated with trading the underlying holdings. This data is available for the Canada region. feeWaiver: type: string description: A reduction in annual ETP expenses, expressed as a percentage. This data is available for the Canada region. meta: type: object description: The meta member contains the meta information of the response. properties: status: $ref: '#/definitions/StatusObject' x-property-sort: - status /factset/etf/timeSeries/listBySymbol: get: tags: - Factset operationId: get/factset/etf/timeSeries/listBySymbol x-supportsOffsetBasedPaging: true x-supportsOffsetBasedPagingWithoutTotal: false x-supportsCursorBasedPaging: false x-supportsCursorBasedPagingWithoutTotal: false x-supportsPush: false x-requiresUser: false x-requiresInternalClient: false x-disallowUser: false x-no-merge: false x-maxSortParameterCount: 10 x-supportsPermissionDeniedResponse: false description: Retrieve the historical NAV data and the respective fund flows and shares outstanding for a specified fund and time period. Please refer currency.fund in /factset/etf/getBySymbol for currency value. summary: Factset Retrieve historical NAV data for a specified ETP. parameters: - name: symbol in: query type: string maxLength: 10 exclusiveMaximum: false required: true description: Market symbol of ETP defined by FactSet. - name: timePeriod in: query type: string required: false default: 1Y description: Time frame of the data. x-enum-description: - One month. - Three months. - Six months. - Year to date. - One year. - Two year. - Three year. - Five years. - Ten years. - Since Inception. enum: - 1M - 3M - 6M - YTD - 1Y - 2Y - 3Y - 5Y - 10Y - SI - name: alignment in: query type: string required: false description: Indicates the reference point for the time series data. x-enum-description: - Time series data is shown relative to the most recent (usually daily) end-of-day NAV. - Time series data is shown relative to the NAV at the most recent end-of-week. - Time series data is shown relative to the NAV at the most recent end-of-month. enum: - day - week-end - month-end - name: _attributes in: query type: array items: type: string maxLength: 100 exclusiveMaximum: false uniqueItems: true maxItems: 50 collectionFormat: csv description: Limit the attributes returned in the response to the specified set. - type: number format: int32 minimum: 0 exclusiveMinimum: false default: 0 description: Non-negative number of entries to skip, or 0 (default). name: _paginationOffset in: query - type: number format: int32 minimum: 0 exclusiveMinimum: false maximum: 1000 exclusiveMaximum: false default: 20 description: Non-negative maximum number of entries to return. name: _paginationLimit in: query responses: '200': description: Successful Response schema: type: object properties: data: type: array items: type: object x-property-sort: - navDate - nav - navChange - navChangePercent - premiumDiscount - fundFlows - sharesOutstanding - aum properties: navDate: type: string format: date description: Historice NAV date value. nav: type: number format: real description: Returns historic Net Asset Value of the ETP. navChange: type: number format: real description: Absolute change in NAV value. navChangePercent: type: number format: real description: Related change in the NAV value. premiumDiscount: type: number format: real description: Difference between market price and NAV of the ETP. fundFlows: type: number format: real description: This value returns factset's ETF fundflow history. Rolling one day fund flows are calculated using the difference of shares outstanding at previous close and shares outstanding one day prior to close mulitplied by the NAV of one day prior to close. sharesOutstanding: type: number format: real description: Returns the historic share Outstanding values of the ETP. aum: type: number format: real description: Returns the historic Total Asset Value of the ETP. uniqueItems: true description: Time series. meta: type: object description: The meta member contains the meta information of the response. properties: status: $ref: '#/definitions/StatusObject' pagination: $ref: '#/definitions/OffsetBasedPaginationOutputObject' x-property-sort: - status - pagination /factset-benchmarks/v1/constituents: get: tags: - Factset summary: Factset Returns the Requested Benchmark Constituents and Respective Weights, Price and Market Value. operationId: getBenchmarkConstituents description: "Returns the requested Benchmark Constituents and respective Weights, Price and Market Value. You must be authorized for the `ids` requested. Use the helper endpoint **/id-list** for valid identifiers. \n" parameters: - $ref: '#/components/parameters/constituentIds' - $ref: '#/components/parameters/requestedDate' - $ref: '#/components/parameters/currency' - $ref: '#/components/parameters/regionCalendar' responses: '200': description: Benchmark data items content: application/json: schema: $ref: '#/components/schemas/benchmarkConstituentsResponse' examples: Result of Benchmark Constituent id SPY-US: $ref: '#/components/examples/resultofBenchmarkIDSPY-US' '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' x-microcks-operation: delay: 0 dispatcher: FALLBACK post: tags: - Factset summary: Factset Returns the Requested Benchmark Constituents and Respective Weights, Price and Market Value. description: 'Returns the requested Benchmark Constituents and respective Weights, Price and Market Value. You must be authorized for the `ids` requested. Use the helper endpoint **/id-list** for valid identifiers. ' operationId: getBenchmarkConstituentsForList requestBody: required: true description: Requests Benchmark Constituents for the given identifier and date. content: application/json: schema: $ref: '#/components/schemas/benchmarkConstituentsRequest' responses: '200': description: Benchmark data items content: application/json: schema: $ref: '#/components/schemas/benchmarkConstituentsResponse' examples: Result of Benchmark Constituent SPY-US: $ref: '#/components/examples/resultofBenchmarkIDSPY-US' '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' x-microcks-operation: delay: 0 dispatcher: FALLBACK /factset-benchmarks/v1/fixed-income-constituents: get: tags: - Factset summary: Factset Returns the Requested Fixed Income Benchmark Constituents and Respective Weights, Price and Market Value. operationId: getFIBenchmarkConstituents description: 'Returns the requested Fixed Income Benchmark Constituents and respective Weights, Price and Market Value. You must be authorized for the `ids` requested. ' parameters: - $ref: '#/components/parameters/fIConstituentIds' - $ref: '#/components/parameters/requestedDate' - $ref: '#/components/parameters/currency' responses: '200': description: Fixed Income Constituent data items content: application/json: schema: $ref: '#/components/schemas/fixedIncomeBenchmarkConstituentsResponse' '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' x-microcks-operation: delay: 0 dispatcher: FALLBACK post: tags: - Factset summary: Factset Returns the Requested Benchmark Constituents and Respective Weights, Price and Market Value. description: 'Returns the requested Fixed Income Benchmark Constituents and respective Weights, Price and Market Value. You must be authorized for the `ids` requested. ' operationId: getFIBenchmarkConstituentsForList requestBody: required: true description: Requests Fixed Income Benchmark Constituents for the given identifier and date. content: application/json: schema: $ref: '#/components/schemas/fixedIncomeBenchmarkConstituentsRequest' responses: '200': description: Fixed Income Constituent data items content: application/json: schema: $ref: '#/components/schemas/fixedIncomeBenchmarkConstituentsResponse' '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' x-microcks-operation: delay: 0 dispatcher: FALLBACK /factset-benchmarks/v1/index-snapshot: get: summary: Factset Index Level Prices, Returns, and Related Information as of a Single Date. operationId: getIndexSnapshot tags: - Factset description: 'Retrieves Index Level Prices and Returns information as of a specific date. Simply submit a valid Benchmark ID (you can use the /id-list endpoint for a sample list of ids), and date and retrieve Index Level Prices, Returns, and related information. ' parameters: - $ref: '#/components/parameters/indexIds' - $ref: '#/components/parameters/requestedDate' - $ref: '#/components/parameters/returnType' - $ref: '#/components/parameters/currency' - $ref: '#/components/parameters/calendar' responses: '200': description: An array of Index Level Prices and Returns information as of a single date content: application/json: schema: $ref: '#/components/schemas/indexSnapshotResponse' examples: Index Level Prices and Returns snapshot for S&P 500 and Russell 3000 as of 2020-08-06: $ref: '#/components/examples/resultofIndexSnapshotMultiple' '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' x-microcks-operation: delay: 0 dispatcher: FALLBACK post: summary: Factset Retrieves the Index Level Snapshot of Prices and Returns Information for a Given Identifier and Single Date. operationId: getIndexSnapshotForList tags: - Factset description: 'Retrieves Index Level Prices and Returns information as aligned with FactSet''s Benchmark Data Feed solution. Simply submit a valid Benchmark ID (you can use the /id-list endpoint for a sample list of ids), and date and retrieve Index Level Prices, Returns, and related information. ' requestBody: required: true description: Requests the Index Level Snapshot for a requested list of identifiers and specified date. content: application/json: schema: $ref: '#/components/schemas/indexSnapshotRequest' responses: '200': description: An array of Index Level Prices and Returns information as of a single date. content: application/json: schema: $ref: '#/components/schemas/indexSnapshotResponse' examples: Index Level Prices and Returns snapshot for S&P 500 and Russell 3000 as of 2020-08-06: $ref: '#/components/examples/resultofIndexSnapshotMultiple' '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' x-microcks-operation: delay: 0 dispatcher: FALLBACK /factset-benchmarks/v1/index-history: get: summary: Factset Retrieves Index Level Prices and Returns Information for a List of Identifiers and Historical Date Range. operationId: getIndexHistory tags: - Factset description: 'Retrieves Index Level Prices and Returns information as of a date range requested. Simply submit a valid Benchmark ID (you can use the /id-list endpoint for a sample list of ids), and date range to retrieve Index Level Prices, Returns, and related information. ' parameters: - $ref: '#/components/parameters/indexIds' - $ref: '#/components/parameters/startDate' - $ref: '#/components/parameters/endDate' - $ref: '#/components/parameters/frequency' - $ref: '#/components/parameters/returnType' - $ref: '#/components/parameters/hedgeType' - $ref: '#/components/parameters/currency' - $ref: '#/components/parameters/calendar' - $ref: '#/components/parameters/impliedDate' responses: '200': description: An array of Index Level Prices and Returns information for a requested date range. content: application/json: schema: $ref: '#/components/schemas/indexHistoryResponse' examples: Index Level Prices and Returns snapshot for S&P 500 and Russell 3000 from 2020-08-05 to 2020-08-06: $ref: '#/components/examples/resultofIndexHistoryMultiple' '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' x-microcks-operation: delay: 0 dispatcher: FALLBACK post: summary: Factset Retrieves Index Level Prices and Returns Information for a List of Identifiers and Historical Date Range. operationId: getIndexHistoryForList tags: - Factset description: 'Retrieves Index Level Prices and Returns information as aligned with FactSet''s Benchmark Data Feed solution. Simply submit a valid Benchmark ID (you can use the /id-list endpoint for a sample list of ids), and date and retrieve Index Level Prices, Returns, and related information. ' requestBody: required: true description: Requests Index Level History Prices and Returns for a list of identifiers and specified date range. content: application/json: schema: $ref: '#/components/schemas/indexHistoryRequest' responses: '200': description: An array of Index Level Prices and Returns information for a requested date range. content: application/json: schema: $ref: '#/components/schemas/indexHistoryResponse' examples: Index Level Prices and Returns snapshot for S&P 500 and Russell 3000 from 2020-08-05 to 2020-08-06: $ref: '#/components/examples/resultofIndexHistoryMultiple' '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' x-microcks-operation: delay: 0 dispatcher: FALLBACK /factset-benchmarks/v1/ratios: get: tags: - Factset summary: Factset Returns the Aggregated Ratios of a Requested Benchmark operationId: getBenchmarkRatios description: 'Retrieves the index level ratios for a requested benchmark. Ratios supported are expressed through metrics parameter, and include Categories of Profitability, Valuation, Coverage, and Leverage.
Using FactSet Market Aggregates, the service combines fundamental, estimates, and pricing content to derive ratios and per share values for global equity market indexes and commercial benchmark vendors. The constituents of the index are fetched on rolling basis over time period requested, and then the metric requested is aggregated up to the index level. To learn more about FMA, visit [OA 15778](https://my.apps.factset.com/oa/pages/15778).
' parameters: - $ref: '#/components/parameters/indexIds' - $ref: '#/components/parameters/metrics' - $ref: '#/components/parameters/startDate' - $ref: '#/components/parameters/endDate' - $ref: '#/components/parameters/frequency' - $ref: '#/components/parameters/periodicity' - $ref: '#/components/parameters/currency' responses: '200': description: Benchmark Ratio data items content: application/json: schema: $ref: '#/components/schemas/benchmarkRatiosResponse' examples: All Index Level Ratios for S&P 500 as of latest year end: $ref: '#/components/examples/allRatiosSP50' '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' x-microcks-operation: delay: 0 dispatcher: FALLBACK post: tags: - Factset summary: Factset Returns the Aggregated Ratios of a Requested Benchmark description: 'Retrieves the index level ratios for a requested benchmark. Ratios supported are expressed through metrics parameter, and include Categories of Profitability, Valuation, Coverage, and Leverage.Using FactSet Market Aggregates, the service combines FactSet Fundamental, FactSet Estimates, and FactSet Pricing content to derive ratios and per share values for global equity market indexes and commercial benchmark vendors. The constituents of the index are fetched on rolling basis over time period requested, and then the metric requested is aggregated up to the index level. To learn more about FMA, visit [OA 15778](https://my.apps.factset.com/oa/pages/15778).
' operationId: getBenchmarkRatiosForList requestBody: required: true description: Requests benchmark ratios for a given id content: application/json: schema: $ref: '#/components/schemas/benchmarkRatiosRequest' examples: Requesting all Index Level Ratios: $ref: '#/components/examples/allRatiosRequest' responses: '200': description: Benchmark Ratio Response Items content: application/json: schema: $ref: '#/components/schemas/benchmarkRatiosResponse' examples: All Index Level Ratios for S&P 500 as of latest year end: $ref: '#/components/examples/allRatiosSP50' '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' x-microcks-operation: delay: 0 dispatcher: FALLBACK /factset-benchmarks/v1/id-list: get: summary: Factset Returns a Sample List of Benchmark Identifiers and the Benchmark Categorization to Use in Other Benchmark Api Endpoints. operationId: getBenchmarkIds tags: - Factset description: Returns a **sample** list of Benchmark Identifiers to use in other Benchmark API endpoints. This is a supporting API to be use alongside the other Benchmark API endpoints. For example, use the fsymID value returned in this response as the input to your `ids` parameter in the /constituents endpoint to return constituents for that id.*This is not the full list of benchmark ids allowed in this service, but rather a representation of the most commonly requested. For complete assistance with ID lookup or concordance services, please reach out to FactSet Support. *
parameters: - $ref: '#/components/parameters/familyFilter' responses: '200': description: List of sample Benchmark Ids content: application/json: schema: $ref: '#/components/schemas/benchmarkIdListResponse' examples: Result of Benchmark Constituent SPY-US: $ref: '#/components/examples/resultofBenchmarkID-TOPIX' '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' x-microcks-operation: delay: 0 dispatcher: FALLBACK post: summary: Factset Returns a Sample List of Benchmark Identifiers and the Benchmark Categorization to Use in Other Benchmark Api Endpoints. operationId: getBenchmarkIdsForList tags: - Factset description: Returns a **sample** list of Benchmark Identifiers to use in other Benchmark API endpoints. This is a supporting API to be use alongside the other Benchmark API endpoints. For example, use the fsymID value returned in this response as the input to your `ids` parameter in the /constituents endpoint to return constituents for that id.*This is not the full list of benchmark ids allowed in this service, but rather a representation of the most commonly requested. For complete assistance with ID lookup or concordance services, please reach out to FactSet Support.*
requestBody: required: true description: Requests a sample list of identifiers that can be used in other Benchmarks API endpoints. content: application/json: schema: $ref: '#/components/schemas/benchmarkIdListRequest' responses: '200': description: List of sample Benchmark Ids content: application/json: schema: $ref: '#/components/schemas/benchmarkIdListResponse' examples: Result of Benchmark Constituent SPY-US: $ref: '#/components/examples/resultofBenchmarkID-TOPIX' '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' x-microcks-operation: delay: 0 dispatcher: FALLBACK /factset-esg/v1/sasb-scores: get: tags: - Factset summary: Factset Gets Short-term, Long-term, and Momentum Scores Based on the 26 Esg Categories Defined by the Sustainability Accounting Standards Board (sasb). operationId: getSasbScores description: 'FactSet Truvalue Labs SASB Scores provides short-term, long-term, and momentum scores that are generated for 26 ESG categories defined by the Sustainability Accounting Standards Board. FactSet Truvalue also calculates a custom overall score called ALLCATEGORIES, can indicate data volume flow, and the Dynamic Materiality of that data flow. ' parameters: - $ref: '#/components/parameters/ids' - $ref: '#/components/parameters/sasbScoreTypes' - $ref: '#/components/parameters/categories' - $ref: '#/components/parameters/startDate_2' - $ref: '#/components/parameters/endDate_2' - $ref: '#/components/parameters/frequency_2' - $ref: '#/components/parameters/calendar_2' responses: '200': description: The SASB Scores response object, including the Pulse Score, Insight Score, Momentum Score, Category Volume, Dynamic Materiality Score and other meta data. content: application/json: schema: $ref: '#/components/schemas/sasbScoresResponse' examples: Single SASB Score Type for all categories for a single entity (AMZN-US): $ref: '#/components/examples/singleSasbScores' Multiple SASB Score Types for multiple categories for multiple entities (AMZN-US, TSLA-US): $ref: '#/components/examples/multipleSasbScores' '400': $ref: '#/components/responses/400_2' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403_2' '415': $ref: '#/components/responses/415_2' '500': $ref: '#/components/responses/500' x-microcks-operation: delay: 0 dispatcher: FALLBACK post: tags: - Factset summary: Factset for a Large List of Ids, Gets Short-term, Long-term, and Momentum Scores Based on the 26 Esg Categories Defined by the Sustainability Accounting Standards Board (sasb). description: 'FactSet Truvalue Labs SASB Scores provides short-term, long-term, and momentum scores that are generated for 26 ESG categories defined by the Sustainability Accounting Standards Board. FactSet Truvalue also calculates a custom overall score called ALLCATEGORIES, can indicate data volume flow, and the Dynamic Materiality of that data flow. ' operationId: getSasbScoresPost requestBody: required: true description: The SASB Scores request body, allowing the user to specify a list of ids, SASB Score Items, SASB categories, date range, and frequency. content: application/json: schema: $ref: '#/components/schemas/sasbScoresRequest' examples: Single SASB Score Type for all categories for a single entity (AMZN-US): $ref: '#/components/examples/singleSasbScoresPost' Multiple SASB Scores Types for multiple categories for multiple mntities (AMZN-US, TSLA-US): $ref: '#/components/examples/multipleSasbScoresPost' responses: '200': description: The SASB Scores response object, including the Pulse Score, Insight Score, Momentum Score, Category Volume, Dynamic Materiality Score and other meta data. content: application/json: schema: $ref: '#/components/schemas/sasbScoresResponse' '400': $ref: '#/components/responses/400_2' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403_2' '415': $ref: '#/components/responses/415_2' '500': $ref: '#/components/responses/500' x-microcks-operation: delay: 0 dispatcher: FALLBACK /factset-esg/v1/sasb-ranks: get: tags: - Factset summary: Factset Gets Esg Rankings for a Requested List of Ids and Dates. operationId: getSasbRanks description: "Indicates if a company is a Leader, Above Average, Average, Below Average, or a Laggard; directly mapping from Industry Percentiles (*request IND_PCTL in scores endpoints*). Mapping of ESG Ranks to Industry Percentile Ranges is as follows - \n\n|Rank|Industry Percentile Range (%)|\n|||\n|Leader|90 - 100|\n|Above Average|70 - 89.9|\n|Average|30 - 69.9|\n|Below Average|10 - 29.9|\n|Laggard|0 - 9.9|\n\nIndustry classifications follow SICS, SASB's Industry Classification System. Using the Adjusted Insight scores, Industry Percentiles are generated for all companies. Companies with five or more articles in a year get ranked in a first pass, then companies with filled-in values are interpolated without forcing the ranking of higher-volume companies up or down. In the case where a company falls into an industry with fewer than 7 high or medium volume companies the Sector Percentile is inserted in the place of the Industry Percentile score.\nOnly Vaild for ALLCATEGORIES and MATERIALITY categories.
\n" parameters: - $ref: '#/components/parameters/ids' - $ref: '#/components/parameters/rankCategories' - $ref: '#/components/parameters/startDate_2' - $ref: '#/components/parameters/endDate_2' - $ref: '#/components/parameters/frequency_2' - $ref: '#/components/parameters/calendar_2' responses: '200': description: The SASB Ranks response object. content: application/json: schema: $ref: '#/components/schemas/sasbRanksResponse' examples: ESG Ranks for multiple entities: $ref: '#/components/examples/multipleSasbRanks' '400': $ref: '#/components/responses/400_2' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403_2' '415': $ref: '#/components/responses/415_2' '500': $ref: '#/components/responses/500' x-microcks-operation: delay: 0 dispatcher: FALLBACK post: tags: - Factset summary: Factset Get Esg Ranks for a Large List of Ids and Specified Date Range. description: "Indicates if a company is a Leader, Above Average, Average, Below Average, or a Laggard; directly mapping from Industry Percentiles (*request IND_PCTL in scores endpoints*). Mapping of ESG Ranks to Industry Percentile Ranges is as follows - \n\n|Rank|Industry Percentile Range (%)|\n|||\n|Leader|90 - 100|\n|Above Average|70 - 89.9|\n|Average|30 - 69.9|\n|Below Average|10 - 29.9|\n|Laggard|0 - 9.9|\n\nIndustry classifications follow SICS, SASB's Industry Classification System. Using the Adjusted Insight scores, Industry Percentiles are generated for all companies. Companies with five or more articles in a year get ranked in a first pass, then companies with filled-in values are interpolated without forcing the ranking of higher-volume companies up or down. In the case where a company falls into an industry with fewer than 7 high or medium volume companies the Sector Percentile is inserted in the place of the Industry Percentile score.\nOnly Vaild for ALLCATEGORIES and MATERIALITY categories.
\n" operationId: getSasbRanksPost requestBody: required: true description: The SASB Ranks Request Object content: application/json: schema: $ref: '#/components/schemas/sasbRanksRequest' responses: '200': description: The SASB Ranks response object. content: application/json: schema: $ref: '#/components/schemas/sasbRanksResponse' examples: ESG Ranks for multiple entities: $ref: '#/components/examples/multipleSasbRanks' '400': $ref: '#/components/responses/400_2' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403_2' '415': $ref: '#/components/responses/415_2' '500': $ref: '#/components/responses/500' x-microcks-operation: delay: 0 dispatcher: FALLBACK /factset-esg/v1/sasb-scores-all: get: tags: - Factset summary: Factset Gets a Flat Key Value Array of Scores for Named Categories of the Input Scoretype(s). operationId: getSasbScoresAll description: '**Retrieves a flat array of all categories for the requested scoreType and ids. Unlike the /sasb-scores endpoint the format of the response returns category names as part of the key value.**Gets values for all categories for the selected score type(s) for the requested identifier(s). FactSet Truvalue Labs SASB Scores provides short-term, long-term, and momentum scores that are generated for 26 ESG categories defined by the Sustainability Accounting Standards Board. ESG Ranks are not supported in this Endpoint. ' parameters: - $ref: '#/components/parameters/ids' - $ref: '#/components/parameters/sasbScoreTypes' - $ref: '#/components/parameters/startDate_2' - $ref: '#/components/parameters/endDate_2' - $ref: '#/components/parameters/frequency_2' - $ref: '#/components/parameters/calendar_2' responses: '200': description: The SASB Scores All Response Object, including the Pulse, Insight, Momentum, Article Volume, Category Volume, Dynamic Materiality, Adjusted Insight, and Industry Percentile scores for all categories. content: application/json: schema: $ref: '#/components/schemas/sasbScoresAllResponse' examples: All SASB Score Types for a Single Entity (AMZN-US): $ref: '#/components/examples/singleSasbScoresAll' Multiple SASB Scores Types for Multiple Entities (AMZN-US, TSLA-US): $ref: '#/components/examples/multipleSasbScoresAll' '400': $ref: '#/components/responses/400_2' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403_2' '415': $ref: '#/components/responses/415_2' '500': $ref: '#/components/responses/500' x-microcks-operation: delay: 0 dispatcher: FALLBACK post: tags: - Factset summary: Factset Gets a Flat Key Value Array of Scores for Named Categories of the Input Score Type(s). description: '**Retrieves a flat array of all categories for the requested scoreType and ids. Unlike the /sasb-scores endpoint the format of the response returns category names as part of the key value.**
Gets values for all categories for the selected score type(s) for the requested identifier(s). FactSet Truvalue Labs SASB Scores provides short-term, long-term, and momentum scores that are generated for 26 ESG categories defined by the Sustainability Accounting Standards Board. ESG Ranks are not supported in this Endpoint. ' operationId: getSasbScoresAllPost requestBody: required: true description: The SASB Scores request body, allowing the user to specify a list of ids, SASB Score Items, SASB categories, date range, and frequency. content: application/json: schema: $ref: '#/components/schemas/sasbScoresAllRequest' examples: All SASB Score Types for a Single Entity (AMZN-US): $ref: '#/components/examples/singleSasbScoresAllPost' Multiple SASB Score Types for Multiple Entities (AMZN-US, TSLA-US): $ref: '#/components/examples/multipleSasbScoresAllPost' responses: '200': description: The SASB Scores All Response Object, including the Pulse, Insight, Momentum, Article Volume, Category Volume, Dynamic Materiality, Adjusted Insight, and Industry Percentile scores for all categories. content: application/json: schema: $ref: '#/components/schemas/sasbScoresAllResponse' '400': $ref: '#/components/responses/400_2' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403_2' '415': $ref: '#/components/responses/415_2' '500': $ref: '#/components/responses/500' x-microcks-operation: delay: 0 dispatcher: FALLBACK /factset-esg/v1/sdg-scores: get: tags: - Factset summary: Factset Gets Short-term, Long-term, and Momentum Scores Based on the 16 Sustainable Development Goals Categories Defined by the United Nations. operationId: getSdgScores description: 'Truvalue Labs SDG Scores provides short-term, long-term, and momentum scores that are generated for 16 Sustainable Development Goals categories defined by the United Nations. ' parameters: - $ref: '#/components/parameters/tvlIds' - $ref: '#/components/parameters/sdgScoreTypes' - $ref: '#/components/parameters/sdgCategories' - $ref: '#/components/parameters/sdgStartDate' - $ref: '#/components/parameters/sdgEndDate' - $ref: '#/components/parameters/sdgFrequency' responses: '200': description: The SDG Scores response object, including the Pulse Score, Insight Score, Momentum Score, Category Volume, Impact Percentage and other meta data. content: application/json: schema: $ref: '#/components/schemas/sdgScoresResponse' examples: Single Score Type for all SDG categories for a single entity (AMZN-US).: $ref: '#/components/examples/singleSdgScores' Multiple Score Types for 4 SDG categories for multiple entities (AMZN-US, TSLA-US): $ref: '#/components/examples/multipleSdgScores' '400': $ref: '#/components/responses/400_2' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403_2' '415': $ref: '#/components/responses/415_2' '500': $ref: '#/components/responses/500' x-microcks-operation: delay: 0 dispatcher: FALLBACK post: tags: - Factset summary: Factset Gets Short-term, Long-term, and Momentum Scores Based on the 16 Sustainable Development Goals Categories Defined by United Nations. description: 'Truvalue Labs SDG Scores provides short-term, long-term, and momentum scores that are generated for 16 Sustainable Development Goals categories defined by the United Nations.* ' operationId: getSdgScoresPost requestBody: required: true description: The SDG Scores request body, allowing the user to specify a list of ids, Score types, SDG categories, date range, and frequency. content: application/json: schema: $ref: '#/components/schemas/sdgScoresRequest' responses: '200': description: The SDG Scores response object, including the Pulse Score, Insight Score, Momentum Score, Category Volume, Impact Percentage and other meta data. content: application/json: schema: $ref: '#/components/schemas/sdgScoresResponse' '400': $ref: '#/components/responses/400_2' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403_2' '415': $ref: '#/components/responses/415_2' '500': $ref: '#/components/responses/500' x-microcks-operation: delay: 0 dispatcher: FALLBACK /factset-esg/v1/sfdr-pai: get: tags: - Factset summary: Factset Gets Principle Adverse Impact (pai) Data to Support Compliant Sfdr Sustainable Finance Disclosure Regulation (sfdr) Reporting operationId: getSfdrPai description: "SFDR Principle Adverse Impact (PAI) data is built specifically to support compliant Sustainable Finance Disclosure Regulation (SFDR) reporting. FactSet collects PAI data items from publicly available company-reported information and FactSet databases, such as FactSet Fundamentals, FactSet RBICS with Revenue and FactSet People, which are also based on company-disclosures. FactSet uses Truvalue Labs SASB Spotlights for supplemental OECD & UNGC violation checks where company reporting is sparse. \n" parameters: - $ref: '#/components/parameters/paiIds' - $ref: '#/components/parameters/feelback' - $ref: '#/components/parameters/fiscalPeriodStart' - $ref: '#/components/parameters/fiscalPeriodEnd' - $ref: '#/components/parameters/indicators' - $ref: '#/components/parameters/calculation' responses: '200': description: The SFDR PAI response object, including the Calculation, Sub Topic Codes, Sub Topic Names, Report End Date,Reporting Period, Standardized Units and Standardized Values content: application/json: schema: $ref: '#/components/schemas/sfdrPaiResponse' '400': $ref: '#/components/responses/400_2' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403_2' '408': $ref: '#/components/responses/408' '415': $ref: '#/components/responses/415_2' '500': $ref: '#/components/responses/500' x-microcks-operation: delay: 0 dispatcher: FALLBACK post: tags: - Factset summary: Factset Gets Principle Adverse Impact (pai) Data to Support Compliant Sfdr Sustainable Finance Disclosure Regulation (sfdr) Reporting description: 'SFDR Principle Adverse Impact (PAI) data is built specifically to support compliant Sustainable Finance Disclosure Regulation (SFDR) reporting. FactSet collects PAI data items from publicly available company-reported information and FactSet databases, such as FactSet Fundamentals, FactSet RBICS with Revenue and FactSet People, which are also based on company-disclosures. FactSet uses Truvalue Labs SASB Spotlights for supplemental OECD & UNGC violation checks where company reporting is sparse. ' operationId: getSfdrPaiForList requestBody: required: true description: The request body, allows the user to specify a list of ids, date range(Annual), and PAI Indicators content: application/json: schema: $ref: '#/components/schemas/sfdrPaiRequest' responses: '200': description: The SFDR PAI response object, including the Calculation, SubTopic Codes, SubTopic Names, Report End Date,Reporting Period, Standardized Units and Standardized Values content: application/json: schema: $ref: '#/components/schemas/sfdrPaiResponse' '400': $ref: '#/components/responses/400_2' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403_2' '408': $ref: '#/components/responses/408' '415': $ref: '#/components/responses/415_2' '500': $ref: '#/components/responses/500' x-microcks-operation: delay: 0 dispatcher: FALLBACK /factset-esg/v1/sasb-spotlights: get: tags: - Factset summary: Factset Gets Spotlight Data for the Most Important Positive and Negative Esg Events to Enable Timely and Systematic Trading Strategies and Portfolio Management operationId: getSasbSpotlights description: "FactSet ESG by Truvalue Labs Spotlight Data solutions are a daily collection of the most important positive and negative ESG events detected by our algorithms, with a variety of quantitative metadata to enable timely and systematic trading strategies and portfolio management. Qualitive informational data points such as the headline and key bullet points for articles is also included. \n" parameters: - $ref: '#/components/parameters/paiIds' - $ref: '#/components/parameters/sdgStartDate' - $ref: '#/components/parameters/sdgEndDate' - $ref: '#/components/parameters/fieldsSasbSpotlights' - $ref: '#/components/parameters/sasbSpotlightsCategories' - $ref: '#/components/parameters/primaryOnly' - $ref: '#/components/parameters/isRemoved' responses: '200': description: The SASB Article metadata like Dates, Headlines, Articles, Volume content: application/json: schema: $ref: '#/components/schemas/spotlightsResponse' '400': $ref: '#/components/responses/400_2' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403_2' '408': $ref: '#/components/responses/408' '415': $ref: '#/components/responses/415_2' '500': $ref: '#/components/responses/500' x-microcks-operation: delay: 0 dispatcher: FALLBACK post: tags: - Factset summary: Factset Gets Spotlight Data for the Most Important Positive and Negative Esg Events to Enable Timely and Systematic Trading Strategies and Portfolio Management description: 'FactSet ESG by Truvalue Labs Spotlight Data solutions are a daily collection of the most important positive and negative ESG events detected by our algorithms, with a variety of quantitative metadata to enable timely and systematic trading strategies and portfolio management. Qualitive informational data points such as the headline and key bullet points for articles is also included. reporting is sparse. ' operationId: getSasbSpotlightsForList requestBody: required: true description: The SASB Article metadata like Dates, Headlines, Articles, Volume content: application/json: schema: $ref: '#/components/schemas/sasbSpotlightsRequest' responses: '200': description: The SASB Article metadata like Dates, Headlines, Articles, Volume content: application/json: schema: $ref: '#/components/schemas/spotlightsResponse' '400': $ref: '#/components/responses/400_2' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403_2' '408': $ref: '#/components/responses/408' '415': $ref: '#/components/responses/415_2' '500': $ref: '#/components/responses/500' x-microcks-operation: delay: 0 dispatcher: FALLBACK /factset-esg/v1/sdg-spotlights: get: tags: - Factset summary: Factset Gets Spotlight Data for the Most Important Positive and Negative Esg Events to Enable Timely and Systematic Trading Strategies and Portfolio Management operationId: getSdgSpotlights description: "FactSet ESG by Truvalue Labs Spotlight Data solutions are a daily collection of the most important positive and negative ESG events detected by our algorithms, with a variety of quantitative metadata to enable timely and systematic trading strategies and portfolio management. Qualitive informational data points such as the headline and key bullet points for articles is also included. \n" parameters: - $ref: '#/components/parameters/paiIds' - $ref: '#/components/parameters/sdgStartDate' - $ref: '#/components/parameters/sdgEndDate' - $ref: '#/components/parameters/sdgSpotlightCategories' - $ref: '#/components/parameters/fieldsSdgSpotlights' - $ref: '#/components/parameters/primaryOnly' - $ref: '#/components/parameters/isRemoved' responses: '200': description: The SDG Article metadata like Dates, Headlines, Articles, Volume content: application/json: schema: $ref: '#/components/schemas/spotlightsResponse' '400': $ref: '#/components/responses/400_2' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403_2' '408': $ref: '#/components/responses/408' '415': $ref: '#/components/responses/415_2' '500': $ref: '#/components/responses/500' x-microcks-operation: delay: 0 dispatcher: FALLBACK post: tags: - Factset summary: Factset Gets Spotlight Data for the Most Important Positive and Negative Esg Events to Enable Timely and Systematic Trading Strategies and Portfolio Management description: 'FactSet ESG by Truvalue Labs Spotlight Data solutions are a daily collection of the most important positive and negative ESG events detected by our algorithms, with a variety of quantitative metadata to enable timely and systematic trading strategies and portfolio management. Qualitive informational data points such as the headline and key bullet points for articles is also included. reporting is sparse. ' operationId: getSdgSpotlightsForList requestBody: required: true description: The SDG Article metadata like Dates, Headlines, Articles, Volume content: application/json: schema: $ref: '#/components/schemas/sdgSpotlightsRequest' responses: '200': description: The SDG Article metadata like Dates, Headlines, Articles, Volume content: application/json: schema: $ref: '#/components/schemas/spotlightsResponse' '400': $ref: '#/components/responses/400_2' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403_2' '408': $ref: '#/components/responses/408' '415': $ref: '#/components/responses/415_2' '500': $ref: '#/components/responses/500' x-microcks-operation: delay: 0 dispatcher: FALLBACK /factset-esg/v1/sasb-articles: get: tags: - Factset summary: Factset Request Articles Tagged With Sasb Lens Categories From 2016-01-01 to Previous Day. operationId: getSasbArticles description: 'Articles endpoint allows to retrieve underlying news articles used by the AI engine to calculate the ESG Scores of companies and therefore provides ESG relevant news and also transparency into the ESG Scores. ' parameters: - $ref: '#/components/parameters/paiIds' - $ref: '#/components/parameters/sdgStartDate' - $ref: '#/components/parameters/sdgEndDate' - $ref: '#/components/parameters/dateOf' - $ref: '#/components/parameters/articlesFields' - $ref: '#/components/parameters/sasbArticlesCategories' responses: '200': description: The SASB Article metadata like Dates, Headlines, Articles, Volume content: application/json: schema: $ref: '#/components/schemas/sasbArticlesResponse' '400': $ref: '#/components/responses/400_2' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403_2' '408': $ref: '#/components/responses/408' '415': $ref: '#/components/responses/415_2' '500': $ref: '#/components/responses/500' x-microcks-operation: delay: 0 dispatcher: FALLBACK post: tags: - Factset summary: Factset Request Articles Tagged With Sasb Lens Categories From 2016-01-01 to Previous Day description: 'Articles endpoint allows to retrieve underlying news articles used by the AI engine to calculate the ESG Scores of companies and therefore provides ESG relevant news and also transparency into the ESG Scores. ' operationId: getSasbArticlesForList requestBody: required: true description: The SASB Article metadata like Dates, Headlines, Articles, Volume content: application/json: schema: $ref: '#/components/schemas/sasbArticlesRequest' responses: '200': description: The SASB Article metadata like Dates, Headlines, Articles, Volume content: application/json: schema: $ref: '#/components/schemas/sasbArticlesResponse' '400': $ref: '#/components/responses/400_2' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403_2' '408': $ref: '#/components/responses/408' '415': $ref: '#/components/responses/415_2' '500': $ref: '#/components/responses/500' x-microcks-operation: delay: 0 dispatcher: FALLBACK /factset-esg/v1/sdg-articles: get: tags: - Factset summary: Factset Request Articles Tagged With Sdg Lens Categories From 2016-01-01 to Previous Day. operationId: getSdgArticles description: 'Articles endpoint allows to retrieve underlying news articles used by the AI engine to calculate the ESG Scores of companies and therefore provides ESG relevant news and also transparency into the ESG Scores. ' parameters: - $ref: '#/components/parameters/paiIds' - $ref: '#/components/parameters/sdgStartDate' - $ref: '#/components/parameters/sdgEndDate' - $ref: '#/components/parameters/dateOf' - $ref: '#/components/parameters/articlesFields' - $ref: '#/components/parameters/sdgArticlesCategories' responses: '200': description: The SDG Article metadata like Dates, Headlines, Articles, Volume content: application/json: schema: $ref: '#/components/schemas/sdgArticlesResponse' '400': $ref: '#/components/responses/400_2' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403_2' '408': $ref: '#/components/responses/408' '415': $ref: '#/components/responses/415_2' '500': $ref: '#/components/responses/500' x-microcks-operation: delay: 0 dispatcher: FALLBACK post: tags: - Factset summary: Factset Request Articles Tagged With Sdg Lens Categories From 2016-01-01 to Previous Day description: 'Articles endpoint allows to retrieve underlying news articles used by the AI engine to calculate the ESG Scores of companies and therefore provides ESG relevant news and also transparency into the ESG Scores. ' operationId: getSdgArticlesForList requestBody: required: true description: The SDG Article metadata like Dates, Headlines, Articles, Volume content: application/json: schema: $ref: '#/components/schemas/sdgArticlesRequest' responses: '200': description: The SDG Article metadata like Dates, Headlines, Articles, Volume content: application/json: schema: $ref: '#/components/schemas/sdgArticlesResponse' '400': $ref: '#/components/responses/400_2' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403_2' '408': $ref: '#/components/responses/408' '415': $ref: '#/components/responses/415_2' '500': $ref: '#/components/responses/500' x-microcks-operation: delay: 0 dispatcher: FALLBACK /factset-estimates/v2/rolling-consensus: get: tags: - Factset summary: Factset Retrieves Consensus Estimates for a Requested List of Ids and Rolling Fiscal Periods. operationId: getRollingConsensus description: 'Returns FactSet Estimates consensus data using rolling fiscal dates.
The rolling behavior causes fiscal year to automatically roll from one year to the next as the historical perspective date changes. The fiscal period rolls forward as of each period end. This endpoint is optimized to allow the request to simply include a relative fiscal period (e.g. use relativeFiscalStart integer 1 and periodicity ANN for next unreported fiscal year end), and then see what the consensus thought the "next fiscal year" estimates were through time as you "roll" back your perspective dates. This differs from locking down an absolute estimate period such as explicitly stating Fiscal Year 2019. This can be done in the fixed-consensus endpoint.
' parameters: - $ref: '#/components/parameters/ids_2' - $ref: '#/components/parameters/metrics_2' - $ref: '#/components/parameters/startDate_3' - $ref: '#/components/parameters/endDate_3' - $ref: '#/components/parameters/frequency_3' - $ref: '#/components/parameters/relativeFiscalStart' - $ref: '#/components/parameters/relativeFiscalEnd' - $ref: '#/components/parameters/periodicity_2' - $ref: '#/components/parameters/currency_2' responses: '200': description: Estimate data items content: application/json: schema: $ref: '#/components/schemas/consensusResponse' '400': $ref: '#/components/responses/400_3' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403_3' '415': $ref: '#/components/responses/415_3' '500': $ref: '#/components/responses/500' x-microcks-operation: delay: 0 dispatcher: FALLBACK post: tags: - Factset summary: Factset Retrieves Consensus Estimates for a Requested List of Ids and Rolling Fiscal Periods description: 'Returns FactSet Estimates consensus data using rolling fiscal dates.The rolling behavior causes fiscal year to automatically roll from one year to the next as the historical perspective date changes. The fiscal period rolls forward as of each period end. This endpoint is optimized to allow the request to simply include a relative fiscal period (e.g. use relativeFiscalStart integer 1 and periodicity ANN for next unreported fiscal year end), and then see what the consensus thought the "next fiscal year" estimates were through time as you "roll" back your perspective dates. This differs from locking down an absolute estimate period such as explicitly stating Fiscal Year 2019. This can be done in the fixed-consensus endpoint.
' operationId: getRollingConsensusForList requestBody: required: true description: Request object for Rolling Conensus estimates. content: application/json: schema: $ref: '#/components/schemas/rollingConsensusRequest' responses: '200': description: Rolling Conensus Estimate data items content: application/json: schema: $ref: '#/components/schemas/consensusResponse' '400': $ref: '#/components/responses/400_3' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403_3' '415': $ref: '#/components/responses/415_3' '500': $ref: '#/components/responses/500' x-microcks-operation: delay: 0 dispatcher: FALLBACK /factset-estimates/v2/fixed-consensus: get: tags: - Factset summary: Factset Retrieves Consensus Estimates for a Requested List of Ids and Fixed Fiscal Periods operationId: getFixedConsensus description: 'Returns FactSet Estimates consensus data using fixed fiscal dates. For example, if the company''s current unreported year is 12/2020, all data returned by formulas that specify as the period/report basis will be for 12/2005 regardless of what perspective dates (startDate/endDate) are used. The fixed dates are "locked" in time and all estimated values are for that explicit date. If you are requesting that the estimated periods can change with the perspective date, please use the rolling-consensus endpoint. ' parameters: - $ref: '#/components/parameters/ids_2' - $ref: '#/components/parameters/metrics_2' - $ref: '#/components/parameters/startDate_3' - $ref: '#/components/parameters/endDate_3' - $ref: '#/components/parameters/frequency_3' - $ref: '#/components/parameters/fiscalPeriodStart_2' - $ref: '#/components/parameters/fiscalPeriodEnd_2' - $ref: '#/components/parameters/periodicity_2' - $ref: '#/components/parameters/currency_2' responses: '200': description: Consensus Estimate Data Items. content: application/json: schema: $ref: '#/components/schemas/consensusResponse' '400': $ref: '#/components/responses/400_3' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403_3' '415': $ref: '#/components/responses/415_3' '500': $ref: '#/components/responses/500' x-microcks-operation: delay: 0 dispatcher: FALLBACK post: tags: - Factset summary: Factset Consensus Estimates for Fixed Fiscal Periods description: 'Returns FactSet Estimates consensus data using fixed fiscal dates. For example, if the company''s current unreported year is 12/2020, all data returned by formulas that specify as the period/report basis will be for 12/2005 regardless of what perspective dates (startDate/endDate) are used. The fixed dates are "locked" in time and all estimated values are for that explicit date. If you are requesting that the estimated periods can change with the perspective date, please use the rolling-consensus endpoint. ' operationId: getFixedConsensusForList requestBody: required: true description: Request object for Estimate Data Items. content: application/json: schema: $ref: '#/components/schemas/fixedConsensusRequest' responses: '200': description: Estimate data items content: application/json: schema: $ref: '#/components/schemas/consensusResponse' '400': $ref: '#/components/responses/400_3' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403_3' '415': $ref: '#/components/responses/415_3' '500': $ref: '#/components/responses/500' x-microcks-operation: delay: 0 dispatcher: FALLBACK /factset-estimates/v2/rolling-detail: get: tags: - Factset summary: Factset Estimates Detail Data for Rolling Fiscal Periods operationId: getRollingDetail description: "Updated intraday, the FactSet detail estimates apis provide individual broker-level estimates collected from over 800 sell-side analysts. This database contains 20+ years of broker history across more than 59,000 global companies. Content is provided for \"rolling\" fiscal periods. \n" parameters: - $ref: '#/components/parameters/ids_2' - $ref: '#/components/parameters/metrics_2' - $ref: '#/components/parameters/startDate_3' - $ref: '#/components/parameters/endDate_3' - $ref: '#/components/parameters/frequency_3' - $ref: '#/components/parameters/periodicityDetail' - $ref: '#/components/parameters/includeAll' - $ref: '#/components/parameters/relativeFiscalStart' - $ref: '#/components/parameters/relativeFiscalEnd' - $ref: '#/components/parameters/currency_2' responses: '200': description: Estimate data items content: application/json: schema: $ref: '#/components/schemas/detailResponse' '400': $ref: '#/components/responses/400_3' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403_3' '415': $ref: '#/components/responses/415_3' '500': $ref: '#/components/responses/500' x-microcks-operation: delay: 0 dispatcher: FALLBACK post: tags: - Factset summary: Factset Estimates Detail Data for Rolling Fiscal Periods description: 'Updated intraday, the FactSet detail estimates apis provide individual broker-level estimates collected from over 800 sell-side analysts. This database contains 20+ years of broker history across more than 59,000 global companies. Content is provided for "rolling" fiscal periods. ' operationId: getRollingDetailForList requestBody: required: true description: Request object for Estimate Data Items. content: application/json: schema: $ref: '#/components/schemas/rollingDetailRequest' responses: '200': description: Estimate data items content: application/json: schema: $ref: '#/components/schemas/detailResponse' '400': $ref: '#/components/responses/400_3' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403_3' '415': $ref: '#/components/responses/415_3' '500': $ref: '#/components/responses/500' x-microcks-operation: delay: 0 dispatcher: FALLBACK /factset-estimates/v2/fixed-detail: get: tags: - Factset summary: Factset Estimates Detail Data for Fixed Fiscal Periods operationId: getFixedDetail description: 'Updated intraday, the FactSet detail estimates apis provide individual broker-level estimates collected from over 800 sell-side analysts. This database contains 20+ years of broker history across more than 59,000 global companies. Content is provided for "fixed" fiscal periods. ' parameters: - $ref: '#/components/parameters/ids_2' - $ref: '#/components/parameters/metrics_2' - $ref: '#/components/parameters/startDate_3' - $ref: '#/components/parameters/endDate_3' - $ref: '#/components/parameters/frequency_3' - $ref: '#/components/parameters/periodicityDetail' - $ref: '#/components/parameters/includeAll' - $ref: '#/components/parameters/fiscalPeriodStart_2' - $ref: '#/components/parameters/fiscalPeriodEnd_2' - $ref: '#/components/parameters/currency_2' responses: '200': description: Estimate data items content: application/json: schema: $ref: '#/components/schemas/detailResponse' '400': $ref: '#/components/responses/400_3' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403_3' '415': $ref: '#/components/responses/415_3' '500': $ref: '#/components/responses/500' x-microcks-operation: delay: 0 dispatcher: FALLBACK post: tags: - Factset summary: Factset Estimates Detail Data for Fixed Fiscal Periods description: 'Updated intraday, the FactSet detail estimates apis provide individual broker-level estimates collected from over 800 sell-side analysts. This database contains 20+ years of broker history across more than 59,000 global companies. Content is provided for "fixed" fiscal periods. ' operationId: getFixedDetailForList requestBody: required: true description: Request object for Estimate Data Items. content: application/json: schema: $ref: '#/components/schemas/fixedDetailRequest' responses: '200': description: Estimate data items content: application/json: schema: $ref: '#/components/schemas/detailResponse' '400': $ref: '#/components/responses/400_3' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403_3' '415': $ref: '#/components/responses/415_3' '500': $ref: '#/components/responses/500' x-microcks-operation: delay: 0 dispatcher: FALLBACK /factset-estimates/v2/consensus-ratings: get: tags: - Factset summary: Factset Ratings Consensus Estimates to Fetch Buy, Overweight, Hold, Underweight, and Sell. operationId: getConsensusRatings description: 'Returns ratings from the FactSet Estimates database for current and historical for an individual security using rolling fiscal dates as of a specific date. ' parameters: - $ref: '#/components/parameters/ids_2' - $ref: '#/components/parameters/startDate_3' - $ref: '#/components/parameters/endDate_3' - $ref: '#/components/parameters/frequency_3' responses: '200': description: Estimate data items content: application/json: schema: $ref: '#/components/schemas/consensusRatingsResponse' '400': $ref: '#/components/responses/400_3' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403_3' '415': $ref: '#/components/responses/415_3' '500': $ref: '#/components/responses/500' x-microcks-operation: delay: 0 dispatcher: FALLBACK post: tags: - Factset summary: Factset Ratings Consensus Estimates to Fetch Buy, Overweight, Hold, Underweight, and Sell. description: 'Returns ratings from the FactSet Estimates database for current and historical for an individual security using rolling fiscal dates as of a specific date. ' operationId: getConsensusRatingsForList requestBody: required: true description: Request object for Estimate Data Items. content: application/json: schema: $ref: '#/components/schemas/consensusRatingsRequest' responses: '200': description: Estimate data items content: application/json: schema: $ref: '#/components/schemas/consensusRatingsResponse' '400': $ref: '#/components/responses/400_3' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403_3' '415': $ref: '#/components/responses/415_3' '500': $ref: '#/components/responses/500' x-microcks-operation: delay: 0 dispatcher: FALLBACK /factset-estimates/v2/detail-ratings: get: tags: - Factset summary: Factset Broker Detail Estimates to Fetch Buy, Overweight, Hold, Underweight, and Sell. operationId: getDetailRatings description: 'Retrieves the Broker Level ratings for the requested Id and date range. Ratings include Buy, Hold, Sell, Overweight, and Underweight.The `startDate` and `endDate` parameters controls the range of perspective dates. By default, the service will return the range of estimateDates within the latest company''s reporting period. As you expand the date range, additional full historical reporting periods and all ratings estimateDates per broker will be returned.
' parameters: - $ref: '#/components/parameters/ids_2' - $ref: '#/components/parameters/startDate_3' - $ref: '#/components/parameters/endDate_3' - $ref: '#/components/parameters/includeAll' responses: '200': description: Estimate Ratings data items content: application/json: schema: $ref: '#/components/schemas/detailRatingsResponse' '400': $ref: '#/components/responses/400_3' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403_3' '415': $ref: '#/components/responses/415_3' '500': $ref: '#/components/responses/500' x-microcks-operation: delay: 0 dispatcher: FALLBACK post: tags: - Factset summary: Factset Broker Detail Estimates to Fetch Buy, Overweight, Hold, Underweight, and Sell. description: 'Retrieves the Broker Level ratings for the requested Id and date range. Ratings include Buy, Hold, Sell, Overweight, and Underweight.The `startDate` and `endDate` parameters controls the range of perspective dates. By default, the service will return the range of estimateDates within the latest company''s reporting period. As you expand the date range, additional full historical reporting periods and all ratings estimateDates per broker will be returned.
' operationId: getDetailRatingsForList requestBody: required: true description: Request object for Detail Reatings Data Items. content: application/json: schema: $ref: '#/components/schemas/detailRatingsRequest' responses: '200': description: Estimate Detail Ratings data items content: application/json: schema: $ref: '#/components/schemas/detailRatingsResponse' '400': $ref: '#/components/responses/400_3' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403_3' '415': $ref: '#/components/responses/415_3' '500': $ref: '#/components/responses/500' x-microcks-operation: delay: 0 dispatcher: FALLBACK /factset-estimates/v2/surprise: get: tags: - Factset summary: Factset Surprise Estimates for Rolling Fiscal Periods operationId: getSurprise description: 'Returns FactSet Estimates surprise data using rolling fiscal dates. ' parameters: - $ref: '#/components/parameters/ids_2' - $ref: '#/components/parameters/metrics_2' - $ref: '#/components/parameters/startDate_3' - $ref: '#/components/parameters/endDate_3' - $ref: '#/components/parameters/frequency_3' - $ref: '#/components/parameters/periodicitySurprise' - $ref: '#/components/parameters/statistic' - $ref: '#/components/parameters/currency_2' responses: '200': description: Estimate data items content: application/json: schema: $ref: '#/components/schemas/surpriseResponse' '400': $ref: '#/components/responses/400_3' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403_3' '415': $ref: '#/components/responses/415_3' '500': $ref: '#/components/responses/500' x-microcks-operation: delay: 0 dispatcher: FALLBACK post: tags: - Factset summary: Factset Surprise Estimates for Rolling Fiscal Periods description: 'Returns FactSet Estimates surprise data using rolling fiscal dates. ' operationId: getSurpriseForList requestBody: required: true description: Request object for `Security` prices. content: application/json: schema: $ref: '#/components/schemas/surpriseRequest' responses: '200': description: Estimate data items content: application/json: schema: $ref: '#/components/schemas/surpriseResponse' '400': $ref: '#/components/responses/400_3' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403_3' '415': $ref: '#/components/responses/415_3' '500': $ref: '#/components/responses/500' x-microcks-operation: delay: 0 dispatcher: FALLBACK /factset-estimates/v2/segments: get: tags: - Factset summary: Factset Retrieves Product & Geographic Segment Estimates for a Requested List of Ids and Fiscal Periods operationId: getSegments description: "Returns FactSet Estimates Consensus Data for the segments gathered from the Business, Geographical, or Actual Reconciliation (ADJUSTMENT) classifications by using fiscal periods with a reporting frequency. \n" parameters: - $ref: '#/components/parameters/segmentIds' - $ref: '#/components/parameters/segmentType' - $ref: '#/components/parameters/metrics_2' - $ref: '#/components/parameters/startDate_3' - $ref: '#/components/parameters/endDate_3' - $ref: '#/components/parameters/relativeFiscalStart' - $ref: '#/components/parameters/relativeFiscalEnd' - $ref: '#/components/parameters/periodicity_2' - $ref: '#/components/parameters/frequency_3' - $ref: '#/components/parameters/currency_2' responses: '200': description: Segment Estimate data items content: application/json: schema: $ref: '#/components/schemas/segmentsResponse' '400': $ref: '#/components/responses/400_3' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403_3' '415': $ref: '#/components/responses/415_3' '500': $ref: '#/components/responses/500' x-microcks-operation: delay: 0 dispatcher: FALLBACK post: tags: - Factset summary: Factset Retrieves Product Segment Estimates for a Requested List of Ids and Fiscal Periods description: "Returns FactSet Estimates Data for the segments gathered from the Business, Geographical, or Actual Reconciliation (ADJUSTMENT) classifications by using fiscal periods with a reporting frequency. \n" operationId: getSegmentsForList requestBody: required: true description: Request object for Product Segments estimates. content: application/json: schema: $ref: '#/components/schemas/segmentsRequest' responses: '200': description: Segments Estimate data items content: application/json: schema: $ref: '#/components/schemas/segmentsResponse' '400': $ref: '#/components/responses/400_3' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403_3' '415': $ref: '#/components/responses/415_3' '500': $ref: '#/components/responses/500' x-microcks-operation: delay: 0 dispatcher: FALLBACK /factset-estimates/v2/metrics: get: summary: Factset Available Estimate Metrics operationId: getEstimateMetrics tags: - Factset description: "Returns list of available Estimate metrics that can be used in the `metrics` parameter of related endpoints.\n**By default, Factset provides Estimated items in millions. For specific metric methodology definitions, reference the `OAurl` response items to launch the available methodology page.** \n" parameters: - $ref: '#/components/parameters/category' - $ref: '#/components/parameters/subcategory' responses: '200': description: Estimate data metric items content: application/json: schema: $ref: '#/components/schemas/metricsResponse' '400': $ref: '#/components/responses/400_3' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403_3' '415': $ref: '#/components/responses/415_3' '500': $ref: '#/components/responses/500' x-microcks-operation: delay: 0 dispatcher: FALLBACK post: summary: Factset Available Estimate Metrics or Ratios. operationId: getEstimateMetricsForList tags: - Factset description: "Returns list of available Estimate metrics that can be used in the `metrics` parameter of related endpoints.\n**By default, Factset provides Estimated items in millions. For specific metric methodology definitions, reference the `OAurl` response items to launch the available methodology page.** \n" requestBody: required: true description: Request object for requesting estimates data content: application/json: schema: $ref: '#/components/schemas/metricsRequest' responses: '200': description: List of Estimate metric Ids content: application/json: schema: $ref: '#/components/schemas/metricsResponse' '400': $ref: '#/components/responses/400_3' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403_3' '415': $ref: '#/components/responses/415_3' '500': $ref: '#/components/responses/500' x-microcks-operation: delay: 0 dispatcher: FALLBACK components: schemas: surpriseRequest: title: Surprise Request Body description: Request object for requesting surprise estimates. type: object properties: ids: $ref: '#/components/schemas/ids_2' metrics: $ref: '#/components/schemas/metrics_2' startDate: $ref: '#/components/schemas/startDate_3' endDate: $ref: '#/components/schemas/endDate_3' frequency: $ref: '#/components/schemas/frequency_3' periodicity: $ref: '#/components/schemas/periodicitySurprise' currency: $ref: '#/components/schemas/currency_2' statistic: $ref: '#/components/schemas/statistic' required: - ids - metrics articlesFields: title: fields type: array items: type: string description: "Request available Articles data fields to be included in the response.\n Default is all fields. _fsymId_ and _articleId_ are always included.\n \n***ids limit** = 1000 per 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 exceed this request line limit of 8KB, its advised for any requests with large request lines to be requested through the respective "POST" method.
* ' example: - AAPL-USA benchmarkConstituent: title: Benchmark Constituent type: object properties: fsymId: type: string description: Benchmark Id example: SPY-US nullable: true date: description: Date of weight and shares. type: string format: date example: '2020-07-01' nullable: true fsymSecurityId: description: FactSet Security Identifier (-S). If Cash or Generic Id holding, response will just pass through generic id (e.g. CASH_USD). type: string example: TKPJVY-S nullable: true fsymRegionalId: description: FactSet Regional Identifier (-R). If Cash or Generic Id holding, response will just pass through generic id (e.g. CASH_USD). type: string example: F07Q7W-R nullable: true currency: description: Currency code for prices. type: string example: USD nullable: true weightClose: description: Weight of Security in benchmark (percent). type: number format: double example: 0.085717610340781 nullable: true adjHolding: description: Shares held adjusted. Units in Millions. type: number format: double example: 0.884722 nullable: true unadjHolding: description: Shares held unadjusted. Units in Millions. type: number format: double example: 0.884722 nullable: true price: description: Price of shares held. type: number format: double example: 267.97 nullable: true adjMarketValue: description: Market value adjusted. Market Value represented in Millions. type: number format: double example: 237.07895434 nullable: true requestId: type: string description: Identifier specified in the request example: SPY-US requestedDate: title: Date type: string description: Date of holding expressed in YYYY-MM-DD format. example: '2020-08-06' sasbScoresAll: title: SASB Scores All Object type: object properties: date: description: Date for the period requested expressed in YYYY-MM-DD format. type: string format: date example: '2020-09-30' nullable: true fsymId: description: FactSet Entity Identifier. Six alpha-numeric characters, excluding vowels, with a -E suffix (XXXXXX-E). type: string example: 001MF1-E nullable: true requestId: description: Identifier that was used for the request. type: string example: AMZN-US scoreType: description: 'The name of the specific SASB Score type being shown in the response. This will be represented by the scoreTypes input: PULSE, INSIGHT, MOMENTUM, ART_VOL_TTM, CAT_VOL_TTM, or DYNAMIC_MAT.' type: string example: PULSE nullable: true accessAndAffordability: description: The Access and Affordability SASB Category. type: number format: double example: 42.0589785474386 nullable: true airQuality: description: The Air Quality SASB Category. type: number format: double example: 29.8807816941901 nullable: true allCategories: description: The All Categories Category. This represents the overall SASB Score for the given 'scoreType'. When scoreType = ESG_RANK, the data type will be string, otherwise data type will be a number with double format. type: object example: 49.1044372161141 nullable: true businessEthics: description: The Business Ethics Category. type: number format: double example: 30.6074308481714 nullable: true businessModelResilience: description: The Business Model Resilience Category. type: number format: double example: 41.8940425184173 nullable: true competitiveBehavior: description: The Competitive Behavior Category. type: number format: double example: 32.5921215119197 nullable: true criticalIncidentRiskManagement: description: The Critical Incident Risk Management Category. type: number format: double example: 45.3820575553375 nullable: true customerPrivacy: description: The Customer Privacy Category. type: number format: double example: 54.9645092108536 nullable: true customerWelfare: description: The Customer Welfare Category. type: number format: double example: 68.5579215857227 nullable: true dataSecurity: description: The Data Security Category. type: number format: double example: 35.4099360664856 nullable: true ecologicalImpacts: description: The Ecological Impacts Category. type: number format: double example: 51.5562478316789 nullable: true employeeEngagementDiversityandInclusion: description: The Employee Engagement Diversity and Inclusion Category. type: number format: double example: 55.6395516005745 nullable: true employeeHealthAndSafety: description: The Employee Health And Safety Category. type: number format: double example: 51.7344801598622 nullable: true energyManagement: description: The Energy Management Category. type: number format: double example: 77.591147035024 nullable: true gHGEmissions: description: The Greenhouse Gases Emissions Category. type: number format: double example: 56.9085694943306 nullable: true humanRightsandCommunityRelations: description: The Human Rights and Community Relations Category. type: number format: double example: 46.5119869803688 nullable: true laborPractices: description: The Labor Practices Category. type: number format: double example: 49.8005302032842 nullable: true managementOfTheLegalAndRegulatoryEnvironment: description: The Management of the Legal and Regulatory Environment Category. type: number format: double example: 52.3487226050073 nullable: true materialsSourcingAndEfficiency: description: The Materials Sourcing and Efficiency Category. type: number format: double example: 59.6849308135668 nullable: true materiality: description: The Materiality Category. When scoreType = ESG_RANK, the data type will be string, otherwise data type will be a number with double format. type: object example: 51.6289633279129 nullable: true physicalImpactsOfClimateChange: description: The Physical Impacts of Climate Change Category. type: number format: double example: 47.376430062074 nullable: true productQualityAndSafety: description: The Product Quality and Safety Category. type: number format: double example: 47.5437583105162 nullable: true productDesignAndLifecycleManagement: description: The Product Design And Lifecycle Management Category. type: number format: double example: 54.5033074297044 nullable: true sellingPracticesAndProductLabeling: description: The Selling Practices And Product Labeling Category. type: number format: double example: 25.1319878766169 nullable: true supplyChainManagement: description: The Supply Chain Management Category. type: number format: double example: 57.6323871116413 nullable: true systemicRiskManagement: description: The Systemic Risk Management Category. type: number format: double example: 53.6422678837999 nullable: true wasteAndHazardousMaterialsManagement: description: The Waste and Hazardous Materials Management Category. type: number format: double example: 56.551268737999 nullable: true waterAndWastewaterManagement: description: The Water and Wastewater Management Category. type: number format: double example: 63.2635158281821 nullable: true sasbArticlesRequest: title: SASB Articles Request Body description: SASB Articles Request Body type: object properties: ids: $ref: '#/components/schemas/paiIds' categories: $ref: '#/components/schemas/sasbArticlesCategories' fields: $ref: '#/components/schemas/articlesFields' startDate: $ref: '#/components/schemas/sdgStartDate' endDate: $ref: '#/components/schemas/sdgEndDate' dateOf: $ref: '#/components/schemas/dateOf' required: - ids - startDate - endDate sasbSpotlightsRequest: title: SASB Spotlights Request Body description: SASB Spotlights Request Body type: object properties: ids: $ref: '#/components/schemas/paiIds' categories: $ref: '#/components/schemas/sasbSpotlightsCategories' fields: $ref: '#/components/schemas/fieldsSasbSpotlights' startDate: $ref: '#/components/schemas/sdgStartDate' endDate: $ref: '#/components/schemas/sdgEndDate' primaryOnly: $ref: '#/components/schemas/primaryOnly' isRemoved: $ref: '#/components/schemas/isRemoved' required: - ids fixedDetailRequest: title: Fixed Detail Request Body description: Request object for requesting rolling detail estimates. type: object properties: ids: $ref: '#/components/schemas/ids_2' metrics: $ref: '#/components/schemas/metrics_2' startDate: $ref: '#/components/schemas/startDate_3' endDate: $ref: '#/components/schemas/endDate_3' frequency: $ref: '#/components/schemas/frequency_3' includeAll: $ref: '#/components/schemas/includeAll' periodicity: $ref: '#/components/schemas/periodicityDetail' fiscalPeriodStart: $ref: '#/components/schemas/fiscalPeriodStart_2' fiscalPeriodEnd: $ref: '#/components/schemas/fiscalPeriodStart_2' currency: $ref: '#/components/schemas/currency_2' required: - ids - metrics segmentIds: type: array items: type: string minItems: 1 maxItems: 50 description: 'The requested list of security identifiers. Accepted ID types include Market Tickers, SEDOL, ISINs, CUSIPs, or FactSet Permanent Ids. * Make Note - id limit of 50 for defaults, otherwise the service is limited to a 30 second duration. This can be reached when increasing total number of metrics requested and depth of history. * ' example: - FDS-US primaryOnly: type: boolean description: 'Return only primary spotlights when set to true ' default: true example: true benchmarkIdListRequest: type: object title: Benchmark Id List Request properties: familyFilter: $ref: '#/components/schemas/familyFilter' indicators: type: array default: - ALL items: type: string description: "The indicators are the Principal Adverse Impact (PAI) metrics which consists of General, Mandatory and Additional indicators which supports the SFDR reporting. The data can also be requested for individual sub topic codes in addition to the indicators mentioned below -\n \n|**SFDR PAI Indicators**|**Description**|\n|||\n|**MandatoryIndicators**| Mandatory indicators are the indicators which must be reported under the EU Sustainable Finance Disclosure Regulation (SFDR).|\n|**AdditionalIndicators**| These are additional environmental and social indicators as mentioned in additional tables as provided in the Annex 1 table in the SFDR RTS report.|\n|**GHGEmissions**| This mandatory indicator includes metrics related to greenhouse emissions such as - Scope 1, 2, and 3 emissions, footprint and intensity and energy consumption from non-renewable and high climate sectors.|\n|**Biodiversity**| This mandatory indicator includes metrics pertaining to biodiversity and a company's impacts on biodiversity-sensitive areas.|\n|**Water**| This mandatory indicator includes data relating to emissions to water as made by the companies.|\n|**Waste**| This mandatory indicator includes data relating to hazardous waste as generated by the companies.|\n|**SocialEmployeeMatters**| This mandatory indicator includes employee-related metrics like gender diversity, pay gap and social-related metrics like violation of UNGC/OECD principles and exposure to controversial weapons.|\n|**Emissions**| This additional indicator includes metrics related to air pollutants, inorganic pollutants and ozone depleting substance. |\n|**EnergyPerformance**| This additional indicator includes metrics related to various sources of non-renewable energy as used by the companies. |\n|**WaterWasteMaterialEmissions**| This mandatory indicator includes employee-related metrics like gender diversity, pay gap and social-related metrics like violation of UNGC/OECD principles and exposure to controversial weapons.|\n|**AdditionalEmployeeMatters**| This additional indicator includes metrics related to workplace discrimination and safety, whistleblower mechanism and supplier code of conduct.|\n|**HumanRights**| This additional indicator includes metrics related to both policies and performance of a company in the areas of human rights, forced labor and human trafficking.|\n|**AntiCorruptionAntiBribery**| This additional indicator includes data related to company violations of anti-corruption and anti-bribery laws, and resulting fines.|\n" example: - Water - HumanRights endDate_3: type: string description: '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 in this endpoint. ' example: '2019-12-31' currency: title: Currency type: string description: Currency for response. example: USD benchmarkRatiosRequest: type: object title: Benchamrk Ratios Request properties: ids: $ref: '#/components/schemas/indexIds' startDate: $ref: '#/components/schemas/startDate' endDate: $ref: '#/components/schemas/endDate' periodicity: $ref: '#/components/schemas/periodicity' metrics: $ref: '#/components/schemas/metrics' frequency: $ref: '#/components/schemas/frequency' currency: $ref: '#/components/schemas/currency' required: - ids - metrics indexHistoryResponse: title: Index History Response type: object properties: data: description: 'Array of Index History response objects. ' type: array items: $ref: '#/components/schemas/indexHistory' example: [] sdgStartDate: type: string description: 'The start date requested for a given date range in YYYY-MM-DD format. The input start date must be before the input end date. Future dates (T+1) are not accepted in this endpoint. ' example: '2021-01-01' consensusRatings: title: Consensus Ratings type: object properties: fsymId: type: string example: SJY281-R nullable: true estimateDate: description: 'Date of estimate expressed in YYYY-MM-DD format. For more details, visit [Online Assistant Page #16598](https://oa.apps.factset.com/pages/16598)' type: string format: date example: '2017-07-24' nullable: true buyCount: description: The number of Buy ratings taken into account in the calculation of a consensus. This information is shown only for a 100-day consensus. type: integer example: 5 nullable: true overweightCount: description: The number of Overweight ratings taken into account in the calculation of a consensus. This information is shown only for a 100-day consensus. type: integer example: 1 nullable: true holdCount: description: The number of Hold ratings taken into account in the calculation of a consensus. This information is shown only for a 100-day consensus. type: integer example: 1 nullable: true underweightCount: description: The number of Underweight ratings taken into account in the calculation of a consensus. This information is shown only for a 100-day consensus. type: integer example: 1 nullable: true sellCount: description: The number of Sell ratings taken into account in the calculation of a consensus. This information is shown only for a 100-day consensus. type: integer example: 1 nullable: true ratingsNestTotal: description: The total number of ratings taken into account in the calculation of a consensus. This information is shown only for a 100-day consensus. type: integer example: 1 nullable: true ratingsNote: description: 'The mean average of ratings for the fiscal dates indicated, where each underlying rating is given a numerical score and then aggregated to a mean consensus - __*Individual Ratings Scores*__ |Value|Rating Description| ||| |1|Buy| |1.5|Overweight| |2|Hold| |2.5|Underweight| |3|Sell| ' type: number format: double example: 1.85555 nullable: true ratingsNoteText: description: "The mean textual rating for the fiscal dates indicated. The text rating is assigned by falling within the below defined ranges - \n__*Textual Ranges for Average*__\n|Value|Rating Description|\n|||\n|< 1.25|Buy|\n|< 1.75|Overweight|\n|< 2.25|Hold|\n|< 2.75|Underweight|\n|<= 3|Sell|\n" type: string example: Hold nullable: true requestId: description: Identifier that was used for the request. type: string example: IBM-US sasbScoresAllRequest: title: SASB Scores All Request Body description: SASB Scores All Request Body type: object properties: ids: $ref: '#/components/schemas/ids' scoreTypes: $ref: '#/components/schemas/sasbScoreTypes' startDate: $ref: '#/components/schemas/startDate_2' endDate: $ref: '#/components/schemas/endDate_2' frequency: $ref: '#/components/schemas/frequency_2' calendar: $ref: '#/components/schemas/calendar_2' required: - ids sdgSpotlightCategories: type: array default: - IMPACT items: type: string description: 'The SDG Categories specified for the Truvalue Scores being requested. To specify select categories returned in the response, provide a comma-separated list of the scores using the description below. |**SDG Category Input**|**Description**| ||| |**IMPACT**|**Impact** - The aggregate SDG score for each company is simply named "Impact." The SDG Impact Score is produced using a weighted average of individual category scores, where the weight utilized is the category score volume.| |**GOAL1NOPOVERTY**|**No Poverty** - Goal 1 focuses on poverty in all its manifestations and also aims to ensure social protection for the poor and vulnerable, increase access to basic services and support people harmed by climate related extreme events and other economic, social and environmental shocks and disasters.**Company-Level Issue Examples** *- Financial services access and affordability, Underserved groups,Unethical pricing.*| |**GOAL2ZEROHUNGER**|**Zero Hunger** - Goal 2 aims to end hunger and all forms of malnutrition and commits to universal access to safe, nutritious and sufficient food at all times of the year, particularly for the poor and people in vulnerable situations (e.g., infants). This will require sustainable food production systems and resilient agricultural practices, equal access to land, technology, and markets and international cooperation on investments in infrastructure and technology to boost agricultural productivity.
**Company-Level Issue Examples** *- Sustainable agricultural practices, Agricultural ingredients sourcing and certifications, Food safety concerns, Animal welfare.*| |**GOAL3GOODHEALTHANDWELLBEING**|**Good Health and Wellbeing** - Goal 3 seeks to ensure health and wellbeing for all, at every stage of life and addresses all major health priorities, including reproductive, maternal, and child health; communicable, noncommunicable and environmental diseases; universal health coverage; and access for all to safe, effective, quality, and affordable medicines and vaccines.
**Company-Level Issue Examples** *- Harmful Chemicals in Products, Product Recalls, Healthcare Access and Affordability.*| |**GOAL4QUALITYEDUCATION**|**Quality Education** - Goal 4 addresses access and affordability of education and skills development starting from childhood development and continuing through adulthood, including for girls, persons with disabilities, indigenous peoples and children in vulnerable situations, Improvements to the access to education it hopes to ensure that all youth and a substantial proportion of adults achieve literacy and numeracy. It also seeks to build and upgrade education facilities and to increase the supply of qualified teachers.
**Company-Level Issue Examples** *- Mentorship and training, Education company quality, Education company ethics.*| |**GOAL5GENDEREQUALITY**|**Gender Equality** - Goal 5 emphasizes eliminating discrimination and violence against women and girls. The Goal emphasizes ensuring women''s full and effective participation and equal opportunities for leadership at all levels of decision-making in political, economic and public life. Access to sexual and reproductive health and reproductive rights and access to economic resources (e.g., land ownership, financial services) are also emphasized.
**Company-Level Issue Examples** *- Board Diversity, Gender Discrimination, Sexual Harassment.*| |**GOAL6CLEANWATERANDSANITATION**|**Clean Water and Sanitation** - Goal 6 not only addresses issues relating to drinking water, sanitation and hygiene, but also the quality and sustainability of water resources worldwide. It strives to achieve universal and equitable access to safe and affordable drinking water for all. It also focuses on adequate and equitable sanitation and hygiene and reducing pollution, minimizing release of hazardous chemicals and materials, and protection of water-related ecosystems. It also highlights increasing water-use efficiency across all sectors, recycling, and ensuring sustainable withdrawals and supply of freshwater.
**Company-Level Issue Examples** *- Water Pollution, Water Recycling and Stewardship, Water Infrastructure.*| |**GOAL7AFFORDABLEANDCLEANENERGY**|**Goal 7 Affordable and Clean Energy** - Goal 7 seeks to ensure access to affordable, reliable, and modern energy services for all. It aims to increase renewable energy in the global energy mix and improve energy efficiency significantly. It also calls for more access to clean energy research, technology, and infrastructure for renewable energy, energy efficiency, and advanced and cleaner fossil-fuel technology, and promoting investment in energy infrastructure and clean energy technology.
**Company-Level Issue Examples** *- Green Buildings, Renewable Energy, Unethical Utility Pricing.*| |**GOAL8DECENTWORKANDECONOMICGROWTH**|**Decent Work and Economic Growth** - Goal 8 focuses on economic productivity and supports policies for entrepreneurship, creativity and innovation that assist micro, small, and medium-sized enterprises. The Goal also seeks to reduce unemployment, the proportion of youth not working or in school, child labor, and forced labor. Also covered are the protection of labor rights, migrant workers, safe and secure working environments, sustainable tourism, and increasing the capacity of domestic financial institutions in regards to access to banking, insurance, and financial services.
**Company-Level Issue Examples** *- Job Creation, Labor Exploitation, Employee Health and Safety, Workplace Turnover, Supplier Transparency.*| |**GOAL9INDUSTRYINNOVATIONANDINFRASTRUCTURE**|**Industry Innovation and Infrastructure** - Goal 9 focuses on three important aspects of sustainable development, infrastructure, industrialization and innovation, including considerations for resiliency, equity, quality, reliability, access and affordability, and regional and transborder infrastructure. The Goal focuses on infrastructure upgrades and retrofitting of industries with increased resource-use efficiency and clean and environmentally sound technologies and industrial processes.
**Company-Level Issue Examples** *- Digital Divide, ESG integration in financial services, Engineering Structural Integrity.*| |**GOAL10REDUCEDINEQUALITIES**|**Reduced Inequalities** - Goal 10 calls for reducing inequalities in income as well as those based on age, sex, disability, race, ethnicity, origin, religion, or economic or other status within a country. The Goal addresses inequalities among countries, including those related to representation, migration, and development assistance. It aims to empower and promote social, economic, and political inclusion of all. The Goal stresses regulation and monitoring of global financial markets and institutions.
**Company-Level Issue Examples** *- Responsible Lending, Worker Discrimination, CEO Pay Gap, Worker Pay Gap, Workplace Diversity and Inclusion.*| |**GOAL11SUSTAINABLECITIESANDCOMMUNITIES**|**Sustainable Cities and Communities** - Goal 11 seeks to ensure access for all to adequate, safe, and affordable housing and basic services, and green and public spaces, and to upgrade slums. It focuses on improving transportation, air quality and municipal and other waste management, and creating inclusive and sustainable urbanization through participatory urban planning. The Goal also supports safeguarding the world''s cultural and natural heritage, while aiming to increase the number of cities and human settlements adopting and implementing integrated policies and plans towards inclusion, resource efficiency, mitigation and adaptation to climate change, and resilience to disasters.
**Company-Level Issue Examples** *- Air Pollution, Environmental Justice, Human Rights Violations, Affordable Housing.*| |**GOAL12RESPONSIBLECONSUMPTIONANDPRODUCTION**|**Responsible Consumption and Production** - Goal 12 aims to achieve the sustainable management and efficient use of natural resources through both the public and private sector. It specifically addresses global food waste in consumption, production, and distribution, sustainable tourism, waste and chemicals management. Goal 12 encourages sustainability reporting in the private sector, while in the public sector it encourages restructuring taxation and subsidies for fossil fuels and promoting sustainable public procurement practices.
**Company-Level Issue Examples** *- Sustainability Reporting, Circular Economy, Hazardous Waste Management, Waste Reduction.*| |**GOAL13CLIMATEACTION**|**Climate Action** - While Goal 13 is focused on actions by countries towards climate mitigation and adaptation, the private sector can also play a role in these areas. The goal seeks to strengthen resilience and adaptive capacity to climate-related hazards and natural disasters in all countries. It calls for integrating climate change measures, including those related to climate resilience and low GHG development, into national policies, strategies, and planning. It aims to improve education and awareness of climate change mitigation, adaptation, impact reduction, and early warning.
**Company-Level Issue Examples** *- GHG Emissions, Sustainable Transportation, Physical Climate Impacts.*| |**GOAL14LIFEBELOWWATER**|**Life Below Water** - Goal 14 focuses on preventing marine pollution of all kinds, particularly from land-based activities, and to minimize and address the impacts of ocean acidification. The Goal also aims to achieve sustainable yields in fisheries, through regulation of harvesting, controlling subsidies, and ending overfishing. It seeks to sustainably manage and protect marine and coastal ecosystems to avoid significant adverse impacts, including by strengthening their resilience, and take action for their restoration in order to achieve healthy and productive oceans.
**Company-Level Issue Examples** *- Impacts on water-related endangered species and habitats, Oil Spills, Seafood Sourcing.*| |**GOAL15LIFEONLAND**|**Life On Land** - Goal 15 seeks to ensure the conservation, restoration, and sustainable use of terrestrial and inland freshwater ecosystems and their services, in order to preserve biodiversity. It focuses specifically on sustainably managing forests, halting deforestation, restoring degraded lands and successfully combating desertification, reducing degraded natural habitats and ending biodiversity loss, with an emphasis on threatened species and invasive alien species.
**Company-Level Issue Examples** *- Impacts on land-related endangered species and habitats, Sustainable forestry practices and certifications, Project lifecycle environmental impacts.*| |**GOAL16PEACEJUSTICEANDSTRONGINSTITUTIONS**|**Peace, Justice, and Strong Institutions** - Goal 16 aims to significantly reduce all forms of violence, and also focuses specifically on reducing violence against children in the forms of abuse, exploitation, trafficking, and torture. It also aims to significantly reduce illicit financial and arms flows and to substantially reduce corruption and bribery in all their forms. The Goal also emphasizes effective and transparent institutions at all levels, inclusive and participatory decision-making, ensuring public access to information, and protection of fundamental freedoms.
**Company-Level Issue Examples** *- Tax Avoidance, Anti-Competitive Behavior, Cyber Security, Corruption, ESG Resolutions.*| ' example: - IMPACT - GOAL1NOPOVERTY sasbSpotlightsCategories: type: array default: - ALLCATEGORIES items: type: string description: "The SASB Categories requested for the respective scoreType(s). The default value is **ALLCATEGORIES**, which represents all 26 categories in a single overall score. To request a specifc category or list of categories, simply input the category names below. \n\n### SASB Categories\n|**SASB Category Inputs**|**Description**|\n|||\n|**ALLCATEGORIES**|**All Categories** - this category represents a company's overall SASB Score for the specific 'scoreType'. This value is equal to the cumulative average of all 26 SASB categories for the specific 'scoreType'.*Note that category is not available for the Dynamic Materiality 'scoreType'.\n|**ACCESSANDAFFORDABILITY**|**Access and Affordability** - The category addresses a company's ability to ensure broad access to its products and services, specifically in the context of underserved markets and/or population groups. It includes the management of issues related to universal needs, such as the accessibility and affordability of health care, financial services, utilities , education, and telecommunications.|\n|**AIRQUALITY**|**Air Quality** - the category addresses management of air quality impacts resulting from stationary (e.g., factories, power plants) and mobile sources (e.g., trucks, delivery vehicles, planes) as well as industrial emissions. Relevant airborne pollutants include, but are not limited to, oxides of nitrogen (NOx), oxides of sulfur (SOx), volatile organic compounds (VOCs), heavy metals, particulate matter, and chlorofluorocarbons. The category does not include GHG emissions, which are addressed in a separate category.|\n|**BUSINESSETHICS**|**Business Ethics** - the category addresses the company's approach to managing risks and opportunities surrounding ethical conduct of business, including fraud, corruption, bribery and facilitation payments, fiduciary responsibilities, and other behavior that may have an ethical component. This includes sensitivity to business norms and standards as they shift over time, jurisdiction, and culture. It addresses the company's ability to provide services that satisfy the highest professional and ethical standards of the industry, which means to avoid conflicts of interest, misrepresentation, bias, and negligence through training employees adequately and implementing policies and procedures to ensure employees provide services free from bias and error.|\n|**BUSMODELRESILIENCE**|**Business Model Resilience** - the category addresses an industry's capacity to manage risks and opportunities associated with incorporating social, environmental, and political transitions into long-term business model planning. This includes responsiveness to the transition to a low-carbon and climate-constrained economy, as well as growth and creation of new markets among unserved and underserved socioeconomic populations. The category highlights industries in which evolving environmental and social realities may challenge companies to fundamentally adapt or may put their business models at risk.|\n|**COMPETITIVEBEHAVIOR**|**Competitive Behavior** - the category covers social issues associated with existence of monopolies, which may include, but are not limited to, excessive prices, poor quality of service, and inefficiencies. It addresses a company's management of legal and social expectation around monopolistic and anti-competitive practices, including issues related to bargaining power, collusion, price fixing or manipulation, and protection of patents and intellectual property (IP).|\n|**CRITINCIDENTRISKMGT**|**Critical Incident Risk Management** - the category addresses the company's use of management systems and scenario planning to identify, understand, and prevent or minimize the occurrence of low-probability, high-impact accidents and emergencies with significant potential environmental and social externalities. It relates to the culture of safety at a company, its relevant safety management systems and technological controls, the potential human, environmental, and social implications of such events occurring, and the long-term effects to an organization, its workers, and society should these events occur.|\n|**CUSTOMERPRIVACY**|**Customer Privacy** - the category addresses management of risks related to the use of personally identifiable information (PII) and other customer or user data for secondary purposes including but not limited to marketing through affiliates and non-affiliates. The scope of the category includes social issues that may arise from a company's approach to collecting data, obtaining consent (e.g., opt-in policies), managing user and customer expectations regarding how their data is used, and managing evolving regulation. It excludes social issues arising from cybersecurity risks, which are covered in a separate category.|\n|**CUSTWELFARE**|**Customer Welfare** - the category addresses customer welfare concerns over issues including, but not limited to, health and nutrition of foods and beverages, antibiotic use in animal production, and management of controlled substances. The category addresses the company's ability to provide consumers with manufactured products and services that are aligned with societal expectations. It does not include issues directly related to quality and safety malfunctions of manufactured products and services, but instead addresses qualities inherent to the design and delivery of products and services where customer welfare may be in question. The scope of the category also captures companies' ability to prevent counterfeit products.|\n|**DATASECURITY**|**Data Security** - the category addresses management of risks related to collection, retention, and use of sensitive, confidential, and/or proprietary customer or user data. It includes social issues that may arise from incidents such as data breaches in which personally identifiable information (PII) and other user or customer data may be exposed. It addresses a company's strategy, policies, and practices related to IT infrastructure, staff training, record keeping, cooperation with law enforcement, and other mechanisms used to ensure security of customer or user data.|\n|**ECOLOGICALIMPACTS**|**Ecological Impacts** - the category addresses management of the company's impacts on ecosystems and biodiversity through activities including, but not limited to, land use for exploration, natural resource extraction, and cultivation, as well as project development, construction, and siting. The impacts include, but are not limited to, biodiversity loss, habitat destruction, and deforestation at all stages planning, land acquisition, permitting, development, operations, and site remediation. The category does not cover impacts of climate change on ecosystems and biodiversity.|\n|**EMPENGDIVANDINC**|**Employee Engagement Diversity and Inclusion** - the category addresses a company's ability to ensure that its culture and hiring and promotion practices embrace the building of a diverse and inclusive workforce that reflects the makeup of local talent pools and its customer base. It addresses the issues of discriminatory practices on the bases of race, gender, ethnicity, religion, sexual orientation, and other factors.|\n|**EMPHEALTHANDSAFETY**|**Employee Health and Safety** - the category addresses a company's ability to create and maintain a safe and healthy workplace environment that is free of injuries, fatalities, and illness (both chronic and acute). It is traditionally accomplished through implementing safety management plans, developing training requirements for employees and contractors, and conducting regular audits of their own practices as well as those of their subcontractors. The category further captures how companies ensure physical and mental health of workforce through technology, training, corporate culture, regulatory compliance, monitoring and testing, and personal protective equipment.|\n|**ENERGYMGT**|**Energy Management** - the category addresses environmental impacts associated with energy consumption. It addresses the company's management of energy in manufacturing and/or for provision of products and services derived from utility providers (grid energy) not owned or controlled by the company. More specifically, it includes management of energy efficiency and intensity, energy mix, as well as grid reliance. Upstream (e.g., suppliers) and downstream (e.g., product use) energy use is not included in the scope.|\n|**GHGEMISSIONS**|**Greenhouse Gas Emissions** - the category addresses direct (Scope 1) greenhouse gas (GHG) emissions that a company generates through its operations. This includes GHG emissions from stationary (e.g., factories, power plants) and mobile sources (e.g., trucks, delivery vehicles, planes), whether a result of combustion of fuel or non-combusted direct releases during activities such as natural resource extraction, power generation, land use, or biogenic processes. The category further includes management of regulatory risks, environmental compliance, and reputational risks and opportunities, as they related to direct GHG emissions. The seven GHGs covered under the Kyoto Protocol are included within the category carbon dioxide (CO2 ), methane (CH4), nitrous oxide (N2O), hydrofluorocarbons (HFCs), perfluorocarbons (PFCs), sulfur hexafluoride (SF6), and nitrogen trifluoride (NF3).|\n|**HUMANRIGHTSANDCOMRELS**|**Human Rights and Community Relations** - the category addresses management of the relationship between businesses and the communities in which they operate, including, but not limited to, management of direct and indirect impacts on core human rights and the treatment of indigenous peoples. More specifically, such management may cover socio-economic community impacts, community engagement, environmental justice, cultivation of local workforces, impact on local businesses, license to operate, and environmental/social impact assessments. The category does not include environmental impacts such as air pollution or waste which, although they may impact the health and safety of members of local communities, are addressed in separate categories.|\n|**LABORPRACTICES**|**Labor Practices** - the category addresses the company's ability to uphold commonly accepted labor standards in the workplace, including compliance with labor laws and internationally accepted norms and standards. This includes, but is not limited to, ensuring basic human rights related to child labor, forced or bonded labor, exploitative labor, fair wages and overtime pay, and other basic workers' rights. It also includes minimum wage policies and provision of benefits, which may influence how a workforce is attracted, retained, and motivated. The category further addresses a company's relationship with organized labor and freedom of association.|\n|**MGTOFLEGALANDREGENV**|**Management of the Legal and Regulatory Environment** - the category addresses a company's approach to engaging with regulators in cases where conflicting corporate and public interests may have the potential for long-term adverse direct or indirect environmental and social impacts. The category addresses a company's level of reliance upon regulatory policy or monetary incentives (such as subsidies and taxes), actions to influence industry policy (such as through lobbying), overall reliance on a favorable regulatory environment for business competitiveness, and ability to comply with relevant regulations. It may relate to the alignment of management and investor views of regulatory engagement and compliance at large.|\n|**MATSOURCINGANDEFF**|**Materials Sourcing and Efficiency** - the category addresses issues related to the resilience of materials supply chains to impacts of climate change and other external environmental and social factors. It captures the impacts of such external factors on operational activity of suppliers, which can further affect availability and pricing of key resources. It addresses a company's ability to manage these risks through product design, manufacturing, and end-of-life management, such as by using of recycled and renewable materials, reducing the use of key materials (dematerialization), maximizing resource efficiency in manufacturing, and making R&D investments in substitute materials. Additionally, companies can manage these issues by screening, selection, monitoring, and engagement with suppliers to ensure their resilience to external risks. It does not address issues associated with environmental and social externalities created by operational activity of individual suppliers, which is covered in a separate category.|\n|**MATERIALITY**|**Materiality** - this category represents a composite score of all 'material' SASB categories for the given entity. For more information on SASB's Materiality Map, visit [materiality.sasb.org](https://materiality.sasb.org/)|\n|**PHYIMPACTSOFCLIMATECHG**|**Physical Impacts of Climate Change** - the category addresses the company's ability to manage risks and opportunities associated with direct exposure of its owned or controlled assets and operations to actual or potential physical impacts of climate change. It captures environmental and social issues that may arise from operational disruptions due to physical impacts of climate change. It further captures socioeconomic issues resulting from companies failing to incorporate climate change consideration in products and services sold, such as insurance policies and mortgages. The category relates to the company's ability to adapt to increased frequency and severity of extreme weather, shifting climate, sea level risk, and other expected physical impacts of climate change. Management may involve enhancing resiliency of physical assets and/or surrounding infrastructure as well as incorporation of climate change-related considerations into key business activities (e.g., mortgage and insurance underwriting, planning and development of real estate projects).|\n|**PDANDLIFECYCLEMGT**|**Product Design and Lifecycle Management** - the category addresses incorporation of environmental, social, and governance (ESG) considerations in characteristics of products and services provided or sold by the company. It includes, but is not limited to, managing the lifecycle impacts of products and services, such as those related to packaging, distribution, use-phase resource intensity, and other environmental and social externalities that may occur during their use-phase or at the end of life. The category captures a company's ability to address customer and societal demand for more sustainable products and services as well as to meet evolving environmental and social regulation. It does not address direct environmental or social impacts of the company's operations nor does it address health and safety risks to consumers from product use, which are covered in other categories.|\n|**PRODQUALITYANDSFTY**|**Product Quality and Safety** - the category addresses issues involving unintended characteristics of products sold or services provided that may create health or safety risks to end-users. It addresses a company's ability to offer manufactured products and/or services that meet customer expectations with respect to their health and safety characteristics. It includes, but is not limited to, issues involving liability, management of recalls and market withdrawals, product testing, and chemicals/content/ ingredient management in products.|\n|**SELLPRACANDPRODLABEL**|**Selling Practices and Product Labeling** - the category addresses social issues that may arise from a failure to manage the transparency, accuracy, and comprehensibility of marketing statements, advertising, and labeling of products and services. It includes, but is not limited to, advertising standards and regulations, ethical and responsible marketing practices, misleading or deceptive labeling, as well as discriminatory or predatory selling and lending practices. This may include deceptive or aggressive selling practices in which incentive structures for employees could encourage the sale of products or services that are not in the best interest of customers or clients.|\n|**SUPPLYCHAINMGT**|**Supply Chain Management** - the category addresses management of environmental, social, and governance (ESG) risks within a company's supply chain. It addresses issues associated with environmental and social externalities created by suppliers through their operational activities. Such issues include, but are not limited to, environmental responsibility, human rights, labor practices, and ethics and corruption. Management may involve screening, selection, monitoring, and engagement with suppliers on their environmental and social impacts. The category does not address the impacts of external factors such as climate change and other environmental and social factors on suppliers' operations and/or on the availability and pricing of key resources, which is covered in a separate category.|\n|**SYSTEMICRISKMGT**|**Systemic Risk Management** - the category addresses the company's contributions to, or management of systemic risks resulting from large-scale weakening or collapse of systems upon which the economy and society depend. This includes financial systems, natural resource systems, and technological systems. It addresses the mechanisms a company has in place to reduce its contributions to systemic risks and to improve safeguards that may mitigate the impacts of systemic failure. For financial institutions, the category also captures the company's ability to absorb shocks arising from financial and economic stress and meet stricter regulatory requirements related to the complexity and interconnectedness of companies in the industry.|\n|**WASTEANDHZRDMATSMGT**|**Waste and Hazardous Materials Management** - the category addresses environmental issues associated with hazardous and non-hazardous waste generated by companies. It addresses a company's management of solid wastes in manufacturing, agriculture, and other industrial processes. It covers treatment, handling, storage, disposal, and regulatory compliance. The category does not cover emissions to air or wastewater, nor does it cover waste from end-of-life of products, which are addressed in separate categories.|\n|**WATERANDWASTEWATERMGT**|**Water and Wastewater Management** - the category addresses a company's water use, water consumption, wastewater generation, and other impacts of operations on water resources, which may be influenced by regional differences in the availability and quality of and competition for water resources. More specifically, it addresses management strategies including, but not limited to, water efficiency, intensity, and recycling. Lastly, the category also addresses management of wastewater treatment and discharge, including groundwater and aquifer pollution.|\n\n### Helper Input\n**ALL** = Simply gives the ability to request all categories in a single request without having to explicitly list out all 26 in the request. *This is not the same as \"ALLCATEGORIES\" which is a single overall score for the company and returned as default.*\n" example: - AIRQUALITY - BUSINESSETHICS - HUMANRIGHTSANDCOMRELS periodicitySurprise: type: string enum: - ANN - QTR - SEMI default: ANN description: The periodicity for the estimates, reflecting Annual, Semi-Annual and Quarterly Estimates. tvlIds: type: array items: type: string minItems: 1 maxItems: 1500 description: 'Security or Entity identifiers. FactSet Identifiers, tickers, CUSIP and SEDOL are accepted input.
***ids limit** = 1500 per 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.
* ' example: - AAPL-USA indexHistoryRequest: type: object title: Index History Request properties: ids: $ref: '#/components/schemas/indexIds' startDate: $ref: '#/components/schemas/startDate' endDate: $ref: '#/components/schemas/endDate' frequency: $ref: '#/components/schemas/frequency' returnType: $ref: '#/components/schemas/returnType' hedgeType: $ref: '#/components/schemas/hedgeType' currency: $ref: '#/components/schemas/currency' calendar: $ref: '#/components/schemas/calendar' impliedDate: $ref: '#/components/schemas/impliedDate' required: - ids spotlightsResponse: type: object title: Spotlights Response properties: data: description: Array ofSpotlights Objects type: array items: $ref: '#/components/schemas/Spotlights' example: [] surprise: title: Surprise type: object properties: fsymId: type: string example: SJY281-R nullable: true date: description: Date for data expressed in YYYY-MM-DD format. type: string format: date example: '2017-12-31' nullable: true currency: description: 'Currency code for adjusting the data. Use ''ESTIMATE'' as input value for the values in Estimate Currency. For a list of currency ISO codes, visit [Online Assistant Page #1470](https://oa.apps.factset.com/pages/1470).' type: string example: USD nullable: true estimateCurrency: description: Estimate currency of the requested Security type: string example: USD nullable: true metric: description: 'Company''s Financial statement ''metric'' that is estimated. Use the factset-estimates/v#/metrics endpoint for a complete list. For more details, visit [Online Assistant Page #15034](https://oa.apps.factset.com/pages/15034).' type: string example: SALES nullable: true statistic: description: 'Method of calculation for the consensus ''statistic''. For more details, visit [Online Assistant Page #16598](https://oa.apps.factset.com/pages/16114).' type: string example: MEAN nullable: true periodicity: description: Company's 'periodicity' for the estimate record, reflecting Annual, Quarterly, or Semi-Annual report periods. Next-twelve-months (NTMA) and Last-twelve-months (LTMA) also supported. type: string example: ANN nullable: true fiscalEndDate: description: Company's 'fiscal end date' for the estimate record expressed in YYYY-MM-DD format type: string format: date example: '2017-12-31' nullable: true fiscalYear: description: Company's 'fiscal year' for the estimate record type: integer example: 2018 nullable: true fiscalPeriod: description: Company's 'fiscal period' for the estimate record. 'Periodicity' defines context for period. type: integer example: 4 nullable: true surpriseDate: description: 'Date of the reported event expressed in YYYY-MM-DD format. For more details, visit [Online Assistant Page #16601](https://oa.apps.factset.com/pages/16601).' type: string format: date example: '2017-02-24' nullable: true surpriseAmount: description: 'Amount of difference between last consensus and actual. For more details, visit [Online Assistant Page #16145](https://oa.apps.factset.com/pages/16145).' type: number format: double example: 0.07951 nullable: true surprisePercent: description: 'Percent difference between last consensus and actual. For more details, visit [Online Assistant Page #16145](https://oa.apps.factset.com/pages/16145).' type: number format: double example: 6.16 nullable: true surpriseBefore: description: 'Last consensus before event. For more details, visit [Online Assistant Page #16145](https://oa.apps.factset.com/pages/16145).' type: number format: double example: 1.2905 nullable: true surpriseAfter: description: 'Actual value after event. For more details, visit [Online Assistant Page #16145](https://oa.apps.factset.com/pages/16145).' type: number format: double example: 1.3653 nullable: true eventDescription: description: 'Description of event. For more details, visit [Online Assistant Page #16601](https://oa.apps.factset.com/pages/16601).' type: string example: Results for 2016 nullable: true eventFlag: description: 'Flag for event. Code of Event Flag, where 0 = results and 1 = profit warning. For more details, visit [Online Assistant Page #16601](https://oa.apps.factset.com/pages/16601).' type: integer example: 0 nullable: true requestId: type: string example: IBM-US periodicity_2: type: string enum: - ANN - QTR - SEMI - LTMA - NTMA default: ANN description: The periodicity for the estimates, reflecting Annual, Semi-Annual and Quarterly Estimates. Next-twelve-months (NTMA) and Last-twelve-months (LTMA) also supported. sasbScores: title: SASB Scores Object type: object properties: date: description: Date for the period requested expressed in YYYY-MM-DD format. type: string format: date example: '2020-09-30' nullable: true fsymId: description: FactSet Entity Identifier. Six alpha-numeric characters, excluding vowels, with a -E suffix (XXXXXX-E). type: string example: 000BJT-E nullable: true requestId: description: Identifier that was used for the request. type: string example: ADBE-US sasbCategory: description: The specific SASB 'category' the score is referring to. type: string example: AIRQUALITY nullable: true sasbScore: description: The SASB Score value for the given 'scoreType' and 'category'. When scoreType = ESG_RANK, the data type will be string, otherwise data type will be a number with double format. type: object example: 41.61229277 nullable: true scoreType: description: 'The name of the specific SASB Score type being shown in the response. This will be represented by the scoreTypes input: PULSE, INSIGHT, MOMENTUM, ART_VOL_TTM, CAT_VOL_TTM, or DYNAMIC_MAT.' type: string example: PULSE nullable: true sdgCategories: type: array default: - IMPACT items: type: string description: "The SDG Categories specified for the Truvalue Scores being requested. To specify select categories returned in the response, provide a comma-separated list of the scores using the description below.\n\n|**SDG Category Input**|**Description**|\n|||\n|**IMPACT**|**Impact** - The aggregate SDG score for each company is simply named \"Impact.\" The SDG Impact Score is produced using a weighted average of individual category scores, where the weight utilized is the category score volume.|\n|**IMPACTARTICLES**|**Impact Articles** - The All Goals Category Volume measures the total number of times any of the 16 goals received a score over a trailing twelve-month (TTM) period of time. **( Data wil be returned only for `TTM_VOLUME` score type)** | \n|**GOAL1NOPOVERTY**|**No Poverty** - Goal 1 focuses on poverty in all its manifestations and also aims to ensure social protection for the poor and vulnerable, increase access to basic services and support people harmed by climate related extreme events and other economic, social and environmental shocks and disasters.**Company-Level Issue Examples** *- Financial services access and affordability, Underserved groups,Unethical pricing.*|\n|**GOAL2ZEROHUNGER**|**Zero Hunger** - Goal 2 aims to end hunger and all forms of malnutrition and commits to universal access to safe, nutritious and sufficient food at all times of the year, particularly for the poor and people in vulnerable situations (e.g., infants). This will require sustainable food production systems and resilient agricultural practices, equal access to land, technology, and markets and international cooperation on investments in infrastructure and technology to boost agricultural productivity.
**Company-Level Issue Examples** *- Sustainable agricultural practices, Agricultural ingredients sourcing and certifications, Food safety concerns, Animal welfare.*|\n|**GOAL3GOODHEALTHANDWELLBEING**|**Good Health and Wellbeing** - Goal 3 seeks to ensure health and wellbeing for all, at every stage of life and addresses all major health priorities, including reproductive, maternal, and child health; communicable, noncommunicable and environmental diseases; universal health coverage; and access for all to safe, effective, quality, and affordable medicines and vaccines.
**Company-Level Issue Examples** *- Harmful Chemicals in Products, Product Recalls, Healthcare Access and Affordability.*|\n|**GOAL4QUALITYEDUCATION**|**Quality Education** - Goal 4 addresses access and affordability of education and skills development starting from childhood development and continuing through adulthood, including for girls, persons with disabilities, indigenous peoples and children in vulnerable situations, Improvements to the access to education it hopes to ensure that all youth and a substantial proportion of adults achieve literacy and numeracy. It also seeks to build and upgrade education facilities and to increase the supply of qualified teachers.
**Company-Level Issue Examples** *- Mentorship and training, Education company quality, Education company ethics.*|\n|**GOAL5GENDEREQUALITY**|**Gender Equality** - Goal 5 emphasizes eliminating discrimination and violence against women and girls. The Goal emphasizes ensuring women's full and effective participation and equal opportunities for leadership at all levels of decision-making in political, economic and public life. Access to sexual and reproductive health and reproductive rights and access to economic resources (e.g., land ownership, financial services) are also emphasized.
**Company-Level Issue Examples** *- Board Diversity, Gender Discrimination, Sexual Harassment.*|\n|**GOAL6CLEANWATERANDSANITATION**|**Clean Water and Sanitation** - Goal 6 not only addresses issues relating to drinking water, sanitation and hygiene, but also the quality and sustainability of water resources worldwide. It strives to achieve universal and equitable access to safe and affordable drinking water for all. It also focuses on adequate and equitable sanitation and hygiene and reducing pollution, minimizing release of hazardous chemicals and materials, and protection of water-related ecosystems. It also highlights increasing water-use efficiency across all sectors, recycling, and ensuring sustainable withdrawals and supply of freshwater.
**Company-Level Issue Examples** *- Water Pollution, Water Recycling and Stewardship, Water Infrastructure.*|\n|**GOAL7AFFORDABLEANDCLEANENERGY**|**Goal 7 Affordable and Clean Energy** - Goal 7 seeks to ensure access to affordable, reliable, and modern energy services for all. It aims to increase renewable energy in the global energy mix and improve energy efficiency significantly. It also calls for more access to clean energy research, technology, and infrastructure for renewable energy, energy efficiency, and advanced and cleaner fossil-fuel technology, and promoting investment in energy infrastructure and clean energy technology.
**Company-Level Issue Examples** *- Green Buildings, Renewable Energy, Unethical Utility Pricing.*|\n|**GOAL8DECENTWORKANDECONOMICGROWTH**|**Decent Work and Economic Growth** - Goal 8 focuses on economic productivity and supports policies for entrepreneurship, creativity and innovation that assist micro, small, and medium-sized enterprises. The Goal also seeks to reduce unemployment, the proportion of youth not working or in school, child labor, and forced labor. Also covered are the protection of labor rights, migrant workers, safe and secure working environments, sustainable tourism, and increasing the capacity of domestic financial institutions in regards to access to banking, insurance, and financial services.
**Company-Level Issue Examples** *- Job Creation, Labor Exploitation, Employee Health and Safety, Workplace Turnover, Supplier Transparency.*|\n|**GOAL9INDUSTRYINNOVATIONANDINFRASTRUCTURE**|**Industry Innovation and Infrastructure** - Goal 9 focuses on three important aspects of sustainable development, infrastructure, industrialization and innovation, including considerations for resiliency, equity, quality, reliability, access and affordability, and regional and transborder infrastructure. The Goal focuses on infrastructure upgrades and retrofitting of industries with increased resource-use efficiency and clean and environmentally sound technologies and industrial processes.
**Company-Level Issue Examples** *- Digital Divide, ESG integration in financial services, Engineering Structural Integrity.*|\n|**GOAL10REDUCEDINEQUALITIES**|**Reduced Inequalities** - Goal 10 calls for reducing inequalities in income as well as those based on age, sex, disability, race, ethnicity, origin, religion, or economic or other status within a country. The Goal addresses inequalities among countries, including those related to representation, migration, and development assistance. It aims to empower and promote social, economic, and political inclusion of all. The Goal stresses regulation and monitoring of global financial markets and institutions.
**Company-Level Issue Examples** *- Responsible Lending, Worker Discrimination, CEO Pay Gap, Worker Pay Gap, Workplace Diversity and Inclusion.*|\n|**GOAL11SUSTAINABLECITIESANDCOMMUNITIES**|**Sustainable Cities and Communities** - Goal 11 seeks to ensure access for all to adequate, safe, and affordable housing and basic services, and green and public spaces, and to upgrade slums. It focuses on improving transportation, air quality and municipal and other waste management, and creating inclusive and sustainable urbanization through participatory urban planning. The Goal also supports safeguarding the world's cultural and natural heritage, while aiming to increase the number of cities and human settlements adopting and implementing integrated policies and plans towards inclusion, resource efficiency, mitigation and adaptation to climate change, and resilience to disasters.
**Company-Level Issue Examples** *- Air Pollution, Environmental Justice, Human Rights Violations, Affordable Housing.*|\n|**GOAL12RESPONSIBLECONSUMPTIONANDPRODUCTION**|**Responsible Consumption and Production** - Goal 12 aims to achieve the sustainable management and efficient use of natural resources through both the public and private sector. It specifically addresses global food waste in consumption, production, and distribution, sustainable tourism, waste and chemicals management. Goal 12 encourages sustainability reporting in the private sector, while in the public sector it encourages restructuring taxation and subsidies for fossil fuels and promoting sustainable public procurement practices.
**Company-Level Issue Examples** *- Sustainability Reporting, Circular Economy, Hazardous Waste Management, Waste Reduction.*|\n|**GOAL13CLIMATEACTION**|**Climate Action** - While Goal 13 is focused on actions by countries towards climate mitigation and adaptation, the private sector can also play a role in these areas. The goal seeks to strengthen resilience and adaptive capacity to climate-related hazards and natural disasters in all countries. It calls for integrating climate change measures, including those related to climate resilience and low GHG development, into national policies, strategies, and planning. It aims to improve education and awareness of climate change mitigation, adaptation, impact reduction, and early warning.
**Company-Level Issue Examples** *- GHG Emissions, Sustainable Transportation, Physical Climate Impacts.*|\n|**GOAL14LIFEBELOWWATER**|**Life Below Water** - Goal 14 focuses on preventing marine pollution of all kinds, particularly from land-based activities, and to minimize and address the impacts of ocean acidification. The Goal also aims to achieve sustainable yields in fisheries, through regulation of harvesting, controlling subsidies, and ending overfishing. It seeks to sustainably manage and protect marine and coastal ecosystems to avoid significant adverse impacts, including by strengthening their resilience, and take action for their restoration in order to achieve healthy and productive oceans.
**Company-Level Issue Examples** *- Impacts on water-related endangered species and habitats, Oil Spills, Seafood Sourcing.*|\n|**GOAL15LIFEONLAND**|**Life On Land** - Goal 15 seeks to ensure the conservation, restoration, and sustainable use of terrestrial and inland freshwater ecosystems and their services, in order to preserve biodiversity. It focuses specifically on sustainably managing forests, halting deforestation, restoring degraded lands and successfully combating desertification, reducing degraded natural habitats and ending biodiversity loss, with an emphasis on threatened species and invasive alien species.
**Company-Level Issue Examples** *- Impacts on land-related endangered species and habitats, Sustainable forestry practices and certifications, Project lifecycle environmental impacts.*|\n|**GOAL16PEACEJUSTICEANDSTRONGINSTITUTIONS**|**Peace, Justice, and Strong Institutions** - Goal 16 aims to significantly reduce all forms of violence, and also focuses specifically on reducing violence against children in the forms of abuse, exploitation, trafficking, and torture. It also aims to significantly reduce illicit financial and arms flows and to substantially reduce corruption and bribery in all their forms. The Goal also emphasizes effective and transparent institutions at all levels, inclusive and participatory decision-making, ensuring public access to information, and protection of fundamental freedoms.
**Company-Level Issue Examples** *- Tax Avoidance, Anti-Competitive Behavior, Cyber Security, Corruption, ESG Resolutions.*|\n" example: - IMPACT - GOAL1NOPOVERTY segmentsResponse: type: object title: Segments Response properties: data: description: Array of Segments objects type: array items: $ref: '#/components/schemas/segmentsEstimate' example: [] calendar: title: Calendar type: string enum: - FIVEDAY - SEVENDAY default: FIVEDAY description: Calendar of data returned. SEVENDAY includes weekends. example: FIVEDAY benchmarkIdList: title: Benchmark Id List Object type: object properties: fsymId: type: string description: Benchmark Id example: '990100' nullable: true name: type: string description: Name of the Benchmark ID example: MSCI World Index nullable: true familyName: type: string description: Name of the Benchmarks Family example: MSCI nullable: true market: type: string description: Market grouping related to the Benchmark Family example: Developed nullable: true categoryDescription: type: string description: Extended name or description of Benchmark Family & Market example: International Indices nullable: true startDate_2: type: string description: 'The start date requested for a given date range in **YYYY-MM-DD** format. Data is available on a Fiscal Annual periodicity, but updated Daily. If left blank, the API will default to previous close. Future dates (T+1) are not accepted in this endpoint. ' example: '2019-01-01' impliedDate: title: Implied Date type: string enum: - Y - N default: N description: This parameter controls the **date** returned in the date field. The default value is **N**. By default, the date field returns the actual date of the observation. This means it will repeat values for weekends and holidays. If set to **Y**, the date field will return the implied date of the observation, making all the dates unique. isRemoved: type: boolean description: 'This parameter would return the spotlights removed in the response(i.e. Spotlight is marked as Rejected but has a firstApprovedOnDate))when set to `true` Only Spotlights that are marked as approved will be returned when set to `false` ' default: false example: false metrics: title: Metrics type: array description: 'Requested List of FactSet Market Aggregates (FMA) or ratios. provided the below complete metrics list. |metric item|Description|category|periodicity |:|:|:|:| |GROSS_MARGIN|Gross Margin|Profitability (%)|NTMA, LTMA, STMA, LTM, QTR, 0, 1, 2 |OPER_INC_SALES|Operating Margin|Profitability (%)|LTM, QTR |NET_MGN|Net Margin|Profitability (%)|NTMA, LTMA, STMA, LTM, QTR, 0, 1, 2 |EBIT_MARGIN|EBIT Margin|Profitability (%)| NTMA, LTMA, STMA, LTM, QTR, 0, 1, 2 |EBITDA_MARGIN|EBITDA Margin|Profitability (%)|NTMA, LTMA, STMA, LTM, QTR, 0, 1, 2 |ROA|Return on Assets|Profitability (%)|LTM |ROE|Return on Equity|Profitability (%)|NTMA, LTMA, LTM, 0, 1, 2 |ROIC|Return on Invested Capital|Profitability (%)| LTM |FCF_MGN|Free Cash Flow Margin|Profitability (%)|LTM, QTR |PE|Price/Earnings|Valuation|NTMA, LTMA, STMA, LTM, QTR, 0, 1, 2 |PEX|Price/Earnings (excl negatives)|Valuation|LTM |PSALES|Price/Sales|Valuation|NTMA, LTMA, STMA, LTM, QTR, 0, 1, 2 |PBK|Price/Book Value|Valuation|NTMA, LTMA, LTM, 0, 1, 2 |PCF|Price/Cash Flow|Valuation|NTMA, LTMA, LTM, 0, 1, 2 |PCFX|Price/Cash Flow (excl negatives)|Valuation|LTM |PFCF|Price/Free Cash Flow|Valuation|NTMA, LTMA, LTM, 0, 1, 2 |EVAL_EBIT|Enterprise Value/EBIT|Valuation|NTMA, LTMA, LTM, 0, 1, 2 |EVAL_EBITDA|Enterprise Value/EBITDA|Valuation|NTMA, LTMA, LTM, 0, 1, 2 |EVAL_SALES|Enterprise Value/Sales|Valuation|NTMA, LTMA, LTM, 0, 1, 2 |NDEBT_EBITDA|Net Debt/EBITDA|Coverage|NTMA, LTMA, LTM, 0, 1, 2 |NDEBT_EBITDA_MIN_CAPEX|Net Debt/(EBITDA-Capex)|Coverage|LTM |DEBT_EBITDA|Total Debt/EBITDA|Coverage|LTM |DEBT_EBIT|Total Debt/EBIT|Coverage|LTM |EBIT_INT_EXP|EBIT/Interest Expense (Int. Coverage)|Coverage|LTM |EBITDA_INT_EXP|EBITDA/Interest Expense|Coverage|LTM |OPER_CF_INT_EXP|CFO/Interest Expense|Coverage|LTM |LTD_EBITDA|LT Debt/EBITDA|Coverage|LTM |NDEBT_FFO|Net Debt/FFO|Coverage|LTM |LTD_FFO|LT Debt/FFO|Coverage|LTM |FCF_DEBT|FCF/Total Debt|Coverage|LTM |OPER_CF_DEBT|CFO/Total Debt|Coverage|LTM |LTD_EQ|LT Debt/Total Equity|Leverage(%)|LTM |LTD_TCAP|LT Debt/Total Capital|Leverage(%)|LTM |LTD_ASSETS|LT Debt/Total Assets|Leverage(%)|LTM |DEBT_ASSETS|Total Debt/Total Assets|Leverage(%)|LTM |DEBT_EQ|Total Debt/Total Equity|Leverage(%)|LTM |NDEBT_TCAP|Net Debt/Total Capital|Leverage(%)|LTM |DEBT_TCAP|Total Debt/Total Capital|Leverage(%)|LTM ' items: type: string minItems: 1 maxItems: 38 example: - PE detailRatingsResponse: type: object title: Detail Ratings Response properties: data: description: Array of detail ratings estimate objects type: array items: $ref: '#/components/schemas/detailRatings' example: [] startDate_3: type: string description: '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 accepted in this #endpoint. ' example: '2019-01-01' fiscalPeriodStart_2: type: string description: "Fiscal period start expressed in absolute date formats. Date that will fall back to most recent completed period during resolution.\n * **Fiscal Quarter-end** - YYYY/FQ (e.g., 2019/1F, 2019/2F, 2019/3F, 2019/4F)\n * **Semiannual Period-end** - YYYY/FSA (e.g., 2019/1S, 2019/2S)\n * **Fiscal Year-end** - YYYY (e.g. 2019)\n" example: '2019' metrics_2: type: array items: type: string description: '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 more details, visit [Online Assistant Page #15034](https://oa.apps.factset.com/pages/15034).' example: - SALES minItems: 1 fixedIncomeBenchmarkConstituentsRequest: type: object title: Fixed Income Benchmark Constituents Request properties: ids: $ref: '#/components/schemas/fIConstituentIds' date: $ref: '#/components/schemas/requestedDate' currency: $ref: '#/components/schemas/currency' required: - ids relativeFiscalStart: type: integer description: Relative fiscal period, expressed as an integer, used to filter results. example: 1 fiscalPeriodEnd_2: type: string description: "Fiscal period end expressed in absolute date formats. Date that will fall back to most recent completed period during resolution.\n * **Month-end** - MM/YYYY (e.g., 11/2019)\n * **Fiscal Quarter-end** - YYYY/FQ (e.g., 2019/1F, 2019/2F, 2019/3F, 2019/4F)\n * **Semiannual Period-end** - YYYY/FSA (e.g., 2019/1S, 2019/2S)\n * **Fiscal Year-end** - YYYY (e.g. 2019)\n" example: '2020' relativeFiscalEnd: type: integer description: Relative fiscal period, expressed as an integer, used to filter results. example: 3 includeAll: type: boolean default: false example: false description: "Include All filter is used to identify included and excluded broker details from the consensus\n By default the service would return only the brokers included in the consensus-\n * **TRUE** = Returns all the brokers included and excluded in the consensus\n * **FALSE** = Returns only the broker details included in the consensus\n" detailEstimate: title: Detail type: object properties: fsymId: type: string example: SJY281-R nullable: true metric: description: 'Company''s Financial statement ''metric'' that is estimated. Use the factset-estimates/v#/metrics endpoint for a complete list. For more details, visit [Online Assistant Page #15034](https://oa.apps.factset.com/pages/15034).' type: string example: SALES nullable: true periodicity: description: Company's 'periodicity' for the estimate record, reflecting Annual, Quarterly, or Semi-Annual report periods. type: string example: ANN nullable: true fiscalYear: description: Company's 'fiscal year' for the estimate record type: integer example: 2018 nullable: true fiscalPeriod: description: Company's 'fiscal period' for the estimate record. 'Periodicity' defines context for period. type: integer example: 4 nullable: true fiscalEndDate: description: Company's 'fiscal end date' for the estimate record expressed in YYYY-MM-DD format type: string format: date example: '2017-12-31' nullable: true relativePeriod: description: '''Fiscal period'' based on relationship to ''estimate date''. This is not applicable for fixed-consensus endpoint. For more details, visit [Online Assistant Page #16598](https://oa.apps.factset.com/pages/16598)' type: integer example: 2 nullable: true currency: description: 'Currency code for adjusting the data. Use ''ESTIMATE'' as input value for the values in Estimate Currency. For a list of currency ISO codes, visit [Online Assistant Page #1470](https://oa.apps.factset.com/pages/1470).' type: string example: USD nullable: true estimateDate: description: 'Date of estimate expressed in YYYY-MM-DD format. For more details, visit [Online Assistant Page #16598](https://oa.apps.factset.com/pages/16598)' type: string format: date example: '2017-07-24' nullable: true estimateValue: description: The value of the estimate. type: number format: double example: 23456 nullable: true analystId: description: The FactSet Entity Identifier for the analyst making the estimate. type: string example: 0DXTST-E nullable: true analystName: description: The name of the analyst making the estimate. type: string example: Josh Baer nullable: true brokerId: description: The FactSet Entity Identifier for the broker making the estimate. type: string example: 05FBK7-E nullable: true brokerName: description: The name of the broker making the estimate. type: string example: Morgan Stanley nullable: true lastModifiedDate: description: The date at which a broker provided an estimate that is a revision. type: string format: date example: '2017-07-24' nullable: true prevEstimateDate: description: 'Date the previous estimate was made expressed in YYYY-MM-DD format. For more details, visit [Online Assistant Page #16598](https://oa.apps.factset.com/pages/16598)' type: string format: date example: '2017-05-02' nullable: true prevEstimateValue: description: The value of the previous estimate. type: number format: double example: 22336 nullable: true section: description: Section of the estimate.Returns the details of brokers inlcuded and excluded in the consensus type: string example: Included nullable: true statusCode: description: Status code of the estimate. type: integer example: 0 nullable: true statusText: description: Status description of the estimate. type: string example: '' nullable: true requestId: description: Identifier that was used for the request. type: string example: IBM-US inputDateTime: description: Date and time when the data is available at the source. type: string format: string example: '2022-10-25T22:40:09' nullable: true securityCurrency: description: The currency that the company trades in. type: string example: USD nullable: true brokerEstimateCurrency: description: The currency in which estimates are made by broker. type: string example: USD nullable: true estimateCurrency: description: Estimate currency of the requested Security type: string example: USD nullable: true dateOf: type: string default: PUBLICATION enum: - PUBLICATION - INGESTION description: "Date of Publication or Ingestion * **Publication:** use for startDate and endDate the articles publication date * **Ingestion:** use for startDate and endDate the articles TVL first processing date \n" example: PUBLICATION benchmarkRatios: title: Benchmark Ratios Object type: object properties: fsymId: type: string description: Requested Identifier. Must be a valid Benchmark Identifier recognized by FactSet. example: SP50 nullable: true date: description: The respective date for values as of the date requested in YYYY-MM-DD format. type: string format: date example: '2020-12-31' nullable: true name: description: Proper Name of Index. type: string example: S&P 500 nullable: true requestId: type: string description: Benchmark Identifier specified in the request. example: SP50 metric: type: string description: Metric requested example: GROSS_MARGIN nullable: true periodicity: type: string description: The periodicity submitted in the request. example: LTM nullable: true currency: type: string description: The currency submitted in the request. example: USD nullable: true value: type: number format: double description: Ratio value based on the metric requested. example: 35.4094680290153 nullable: true sdgArticle: title: Articles All Object type: object properties: date: description: Date of article based on dateOf parameter. type: string format: date example: '2020-05-02' nullable: true fsymId: description: FactSet Entity Identifier. Six alpha-numeric characters, excluding vowels, with a -E suffix (XXXXXX-E). type: string example: 001MF1-E nullable: true requestId: description: Identifier that was used for the request. type: string example: AAPL-US additionalProperties: true required: - date - fsymId - requestId returnType: title: Return Type type: string enum: - GROSS - NET default: GROSS description: The return type adjustment used in returns response items. Adjustment can be made for GROSS and NET dividends that will be included in the return calculation. The service will default to GROSS. example: GROSS frequency: title: Frequency type: string enum: - D - W - M - AM - CQ - AY - CY default: CY description: "Controls the display frequency of the data returned.\n * **D** = Daily\n * **W** = Weekly, based on the last day of the week of the start date.\n * **M** = Monthly, based on the last trading day of the month.\n * **AM** = Monthly, based on the start date (e.g., if the start date is June 16, data is displayed for June 16, May 16, April 16 etc.). \n * **CQ** = Quarterly based on the last trading day of the calendar quarter (March, June, September, or December).\n * **AY** = Actual Annual, based on the start date.\n * **CY** = Calendar Annual, based on the last trading day of the calendar year.\n" example: CY indexHistory: title: Index History Object type: object properties: fsymId: type: string description: Requested Identifier. Must be a valid Benchmark Identifier recognized by FactSet. example: SP50 nullable: true date: description: The respective date for values as of the date requested in YYYY-MM-DD format. type: string format: date example: '2020-07-01' nullable: true name: description: Proper Name of Index. type: string example: S&P 500 nullable: true constituentNumber: description: The total number of constituents as of the date requested. type: integer example: 502 nullable: true currency: description: Currency Code used in adjustments. If no Currency was requested, the service will default to LOCAL ('LOC'). type: string example: USD nullable: true marketValue: description: Index Level Market Capitalization as of the date requested expressed in millions. type: number format: double example: 27696158.012077 nullable: true price: description: Index Level Price type: number format: double example: 3349.15600690205 nullable: true priceReturnPercent: description: Index Level Price Percent Change type: number format: double example: 0.642620385795123 nullable: true totalReturnLevel: description: Index Level Total Return Amount type: number format: double example: 6870.86168040129 nullable: true totalReturnPercent: description: Index Level Total Return Percent Change type: number format: double example: 0.653957589855003 nullable: true returnType: description: The requested Return Type - GROSS or NET type: string example: GROSS nullable: true hedgeType: description: The requested Hedge Type - HEDGED or UNHEDGED type: string example: UNHEDGED nullable: true requestId: type: string description: Benchmark Identifier specified in the request example: SP50 observationDate: description: This field will always return the date of the data that was actually returned. type: string example: '2020-07-21' nullable: true familyFilter: title: Family Filter description: 'Highest Level Filter to search by common Benchmark Families, such as S&P, MSCI, or Russell. This will retrieve all related benchmark ids. For further filtering, use the response items such as the categoryDescription field. Leave blank if you wish to see a full sample list of ids. requested- * **CHINA & HK INDICES** - Major Hong Kong and China Indices, such as Hang Seng Index (HSI-HKX) * **DOW JONES** - Dow Jones Global, Regions, Countries, Titans. * **FACTSET MARKET INDICES** - Regional and Country Indices defined by FactSet * **FTSE** - FTSE Global, UK, Global All Cap, World, Xinhua, European, GWA, JSE, Multinationals, and Style indices * **GLOBAL INDICES** - A mix of major indices across the globe. * **MSCI** - MSCI All Country, Asia Pacific, Thematic & Strategy, Emerging, Developed, US. * **RUSSELL** - US, Global, and Nomura. * **S&P** - US, ASX, Select Industry, BMI, Global, Thematic, Emerging, TSX. * **STOXX** - Total Market, Europe, and Nordic * **TOPIX** - Topix Indices, such as TOPIX 500 (182301) ' type: string enum: - CHINA_HK_INDICES - DOW_JONES - FACTSET_MARKET_INDICES - FTSE - GLOBAL_INDICES - MSCI - RUSSELL - SP - STOXX - TOPIX example: MSCI endDate_2: type: string description: 'The end date requested for a given date range in **YYYY-MM-DD** format. Data is available on a Fiscal Annual periodicity, but updated Daily. If left blank, the API will default to previous close. Future dates (T+1) are not accepted in this endpoint. ' example: '2019-12-31' sdgScores: title: SDG Scores All Object type: object properties: date: description: Ending date for the period requested expressed in YYYY-MM-DD format. type: string format: date example: '2020-05-02' nullable: true fsymId: description: FactSet Entity Identifier. Six alpha-numeric characters, excluding vowels, with a -E suffix (XXXXXX-E). type: string example: 001MF1-E nullable: true requestId: description: Identifier that was used for the request. type: string example: US0231351067 scoreType: description: 'The name of the specific SDG Score type being shown in the response. This will be represented by the scoreTypes input: PULSE, INSIGHT, MOMENTUM, ART_VOL_TTM, CAT_VOL_TTM, or DYNAMIC_MAT.' type: string example: PULSE nullable: true additionalProperties: true required: - date - fsymId - requestId - scoreType sasbScoresResponse: type: object title: SASB Scores Response properties: data: description: Array of SASB Scores Objects type: array items: $ref: '#/components/schemas/sasbScores' example: [] sdgArticlesCategories: type: array default: - IMPACT items: type: string description: 'The SDG Categories specified for the Truvalue Scores being requested. To specify select categories returned in the response, provide a comma-separated list of the scores using the description below. |**SDG Category Input**|**Description**| ||| |**IMPACT**|**Impact** - Provides Articles tagged to all SDG categories| |**GOAL1NOPOVERTY**|**No Poverty** - Goal 1 focuses on poverty in all its manifestations and also aims to ensure social protection for the poor and vulnerable, increase access to basic services and support people harmed by climate related extreme events and other economic, social and environmental shocks and disasters.
**Company-Level Issue Examples** *- Financial services access and affordability, Underserved groups,Unethical pricing.*| |**GOAL2ZEROHUNGER**|**Zero Hunger** - Goal 2 aims to end hunger and all forms of malnutrition and commits to universal access to safe, nutritious and sufficient food at all times of the year, particularly for the poor and people in vulnerable situations (e.g., infants). This will require sustainable food production systems and resilient agricultural practices, equal access to land, technology, and markets and international cooperation on investments in infrastructure and technology to boost agricultural productivity.
**Company-Level Issue Examples** *- Sustainable agricultural practices, Agricultural ingredients sourcing and certifications, Food safety concerns, Animal welfare.*| |**GOAL3GOODHEALTHANDWELLBEING**|**Good Health and Wellbeing** - Goal 3 seeks to ensure health and wellbeing for all, at every stage of life and addresses all major health priorities, including reproductive, maternal, and child health; communicable, noncommunicable and environmental diseases; universal health coverage; and access for all to safe, effective, quality, and affordable medicines and vaccines.
**Company-Level Issue Examples** *- Harmful Chemicals in Products, Product Recalls, Healthcare Access and Affordability.*| |**GOAL4QUALITYEDUCATION**|**Quality Education** - Goal 4 addresses access and affordability of education and skills development starting from childhood development and continuing through adulthood, including for girls, persons with disabilities, indigenous peoples and children in vulnerable situations, Improvements to the access to education it hopes to ensure that all youth and a substantial proportion of adults achieve literacy and numeracy. It also seeks to build and upgrade education facilities and to increase the supply of qualified teachers.
**Company-Level Issue Examples** *- Mentorship and training, Education company quality, Education company ethics.*| |**GOAL5GENDEREQUALITY**|**Gender Equality** - Goal 5 emphasizes eliminating discrimination and violence against women and girls. The Goal emphasizes ensuring women''s full and effective participation and equal opportunities for leadership at all levels of decision-making in political, economic and public life. Access to sexual and reproductive health and reproductive rights and access to economic resources (e.g., land ownership, financial services) are also emphasized.
**Company-Level Issue Examples** *- Board Diversity, Gender Discrimination, Sexual Harassment.*| |**GOAL6CLEANWATERANDSANITATION**|**Clean Water and Sanitation** - Goal 6 not only addresses issues relating to drinking water, sanitation and hygiene, but also the quality and sustainability of water resources worldwide. It strives to achieve universal and equitable access to safe and affordable drinking water for all. It also focuses on adequate and equitable sanitation and hygiene and reducing pollution, minimizing release of hazardous chemicals and materials, and protection of water-related ecosystems. It also highlights increasing water-use efficiency across all sectors, recycling, and ensuring sustainable withdrawals and supply of freshwater.
**Company-Level Issue Examples** *- Water Pollution, Water Recycling and Stewardship, Water Infrastructure.*| |**GOAL7AFFORDABLEANDCLEANENERGY**|**Goal 7 Affordable and Clean Energy** - Goal 7 seeks to ensure access to affordable, reliable, and modern energy services for all. It aims to increase renewable energy in the global energy mix and improve energy efficiency significantly. It also calls for more access to clean energy research, technology, and infrastructure for renewable energy, energy efficiency, and advanced and cleaner fossil-fuel technology, and promoting investment in energy infrastructure and clean energy technology.
**Company-Level Issue Examples** *- Green Buildings, Renewable Energy, Unethical Utility Pricing.*| |**GOAL8DECENTWORKANDECONOMICGROWTH**|**Decent Work and Economic Growth** - Goal 8 focuses on economic productivity and supports policies for entrepreneurship, creativity and innovation that assist micro, small, and medium-sized enterprises. The Goal also seeks to reduce unemployment, the proportion of youth not working or in school, child labor, and forced labor. Also covered are the protection of labor rights, migrant workers, safe and secure working environments, sustainable tourism, and increasing the capacity of domestic financial institutions in regards to access to banking, insurance, and financial services.
**Company-Level Issue Examples** *- Job Creation, Labor Exploitation, Employee Health and Safety, Workplace Turnover, Supplier Transparency.*| |**GOAL9INDUSTRYINNOVATIONANDINFRASTRUCTURE**|**Industry Innovation and Infrastructure** - Goal 9 focuses on three important aspects of sustainable development, infrastructure, industrialization and innovation, including considerations for resiliency, equity, quality, reliability, access and affordability, and regional and transborder infrastructure. The Goal focuses on infrastructure upgrades and retrofitting of industries with increased resource-use efficiency and clean and environmentally sound technologies and industrial processes.
**Company-Level Issue Examples** *- Digital Divide, ESG integration in financial services, Engineering Structural Integrity.*| |**GOAL10REDUCEDINEQUALITIES**|**Reduced Inequalities** - Goal 10 calls for reducing inequalities in income as well as those based on age, sex, disability, race, ethnicity, origin, religion, or economic or other status within a country. The Goal addresses inequalities among countries, including those related to representation, migration, and development assistance. It aims to empower and promote social, economic, and political inclusion of all. The Goal stresses regulation and monitoring of global financial markets and institutions.
**Company-Level Issue Examples** *- Responsible Lending, Worker Discrimination, CEO Pay Gap, Worker Pay Gap, Workplace Diversity and Inclusion.*| |**GOAL11SUSTAINABLECITIESANDCOMMUNITIES**|**Sustainable Cities and Communities** - Goal 11 seeks to ensure access for all to adequate, safe, and affordable housing and basic services, and green and public spaces, and to upgrade slums. It focuses on improving transportation, air quality and municipal and other waste management, and creating inclusive and sustainable urbanization through participatory urban planning. The Goal also supports safeguarding the world''s cultural and natural heritage, while aiming to increase the number of cities and human settlements adopting and implementing integrated policies and plans towards inclusion, resource efficiency, mitigation and adaptation to climate change, and resilience to disasters.
**Company-Level Issue Examples** *- Air Pollution, Environmental Justice, Human Rights Violations, Affordable Housing.*| |**GOAL12RESPONSIBLECONSUMPTIONANDPRODUCTION**|**Responsible Consumption and Production** - Goal 12 aims to achieve the sustainable management and efficient use of natural resources through both the public and private sector. It specifically addresses global food waste in consumption, production, and distribution, sustainable tourism, waste and chemicals management. Goal 12 encourages sustainability reporting in the private sector, while in the public sector it encourages restructuring taxation and subsidies for fossil fuels and promoting sustainable public procurement practices.
**Company-Level Issue Examples** *- Sustainability Reporting, Circular Economy, Hazardous Waste Management, Waste Reduction.*| |**GOAL13CLIMATEACTION**|**Climate Action** - While Goal 13 is focused on actions by countries towards climate mitigation and adaptation, the private sector can also play a role in these areas. The goal seeks to strengthen resilience and adaptive capacity to climate-related hazards and natural disasters in all countries. It calls for integrating climate change measures, including those related to climate resilience and low GHG development, into national policies, strategies, and planning. It aims to improve education and awareness of climate change mitigation, adaptation, impact reduction, and early warning.
**Company-Level Issue Examples** *- GHG Emissions, Sustainable Transportation, Physical Climate Impacts.*| |**GOAL14LIFEBELOWWATER**|**Life Below Water** - Goal 14 focuses on preventing marine pollution of all kinds, particularly from land-based activities, and to minimize and address the impacts of ocean acidification. The Goal also aims to achieve sustainable yields in fisheries, through regulation of harvesting, controlling subsidies, and ending overfishing. It seeks to sustainably manage and protect marine and coastal ecosystems to avoid significant adverse impacts, including by strengthening their resilience, and take action for their restoration in order to achieve healthy and productive oceans.
**Company-Level Issue Examples** *- Impacts on water-related endangered species and habitats, Oil Spills, Seafood Sourcing.*| |**GOAL15LIFEONLAND**|**Life On Land** - Goal 15 seeks to ensure the conservation, restoration, and sustainable use of terrestrial and inland freshwater ecosystems and their services, in order to preserve biodiversity. It focuses specifically on sustainably managing forests, halting deforestation, restoring degraded lands and successfully combating desertification, reducing degraded natural habitats and ending biodiversity loss, with an emphasis on threatened species and invasive alien species.
**Company-Level Issue Examples** *- Impacts on land-related endangered species and habitats, Sustainable forestry practices and certifications, Project lifecycle environmental impacts.*| |**GOAL16PEACEJUSTICEANDSTRONGINSTITUTIONS**|**Peace, Justice, and Strong Institutions** - Goal 16 aims to significantly reduce all forms of violence, and also focuses specifically on reducing violence against children in the forms of abuse, exploitation, trafficking, and torture. It also aims to significantly reduce illicit financial and arms flows and to substantially reduce corruption and bribery in all their forms. The Goal also emphasizes effective and transparent institutions at all levels, inclusive and participatory decision-making, ensuring public access to information, and protection of fundamental freedoms.
**Company-Level Issue Examples** *- Tax Avoidance, Anti-Competitive Behavior, Cyber Security, Corruption, ESG Resolutions.*| ' example: - IMPACT - GOAL1NOPOVERTY sfdrPai: title: SFDR PAI Indicators Response Object type: object properties: fsymId: description: FactSet Entity Identifier. Six alpha-numeric characters, excluding vowels, with a -E suffix (XXXXXX-E). type: string example: 001MF1-E nullable: true requestId: description: Identifier that was used for the request. type: string example: US0231351067 subTopicCode: description: Codes for the General, Mandatory and Additional PAI indicators type: string example: EN001 nullable: true subTopicName: description: Names for the General, Mandatory and Additional PAI indicators type: string example: Scope 1 GHG emissions nullable: true indicatorType: description: The type of indicator - General, Additional & Mandatory type: string example: Mandatory nullable: true periodEndDate: description: The Reporting period end date expressed in YYYY-MM-DD format type: string format: date example: '2020-09-26' nullable: true reportingPeriod: description: The reporting period of the company expressed in YYYY format type: string example: '2020' nullable: true standardizedUnit: description: The units of measurements for the indicators type: string example: Metric ton CO2 e nullable: true standardizedValue: description: The PAI calculations based on the company-reported data, some metrics sourced from Factset Databases and Truvalue SASB Spotlights type: string example: '9620000' nullable: true sdgEndDate: type: string description: 'The end date requested for a given date range in YYYY-MM-DD format. The input end date must be after the input start date. Future dates (T+1) are not accepted in this endpoint. ' example: '2021-10-30' consensusEstimate: title: Consensus Estimate type: object properties: requestId: description: Identifier that was used for the request. type: string example: IBM-US fsymId: description: Factset Regional Security Identifier. Six alpha-numeric characters, excluding vowels, with an -R suffix (XXXXXX-R). Identifies the security's best regional security data series per currency. For equities, all primary listings per region and currency are allocated a regional-level permanent identifier. The regional-level permanent identifier will be available once a SEDOL representing the region/currency has been allocated and the identifiers are on FactSet. type: string example: SJY281-R nullable: true metric: description: 'Company''s Financial statement ''metric'' that is estimated. Use the factset-estimates/v#/metrics endpoint for a complete list. For more details, visit [Online Assistant Page #15034](https://oa.apps.factset.com/pages/15034)' type: string example: SALES nullable: true periodicity: description: The reporting interval for the estimate. This is derived from Estimate Date and is translated to the Period List = ANN, QTR, SEMI, LTMA, or NMTA. type: string example: ANN nullable: true fiscalPeriod: description: 'Company''s ''fiscal period'' for the estimate record. Periods for periodicity of ANN = 1, and SEMI = 2. For more details, visit [Online Assistant Page #16598](https://oa.apps.factset.com/pages/16598).' type: integer example: 4 nullable: true fiscalYear: description: 'Company''s ''fiscal year'' for the estimate record. For more details, visit [Online Assistant Page #16598](https://oa.apps.factset.com/pages/16598)' type: integer example: 2018 nullable: true fiscalEndDate: description: 'Company''s ''fiscal end date'' for the estimate record expressed in YYYY-MM-DD format. For more details, visit [Online Assistant Page #16598](https://oa.apps.factset.com/pages/16598)' type: string format: date example: '2017-12-31' nullable: true relativePeriod: description: '''Fiscal period'' based on relationship to ''estimate date''. This is not applicable for fixed-consensus endpoint. For more details, visit [Online Assistant Page #16598](https://oa.apps.factset.com/pages/16598)' type: integer example: 2 nullable: true estimateDate: description: 'Date of estimate expressed in YYYY-MM-DD format. For more details, visit [Online Assistant Page #16598](https://oa.apps.factset.com/pages/16598)' type: string format: date example: '2017-07-24' nullable: true currency: description: 'Currency code for adjusting the data. Use ''ESTIMATE'' as input value for the values in Estimate Currency. For a list of currency ISO codes, visit [Online Assistant Page #1470](https://oa.apps.factset.com/pages/1470).' type: string example: USD nullable: true estimateCurrency: description: Estimate currency of the requested Security type: string example: USD nullable: true mean: description: 'Mean of estimates in consensus calculation. For more details, visit [Online Assistant Page #16598](https://oa.apps.factset.com/pages/16114)' type: number format: double example: 12345.01 nullable: true median: description: 'Median of estimates in consensus calculation. For more details, visit [Online Assistant Page #16598](https://oa.apps.factset.com/pages/16114)' type: number format: double example: 12346.01 nullable: true standardDeviation: description: 'Standard deviation of estimates in consensus calculation. For more details, visit [Online Assistant Page #16598](https://oa.apps.factset.com/pages/16114)' type: number format: double example: 0.011034 nullable: true high: description: 'Highest estimate in consensus calculation. For more details, visit [Online Assistant Page #16598](https://oa.apps.factset.com/pages/16114).' type: number format: double example: 12349.01 nullable: true low: description: 'Lowest estimate in consensus calculation. For more details, visit [Online Assistant Page #16598](https://oa.apps.factset.com/pages/16114)' type: number format: double example: 12344.01 nullable: true estimateCount: description: 'Count or NEST of estimates in consensus calculation. For more details, visit [Online Assistant Page #16598](https://oa.apps.factset.com/pages/16114)' type: integer example: 20 nullable: true up: description: 'Number of Up Revisions within the consensus for the metric and period. The default window size is 100 days For more details, visit [Online Assistant Page #16598](https://oa.apps.factset.com/pages/16114).' type: integer example: 6 nullable: true down: description: 'Number of Up Revisions within the consensus for the metric and period. The default window size is 100 days. For more details, visit [Online Assistant Page #16598](https://oa.apps.factset.com/pages/16114).' type: integer example: 4 nullable: true frequency_3: type: string enum: - D - W - AM - AQ - AY default: D description: "Controls the display frequency of the data returned.\n * **D** = Daily\n * **W** = Weekly, based on the last day of the week of the start date.\n * **AM** = Monthly, based on the start date (e.g., if the start date is June 16, data is displayed for June 16, May 16, April 16 etc.). \n * **AQ** = Quarterly, based on the start date.\n * **AY** = Actual Annual, based on the start date.\n" example: AM sasbArticlesCategories: type: array default: - ALLCATEGORIES items: type: string description: 'Comma seperated list of one or more SASB category names as described below. The default value is **ALLCATEGORIES**. ### SASB Categories |**SASB Category Inputs**|**Description**| ||| |**ALLCATEGORIES**|**All Categories** - Provides articles tagged to all 26 categories of SASB. Equivalent to providing all 26 categories| |**SASBMATERIALITY**|**SASBMateriality**- provides articles tagged to material categories according to SASB''s materiality framework. When provided, only material categories for each company is fetched| |**ACCESSANDAFFORDABILITY**|**Access and Affordability** - The category addresses a company''s ability to ensure broad access to its products and services, specifically in the context of underserved markets and/or population groups. It includes the management of issues related to universal needs, such as the accessibility and affordability of health care, financial services, utilities , education, and telecommunications.| |**AIRQUALITY**|**Air Quality** - the category addresses management of air quality impacts resulting from stationary (e.g., factories, power plants) and mobile sources (e.g., trucks, delivery vehicles, planes) as well as industrial emissions. Relevant airborne pollutants include, but are not limited to, oxides of nitrogen (NOx), oxides of sulfur (SOx), volatile organic compounds (VOCs), heavy metals, particulate matter, and chlorofluorocarbons. The category does not include GHG emissions, which are addressed in a separate category.| |**BUSINESSETHICS**|**Business Ethics** - the category addresses the company''s approach to managing risks and opportunities surrounding ethical conduct of business, including fraud, corruption, bribery and facilitation payments, fiduciary responsibilities, and other behavior that may have an ethical component. This includes sensitivity to business norms and standards as they shift over time, jurisdiction, and culture. It addresses the company''s ability to provide services that satisfy the highest professional and ethical standards of the industry, which means to avoid conflicts of interest, misrepresentation, bias, and negligence through training employees adequately and implementing policies and procedures to ensure employees provide services free from bias and error.| |**BUSMODELRESILIENCE**|**Business Model Resilience** - the category addresses an industry''s capacity to manage risks and opportunities associated with incorporating social, environmental, and political transitions into long-term business model planning. This includes responsiveness to the transition to a low-carbon and climate-constrained economy, as well as growth and creation of new markets among unserved and underserved socioeconomic populations. The category highlights industries in which evolving environmental and social realities may challenge companies to fundamentally adapt or may put their business models at risk.| |**COMPETITIVEBEHAVIOR**|**Competitive Behavior** - the category covers social issues associated with existence of monopolies, which may include, but are not limited to, excessive prices, poor quality of service, and inefficiencies. It addresses a company''s management of legal and social expectation around monopolistic and anti-competitive practices, including issues related to bargaining power, collusion, price fixing or manipulation, and protection of patents and intellectual property (IP).| |**CRITINCIDENTRISKMGT**|**Critical Incident Risk Management** - the category addresses the company''s use of management systems and scenario planning to identify, understand, and prevent or minimize the occurrence of low-probability, high-impact accidents and emergencies with significant potential environmental and social externalities. It relates to the culture of safety at a company, its relevant safety management systems and technological controls, the potential human, environmental, and social implications of such events occurring, and the long-term effects to an organization, its workers, and society should these events occur.| |**CUSTOMERPRIVACY**|**Customer Privacy** - the category addresses management of risks related to the use of personally identifiable information (PII) and other customer or user data for secondary purposes including but not limited to marketing through affiliates and non-affiliates. The scope of the category includes social issues that may arise from a company''s approach to collecting data, obtaining consent (e.g., opt-in policies), managing user and customer expectations regarding how their data is used, and managing evolving regulation. It excludes social issues arising from cybersecurity risks, which are covered in a separate category.| |**CUSTWELFARE**|**Customer Welfare** - the category addresses customer welfare concerns over issues including, but not limited to, health and nutrition of foods and beverages, antibiotic use in animal production, and management of controlled substances. The category addresses the company''s ability to provide consumers with manufactured products and services that are aligned with societal expectations. It does not include issues directly related to quality and safety malfunctions of manufactured products and services, but instead addresses qualities inherent to the design and delivery of products and services where customer welfare may be in question. The scope of the category also captures companies'' ability to prevent counterfeit products.| |**DATASECURITY**|**Data Security** - the category addresses management of risks related to collection, retention, and use of sensitive, confidential, and/or proprietary customer or user data. It includes social issues that may arise from incidents such as data breaches in which personally identifiable information (PII) and other user or customer data may be exposed. It addresses a company''s strategy, policies, and practices related to IT infrastructure, staff training, record keeping, cooperation with law enforcement, and other mechanisms used to ensure security of customer or user data.| |**ECOLOGICALIMPACTS**|**Ecological Impacts** - the category addresses management of the company''s impacts on ecosystems and biodiversity through activities including, but not limited to, land use for exploration, natural resource extraction, and cultivation, as well as project development, construction, and siting. The impacts include, but are not limited to, biodiversity loss, habitat destruction, and deforestation at all stages planning, land acquisition, permitting, development, operations, and site remediation. The category does not cover impacts of climate change on ecosystems and biodiversity.| |**EMPENGDIVANDINC**|**Employee Engagement Diversity and Inclusion** - the category addresses a company''s ability to ensure that its culture and hiring and promotion practices embrace the building of a diverse and inclusive workforce that reflects the makeup of local talent pools and its customer base. It addresses the issues of discriminatory practices on the bases of race, gender, ethnicity, religion, sexual orientation, and other factors.| |**EMPHEALTHANDSAFETY**|**Employee Health and Safety** - the category addresses a company''s ability to create and maintain a safe and healthy workplace environment that is free of injuries, fatalities, and illness (both chronic and acute). It is traditionally accomplished through implementing safety management plans, developing training requirements for employees and contractors, and conducting regular audits of their own practices as well as those of their subcontractors. The category further captures how companies ensure physical and mental health of workforce through technology, training, corporate culture, regulatory compliance, monitoring and testing, and personal protective equipment.| |**ENERGYMGT**|**Energy Management** - the category addresses environmental impacts associated with energy consumption. It addresses the company''s management of energy in manufacturing and/or for provision of products and services derived from utility providers (grid energy) not owned or controlled by the company. More specifically, it includes management of energy efficiency and intensity, energy mix, as well as grid reliance. Upstream (e.g., suppliers) and downstream (e.g., product use) energy use is not included in the scope.| |**GHGEMISSIONS**|**Greenhouse Gas Emissions** - the category addresses direct (Scope 1) greenhouse gas (GHG) emissions that a company generates through its operations. This includes GHG emissions from stationary (e.g., factories, power plants) and mobile sources (e.g., trucks, delivery vehicles, planes), whether a result of combustion of fuel or non-combusted direct releases during activities such as natural resource extraction, power generation, land use, or biogenic processes. The category further includes management of regulatory risks, environmental compliance, and reputational risks and opportunities, as they related to direct GHG emissions. The seven GHGs covered under the Kyoto Protocol are included within the category carbon dioxide (CO2 ), methane (CH4), nitrous oxide (N2O), hydrofluorocarbons (HFCs), perfluorocarbons (PFCs), sulfur hexafluoride (SF6), and nitrogen trifluoride (NF3).| |**HUMANRIGHTSANDCOMRELS**|**Human Rights and Community Relations** - the category addresses management of the relationship between businesses and the communities in which they operate, including, but not limited to, management of direct and indirect impacts on core human rights and the treatment of indigenous peoples. More specifically, such management may cover socio-economic community impacts, community engagement, environmental justice, cultivation of local workforces, impact on local businesses, license to operate, and environmental/social impact assessments. The category does not include environmental impacts such as air pollution or waste which, although they may impact the health and safety of members of local communities, are addressed in separate categories.| |**LABORPRACTICES**|**Labor Practices** - the category addresses the company''s ability to uphold commonly accepted labor standards in the workplace, including compliance with labor laws and internationally accepted norms and standards. This includes, but is not limited to, ensuring basic human rights related to child labor, forced or bonded labor, exploitative labor, fair wages and overtime pay, and other basic workers'' rights. It also includes minimum wage policies and provision of benefits, which may influence how a workforce is attracted, retained, and motivated. The category further addresses a company''s relationship with organized labor and freedom of association.| |**MGTOFLEGALANDREGENV**|**Management of the Legal and Regulatory Environment** - the category addresses a company''s approach to engaging with regulators in cases where conflicting corporate and public interests may have the potential for long-term adverse direct or indirect environmental and social impacts. The category addresses a company''s level of reliance upon regulatory policy or monetary incentives (such as subsidies and taxes), actions to influence industry policy (such as through lobbying), overall reliance on a favorable regulatory environment for business competitiveness, and ability to comply with relevant regulations. It may relate to the alignment of management and investor views of regulatory engagement and compliance at large.| |**MATSOURCINGANDEFF**|**Materials Sourcing and Efficiency** - the category addresses issues related to the resilience of materials supply chains to impacts of climate change and other external environmental and social factors. It captures the impacts of such external factors on operational activity of suppliers, which can further affect availability and pricing of key resources. It addresses a company''s ability to manage these risks through product design, manufacturing, and end-of-life management, such as by using of recycled and renewable materials, reducing the use of key materials (dematerialization), maximizing resource efficiency in manufacturing, and making R&D investments in substitute materials. Additionally, companies can manage these issues by screening, selection, monitoring, and engagement with suppliers to ensure their resilience to external risks. It does not address issues associated with environmental and social externalities created by operational activity of individual suppliers, which is covered in a separate category.| |**PHYIMPACTSOFCLIMATECHG**|**Physical Impacts of Climate Change** - the category addresses the company''s ability to manage risks and opportunities associated with direct exposure of its owned or controlled assets and operations to actual or potential physical impacts of climate change. It captures environmental and social issues that may arise from operational disruptions due to physical impacts of climate change. It further captures socioeconomic issues resulting from companies failing to incorporate climate change consideration in products and services sold, such as insurance policies and mortgages. The category relates to the company''s ability to adapt to increased frequency and severity of extreme weather, shifting climate, sea level risk, and other expected physical impacts of climate change. Management may involve enhancing resiliency of physical assets and/or surrounding infrastructure as well as incorporation of climate change-related considerations into key business activities (e.g., mortgage and insurance underwriting, planning and development of real estate projects).| |**PDANDLIFECYCLEMGT**|**Product Design and Lifecycle Management** - the category addresses incorporation of environmental, social, and governance (ESG) considerations in characteristics of products and services provided or sold by the company. It includes, but is not limited to, managing the lifecycle impacts of products and services, such as those related to packaging, distribution, use-phase resource intensity, and other environmental and social externalities that may occur during their use-phase or at the end of life. The category captures a company''s ability to address customer and societal demand for more sustainable products and services as well as to meet evolving environmental and social regulation. It does not address direct environmental or social impacts of the company''s operations nor does it address health and safety risks to consumers from product use, which are covered in other categories.| |**PRODQUALITYANDSFTY**|**Product Quality and Safety** - the category addresses issues involving unintended characteristics of products sold or services provided that may create health or safety risks to end-users. It addresses a company''s ability to offer manufactured products and/or services that meet customer expectations with respect to their health and safety characteristics. It includes, but is not limited to, issues involving liability, management of recalls and market withdrawals, product testing, and chemicals/content/ ingredient management in products.| |**SELLPRACANDPRODLABEL**|**Selling Practices and Product Labeling** - the category addresses social issues that may arise from a failure to manage the transparency, accuracy, and comprehensibility of marketing statements, advertising, and labeling of products and services. It includes, but is not limited to, advertising standards and regulations, ethical and responsible marketing practices, misleading or deceptive labeling, as well as discriminatory or predatory selling and lending practices. This may include deceptive or aggressive selling practices in which incentive structures for employees could encourage the sale of products or services that are not in the best interest of customers or clients.| |**SUPPLYCHAINMGT**|**Supply Chain Management** - the category addresses management of environmental, social, and governance (ESG) risks within a company''s supply chain. It addresses issues associated with environmental and social externalities created by suppliers through their operational activities. Such issues include, but are not limited to, environmental responsibility, human rights, labor practices, and ethics and corruption. Management may involve screening, selection, monitoring, and engagement with suppliers on their environmental and social impacts. The category does not address the impacts of external factors such as climate change and other environmental and social factors on suppliers'' operations and/or on the availability and pricing of key resources, which is covered in a separate category.| |**SYSTEMICRISKMGT**|**Systemic Risk Management** - the category addresses the company''s contributions to, or management of systemic risks resulting from large-scale weakening or collapse of systems upon which the economy and society depend. This includes financial systems, natural resource systems, and technological systems. It addresses the mechanisms a company has in place to reduce its contributions to systemic risks and to improve safeguards that may mitigate the impacts of systemic failure. For financial institutions, the category also captures the company''s ability to absorb shocks arising from financial and economic stress and meet stricter regulatory requirements related to the complexity and interconnectedness of companies in the industry.| |**WASTEANDHZRDMATSMGT**|**Waste and Hazardous Materials Management** - the category addresses environmental issues associated with hazardous and non-hazardous waste generated by companies. It addresses a company''s management of solid wastes in manufacturing, agriculture, and other industrial processes. It covers treatment, handling, storage, disposal, and regulatory compliance. The category does not cover emissions to air or wastewater, nor does it cover waste from end-of-life of products, which are addressed in separate categories.| |**WATERANDWASTEWATERMGT**|**Water and Wastewater Management** - the category addresses a company''s water use, water consumption, wastewater generation, and other impacts of operations on water resources, which may be influenced by regional differences in the availability and quality of and competition for water resources. More specifically, it addresses management strategies including, but not limited to, water efficiency, intensity, and recycling. Lastly, the category also addresses management of wastewater treatment and discharge, including groundwater and aquifer pollution.| ### Helper Input **ALL** = Simply gives the ability to request all categories in a single request without having to explicitly list out all 26 in the request. *This is not the same as "ALLCATEGORIES" which is a single overall score for the company and returned as default.* ' example: - AIRQUALITY - BUSINESSETHICS - HUMANRIGHTSANDCOMRELS indexSnapshotRequest: type: object title: Index Snapshot Request properties: ids: $ref: '#/components/schemas/indexIds' date: $ref: '#/components/schemas/requestedDate' returnType: $ref: '#/components/schemas/returnType' currency: $ref: '#/components/schemas/currency' calendar: $ref: '#/components/schemas/calendar' required: - ids benchmarkRatiosResponse: title: Benchmark Ratios Response type: object properties: data: description: 'Array of Index History response objects. ' type: array items: $ref: '#/components/schemas/benchmarkRatios' example: [] endDate: title: End Date type: string description: Requested end date for Range expressed in YYYY-MM-DD format. example: '2019-12-31' segmentsEstimate: title: Segments Estimate type: object properties: requestId: description: Identifier that was used for the request. type: string example: AAPL fsymId: description: Factset Regional Security Identifier. Six alpha-numeric characters, excluding vowels, with an -R suffix (XXXXXX-R). Identifies the securitys best regional security data series per currency. For equities, all primary listings per region and currency are allocated a regional-level permanent identifier. The regional-level permanent identifier will be available once a SEDOL representing the region/currency has been allocated and the identifiers are on FactSet. type: string example: SJY281-R nullable: true segmentType: description: Segment selected type: string example: BUS nullable: true metric: description: 'Company''s Financial statement ''metric'' that is estimated. Use the factset-estimates/v#/metrics endpoint for a complete list. For more details, visit [Online Assistant Page #15034](https://oa.apps.factset.com/pages/15034)' type: string example: SALES nullable: true fiscalPeriod: description: 'Company''s ''fiscal period'' for the estimate record. Periods for periodicity of ANN = 1, and SEMI = 2. For more details, visit [Online Assistant Page #16598](https://oa.apps.factset.com/pages/16598).' type: integer example: 1 nullable: true fiscalYear: description: 'Company''s ''fiscal year'' for the estimate record. For more details, visit [Online Assistant Page #16598](https://oa.apps.factset.com/pages/16598)' type: integer example: 2018 nullable: true segmentLabel: description: Displays the specific label of the segment. type: string example: iPhone nullable: true segmentLevel: description: Returns the level of the segment item as either P = Parent or S = Subordinate type: string example: S nullable: true fiscalEndDate: description: 'Company''s ''fiscal end date'' for the estimate record expressed in YYYY-MM-DD format. For more details, visit [Online Assistant Page #16598](https://oa.apps.factset.com/pages/16598)' type: string format: date example: '2021-09-30' nullable: true estimateDate: description: The date the estimates are as of in YYYY-MM-DD format. type: string format: date example: '2021-07-01' nullable: true currency: description: 'Currency used estimates in consensus calculations. Use ''ESTIMATE'' as input for values in Estimate Currency. For a list of currency ISO codes, visit [Online Assistant Page #1470](https://oa.apps.factset.com/pages/1470).' type: string example: USD nullable: true estimateCurrency: description: Estimate currency of the requested Security type: string example: USD nullable: true mean: description: 'Mean of estimates in consensus calculation. For more details, visit [Online Assistant Page #16598](https://oa.apps.factset.com/pages/16114)' type: number format: double example: 12345.01 nullable: true median: description: 'Median of estimates in consensus calculation. For more details, visit [Online Assistant Page #16598](https://oa.apps.factset.com/pages/16114)' type: number format: double example: 12346.01 nullable: true standardDeviation: description: 'Standard deviation of estimates in consensus calculation. For more details, visit [Online Assistant Page #16598](https://oa.apps.factset.com/pages/16114)' type: number format: double example: 0.011034 nullable: true high: description: 'Highest estimate in consensus calculation. For more details, visit [Online Assistant Page #16598](https://oa.apps.factset.com/pages/16114).' type: number format: double example: 12349.01 nullable: true low: description: 'Lowest estimate in consensus calculation. For more details, visit [Online Assistant Page #16598](https://oa.apps.factset.com/pages/16114)' type: number format: double example: 12344.01 nullable: true estimateCount: description: 'Count or NEST of estimates in consensus calculation. For more details, visit [Online Assistant Page #16598](https://oa.apps.factset.com/pages/16114)' type: integer example: 20 nullable: true up: description: 'Number of Up Revisions within the consensus for the metric and period. The default window size is 100 days For more details, visit [Online Assistant Page #16598](https://oa.apps.factset.com/pages/16114).' type: integer example: 6 nullable: true down: description: 'Number of Up Revisions within the consensus for the metric and period. The default window size is 100 days. For more details, visit [Online Assistant Page #16598](https://oa.apps.factset.com/pages/16114).' type: integer example: 4 nullable: true subcategory: type: string example: AIRLINES enum: - AIRLINES - BALANCE_SHEET - BANKS - CASH_FLOW - COMMODITIES - COMPUTER_HARDWARE - CONSUMER_SERVICES - EDUCATION - FINANCIAL_SERVICE_PROVIDER - HOME_BUILDERS - HOSPITALS - HOTELS - INCOME_STATEMENT - INSURANCE - MARIJUANA - MINING - MISCELLANEOUS - MULTIFINANCIAL - OIL_AND_GAS - OTHER - REITS - RESTAURANTS - RETAILERS - TELECOMMUNICATIONS - TRANSPORTATION description: "Sub-Category Filter for the Primary Category Requested. Choose a related sub-category for the Category requested. For methodology, visit [OA 16038](https://my.apps.factset.com/oa/pages/16038)
Financial Statement - \n * **BALANCE_SHEET** - Balance Sheet line items, such as Assets, Long-term Debt, and more.\n * **CASH_FLOW** - Cash Flow Statement line items, such as Free Cash Flow and Share Repurchases\n * **INCOME_STATEMENT** - Income Statement line items, such as EPS, Sales, DPS, and more.\n * **MISCELLANEOUS** - EPS Long Term Growth\n
Industry Metrics - \n\n * **AIRLINES** - Including items such as Revenue Passenger, Total Revenue per ASK, Available Seats, and more.\n * **BANKS** - Including items such as Net Interest Income, Trading Income, Net Loans, and more. SUPPLEMENTAL\n * **COMMODITIES** - Including items such as Average Target Price.\n * **COMPUTER_HARDWARE** - Including items such as Total Addressable Market.\n * **CONSUMER_SERVICES** - Including items such as Gross Merchandise Volume\n * **EDUCATION** - Including Items such as Total Student Enrollment\n * **FINANCIAL_SERVICE_PROVIDER** - Including items such as Annual Subscription Value\n * **HOME_BUILDERS** - Including items such as Home Sales, Land Sales, Cancellation Rates, and more.\n * **HOSPITALS** - Including items such as Bad Debt Provisions, Medical Cost Ratio, SS Admissions and more.\n * **HOTELS** - Including items such as Average Daily Rate, Occupancy %, RevPAR, and more.\n * **INSURANCE** - Including items such as Gross Premiums Written, Underwriting Income, and Claims.\n * **HOSPITALS** - Including items such as Bad Debt Provisions, Medical Cost Ratio, SS Admissions and more.\n * **HOTELS** - Including items such as Average Daily Rate, Occupancy %, RevPAR, and more.\n * **INSURANCE** - Including items such as Gross Premiums Written, Underwriting Income, and Claims.\n * **MARIJUANA** - Including items such as Cost per Gram and Kg of Cannabis Sold.\n * **MINING** - Including items such as Realized Price and Total Production\n * **MULTIFINANCIAL** - Including items such as AUM, Net Flows, and Fee Related Earnings.\n * **OIL_AND_GAS** - Including items such as Downstream Income, Production per Day, and Exploration Expense.\n * **OTHER** - Target Price\n * **REITS** - Including items such as Funds from Operations, Implied Cap Rate, and LTV.\n * **RESTAURANTS** - Including items such as Restaurant Margin.\n * **RETAILERS** - Including items such as Stores Information, Selling Space and Net sales per square foot.\n * **TELECOMMUNICATIONS** - Including items such as Gross Adds, Monthly Revenue Per User, Churn, and more.\n * **TRANSPORTATION** - Including items such as Revenue Per Unit, Volume Growth, and Operating Ratio.
\n" sdgScoresResponse: type: object title: SDG Scores Response properties: data: description: Array of SDG Scores Objects type: array items: $ref: '#/components/schemas/sdgScores' example: [] sasbRanks: title: SASB Ranks Object type: object properties: date: description: Date for the period requested expressed in YYYY-MM-DD format. type: string format: date example: '2020-09-30' nullable: true fsymId: description: FactSet Entity Identifier. Six alpha-numeric characters, excluding vowels, with a -E suffix (XXXXXX-E). type: string example: 000BJT-E nullable: true requestId: description: Identifier that was used for the request. type: string example: ADBE-US sasbCategory: description: The specific SASB 'category' the Rank is referring to. type: string example: ALLCATEGORIES nullable: true sasbRank: description: "The SASB Rank for the given category in Proper format.\n |Rank|Industry Percentile Range (%)|\n |||\n |Leader|90 - 100|\n |Above Average|70 - 89.9|\n |Average|30 - 69.9|\n |Below Average|10 - 29.9|\n |Laggard|0 - 9.9|\n" type: string example: Average nullable: true fixedIncomeBenchmarkConstituent: title: Benchmark Constituent type: object properties: fsymId: type: string description: Benchmark Id example: LHMN0001 nullable: true date: description: Date of weight and shares. type: string format: date example: '2021-04-12' nullable: true fsymSecurityId: description: FactSet Security Identifier (-S). type: string example: FV4SC0-S nullable: true weightClose: description: Weight of Security in benchmark (percent). type: number format: double example: 0.00303380596473456 nullable: true amountOutstanding: description: Amount Outstanding for the Fixed Income Security. type: number format: double example: 700000 nullable: true price: description: Fixed Income Price of security held. type: number format: double example: 106.976 nullable: true adjMarketValue: description: Market value adjusted. Market Value represented in Millions. type: number format: double example: 757.233375 nullable: true requestId: type: string description: Identifier specified in the request example: LHMN0001 sdgScoreTypes: type: array default: - ALL items: type: string minItems: 1 maxItems: 8 description: 'The FactSet Truvalue Score types being requested. Score Types include the Pulse, Insight, Momentum, Article Volume, Category Volume, Dynamic Materiality Score, Adjusted Insight, and Industry Percentile. When left blank all score types will be returned for the requested Id. To specify select scores returned in the response, provide a comma-separated list of the scores using the description below.These scores use the same underlying data and 100-point scale, except for ranks and percentiles. The cognitive computing system behind FactSet''s Truvalue Platform uses natural language processing to interpret semantic content and generate analytics. It does so by applying criteria that are consistent with established sustainability and ESG frameworks, scoring data points on performance using a 0 to 100 scale. A score of 50 represents a neutral impact. Scores above 50 indicate positive performance, and scores below reflect negative performance.
### SDG Score Types |**SDG Category Input**|**Description**| ||| |**PULSE**|*Pulse Score*, is a measure of near-term performance changes that highlights opportunities and controversies, enabling real-time monitoring of companies. It focuses on events of the day and provides a responsive signal to alert investors to dynamic moves.| |**INSIGHT**|*Insight Score*, a measure of a company''s longer-term SDG track record, similar to a ratings system. Scores are less sensitive to daily events and reflect the enduring performance record of a company over time. Scores are derived using an exponentially-weighted moving average of the Pulse, defined below, and the half-life of an event''s influence on the overall score is 6 months.| |**MOMENTUM**|*Momentum Score*, measures the trend of a company''s Insight score. It is a unique SDG metric in the industry that gives investors a high-precision view of the trajectory of a company''s ESG performance, relative to peers. It does so by precisely articulating upward or downward movement, relative to that of all others in the universe, making it a measure that enhances quantitative workflows.| |**DYNAMIC_MAT**|*Dynamic Materiality Score*, shows the percentage value of data flow by category compared with the total data flow for the organization | |**ADJ_INSIGHT**|*Adjusted Insight*, Measures company ESG performance, generating scores for lower-volume and zero-volume firms by blending company scores with industry medians. **(ONLY Vaild for `IMPACT` category)**.**Adjusted Insight Score = (# of articles / 5) x Company Insight Score + ((5 - # of articles) / 5) x Industry (or Sector) Median Insight Score.
| |**IND_PCTL**|*Industry Percentile*, offers context on company Adjusted Insight scores relative to peers in the same SICS Industry. This value is used to establish the textual ESG Rank. **(ONLY Vaild for `IMPACT` category).**| |**TTM_VOLUME**|*TTM Volume*, measures the data flow over a trailing twelve month period.| |**SDG_RANK**|*SDG Rank*, offers rank leveraging the 16 ESG categories defined by Sustainable Development Goals (SDG).**(ONLY Vaild for `IMPACT` category)**The datatype for the data returned when this score types is requested is String.| ' example: - PULSE - INSIGHT - MOMENTUM constituentIds: title: Constituent Ids type: array items: type: string minItems: 1 maxItems: 1 description: Benchmark Identifiers. Reference the helper endpoint **/id-list** to get a sample list of valid identifiers. You must be authorized for the `ids` requested, otherwise you will receive an error. example: - SP50 calculation: type: boolean description: 'This parameter would return the PAI data based on the input provided. All the data for indicators or subtopics requested are returned when the input is `true` and the SFDR required metrics are only returned when the input is`false` ' default: true example: true consensusRatingsRequest: title: Consensus Ratings Request Body description: Request object for requesting consensus ratings estimates. type: object properties: ids: $ref: '#/components/schemas/ids_2' startDate: $ref: '#/components/schemas/startDate_3' endDate: $ref: '#/components/schemas/endDate_3' frequency: $ref: '#/components/schemas/frequency_3' required: - ids benchmarkConstituentsRequest: type: object title: Benchmark Constituents Request properties: ids: $ref: '#/components/schemas/constituentIds' date: $ref: '#/components/schemas/requestedDate' currency: $ref: '#/components/schemas/currency' calendar: $ref: '#/components/schemas/regionCalendar' required: - ids periodicity: title: Periodicity type: string description: 'The calculation periodicity for the aggregated period. **Note** - Not all periodicities are supported for each metric, depending on the type of ratio. LTM is set as default and supported for all metrics. See Metrics Parameter for additional detail on which periodicities are available per metric. |Periodicity|Description| |:|:| |LTM|Last Twelve Months |LTMA|Last Twelve Months using Broker Actuals for Estimated Items |STMA| Second Twelve Month Forward |NTMA| 12 Month Forward |0| Latest Reported Calendar Year |1| Current Unreported Year |2| Following Year |QTR| Quarterly - Reported by companies ' enum: - LTM - LTMA - STMA - NTMA - '0' - '1' - '2' - QTR default: LTM example: LTM indexSnapshot: title: Index Snapshot Object type: object properties: fsymId: type: string description: Requested Identifier. Must be a valid Benchmark Identifier recognized by FactSet. example: SP50 nullable: true date: description: The respective date for values as of the date requested in YYYY-MM-DD format. type: string format: date example: '2020-07-01' nullable: true name: description: Proper Name of Index. type: string example: S&P 500 nullable: true constituentNumber: description: The total number of constituents as of the date requested. type: integer example: 502 nullable: true currency: description: Currency Code used in adjustments. If no Currency was requested, the service will default to the local Calendar. type: string example: USD nullable: true marketValue: description: Index Level Market Capitalization as of the date requested expressed in millions. type: number format: double example: 27696158.012077 nullable: true price: description: Index Level Price type: number format: double example: 3349.15600690205 nullable: true priceReturnPercent1D: description: Index Level Price - 1 Day percent change type: number format: double example: 0.642620385795123 nullable: true priceReturnPercentQTD: description: Index Level Price - Quarter-to-Date percent change type: number format: double example: 8.02735451465131 nullable: true priceReturnPercentYTD: description: Index Level Price - Year-to-Date percent change type: number format: double example: 3.66394447660916 nullable: true totalReturnLevel: description: Index Level Total Return Amount. (Gross or Net depends on requested returnType) type: number format: double example: 6870.86168040129 nullable: true totalReturnPercent1D: description: Index Level Total Return - 1 Day percent change. (Gross or Net depends on requested returnType) type: number format: double example: 0.653957589855003 nullable: true totalReturnPercentQTD: description: Index Level Total Return - Quarter-to-Date percent change. (Gross or Net depends on requested returnType) type: number format: double example: 8.17415047623613 nullable: true totalReturnPercentYTD: description: Index Level Total Return - Year-to-Date percent change. (Gross or Net depends on requested returnType) type: number format: double example: 4.84152796547426 nullable: true returnType: description: The requested Return Type - GROSS or NET type: string example: GROSS nullable: true requestId: type: string description: Benchmark Identifier specified in the request example: SP50 currency_2: description: '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 #1470](https://oa.apps.factset.com/pages/1470).' type: string example: USD fiscalPeriodEnd: type: string description: 'Fiscal period end is expressed in YYYY formats. The input start date must be before the input end date. Future dates (T+1) are not accepted in this endpoint. ' example: '2021' sasbArticle: title: Articles All Object type: object properties: date: description: Date of article based on dateOf parameter type: string format: date example: '2020-05-02' nullable: true fsymId: description: FactSet Entity Identifier. Six alpha-numeric characters, excluding vowels, with a -E suffix (XXXXXX-E). type: string example: 001MF1-E nullable: true requestId: description: Identifier that was used for the request. type: string example: US0231351067 additionalProperties: true required: - date - fsymId - requestId sdgSpotlightsRequest: title: SDG Spotlights Request Body description: SDG Spotlights Request Body type: object properties: ids: $ref: '#/components/schemas/paiIds' startDate: $ref: '#/components/schemas/sdgStartDate' endDate: $ref: '#/components/schemas/sdgEndDate' categories: $ref: '#/components/schemas/sdgSpotlightCategories' fields: $ref: '#/components/schemas/fieldsSdgSpotlights' primaryOnly: $ref: '#/components/schemas/primaryOnly' isRemoved: $ref: '#/components/schemas/isRemoved' required: - ids detailResponse: type: object title: Detail Response properties: data: description: Array of consensus estimate objects type: array items: $ref: '#/components/schemas/detailEstimate' example: [] sfdrPaiRequest: title: SFDR PAI Indicators Request Body description: SFDR PAI Indicators Request Body type: object properties: ids: $ref: '#/components/schemas/paiIds' feelback: $ref: '#/components/schemas/feelback' fiscalPeriodStart: $ref: '#/components/schemas/fiscalPeriodStart' fiscalPeriodEnd: $ref: '#/components/schemas/fiscalPeriodEnd' indicators: $ref: '#/components/schemas/indicators' calculation: $ref: '#/components/schemas/calculation' required: - ids startDate: title: Start Date type: string description: Requested start date expressed in YYYY-MM-DD format. example: '2018-12-31' sdgArticlesResponse: type: object title: SDG Articles Response properties: data: description: Array of SDG Articles Objects type: array items: $ref: '#/components/schemas/sdgArticle' example: [] feelback: type: boolean description: 'This parameter would return the latest PAI data based on the indicators or subtopics requested. The parameter should not be used in conjuction `fiscalPeriodStart` and `fiscalPeriodEnd` ' default: false example: false fiscalPeriodStart: type: string description: 'Fiscal period start is expressed in YYYY formats. The input start date must be before the input end date. Future dates (T+1) are not accepted in this endpoint. ' example: '2020' sasbRanksRequest: title: SASB Scores Request Body description: SASB Scores Request Body type: object properties: ids: $ref: '#/components/schemas/ids' categories: $ref: '#/components/schemas/rankCategories' startDate: $ref: '#/components/schemas/startDate_2' endDate: $ref: '#/components/schemas/endDate_2' frequency: $ref: '#/components/schemas/frequency_2' calendar: $ref: '#/components/schemas/calendar_2' required: - ids regionCalendar: title: Calendar type: string default: FIVEDAY description: Calendar of data returned. example: FIVEDAY benchmarkIdListResponse: title: Benchmark Id List Response type: object properties: data: description: 'Array of Benchmark Ids and their respective categorizations. ' type: array items: $ref: '#/components/schemas/benchmarkIdList' example: [] sasbScoresAllResponse: type: object title: SASB Scores All Response properties: data: description: Array of SASB Scores All Objects type: array items: $ref: '#/components/schemas/sasbScoresAll' example: [] category: type: string enum: - FINANCIAL_STATEMENT - INDUSTRY_METRIC - OTHER example: INDUSTRY_METRIC description: "Filters the list of Estimate metrics by major category -\n * **FINANCIAL_STATEMENT** = Includes Balance Sheet, Cash Flow, and Income Statement.\n * **INDUSTRY_METRICS** = Industry specific metrics.\n * **OTHER** = Target Price\n" sasbArticlesResponse: type: object title: Articles Response properties: data: description: Array of Articles Objects type: array items: $ref: '#/components/schemas/sasbArticle' example: [] segmentsRequest: title: Segments Request Body description: Request object for requesting segments estimates. type: object properties: ids: $ref: '#/components/schemas/segmentIds' startDate: $ref: '#/components/schemas/startDate_3' endDate: $ref: '#/components/schemas/endDate_3' relativeFiscalStart: $ref: '#/components/schemas/relativeFiscalStart' relativeFiscalEnd: $ref: '#/components/schemas/relativeFiscalEnd' periodicity: $ref: '#/components/schemas/periodicity_2' frequency: $ref: '#/components/schemas/frequency_3' segmentType: $ref: '#/components/schemas/segmentType' metrics: $ref: '#/components/schemas/metrics_2' currency: $ref: '#/components/schemas/currency_2' required: - ids - metrics rollingConsensusRequest: title: Rolling Consensus Request Body description: Request object for requesting rolling consensus estimates. type: object properties: ids: $ref: '#/components/schemas/ids_2' metrics: $ref: '#/components/schemas/metrics_2' startDate: $ref: '#/components/schemas/startDate_3' endDate: $ref: '#/components/schemas/endDate_3' frequency: $ref: '#/components/schemas/frequency_3' relativeFiscalStart: $ref: '#/components/schemas/relativeFiscalStart' relativeFiscalEnd: $ref: '#/components/schemas/relativeFiscalEnd' periodicity: $ref: '#/components/schemas/periodicity_2' currency: $ref: '#/components/schemas/currency_2' required: - ids - metrics rollingDetailRequest: title: Rolling Detail Request Body description: Request object for requesting rolling detail estimates. type: object properties: ids: $ref: '#/components/schemas/ids_2' startDate: $ref: '#/components/schemas/startDate_3' endDate: $ref: '#/components/schemas/endDate_3' frequency: $ref: '#/components/schemas/frequency_3' includeAll: $ref: '#/components/schemas/includeAll' relativeFiscalStart: $ref: '#/components/schemas/relativeFiscalStart' relativeFiscalEnd: $ref: '#/components/schemas/relativeFiscalEnd' periodicity: $ref: '#/components/schemas/periodicityDetail' metrics: $ref: '#/components/schemas/metrics_2' currency: $ref: '#/components/schemas/currency_2' required: - ids - metrics calendar_2: type: string enum: - FIVEDAY - SEVENDAY - LOCAL default: SEVENDAY description: Calendar of data returned. SEVENDAY includes weekends. LOCAL calendar will default to the securities' trading calendar which excludes date records for respective holiday periods. example: FIVEDAY consensusResponse: type: object title: Consensus Response properties: data: description: Array of consensus estimate objects type: array items: $ref: '#/components/schemas/consensusEstimate' example: [] periodicityDetail: type: string enum: - ANN - QTR - SEMI default: ANN description: The periodicity for the estimates, reflecting Annual, Semi-Annual and Quarterly Estimates. ids_2: type: array items: type: string minItems: 1 maxItems: 3000 description: 'The requested list of security identifiers. Accepted ID types include Market Tickers, SEDOL, ISINs, CUSIPs, or FactSet Permanent Ids. * Make Note - id limit of 3000 for defaults, otherwise the service is limited to a 30 second duration. This can be reached when increasing total number of metrics requested and depth of history. * ' example: - FDS-US indexIds: title: Index Ids type: array items: type: string minItems: 1 maxItems: 500 description: Benchmark Identifiers. Reference the helper endpoint **/id-list** to get a sample list of valid identifiers. example: - SP50 fixedConsensusRequest: title: Fixed Consensus Request Body description: Request object for requesting fixed consensus estimates. type: object properties: ids: $ref: '#/components/schemas/ids_2' metrics: $ref: '#/components/schemas/metrics_2' startDate: $ref: '#/components/schemas/startDate_3' endDate: $ref: '#/components/schemas/endDate_3' frequency: $ref: '#/components/schemas/frequency_3' fiscalPeriodStart: $ref: '#/components/schemas/fiscalPeriodStart_2' fiscalPeriodEnd: $ref: '#/components/schemas/fiscalPeriodEnd_2' periodicity: $ref: '#/components/schemas/periodicity_2' currency: $ref: '#/components/schemas/currency_2' required: - ids - metrics sdgFrequency: type: string enum: - D - W - M - CY - '' default: M description: "Controls the display frequency of the data returned.\n * **D** = Daily data (to receive most recent day's values, you must use daily frequency). \n * **W** = Weekly, End of week as of UTC Sunday at 12 AM. \n * **M** = Monthly, End of month as of UTC 12 AM.\n * **CY** = Yearly, End of year as of UTC 12 AM.\n" sdgScoresRequest: title: SDG Scores Request Body description: SDG Scores Request Body type: object properties: ids: $ref: '#/components/schemas/tvlIds' scoreTypes: $ref: '#/components/schemas/sdgScoreTypes' categories: $ref: '#/components/schemas/sdgCategories' startDate: $ref: '#/components/schemas/sdgStartDate' endDate: $ref: '#/components/schemas/sdgEndDate' frequency: $ref: '#/components/schemas/sdgFrequency' required: - ids Spotlights: title: Spotlights All Object type: object properties: date: description: Ending date for the period requested expressed in YYYY-MM-DD format. type: string format: date example: '2020-05-02' nullable: true fsymId: description: FactSet Entity Identifier. Six alpha-numeric characters, excluding vowels, with a -E suffix (XXXXXX-E). type: string example: 001MF1-E nullable: true requestId: description: Identifier that was used for the request. type: string example: US0231351067 additionalProperties: true required: - date - fsymId - requestId sasbRanksResponse: type: object title: SASB Ranks Response properties: data: description: Array of SASB Ranks Objects type: array items: $ref: '#/components/schemas/sasbRanks' example: [] fieldsSasbSpotlights: title: fields type: array items: type: string description: "Request available SASB Spotlights data fields to be included in the response.\n Default is all fields. _fsymId_,_orgId_, _date_, _spotlightId_, _groupId_ and _requestId_ are always included.\n \n |field|description|\n |||\n |fsymId|Factset Regional Security Identifier|\n |orgId|Unique identifier assigned that is applied on an organization level|\n |spotlightId|Unique identifier assigned identifying a Spotlight ESG event that is detected at the company level, within a single category.|\n |requestId|Identifier that was used for the request.|\n |primaryArticleHeadline|Headline of primary Spotlight article.| \n |liveDate|Date when a Spotlight meets confidence threshold and is considered a Spotlight. This date should never precede start date.|\n" example: - spotlightId - groupId sdgArticlesRequest: title: SDG Articles Request Body description: SDG Articles Request Body type: object properties: ids: $ref: '#/components/schemas/paiIds' categories: $ref: '#/components/schemas/sdgArticlesCategories' fields: $ref: '#/components/schemas/articlesFields' startDate: $ref: '#/components/schemas/sdgStartDate' endDate: $ref: '#/components/schemas/sdgEndDate' dateOf: $ref: '#/components/schemas/dateOf' required: - ids - startDate - endDate detailRatingsRequest: title: Detail Ratings Request Body description: Request object for requesting detail ratings estimates. type: object properties: ids: $ref: '#/components/schemas/ids_2' startDate: $ref: '#/components/schemas/startDate_3' endDate: $ref: '#/components/schemas/endDate_3' includeAll: $ref: '#/components/schemas/includeAll' required: - ids sasbScoresRequest: title: SASB Scores Request Body description: SASB Scores Request Body type: object properties: ids: $ref: '#/components/schemas/ids' scoreTypes: $ref: '#/components/schemas/sasbScoreTypes' categories: $ref: '#/components/schemas/categories' startDate: $ref: '#/components/schemas/startDate_2' endDate: $ref: '#/components/schemas/endDate_2' frequency: $ref: '#/components/schemas/frequency_2' calendar: $ref: '#/components/schemas/calendar_2' required: - ids metric: title: Metric Object type: object properties: metric: description: Metric identifier to be used as `metrics` input in the FactSet Estimate endpoints. type: string example: ASSETS nullable: true name: description: Plain text name of the metric. type: string example: Total Assets nullable: true category: description: Primary Category of metric item, such as, FINANCIAL_STATEMENT or INDUSTRY_METRIC type: string example: FINANCIAL_STATEMENT nullable: true subcategory: description: Sub-category of metric items, such as the INCOME_STATEMENT or AIRLINES. type: string example: BALANCE_SHEET nullable: true OAurl: description: The Online Assistant Page URL, used to lookup the definition and methodology of the requested item. type: string example: https://my.apps.factset.com/oa/pages/16283 nullable: true fIConstituentIds: title: Fixed Income Constituent Ids type: array items: type: string minItems: 1 maxItems: 1 description: Fixed Income Benchmark Identifiers. Reference the helper endpoint **/id-list** to get a sample list of valid identifiers. You must be authorized for the `ids` requested, otherwise you will receive an error. example: - LHMN0001 consensusRatingsResponse: type: object title: Consensus Ratings Response properties: data: description: Array of consensus ratings estimate objects type: array items: $ref: '#/components/schemas/consensusRatings' example: [] sfdrPaiResponse: type: object title: SFDR PAI Response properties: data: description: Array of SFDR PAI Response object type: array items: $ref: '#/components/schemas/sfdrPai' example: [] errorResponse: type: object 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-benchmarks/v1/{endpoint} 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 example: example_value frequency_2: type: string enum: - D - W - M - CY - '' default: D description: "Controls the display frequency of the data returned.\n * **D** = Daily\n * **W** = Weekly, based on the last day of the week of the start date.\n * **M** = Monthly, based on the last trading day of the month.\n * **CY** = Calendar Annual, based on the last trading day of the calendar year.\n \n" segmentType: type: string enum: - BUS - GEO default: BUS description: "Controls the type of segment selected.\n * **BUS** = Business\n * **GEO** = Geographic\n" example: BUS hedgeType: title: Hedge Type type: string enum: - UNHEDGED - HEDGED default: UNHEDGED description: The hedge type adjustment used in returns response items. Adjustment can be made for HEDGED and UNHEDGED values that will be included in the return calculation. The service weill default to UNHEDGED. example: UNHEDGED sasbScoreTypes: type: array default: - ALL items: type: string minItems: 1 maxItems: 8 description: 'The FactSet Truvalue Score types being requested. Score Types include the Pulse, Insight, Momentum, Article Volume, Category Volume, Dynamic Materiality Score, Adjusted Insight, and Industry Percentile. When left blank all score types will be returned for the requested Id. To specify select scores returned in the response, provide a comma-separated list of the scores using the description below.These scores use the same underlying data and 100-point scale, except for ranks and percentiles. The cognitive computing system behind FactSet''s Truvalue Platform uses natural language processing to interpret semantic content and generate analytics. It does so by applying criteria that are consistent with established sustainability and ESG frameworks, scoring data points on performance using a 0 to 100 scale. A score of 50 represents a neutral impact. Scores above 50 indicate positive performance, and scores below reflect negative performance.
### ESG Score Types |**SASB Category Input**|**Description**| ||| |**PULSE**|*Pulse Score*, is a measure of near-term performance changes that highlights opportunities and controversies, enabling real-time monitoring of companies. It focuses on events of the day and provides a responsive signal to alert investors to dynamic moves.| |**INSIGHT**|*Insight Score*, a measure of a company''s longer-term ESG track record, similar to a ratings system. Scores are less sensitive to daily events and reflect the enduring performance record of a company over time. Scores are derived using an exponentially-weighted moving average of the Pulse, defined below, and the half-life of an event''s influence on the overall score is 6 months.| |**MOMENTUM**|*Momentum Score*, measures the trend of a company''s Insight score. It is a unique ESG metric in the industry that gives investors a high-precision view of the trajectory of a company''s ESG performance, relative to peers. It does so by precisely articulating upward or downward movement, relative to that of all others in the universe, making it a measure that enhances quantitative workflows.| |**ART_VOL_TTM**|*Article Volume Score*, measures the information flow or number of articles about a company over the past 12 months.| |**CAT_VOL_TTM**|*Category Volume Score*, returns the total number of times any of the 26 categories received a score over a trailing twelve-month (TTM) period of time.| |**DYNAMIC_MAT**|*Dynamic Materiality Score*, shows the percentage value of data flow by category compared with the total data flow for the organization **(NOT VALID for `ALLCATEGORIES` and `MATERIALITY` category types).**| |**ADJ_INSIGHT**|*Adjusted Insight*, Measures company ESG performance, generating scores for lower-volume and zero-volume firms by blending company scores with industry medians. **(ONLY Vaild for `ALLCATEGORIES` and `MATERIALITY` categories).**Adjusted Insight Score = (# of articles / 5) x Company Insight Score + ((5 - # of articles) / 5) x Industry (or Sector) Median Insight Score.
| |**IND_PCTL**|*Industry Percentile*, offers context on company Adjusted Insight scores relative to peers in the same SICS Industry. This value is used to establish the textual ESG Rank. **(ONLY Vaild for `ALLCATEGORIES` and `MATERIALITY` categories).**| ### Helper Input **ALL**= *Ability to fetch all of the "scoreTypes" listed above in a simplified query.* This is used by default and removes the need to explitly request each scoreType in the list. ' example: - PULSE - INSIGHT - MOMENTUM statistic: type: string enum: - MEAN - MEDIAN - HIGH - LOW - COUNT - STDDEV default: MEAN description: Statistic for consensus calculation. example: MEDIAN errorResponse_2: type: object 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-esg/v1/sasb-scores 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 nullable: true 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 example: example_value rankCategories: type: array default: - ALL items: type: string minItems: 1 maxItems: 2 description: "The Categories representing overall or composite rankings from all underlying 26 SASB Categories.\n\n### SASB Categories\n|**SASB Category Inputs**|**Description**|\n|||\n|**ALLCATEGORIES**|**All Categories** - The company's overall SASB Rank. This value is equal to the cumulative average of all 26 SASB categories.\n|**MATERIALITY**|**Materiality** - The composite rank of all 'material' SASB categories for the given entity. For more information on SASB's Materiality Map, visit [materiality.sasb.org](https://materiality.sasb.org/)|\n\n### Helper Input\n**ALL** = Simply gives the ability to request all categories in a single request without having to explicitly list each available category. \n" example: - ALLCATEGORIES - MATERIALITY metricsResponse: type: object title: Metrics Response properties: data: description: 'Array of metric objects representing the metrics that can be requested from the estimates APIs. ' type: array items: $ref: '#/components/schemas/metric' example: [] fixedIncomeBenchmarkConstituentsResponse: title: Fixed Income Benchmark Constituents Response type: object properties: data: description: 'Array of metric objects representing the metrics that can be requested from the estimates APIs. ' type: array items: $ref: '#/components/schemas/fixedIncomeBenchmarkConstituent' example: [] categories: type: array default: - ALLCATEGORIES items: type: string minItems: 1 maxItems: 28 description: "The SASB Categories requested for the respective scoreType(s). The default value is **ALLCATEGORIES**, which represents all 26 categories in a single overall score. To request a specifc category or list of categories, simply input the category names below. \n\n### SASB Categories\n|**SASB Category Inputs**|**Description**|\n|||\n|**ALLCATEGORIES**|**All Categories** - this category represents a company's overall SASB Score for the specific 'scoreType'. This value is equal to the cumulative average of all 26 SASB categories for the specific 'scoreType'.*Note that category is not available for the Dynamic Materiality 'scoreType'.**|\n|**ACCESSANDAFFORDABILITY**|**Access and Affordability** - The category addresses a company's ability to ensure broad access to its products and services, specifically in the context of underserved markets and/or population groups. It includes the management of issues related to universal needs, such as the accessibility and affordability of health care, financial services, utilities , education, and telecommunications.|\n|**AIRQUALITY**|**Air Quality** - the category addresses management of air quality impacts resulting from stationary (e.g., factories, power plants) and mobile sources (e.g., trucks, delivery vehicles, planes) as well as industrial emissions. Relevant airborne pollutants include, but are not limited to, oxides of nitrogen (NOx), oxides of sulfur (SOx), volatile organic compounds (VOCs), heavy metals, particulate matter, and chlorofluorocarbons. The category does not include GHG emissions, which are addressed in a separate category.|\n|**BUSINESSETHICS**|**Business Ethics** - the category addresses the company's approach to managing risks and opportunities surrounding ethical conduct of business, including fraud, corruption, bribery and facilitation payments, fiduciary responsibilities, and other behavior that may have an ethical component. This includes sensitivity to business norms and standards as they shift over time, jurisdiction, and culture. It addresses the company's ability to provide services that satisfy the highest professional and ethical standards of the industry, which means to avoid conflicts of interest, misrepresentation, bias, and negligence through training employees adequately and implementing policies and procedures to ensure employees provide services free from bias and error.|\n|**BUSMODELRESILIENCE**|**Business Model Resilience** - the category addresses an industry's capacity to manage risks and opportunities associated with incorporating social, environmental, and political transitions into long-term business model planning. This includes responsiveness to the transition to a low-carbon and climate-constrained economy, as well as growth and creation of new markets among unserved and underserved socioeconomic populations. The category highlights industries in which evolving environmental and social realities may challenge companies to fundamentally adapt or may put their business models at risk.|\n|**COMPETITIVEBEHAVIOR**|**Competitive Behavior** - the category covers social issues associated with existence of monopolies, which may include, but are not limited to, excessive prices, poor quality of service, and inefficiencies. It addresses a company's management of legal and social expectation around monopolistic and anti-competitive practices, including issues related to bargaining power, collusion, price fixing or manipulation, and protection of patents and intellectual property (IP).|\n|**CRITINCIDENTRISKMGT**|**Critical Incident Risk Management** - the category addresses the company's use of management systems and scenario planning to identify, understand, and prevent or minimize the occurrence of low-probability, high-impact accidents and emergencies with significant potential environmental and social externalities. It relates to the culture of safety at a company, its relevant safety management systems and technological controls, the potential human, environmental, and social implications of such events occurring, and the long-term effects to an organization, its workers, and society should these events occur.|\n|**CUSTOMERPRIVACY**|**Customer Privacy** - the category addresses management of risks related to the use of personally identifiable information (PII) and other customer or user data for secondary purposes including but not limited to marketing through affiliates and non-affiliates. The scope of the category includes social issues that may arise from a company's approach to collecting data, obtaining consent (e.g., opt-in policies), managing user and customer expectations regarding how their data is used, and managing evolving regulation. It excludes social issues arising from cybersecurity risks, which are covered in a separate category.|\n|**CUSTWELFARE**|**Customer Welfare** - the category addresses customer welfare concerns over issues including, but not limited to, health and nutrition of foods and beverages, antibiotic use in animal production, and management of controlled substances. The category addresses the company's ability to provide consumers with manufactured products and services that are aligned with societal expectations. It does not include issues directly related to quality and safety malfunctions of manufactured products and services, but instead addresses qualities inherent to the design and delivery of products and services where customer welfare may be in question. The scope of the category also captures companies' ability to prevent counterfeit products.|\n|**DATASECURITY**|**Data Security** - the category addresses management of risks related to collection, retention, and use of sensitive, confidential, and/or proprietary customer or user data. It includes social issues that may arise from incidents such as data breaches in which personally identifiable information (PII) and other user or customer data may be exposed. It addresses a company's strategy, policies, and practices related to IT infrastructure, staff training, record keeping, cooperation with law enforcement, and other mechanisms used to ensure security of customer or user data.|\n|**ECOLOGICALIMPACTS**|**Ecological Impacts** - the category addresses management of the company's impacts on ecosystems and biodiversity through activities including, but not limited to, land use for exploration, natural resource extraction, and cultivation, as well as project development, construction, and siting. The impacts include, but are not limited to, biodiversity loss, habitat destruction, and deforestation at all stages planning, land acquisition, permitting, development, operations, and site remediation. The category does not cover impacts of climate change on ecosystems and biodiversity.|\n|**EMPENGDIVANDINC**|**Employee Engagement Diversity and Inclusion** - the category addresses a company's ability to ensure that its culture and hiring and promotion practices embrace the building of a diverse and inclusive workforce that reflects the makeup of local talent pools and its customer base. It addresses the issues of discriminatory practices on the bases of race, gender, ethnicity, religion, sexual orientation, and other factors.|\n|**EMPHEALTHANDSAFETY**|**Employee Health and Safety** - the category addresses a company's ability to create and maintain a safe and healthy workplace environment that is free of injuries, fatalities, and illness (both chronic and acute). It is traditionally accomplished through implementing safety management plans, developing training requirements for employees and contractors, and conducting regular audits of their own practices as well as those of their subcontractors. The category further captures how companies ensure physical and mental health of workforce through technology, training, corporate culture, regulatory compliance, monitoring and testing, and personal protective equipment.|\n|**ENERGYMGT**|**Energy Management** - the category addresses environmental impacts associated with energy consumption. It addresses the company's management of energy in manufacturing and/or for provision of products and services derived from utility providers (grid energy) not owned or controlled by the company. More specifically, it includes management of energy efficiency and intensity, energy mix, as well as grid reliance. Upstream (e.g., suppliers) and downstream (e.g., product use) energy use is not included in the scope.|\n|**GHGEMISSIONS**|**Greenhouse Gas Emissions** - the category addresses direct (Scope 1) greenhouse gas (GHG) emissions that a company generates through its operations. This includes GHG emissions from stationary (e.g., factories, power plants) and mobile sources (e.g., trucks, delivery vehicles, planes), whether a result of combustion of fuel or non-combusted direct releases during activities such as natural resource extraction, power generation, land use, or biogenic processes. The category further includes management of regulatory risks, environmental compliance, and reputational risks and opportunities, as they related to direct GHG emissions. The seven GHGs covered under the Kyoto Protocol are included within the category carbon dioxide (CO2 ), methane (CH4), nitrous oxide (N2O), hydrofluorocarbons (HFCs), perfluorocarbons (PFCs), sulfur hexafluoride (SF6), and nitrogen trifluoride (NF3).|\n|**HUMANRIGHTSANDCOMRELS**|**Human Rights and Community Relations** - the category addresses management of the relationship between businesses and the communities in which they operate, including, but not limited to, management of direct and indirect impacts on core human rights and the treatment of indigenous peoples. More specifically, such management may cover socio-economic community impacts, community engagement, environmental justice, cultivation of local workforces, impact on local businesses, license to operate, and environmental/social impact assessments. The category does not include environmental impacts such as air pollution or waste which, although they may impact the health and safety of members of local communities, are addressed in separate categories.|\n|**LABORPRACTICES**|**Labor Practices** - the category addresses the company's ability to uphold commonly accepted labor standards in the workplace, including compliance with labor laws and internationally accepted norms and standards. This includes, but is not limited to, ensuring basic human rights related to child labor, forced or bonded labor, exploitative labor, fair wages and overtime pay, and other basic workers' rights. It also includes minimum wage policies and provision of benefits, which may influence how a workforce is attracted, retained, and motivated. The category further addresses a company's relationship with organized labor and freedom of association.|\n|**MGTOFLEGALANDREGENV**|**Management of the Legal and Regulatory Environment** - the category addresses a company's approach to engaging with regulators in cases where conflicting corporate and public interests may have the potential for long-term adverse direct or indirect environmental and social impacts. The category addresses a company's level of reliance upon regulatory policy or monetary incentives (such as subsidies and taxes), actions to influence industry policy (such as through lobbying), overall reliance on a favorable regulatory environment for business competitiveness, and ability to comply with relevant regulations. It may relate to the alignment of management and investor views of regulatory engagement and compliance at large.|\n|**MATSOURCINGANDEFF**|**Materials Sourcing and Efficiency** - the category addresses issues related to the resilience of materials supply chains to impacts of climate change and other external environmental and social factors. It captures the impacts of such external factors on operational activity of suppliers, which can further affect availability and pricing of key resources. It addresses a company's ability to manage these risks through product design, manufacturing, and end-of-life management, such as by using of recycled and renewable materials, reducing the use of key materials (dematerialization), maximizing resource efficiency in manufacturing, and making R&D investments in substitute materials. Additionally, companies can manage these issues by screening, selection, monitoring, and engagement with suppliers to ensure their resilience to external risks. It does not address issues associated with environmental and social externalities created by operational activity of individual suppliers, which is covered in a separate category.|\n|**MATERIALITY**|**Materiality** - this category represents a composite score of all 'material' SASB categories for the given entity. For more information on SASB's Materiality Map, visit [materiality.sasb.org](https://materiality.sasb.org/)|\n|**PHYIMPACTSOFCLIMATECHG**|**Physical Impacts of Climate Change** - the category addresses the company's ability to manage risks and opportunities associated with direct exposure of its owned or controlled assets and operations to actual or potential physical impacts of climate change. It captures environmental and social issues that may arise from operational disruptions due to physical impacts of climate change. It further captures socioeconomic issues resulting from companies failing to incorporate climate change consideration in products and services sold, such as insurance policies and mortgages. The category relates to the company's ability to adapt to increased frequency and severity of extreme weather, shifting climate, sea level risk, and other expected physical impacts of climate change. Management may involve enhancing resiliency of physical assets and/or surrounding infrastructure as well as incorporation of climate change-related considerations into key business activities (e.g., mortgage and insurance underwriting, planning and development of real estate projects).|\n|**PDANDLIFECYCLEMGT**|**Product Design and Lifecycle Management** - the category addresses incorporation of environmental, social, and governance (ESG) considerations in characteristics of products and services provided or sold by the company. It includes, but is not limited to, managing the lifecycle impacts of products and services, such as those related to packaging, distribution, use-phase resource intensity, and other environmental and social externalities that may occur during their use-phase or at the end of life. The category captures a company's ability to address customer and societal demand for more sustainable products and services as well as to meet evolving environmental and social regulation. It does not address direct environmental or social impacts of the company's operations nor does it address health and safety risks to consumers from product use, which are covered in other categories.|\n|**PRODQUALITYANDSFTY**|**Product Quality and Safety** - the category addresses issues involving unintended characteristics of products sold or services provided that may create health or safety risks to end-users. It addresses a company's ability to offer manufactured products and/or services that meet customer expectations with respect to their health and safety characteristics. It includes, but is not limited to, issues involving liability, management of recalls and market withdrawals, product testing, and chemicals/content/ ingredient management in products.|\n|**SELLPRACANDPRODLABEL**|**Selling Practices and Product Labeling** - the category addresses social issues that may arise from a failure to manage the transparency, accuracy, and comprehensibility of marketing statements, advertising, and labeling of products and services. It includes, but is not limited to, advertising standards and regulations, ethical and responsible marketing practices, misleading or deceptive labeling, as well as discriminatory or predatory selling and lending practices. This may include deceptive or aggressive selling practices in which incentive structures for employees could encourage the sale of products or services that are not in the best interest of customers or clients.|\n|**SUPPLYCHAINMGT**|**Supply Chain Management** - the category addresses management of environmental, social, and governance (ESG) risks within a company's supply chain. It addresses issues associated with environmental and social externalities created by suppliers through their operational activities. Such issues include, but are not limited to, environmental responsibility, human rights, labor practices, and ethics and corruption. Management may involve screening, selection, monitoring, and engagement with suppliers on their environmental and social impacts. The category does not address the impacts of external factors such as climate change and other environmental and social factors on suppliers' operations and/or on the availability and pricing of key resources, which is covered in a separate category.|\n|**SYSTEMICRISKMGT**|**Systemic Risk Management** - the category addresses the company's contributions to, or management of systemic risks resulting from large-scale weakening or collapse of systems upon which the economy and society depend. This includes financial systems, natural resource systems, and technological systems. It addresses the mechanisms a company has in place to reduce its contributions to systemic risks and to improve safeguards that may mitigate the impacts of systemic failure. For financial institutions, the category also captures the company's ability to absorb shocks arising from financial and economic stress and meet stricter regulatory requirements related to the complexity and interconnectedness of companies in the industry.|\n|**WASTEANDHZRDMATSMGT**|**Waste and Hazardous Materials Management** - the category addresses environmental issues associated with hazardous and non-hazardous waste generated by companies. It addresses a company's management of solid wastes in manufacturing, agriculture, and other industrial processes. It covers treatment, handling, storage, disposal, and regulatory compliance. The category does not cover emissions to air or wastewater, nor does it cover waste from end-of-life of products, which are addressed in separate categories.|\n|**WATERANDWASTEWATERMGT**|**Water and Wastewater Management** - the category addresses a company's water use, water consumption, wastewater generation, and other impacts of operations on water resources, which may be influenced by regional differences in the availability and quality of and competition for water resources. More specifically, it addresses management strategies including, but not limited to, water efficiency, intensity, and recycling. Lastly, the category also addresses management of wastewater treatment and discharge, including groundwater and aquifer pollution.|\n\n### Helper Input\n**ALL** = Simply gives the ability to request all categories in a single request without having to explicitly list out all 26 in the request. *This is not the same as \"ALLCATEGORIES\" which is a single overall score for the company and returned as default.*\n" example: - AIRQUALITY - BUSINESSETHICS - HUMANRIGHTSANDCOMRELS detailRatings: title: Detail Ratings type: object properties: fsymId: type: string example: SJY281-R nullable: true estimateDate: description: 'Date of estimate expressed in YYYY-MM-DD format. For more details, visit [Online Assistant Page #16598](https://oa.apps.factset.com/pages/16598)' type: string format: date example: '2017-07-24' nullable: true analystId: description: The FactSet Entity Identifier for the analyst making the estimate. type: string example: 0DXTST-E nullable: true analystName: description: The name of the analyst making the estimate. type: string example: Josh Baer nullable: true brokerId: description: The FactSet Entity Identifier for the broker making the estimate. type: string example: 05FBK7-E nullable: true brokerName: description: The name of the broker making the estimate. type: string example: Morgan Stanley nullable: true ratingsNoteText: description: "A textual representation of the analysts rating. Broker recommendations are divided into five main broad categories- **Buy, Overweight, Hold, Underweight, and Sell**.Additional recommendations may be displayed for the below reasons - \n* Without- A rating \"Without\" is displayed when a broker provides estimates but does not provide a rating.\n* Dropping- When a broker stops covering an equity, the recommendation will show \"Dropping.\"\n* Not Available- A broker may be \"Not Available\" due to outstanding circumstances with that particular security. Ratings are not displayed until a new rating is provided.\n* Most/Least- \"Most\" or \"Least\" favorable rating is displayed for top or bottom rating available for a particular security.\n" type: string example: overweight nullable: true requestId: description: Identifier that was used for the request. type: string example: IBM-US inputDateTime: description: Date and time when the data is available at the source. type: string format: string example: '2022-10-25T22:40:09' nullable: true lastModifiedDate: description: The date at which a broker provided an estimate that is a revision. type: string format: date example: '2017-07-24' nullable: true indexSnapshotResponse: title: Index Snapshot Response type: object properties: data: description: 'Array of index snapshot response objects. ' type: array items: $ref: '#/components/schemas/indexSnapshot' example: [] surpriseResponse: title: Surprise Response type: object properties: data: description: Array of surprises type: array items: $ref: '#/components/schemas/surprise' example: [] metricsRequest: title: Metrics Request Body description: Metrics Request Body type: object properties: category: $ref: '#/components/schemas/category' subcategory: $ref: '#/components/schemas/subcategory' paiIds: type: array items: type: string description: 'Security or Entity identifiers. FactSet Identifiers, tickers, CUSIP and SEDOL are accepted input. *
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.
* ' example: - AAPL-USA errorResponse_3: type: object 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-estimates/v2/prices 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 example: example_value fieldsSdgSpotlights: title: fields type: array items: type: string description: "Request available SDG Spotlights data fields to be included in the response.\nDefault is all fields. _fsymId_,_orgId_, _date_, _spotlightId_, _groupId_ and _requestId_ are always included.\n \n |field|description|\n |-|-|\n |orgId|Unique identifier assigned by Truvalue that is applied on an organization level |\n |spotlightId|Unique identifier assigned by Truvalue identifying a Spotlight ESG event that is detected at the company level, within a single category. |\n |orgName|The current name of the organization according to Truvalue (not point-in-time)|\n |groupId|Unique identifier assigned by Truvalue identifying a Spotlight group using the Spotlight ID of the Primary Spotlight. |\n |primarySpotlight|Value indicating the primary Spotlight in a Spotlight Group. It could be either \"Yes\" or \"No\".|\n |spotlightCategory|SDG category tagged to each Spotlight.| \n |status|Indicates status of a spotlight, which can be one of Completed or Ongoing. |\n |removed|Displays the date a Spotlight was removed from the dataset, if it has been removed.| \n |startDate|Date when a Spotlight has met the volume threshold for Spotlight consideration. Score and volume change metadata are associated with this date.|\n |liveDate|Date when a Spotlight meets confidence threshold and is considered a Spotlight. This date should never precede start_date. | \n |firstArticleDate|Date of earliest article in the Spotlight as of the Start Date. |\n |finalArticleDate|Date of final article in the Spotlight. This value can change over the course of the Spotlight until the Spotlight is marked as completed.| \n |organizationalVolumeThreshold| The article volume needed to create a Spotlight, as set by the company's overall volume level classification on the Start Date. | \n |totalSpotlightVolume|Total number of articles in the Spotlight. This number will change until the Spotlight is marked as completed.| \n |startDateVolume|Number of articles in the Spotlight on the Start Date when it met the volume threshold. Does not include the number of articles that were added to the Spotlight after the Spotlight\nStart Date.|\n |primaryArticleSource|Source of the primary article.| \n |primaryArticleUrl|URL of the primary article.| \n |primaryArticleHeadline|Headline of primary Spotlight article.| \n |primaryArticleBulletpoints|Bullet points summarizing the primary article. |\n |meanArtScoreFinalDate|Average score of articles in Spotlight on Final Article Date. This score will continue to change until the Spotlight is marked as completed.| \n |meanArtScoreStartDate|Average score of articles in Spotlight on Start Date. This score will not change throughout the history of the spotlight.| \n |meanPulseScore|Average of pulse scores for each day from First Article Date to Final Article Date, including scores for both Start Date and Final Article Date.|\n |primaryArticleSource|Headline of primary Spotlight article.| \n |pulseBeforeFirstArticle|Pulse score for category at end-of-day on day before the First Article Date. | \n |pulseOnFinalArticleDate|Pulse score for category at the end-of-day on the Final Article Date.| \n |pulseOnStartDate|Pulse score for the category at the end-of-day on the Start Date. |\n |zScoreOnFinalDate|Z-score for Spotlight as of Final Article Date. This score will continue to change until the Spotlight is marked as completed.| \n |zScoreOnStartDate|Z-score for Spotlight as of Start Date. This score will not change throughout the history of the spotlight.|\n |startoutLvlOnFinalDate|Describes if the spotlight is a High, Medium, or Low standout spotlight. This score will continue to change until the Spotlight is marked as completed.| \n |startoutLvlOnStartDate|Describes if the spotlight is a High, Medium, or Low standout spotlight.| \n" example: - orgId - spotlightId - status parameters: sdgSpotlightCategories: name: categories in: query schema: type: array default: - IMPACT items: type: string required: false explode: false description: 'The SDG Categories specified for the Truvalue Scores being requested. To specify select categories returned in the response, provide a comma-separated list of the scores using the description below. |**SDG Category Input**|**Description**| ||| |**IMPACT**|**Impact** - The aggregate SDG score for each company is simply named "Impact." The SDG Impact Score is produced using a weighted average of individual category scores, where the weight utilized is the category score volume.| |**GOAL1NOPOVERTY**|**No Poverty** - Goal 1 focuses on poverty in all its manifestations and also aims to ensure social protection for the poor and vulnerable, increase access to basic services and support people harmed by climate related extreme events and other economic, social and environmental shocks and disasters.**Company-Level Issue Examples** *- Financial services access and affordability, Underserved groups,Unethical pricing.*| |**GOAL2ZEROHUNGER**|**Zero Hunger** - Goal 2 aims to end hunger and all forms of malnutrition and commits to universal access to safe, nutritious and sufficient food at all times of the year, particularly for the poor and people in vulnerable situations (e.g., infants). This will require sustainable food production systems and resilient agricultural practices, equal access to land, technology, and markets and international cooperation on investments in infrastructure and technology to boost agricultural productivity.
**Company-Level Issue Examples** *- Sustainable agricultural practices, Agricultural ingredients sourcing and certifications, Food safety concerns, Animal welfare.*| |**GOAL3GOODHEALTHANDWELLBEING**|**Good Health and Wellbeing** - Goal 3 seeks to ensure health and wellbeing for all, at every stage of life and addresses all major health priorities, including reproductive, maternal, and child health; communicable, noncommunicable and environmental diseases; universal health coverage; and access for all to safe, effective, quality, and affordable medicines and vaccines.
**Company-Level Issue Examples** *- Harmful Chemicals in Products, Product Recalls, Healthcare Access and Affordability.*| |**GOAL4QUALITYEDUCATION**|**Quality Education** - Goal 4 addresses access and affordability of education and skills development starting from childhood development and continuing through adulthood, including for girls, persons with disabilities, indigenous peoples and children in vulnerable situations, Improvements to the access to education it hopes to ensure that all youth and a substantial proportion of adults achieve literacy and numeracy. It also seeks to build and upgrade education facilities and to increase the supply of qualified teachers.
**Company-Level Issue Examples** *- Mentorship and training, Education company quality, Education company ethics.*| |**GOAL5GENDEREQUALITY**|**Gender Equality** - Goal 5 emphasizes eliminating discrimination and violence against women and girls. The Goal emphasizes ensuring women''s full and effective participation and equal opportunities for leadership at all levels of decision-making in political, economic and public life. Access to sexual and reproductive health and reproductive rights and access to economic resources (e.g., land ownership, financial services) are also emphasized.
**Company-Level Issue Examples** *- Board Diversity, Gender Discrimination, Sexual Harassment.*| |**GOAL6CLEANWATERANDSANITATION**|**Clean Water and Sanitation** - Goal 6 not only addresses issues relating to drinking water, sanitation and hygiene, but also the quality and sustainability of water resources worldwide. It strives to achieve universal and equitable access to safe and affordable drinking water for all. It also focuses on adequate and equitable sanitation and hygiene and reducing pollution, minimizing release of hazardous chemicals and materials, and protection of water-related ecosystems. It also highlights increasing water-use efficiency across all sectors, recycling, and ensuring sustainable withdrawals and supply of freshwater.
**Company-Level Issue Examples** *- Water Pollution, Water Recycling and Stewardship, Water Infrastructure.*| |**GOAL7AFFORDABLEANDCLEANENERGY**|**Goal 7 Affordable and Clean Energy** - Goal 7 seeks to ensure access to affordable, reliable, and modern energy services for all. It aims to increase renewable energy in the global energy mix and improve energy efficiency significantly. It also calls for more access to clean energy research, technology, and infrastructure for renewable energy, energy efficiency, and advanced and cleaner fossil-fuel technology, and promoting investment in energy infrastructure and clean energy technology.
**Company-Level Issue Examples** *- Green Buildings, Renewable Energy, Unethical Utility Pricing.*| |**GOAL8DECENTWORKANDECONOMICGROWTH**|**Decent Work and Economic Growth** - Goal 8 focuses on economic productivity and supports policies for entrepreneurship, creativity and innovation that assist micro, small, and medium-sized enterprises. The Goal also seeks to reduce unemployment, the proportion of youth not working or in school, child labor, and forced labor. Also covered are the protection of labor rights, migrant workers, safe and secure working environments, sustainable tourism, and increasing the capacity of domestic financial institutions in regards to access to banking, insurance, and financial services.
**Company-Level Issue Examples** *- Job Creation, Labor Exploitation, Employee Health and Safety, Workplace Turnover, Supplier Transparency.*| |**GOAL9INDUSTRYINNOVATIONANDINFRASTRUCTURE**|**Industry Innovation and Infrastructure** - Goal 9 focuses on three important aspects of sustainable development, infrastructure, industrialization and innovation, including considerations for resiliency, equity, quality, reliability, access and affordability, and regional and transborder infrastructure. The Goal focuses on infrastructure upgrades and retrofitting of industries with increased resource-use efficiency and clean and environmentally sound technologies and industrial processes.
**Company-Level Issue Examples** *- Digital Divide, ESG integration in financial services, Engineering Structural Integrity.*| |**GOAL10REDUCEDINEQUALITIES**|**Reduced Inequalities** - Goal 10 calls for reducing inequalities in income as well as those based on age, sex, disability, race, ethnicity, origin, religion, or economic or other status within a country. The Goal addresses inequalities among countries, including those related to representation, migration, and development assistance. It aims to empower and promote social, economic, and political inclusion of all. The Goal stresses regulation and monitoring of global financial markets and institutions.
**Company-Level Issue Examples** *- Responsible Lending, Worker Discrimination, CEO Pay Gap, Worker Pay Gap, Workplace Diversity and Inclusion.*| |**GOAL11SUSTAINABLECITIESANDCOMMUNITIES**|**Sustainable Cities and Communities** - Goal 11 seeks to ensure access for all to adequate, safe, and affordable housing and basic services, and green and public spaces, and to upgrade slums. It focuses on improving transportation, air quality and municipal and other waste management, and creating inclusive and sustainable urbanization through participatory urban planning. The Goal also supports safeguarding the world''s cultural and natural heritage, while aiming to increase the number of cities and human settlements adopting and implementing integrated policies and plans towards inclusion, resource efficiency, mitigation and adaptation to climate change, and resilience to disasters.
**Company-Level Issue Examples** *- Air Pollution, Environmental Justice, Human Rights Violations, Affordable Housing.*| |**GOAL12RESPONSIBLECONSUMPTIONANDPRODUCTION**|**Responsible Consumption and Production** - Goal 12 aims to achieve the sustainable management and efficient use of natural resources through both the public and private sector. It specifically addresses global food waste in consumption, production, and distribution, sustainable tourism, waste and chemicals management. Goal 12 encourages sustainability reporting in the private sector, while in the public sector it encourages restructuring taxation and subsidies for fossil fuels and promoting sustainable public procurement practices.
**Company-Level Issue Examples** *- Sustainability Reporting, Circular Economy, Hazardous Waste Management, Waste Reduction.*| |**GOAL13CLIMATEACTION**|**Climate Action** - While Goal 13 is focused on actions by countries towards climate mitigation and adaptation, the private sector can also play a role in these areas. The goal seeks to strengthen resilience and adaptive capacity to climate-related hazards and natural disasters in all countries. It calls for integrating climate change measures, including those related to climate resilience and low GHG development, into national policies, strategies, and planning. It aims to improve education and awareness of climate change mitigation, adaptation, impact reduction, and early warning.
**Company-Level Issue Examples** *- GHG Emissions, Sustainable Transportation, Physical Climate Impacts.*| |**GOAL14LIFEBELOWWATER**|**Life Below Water** - Goal 14 focuses on preventing marine pollution of all kinds, particularly from land-based activities, and to minimize and address the impacts of ocean acidification. The Goal also aims to achieve sustainable yields in fisheries, through regulation of harvesting, controlling subsidies, and ending overfishing. It seeks to sustainably manage and protect marine and coastal ecosystems to avoid significant adverse impacts, including by strengthening their resilience, and take action for their restoration in order to achieve healthy and productive oceans.
**Company-Level Issue Examples** *- Impacts on water-related endangered species and habitats, Oil Spills, Seafood Sourcing.*| |**GOAL15LIFEONLAND**|**Life On Land** - Goal 15 seeks to ensure the conservation, restoration, and sustainable use of terrestrial and inland freshwater ecosystems and their services, in order to preserve biodiversity. It focuses specifically on sustainably managing forests, halting deforestation, restoring degraded lands and successfully combating desertification, reducing degraded natural habitats and ending biodiversity loss, with an emphasis on threatened species and invasive alien species.
**Company-Level Issue Examples** *- Impacts on land-related endangered species and habitats, Sustainable forestry practices and certifications, Project lifecycle environmental impacts.*| |**GOAL16PEACEJUSTICEANDSTRONGINSTITUTIONS**|**Peace, Justice, and Strong Institutions** - Goal 16 aims to significantly reduce all forms of violence, and also focuses specifically on reducing violence against children in the forms of abuse, exploitation, trafficking, and torture. It also aims to significantly reduce illicit financial and arms flows and to substantially reduce corruption and bribery in all their forms. The Goal also emphasizes effective and transparent institutions at all levels, inclusive and participatory decision-making, ensuring public access to information, and protection of fundamental freedoms.
**Company-Level Issue Examples** *- Tax Avoidance, Anti-Competitive Behavior, Cyber Security, Corruption, ESG Resolutions.*| ' example: IMPACT calendar_2: name: calendar in: query schema: type: string enum: - FIVEDAY - SEVENDAY - LOCAL default: SEVENDAY description: Calendar of data returned. SEVENDAY includes weekends. LOCAL calendar will default to the securities' trading calendar which excludes date records for respective holiday periods. example: FIVEDAY sdgCategories: name: categories in: query schema: type: array default: - IMPACT items: type: string required: false explode: false description: "The SDG Categories specified for the Truvalue Scores being requested. To specify select categories returned in the response, provide a comma-separated list of the scores using the description below.\n\n|**SDG Category Input**|**Description**|\n|||\n|**IMPACT**|**Impact** - The aggregate SDG score for each company is simply named \"Impact.\" The SDG Impact Score is produced using a weighted average of individual category scores, where the weight utilized is the category score volume.|\n|**IMPACTARTICLES**|**Impact Articles** - The All Goals Category Volume measures the total number of times any of the 16 goals received a score over a trailing twelve-month (TTM) period of time. **( Data wil be returned only for `TTM_VOLUME` score type)**| \n|**GOAL1NOPOVERTY**|**No Poverty** - Goal 1 focuses on poverty in all its manifestations and also aims to ensure social protection for the poor and vulnerable, increase access to basic services and support people harmed by climate related extreme events and other economic, social and environmental shocks and disasters.
**Company-Level Issue Examples** *- Financial services access and affordability, Underserved groups,Unethical pricing.*|\n|**GOAL2ZEROHUNGER**|**Zero Hunger** - Goal 2 aims to end hunger and all forms of malnutrition and commits to universal access to safe, nutritious and sufficient food at all times of the year, particularly for the poor and people in vulnerable situations (e.g., infants). This will require sustainable food production systems and resilient agricultural practices, equal access to land, technology, and markets and international cooperation on investments in infrastructure and technology to boost agricultural productivity.
**Company-Level Issue Examples** *- Sustainable agricultural practices, Agricultural ingredients sourcing and certifications, Food safety concerns, Animal welfare.*|\n|**GOAL3GOODHEALTHANDWELLBEING**|**Good Health and Wellbeing** - Goal 3 seeks to ensure health and wellbeing for all, at every stage of life and addresses all major health priorities, including reproductive, maternal, and child health; communicable, noncommunicable and environmental diseases; universal health coverage; and access for all to safe, effective, quality, and affordable medicines and vaccines.
**Company-Level Issue Examples** *- Harmful Chemicals in Products, Product Recalls, Healthcare Access and Affordability.*|\n|**GOAL4QUALITYEDUCATION**|**Quality Education** - Goal 4 addresses access and affordability of education and skills development starting from childhood development and continuing through adulthood, including for girls, persons with disabilities, indigenous peoples and children in vulnerable situations, Improvements to the access to education it hopes to ensure that all youth and a substantial proportion of adults achieve literacy and numeracy. It also seeks to build and upgrade education facilities and to increase the supply of qualified teachers.
**Company-Level Issue Examples** *- Mentorship and training, Education company quality, Education company ethics.*|\n|**GOAL5GENDEREQUALITY**|**Gender Equality** - Goal 5 emphasizes eliminating discrimination and violence against women and girls. The Goal emphasizes ensuring women's full and effective participation and equal opportunities for leadership at all levels of decision-making in political, economic and public life. Access to sexual and reproductive health and reproductive rights and access to economic resources (e.g., land ownership, financial services) are also emphasized.
**Company-Level Issue Examples** *- Board Diversity, Gender Discrimination, Sexual Harassment.*|\n|**GOAL6CLEANWATERANDSANITATION**|**Clean Water and Sanitation** - Goal 6 not only addresses issues relating to drinking water, sanitation and hygiene, but also the quality and sustainability of water resources worldwide. It strives to achieve universal and equitable access to safe and affordable drinking water for all. It also focuses on adequate and equitable sanitation and hygiene and reducing pollution, minimizing release of hazardous chemicals and materials, and protection of water-related ecosystems. It also highlights increasing water-use efficiency across all sectors, recycling, and ensuring sustainable withdrawals and supply of freshwater.
**Company-Level Issue Examples** *- Water Pollution, Water Recycling and Stewardship, Water Infrastructure.*|\n|**GOAL7AFFORDABLEANDCLEANENERGY**|**Goal 7 Affordable and Clean Energy** - Goal 7 seeks to ensure access to affordable, reliable, and modern energy services for all. It aims to increase renewable energy in the global energy mix and improve energy efficiency significantly. It also calls for more access to clean energy research, technology, and infrastructure for renewable energy, energy efficiency, and advanced and cleaner fossil-fuel technology, and promoting investment in energy infrastructure and clean energy technology.
**Company-Level Issue Examples** *- Green Buildings, Renewable Energy, Unethical Utility Pricing.*|\n|**GOAL8DECENTWORKANDECONOMICGROWTH**|**Decent Work and Economic Growth** - Goal 8 focuses on economic productivity and supports policies for entrepreneurship, creativity and innovation that assist micro, small, and medium-sized enterprises. The Goal also seeks to reduce unemployment, the proportion of youth not working or in school, child labor, and forced labor. Also covered are the protection of labor rights, migrant workers, safe and secure working environments, sustainable tourism, and increasing the capacity of domestic financial institutions in regards to access to banking, insurance, and financial services.
**Company-Level Issue Examples** *- Job Creation, Labor Exploitation, Employee Health and Safety, Workplace Turnover, Supplier Transparency.*|\n|**GOAL9INDUSTRYINNOVATIONANDINFRASTRUCTURE**|**Industry Innovation and Infrastructure** - Goal 9 focuses on three important aspects of sustainable development, infrastructure, industrialization and innovation, including considerations for resiliency, equity, quality, reliability, access and affordability, and regional and transborder infrastructure. The Goal focuses on infrastructure upgrades and retrofitting of industries with increased resource-use efficiency and clean and environmentally sound technologies and industrial processes.
**Company-Level Issue Examples** *- Digital Divide, ESG integration in financial services, Engineering Structural Integrity.*|\n|**GOAL10REDUCEDINEQUALITIES**|**Reduced Inequalities** - Goal 10 calls for reducing inequalities in income as well as those based on age, sex, disability, race, ethnicity, origin, religion, or economic or other status within a country. The Goal addresses inequalities among countries, including those related to representation, migration, and development assistance. It aims to empower and promote social, economic, and political inclusion of all. The Goal stresses regulation and monitoring of global financial markets and institutions.
**Company-Level Issue Examples** *- Responsible Lending, Worker Discrimination, CEO Pay Gap, Worker Pay Gap, Workplace Diversity and Inclusion.*|\n|**GOAL11SUSTAINABLECITIESANDCOMMUNITIES**|**Sustainable Cities and Communities** - Goal 11 seeks to ensure access for all to adequate, safe, and affordable housing and basic services, and green and public spaces, and to upgrade slums. It focuses on improving transportation, air quality and municipal and other waste management, and creating inclusive and sustainable urbanization through participatory urban planning. The Goal also supports safeguarding the world's cultural and natural heritage, while aiming to increase the number of cities and human settlements adopting and implementing integrated policies and plans towards inclusion, resource efficiency, mitigation and adaptation to climate change, and resilience to disasters.
**Company-Level Issue Examples** *- Air Pollution, Environmental Justice, Human Rights Violations, Affordable Housing.*|\n|**GOAL12RESPONSIBLECONSUMPTIONANDPRODUCTION**|**Responsible Consumption and Production** - Goal 12 aims to achieve the sustainable management and efficient use of natural resources through both the public and private sector. It specifically addresses global food waste in consumption, production, and distribution, sustainable tourism, waste and chemicals management. Goal 12 encourages sustainability reporting in the private sector, while in the public sector it encourages restructuring taxation and subsidies for fossil fuels and promoting sustainable public procurement practices.
**Company-Level Issue Examples** *- Sustainability Reporting, Circular Economy, Hazardous Waste Management, Waste Reduction.*|\n|**GOAL13CLIMATEACTION**|**Climate Action** - While Goal 13 is focused on actions by countries towards climate mitigation and adaptation, the private sector can also play a role in these areas. The goal seeks to strengthen resilience and adaptive capacity to climate-related hazards and natural disasters in all countries. It calls for integrating climate change measures, including those related to climate resilience and low GHG development, into national policies, strategies, and planning. It aims to improve education and awareness of climate change mitigation, adaptation, impact reduction, and early warning.
**Company-Level Issue Examples** *- GHG Emissions, Sustainable Transportation, Physical Climate Impacts.*|\n|**GOAL14LIFEBELOWWATER**|**Life Below Water** - Goal 14 focuses on preventing marine pollution of all kinds, particularly from land-based activities, and to minimize and address the impacts of ocean acidification. The Goal also aims to achieve sustainable yields in fisheries, through regulation of harvesting, controlling subsidies, and ending overfishing. It seeks to sustainably manage and protect marine and coastal ecosystems to avoid significant adverse impacts, including by strengthening their resilience, and take action for their restoration in order to achieve healthy and productive oceans.
**Company-Level Issue Examples** *- Impacts on water-related endangered species and habitats, Oil Spills, Seafood Sourcing.*|\n|**GOAL15LIFEONLAND**|**Life On Land** - Goal 15 seeks to ensure the conservation, restoration, and sustainable use of terrestrial and inland freshwater ecosystems and their services, in order to preserve biodiversity. It focuses specifically on sustainably managing forests, halting deforestation, restoring degraded lands and successfully combating desertification, reducing degraded natural habitats and ending biodiversity loss, with an emphasis on threatened species and invasive alien species.
**Company-Level Issue Examples** *- Impacts on land-related endangered species and habitats, Sustainable forestry practices and certifications, Project lifecycle environmental impacts.*|\n|**GOAL16PEACEJUSTICEANDSTRONGINSTITUTIONS**|**Peace, Justice, and Strong Institutions** - Goal 16 aims to significantly reduce all forms of violence, and also focuses specifically on reducing violence against children in the forms of abuse, exploitation, trafficking, and torture. It also aims to significantly reduce illicit financial and arms flows and to substantially reduce corruption and bribery in all their forms. The Goal also emphasizes effective and transparent institutions at all levels, inclusive and participatory decision-making, ensuring public access to information, and protection of fundamental freedoms.
**Company-Level Issue Examples** *- Tax Avoidance, Anti-Competitive Behavior, Cyber Security, Corruption, ESG Resolutions.*|\n" example: IMPACT sdgEndDate: name: endDate in: query required: true schema: type: string description: 'The end date requested for a given date range in YYYY-MM-DD format. The input end date must be after the input start date. Future dates (T+1) are not accepted in this endpoint. ' example: '2021-10-30' periodicity: name: periodicity in: query schema: type: string enum: - LTM - LTMA - STMA - NTMA - '0' - '1' - '2' - QTR default: LTM required: false description: 'The calculation periodicity for the aggregated period. **Note** - Not all periodicities are supported for each metric, depending on the type of ratio. LTM is set as default and supported for all metrics. See Metrics Parameter for additional detail on which periodicities are available per metric. |Periodicity| Description| |:|:| |LTM| Last Twelve Months |LTMA| Last Twelve Months using Broker Actuals for Estimated Items |STMA| Second Twelve Month Forward |NTMA| 12 Month Forward |0| Latest Reported Calendar Year |1| Current Unreported Year |2| Following Year |QTR| Quarterly - Reported by companies ' indicators: name: indicators in: query schema: type: array default: - ALL items: type: string description: "The indicators are the Principal Adverse Impact (PAI) metrics which consists of General, Mandatory and Additional indicators which supports the SFDR reporting. \n\nThe General indicators data can retrieved by providing the `GL001` and `GL002` subTopic codes as input. Please refer to the attached documentation for the full list of subtopics codes and their mapping with the indicators.\n\nThe data can also be requested for individual sub topic codes in addition to the indicators mentioned below -\n \n|**SFDR PAI Indicators**|**Description**|\n|||\n|**MandatoryIndicators**| Mandatory indicators are the indicators which must be reported under the EU Sustainable Finance Disclosure Regulation (SFDR).|\n|**AdditionalIndicators**| These are additional environmental and social indicators as mentioned in additional tables as provided in the Annex 1 table in the SFDR RTS report.|\n|**GHGEmissions**| This mandatory indicator includes metrics related to greenhouse emissions such as - Scope 1, 2, and 3 emissions, footprint and intensity and energy consumption from non-renewable and high climate sectors.|\n|**Biodiversity**| This mandatory indicator includes metrics pertaining to biodiversity and a company's impacts on biodiversity-sensitive areas.|\n|**Water**| This mandatory indicator includes data relating to emissions to water as made by the companies.|\n|**Waste**| This mandatory indicator includes data relating to hazardous waste as generated by the companies.|\n|**SocialEmployeeMatters**| This mandatory indicator includes employee-related metrics like gender diversity, pay gap and social-related metrics like violation of UNGC/OECD principles and exposure to controversial weapons.|\n|**Emissions**| This additional indicator includes metrics related to air pollutants, inorganic pollutants and ozone depleting substance. |\n|**EnergyPerformance**| This additional indicator includes metrics related to various sources of non-renewable energy as used by the companies. |\n|**WaterWasteMaterialEmissions**| This mandatory indicator includes employee-related metrics like gender diversity, pay gap and social-related metrics like violation of UNGC/OECD principles and exposure to controversial weapons.|\n|**AdditionalEmployeeMatters**| This additional indicator includes metrics related to workplace discrimination and safety, whistleblower mechanism and supplier code of conduct.|\n|**HumanRights**| This additional indicator includes metrics related to both policies and performance of a company in the areas of human rights, forced labor and human trafficking.|\n|**AntiCorruptionAntiBribery**| This additional indicator includes data related to company violations of anti-corruption and anti-bribery laws, and resulting fines.|\n" example: - Water - HumanRights categories: name: categories in: query schema: type: array default: - ALLCATEGORIES items: type: string minItems: 1 maxItems: 28 required: false explode: false description: "The SASB Categories requested for the respective scoreType(s). The default value is **ALLCATEGORIES**, which represents all 26 categories in a single overall score. To request a specifc category or list of categories, simply input the category names below. \n\n### SASB Categories\n|**SASB Category Inputs**|**Description**|\n|||\n|**ALLCATEGORIES**|**All Categories** - this category represents a company's overall SASB Score for the specific 'scoreType'. This value is equal to the cumulative average of all 26 SASB categories for the specific 'scoreType'.*Note that category is not available for the Dynamic Materiality 'scoreType'.\n|**ACCESSANDAFFORDABILITY**|**Access and Affordability** - The category addresses a company's ability to ensure broad access to its products and services, specifically in the context of underserved markets and/or population groups. It includes the management of issues related to universal needs, such as the accessibility and affordability of health care, financial services, utilities , education, and telecommunications.|\n|**AIRQUALITY**|**Air Quality** - the category addresses management of air quality impacts resulting from stationary (e.g., factories, power plants) and mobile sources (e.g., trucks, delivery vehicles, planes) as well as industrial emissions. Relevant airborne pollutants include, but are not limited to, oxides of nitrogen (NOx), oxides of sulfur (SOx), volatile organic compounds (VOCs), heavy metals, particulate matter, and chlorofluorocarbons. The category does not include GHG emissions, which are addressed in a separate category.|\n|**BUSINESSETHICS**|**Business Ethics** - the category addresses the company's approach to managing risks and opportunities surrounding ethical conduct of business, including fraud, corruption, bribery and facilitation payments, fiduciary responsibilities, and other behavior that may have an ethical component. This includes sensitivity to business norms and standards as they shift over time, jurisdiction, and culture. It addresses the company's ability to provide services that satisfy the highest professional and ethical standards of the industry, which means to avoid conflicts of interest, misrepresentation, bias, and negligence through training employees adequately and implementing policies and procedures to ensure employees provide services free from bias and error.|\n|**BUSMODELRESILIENCE**|**Business Model Resilience** - the category addresses an industry's capacity to manage risks and opportunities associated with incorporating social, environmental, and political transitions into long-term business model planning. This includes responsiveness to the transition to a low-carbon and climate-constrained economy, as well as growth and creation of new markets among unserved and underserved socioeconomic populations. The category highlights industries in which evolving environmental and social realities may challenge companies to fundamentally adapt or may put their business models at risk.|\n|**COMPETITIVEBEHAVIOR**|**Competitive Behavior** - the category covers social issues associated with existence of monopolies, which may include, but are not limited to, excessive prices, poor quality of service, and inefficiencies. It addresses a company's management of legal and social expectation around monopolistic and anti-competitive practices, including issues related to bargaining power, collusion, price fixing or manipulation, and protection of patents and intellectual property (IP).|\n|**CRITINCIDENTRISKMGT**|**Critical Incident Risk Management** - the category addresses the company's use of management systems and scenario planning to identify, understand, and prevent or minimize the occurrence of low-probability, high-impact accidents and emergencies with significant potential environmental and social externalities. It relates to the culture of safety at a company, its relevant safety management systems and technological controls, the potential human, environmental, and social implications of such events occurring, and the long-term effects to an organization, its workers, and society should these events occur.|\n|**CUSTOMERPRIVACY**|**Customer Privacy** - the category addresses management of risks related to the use of personally identifiable information (PII) and other customer or user data for secondary purposes including but not limited to marketing through affiliates and non-affiliates. The scope of the category includes social issues that may arise from a company's approach to collecting data, obtaining consent (e.g., opt-in policies), managing user and customer expectations regarding how their data is used, and managing evolving regulation. It excludes social issues arising from cybersecurity risks, which are covered in a separate category.|\n|**CUSTWELFARE**|**Customer Welfare** - the category addresses customer welfare concerns over issues including, but not limited to, health and nutrition of foods and beverages, antibiotic use in animal production, and management of controlled substances. The category addresses the company's ability to provide consumers with manufactured products and services that are aligned with societal expectations. It does not include issues directly related to quality and safety malfunctions of manufactured products and services, but instead addresses qualities inherent to the design and delivery of products and services where customer welfare may be in question. The scope of the category also captures companies' ability to prevent counterfeit products.|\n|**DATASECURITY**|**Data Security** - the category addresses management of risks related to collection, retention, and use of sensitive, confidential, and/or proprietary customer or user data. It includes social issues that may arise from incidents such as data breaches in which personally identifiable information (PII) and other user or customer data may be exposed. It addresses a company's strategy, policies, and practices related to IT infrastructure, staff training, record keeping, cooperation with law enforcement, and other mechanisms used to ensure security of customer or user data.|\n|**ECOLOGICALIMPACTS**|**Ecological Impacts** - the category addresses management of the company's impacts on ecosystems and biodiversity through activities including, but not limited to, land use for exploration, natural resource extraction, and cultivation, as well as project development, construction, and siting. The impacts include, but are not limited to, biodiversity loss, habitat destruction, and deforestation at all stages planning, land acquisition, permitting, development, operations, and site remediation. The category does not cover impacts of climate change on ecosystems and biodiversity.|\n|**EMPENGDIVANDINC**|**Employee Engagement Diversity and Inclusion** - the category addresses a company's ability to ensure that its culture and hiring and promotion practices embrace the building of a diverse and inclusive workforce that reflects the makeup of local talent pools and its customer base. It addresses the issues of discriminatory practices on the bases of race, gender, ethnicity, religion, sexual orientation, and other factors.|\n|**EMPHEALTHANDSAFETY**|**Employee Health and Safety** - the category addresses a company's ability to create and maintain a safe and healthy workplace environment that is free of injuries, fatalities, and illness (both chronic and acute). It is traditionally accomplished through implementing safety management plans, developing training requirements for employees and contractors, and conducting regular audits of their own practices as well as those of their subcontractors. The category further captures how companies ensure physical and mental health of workforce through technology, training, corporate culture, regulatory compliance, monitoring and testing, and personal protective equipment.|\n|**ENERGYMGT**|**Energy Management** - the category addresses environmental impacts associated with energy consumption. It addresses the company's management of energy in manufacturing and/or for provision of products and services derived from utility providers (grid energy) not owned or controlled by the company. More specifically, it includes management of energy efficiency and intensity, energy mix, as well as grid reliance. Upstream (e.g., suppliers) and downstream (e.g., product use) energy use is not included in the scope.|\n|**GHGEMISSIONS**|**Greenhouse Gas Emissions** - the category addresses direct (Scope 1) greenhouse gas (GHG) emissions that a company generates through its operations. This includes GHG emissions from stationary (e.g., factories, power plants) and mobile sources (e.g., trucks, delivery vehicles, planes), whether a result of combustion of fuel or non-combusted direct releases during activities such as natural resource extraction, power generation, land use, or biogenic processes. The category further includes management of regulatory risks, environmental compliance, and reputational risks and opportunities, as they related to direct GHG emissions. The seven GHGs covered under the Kyoto Protocol are included within the category carbon dioxide (CO2 ), methane (CH4), nitrous oxide (N2O), hydrofluorocarbons (HFCs), perfluorocarbons (PFCs), sulfur hexafluoride (SF6), and nitrogen trifluoride (NF3).|\n|**HUMANRIGHTSANDCOMRELS**|**Human Rights and Community Relations** - the category addresses management of the relationship between businesses and the communities in which they operate, including, but not limited to, management of direct and indirect impacts on core human rights and the treatment of indigenous peoples. More specifically, such management may cover socio-economic community impacts, community engagement, environmental justice, cultivation of local workforces, impact on local businesses, license to operate, and environmental/social impact assessments. The category does not include environmental impacts such as air pollution or waste which, although they may impact the health and safety of members of local communities, are addressed in separate categories.|\n|**LABORPRACTICES**|**Labor Practices** - the category addresses the company's ability to uphold commonly accepted labor standards in the workplace, including compliance with labor laws and internationally accepted norms and standards. This includes, but is not limited to, ensuring basic human rights related to child labor, forced or bonded labor, exploitative labor, fair wages and overtime pay, and other basic workers' rights. It also includes minimum wage policies and provision of benefits, which may influence how a workforce is attracted, retained, and motivated. The category further addresses a company's relationship with organized labor and freedom of association.|\n|**MGTOFLEGALANDREGENV**|**Management of the Legal and Regulatory Environment** - the category addresses a company's approach to engaging with regulators in cases where conflicting corporate and public interests may have the potential for long-term adverse direct or indirect environmental and social impacts. The category addresses a company's level of reliance upon regulatory policy or monetary incentives (such as subsidies and taxes), actions to influence industry policy (such as through lobbying), overall reliance on a favorable regulatory environment for business competitiveness, and ability to comply with relevant regulations. It may relate to the alignment of management and investor views of regulatory engagement and compliance at large.|\n|**MATSOURCINGANDEFF**|**Materials Sourcing and Efficiency** - the category addresses issues related to the resilience of materials supply chains to impacts of climate change and other external environmental and social factors. It captures the impacts of such external factors on operational activity of suppliers, which can further affect availability and pricing of key resources. It addresses a company's ability to manage these risks through product design, manufacturing, and end-of-life management, such as by using of recycled and renewable materials, reducing the use of key materials (dematerialization), maximizing resource efficiency in manufacturing, and making R&D investments in substitute materials. Additionally, companies can manage these issues by screening, selection, monitoring, and engagement with suppliers to ensure their resilience to external risks. It does not address issues associated with environmental and social externalities created by operational activity of individual suppliers, which is covered in a separate category.|\n|**MATERIALITY**|**Materiality** - this category represents a composite score of all 'material' SASB categories for the given entity. For more information on SASB's Materiality Map, visit [materiality.sasb.org](https://materiality.sasb.org/)|\n|**PHYIMPACTSOFCLIMATECHG**|**Physical Impacts of Climate Change** - the category addresses the company's ability to manage risks and opportunities associated with direct exposure of its owned or controlled assets and operations to actual or potential physical impacts of climate change. It captures environmental and social issues that may arise from operational disruptions due to physical impacts of climate change. It further captures socioeconomic issues resulting from companies failing to incorporate climate change consideration in products and services sold, such as insurance policies and mortgages. The category relates to the company's ability to adapt to increased frequency and severity of extreme weather, shifting climate, sea level risk, and other expected physical impacts of climate change. Management may involve enhancing resiliency of physical assets and/or surrounding infrastructure as well as incorporation of climate change-related considerations into key business activities (e.g., mortgage and insurance underwriting, planning and development of real estate projects).|\n|**PDANDLIFECYCLEMGT**|**Product Design and Lifecycle Management** - the category addresses incorporation of environmental, social, and governance (ESG) considerations in characteristics of products and services provided or sold by the company. It includes, but is not limited to, managing the lifecycle impacts of products and services, such as those related to packaging, distribution, use-phase resource intensity, and other environmental and social externalities that may occur during their use-phase or at the end of life. The category captures a company's ability to address customer and societal demand for more sustainable products and services as well as to meet evolving environmental and social regulation. It does not address direct environmental or social impacts of the company's operations nor does it address health and safety risks to consumers from product use, which are covered in other categories.|\n|**PRODQUALITYANDSFTY**|**Product Quality and Safety** - the category addresses issues involving unintended characteristics of products sold or services provided that may create health or safety risks to end-users. It addresses a company's ability to offer manufactured products and/or services that meet customer expectations with respect to their health and safety characteristics. It includes, but is not limited to, issues involving liability, management of recalls and market withdrawals, product testing, and chemicals/content/ ingredient management in products.|\n|**SELLPRACANDPRODLABEL**|**Selling Practices and Product Labeling** - the category addresses social issues that may arise from a failure to manage the transparency, accuracy, and comprehensibility of marketing statements, advertising, and labeling of products and services. It includes, but is not limited to, advertising standards and regulations, ethical and responsible marketing practices, misleading or deceptive labeling, as well as discriminatory or predatory selling and lending practices. This may include deceptive or aggressive selling practices in which incentive structures for employees could encourage the sale of products or services that are not in the best interest of customers or clients.|\n|**SUPPLYCHAINMGT**|**Supply Chain Management** - the category addresses management of environmental, social, and governance (ESG) risks within a company's supply chain. It addresses issues associated with environmental and social externalities created by suppliers through their operational activities. Such issues include, but are not limited to, environmental responsibility, human rights, labor practices, and ethics and corruption. Management may involve screening, selection, monitoring, and engagement with suppliers on their environmental and social impacts. The category does not address the impacts of external factors such as climate change and other environmental and social factors on suppliers' operations and/or on the availability and pricing of key resources, which is covered in a separate category.|\n|**SYSTEMICRISKMGT**|**Systemic Risk Management** - the category addresses the company's contributions to, or management of systemic risks resulting from large-scale weakening or collapse of systems upon which the economy and society depend. This includes financial systems, natural resource systems, and technological systems. It addresses the mechanisms a company has in place to reduce its contributions to systemic risks and to improve safeguards that may mitigate the impacts of systemic failure. For financial institutions, the category also captures the company's ability to absorb shocks arising from financial and economic stress and meet stricter regulatory requirements related to the complexity and interconnectedness of companies in the industry.|\n|**WASTEANDHZRDMATSMGT**|**Waste and Hazardous Materials Management** - the category addresses environmental issues associated with hazardous and non-hazardous waste generated by companies. It addresses a company's management of solid wastes in manufacturing, agriculture, and other industrial processes. It covers treatment, handling, storage, disposal, and regulatory compliance. The category does not cover emissions to air or wastewater, nor does it cover waste from end-of-life of products, which are addressed in separate categories.|\n|**WATERANDWASTEWATERMGT**|**Water and Wastewater Management** - the category addresses a company's water use, water consumption, wastewater generation, and other impacts of operations on water resources, which may be influenced by regional differences in the availability and quality of and competition for water resources. More specifically, it addresses management strategies including, but not limited to, water efficiency, intensity, and recycling. Lastly, the category also addresses management of wastewater treatment and discharge, including groundwater and aquifer pollution.|\n\n### Helper Input\n**ALL** = Simply gives the ability to request all categories in a single request without having to explicitly list out all 26 in the request. *This is not the same as \"ALLCATEGORIES\" which is a single overall score for the company and returned as default.*\n" example: - AIRQUALITY - BUSINESSETHICS - HUMANRIGHTSANDCOMRELS isRemoved: name: isRemoved in: query schema: type: boolean default: false description: 'This parameter would return the spotlights removed in the response(i.e. Spotlight is marked as Rejected but has a firstApprovedOnDate))when set to `true` Only Spotlights that are marked as approved will be returned when set to `false` ' startDate_3: name: startDate in: query required: false schema: type: string description: Start date for point in time of estimates expressed in YYYY-MM-DD format. example: '2019-07-30' fIConstituentIds: name: ids in: query required: true explode: false schema: type: array items: type: string minItems: 1 maxItems: 1 example: LHMN0001 description: Fixed Income Benchmark Identifiers. You must be authorized for the `ids` requested, otherwise you will receive an error.
***ids limit** = 1 per request*
sdgStartDate: name: startDate in: query required: true schema: type: string description: 'The start date requested for a given date range in YYYY-MM-DD format. The input start date must be before the input end date. Future dates (T+1) are not accepted in this endpoint. ' example: '2021-01-01' fiscalPeriodEnd_2: name: fiscalPeriodEnd in: query required: false schema: type: string description: "Fiscal period start expressed in absolute date formats. Date that will fall back to most recent completed period during resolution.\n * **Fiscal Quarter-end** - YYYY/FQ (e.g., 2019/1F, 2019/2F, 2019/3F, 2019/4F)\n * **Fiscal Year-end** - YYYY (e.g. 2019)\n" example: '2020' constituentIds: name: ids in: query required: true explode: false schema: type: array items: type: string minItems: 1 maxItems: 1 description: Benchmark Identifiers. Reference the helper endpoint **/id-list** to get a sample list of valid identifiers. You must be authorized for the `ids` requested, otherwise you will receive an error.***ids limit** = 1 per request*
statistic: name: statistic in: query required: false schema: type: string enum: - MEAN - MEDIAN - HIGH - LOW - COUNT - STDDEV default: MEAN description: Statistic for consensus calculation. impliedDate: name: impliedDate in: query required: false schema: type: string enum: - Y - N default: N description: This parameter controls the **date** returned in the date field. The default value is **N**. By default, the date field returns the actual date of the observation. This means it will repeat values for weekends and holidays. If set to **Y**, the date field will return the implied date of the observation, making all the dates unique. paiIds: name: ids in: query schema: type: array items: type: string required: true explode: false description: 'Security or Entity identifiers. FactSet Identifiers, tickers, CUSIP and SEDOL are accepted input.***ids limit** = 1500 per 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.
* ' examples: oneId: summary: One Market Identifier value: - AAPL-USA multipleIds: summary: Multiple Market Identifiers value: - AAPL-US - GOOGL-US - MSFT-US ids: name: ids in: query schema: type: array items: type: string minItems: 1 maxItems: 1000 required: true explode: false description: 'Security or Entity identifiers. FactSet Identifiers, tickers, CUSIP, SEDOL, and ISIN are accepted inputs.***ids limit** = 1000 per 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 exceed this request line limit of 8KB, its advised for any requests with large request lines to be requested through the respective "POST" method.
* ' examples: oneId: summary: One Market Identifier value: - AAPL-USA multipleIds: summary: Multiple Market Identifiers value: - GOOGL-US - AAPL-US - MSFT-US familyFilter: name: familyFilter in: query required: false description: 'Highest Level Filter to search by common Benchmark Families, such as S&P, MSCI, or Russell. This will retrieve all related benchmark ids. For further filtering, use the response items such as the categoryDescription field. Leave blank if you wish to see a full sample list of ids. requested- * **CHINA & HK INDICES** - Major Hong Kong and China Indices, such as Hang Seng Index (HSI-HKX) * **DOW JONES** - Dow Jones Global, Regions, Countries, Titans. * **FACTSET MARKET INDICES** - Regional and Country Indices defined by FactSet * **FTSE** - FTSE Global, UK, Global All Cap, World, Xinhua, European, GWA, JSE, Multinationals, and Style indices * **GLOBAL INDICES** - A mix of major indices across the globe. * **MSCI** - MSCI All Country, Asia Pacific, Thematic & Strategy, Emerging, Developed, US. * **RUSSELL** - US, Global, and Nomura. * **S&P** - US, ASX, Select Industry, BMI, Global, Thematic, Emerging, TSX. * **STOXX** - Total Market, Europe, and Nordic * **TOPIX** - Topix Indices, such as TOPIX 500 (182301) ' schema: type: string enum: - CHINA_HK_INDICES - DOW_JONES - FACTSET_MARKET_INDICES - FTSE - GLOBAL_INDICES - MSCI - RUSSELL - SP - STOXX - TOPIX startDate_2: name: startDate in: query required: false schema: type: string description: 'The start date requested for a given date range in **YYYY-MM-DD** format. If left blank, the API will default to latest available completed period. ' example: '2018-12-31' fiscalPeriodStart_2: name: fiscalPeriodStart in: query required: false schema: type: string description: "Fiscal period start expressed in absolute date formats. Date that will fall back to most recent completed period during resolution.\n * **Fiscal Quarter-end** - YYYY/FQ (e.g., 2019/1F, 2019/2F, 2019/3F, 2019/4F)\n * **Fiscal Year-end** - YYYY (e.g. 2019)\n" example: '2019' returnType: name: returnType in: query required: false schema: type: string enum: - GROSS - NET default: GROSS description: The return type adjustment used in returns response items. Adjustment can be made for GROSS and NET dividends that will be included in the return calculation. The service will default to GROSS. hedgeType: name: hedgeType in: query required: false schema: type: string enum: - UNHEDGED - HEDGED default: UNHEDGED description: The hedge type adjustment used in returns response items. Adjustment can be made for HEDGED and UNHEDGED values that will be included in the return calculation. The service will default to UNHEDGED. segmentType: name: segmentType in: query required: true schema: type: string enum: - BUS - GEO default: BUS description: "Controls the type of segment selected.\n * **BUS** = Business / Product Segment\n * **GEO** = Geographic Segment\n" examples: Business: summary: BUS - Business Segments value: BUS Geographic: summary: GEO - Geographic Segments value: GEO sasbArticlesCategories: name: categories in: query schema: type: array default: - ALLCATEGORIES items: type: string required: false explode: false description: "Comma seperated list of one or more SASB category names as described below. The default value is **ALLCATEGORIES**. \n\n### SASB Categories\n|**SASB Category Inputs**|**Description**|\n|||\n|**ALLCATEGORIES**|**All Categories** - Provides articles tagged to all 26 categories of SASB. Equivalent to providing all 26 categories\n|**SASBMATERIALITY**|**SASBMateriality** - provides articles tagged to material categories according to SASB's materiality framework. When provided, only material categories for each company is fetched|\n|**ACCESSANDAFFORDABILITY**|**Access and Affordability** - The category addresses a company's ability to ensure broad access to its products and services, specifically in the context of underserved markets and/or population groups. It includes the management of issues related to universal needs, such as the accessibility and affordability of health care, financial services, utilities , education, and telecommunications.|\n|**AIRQUALITY**|**Air Quality** - the category addresses management of air quality impacts resulting from stationary (e.g., factories, power plants) and mobile sources (e.g., trucks, delivery vehicles, planes) as well as industrial emissions. Relevant airborne pollutants include, but are not limited to, oxides of nitrogen (NOx), oxides of sulfur (SOx), volatile organic compounds (VOCs), heavy metals, particulate matter, and chlorofluorocarbons. The category does not include GHG emissions, which are addressed in a separate category.|\n|**BUSINESSETHICS**|**Business Ethics** - the category addresses the company's approach to managing risks and opportunities surrounding ethical conduct of business, including fraud, corruption, bribery and facilitation payments, fiduciary responsibilities, and other behavior that may have an ethical component. This includes sensitivity to business norms and standards as they shift over time, jurisdiction, and culture. It addresses the company's ability to provide services that satisfy the highest professional and ethical standards of the industry, which means to avoid conflicts of interest, misrepresentation, bias, and negligence through training employees adequately and implementing policies and procedures to ensure employees provide services free from bias and error.|\n|**BUSMODELRESILIENCE**|**Business Model Resilience** - the category addresses an industry's capacity to manage risks and opportunities associated with incorporating social, environmental, and political transitions into long-term business model planning. This includes responsiveness to the transition to a low-carbon and climate-constrained economy, as well as growth and creation of new markets among unserved and underserved socioeconomic populations. The category highlights industries in which evolving environmental and social realities may challenge companies to fundamentally adapt or may put their business models at risk.|\n|**COMPETITIVEBEHAVIOR**|**Competitive Behavior** - the category covers social issues associated with existence of monopolies, which may include, but are not limited to, excessive prices, poor quality of service, and inefficiencies. It addresses a company's management of legal and social expectation around monopolistic and anti-competitive practices, including issues related to bargaining power, collusion, price fixing or manipulation, and protection of patents and intellectual property (IP).|\n|**CRITINCIDENTRISKMGT**|**Critical Incident Risk Management** - the category addresses the company's use of management systems and scenario planning to identify, understand, and prevent or minimize the occurrence of low-probability, high-impact accidents and emergencies with significant potential environmental and social externalities. It relates to the culture of safety at a company, its relevant safety management systems and technological controls, the potential human, environmental, and social implications of such events occurring, and the long-term effects to an organization, its workers, and society should these events occur.|\n|**CUSTOMERPRIVACY**|**Customer Privacy** - the category addresses management of risks related to the use of personally identifiable information (PII) and other customer or user data for secondary purposes including but not limited to marketing through affiliates and non-affiliates. The scope of the category includes social issues that may arise from a company's approach to collecting data, obtaining consent (e.g., opt-in policies), managing user and customer expectations regarding how their data is used, and managing evolving regulation. It excludes social issues arising from cybersecurity risks, which are covered in a separate category.|\n|**CUSTWELFARE**|**Customer Welfare** - the category addresses customer welfare concerns over issues including, but not limited to, health and nutrition of foods and beverages, antibiotic use in animal production, and management of controlled substances. The category addresses the company's ability to provide consumers with manufactured products and services that are aligned with societal expectations. It does not include issues directly related to quality and safety malfunctions of manufactured products and services, but instead addresses qualities inherent to the design and delivery of products and services where customer welfare may be in question. The scope of the category also captures companies' ability to prevent counterfeit products.|\n|**DATASECURITY**|**Data Security** - the category addresses management of risks related to collection, retention, and use of sensitive, confidential, and/or proprietary customer or user data. It includes social issues that may arise from incidents such as data breaches in which personally identifiable information (PII) and other user or customer data may be exposed. It addresses a company's strategy, policies, and practices related to IT infrastructure, staff training, record keeping, cooperation with law enforcement, and other mechanisms used to ensure security of customer or user data.|\n|**ECOLOGICALIMPACTS**|**Ecological Impacts** - the category addresses management of the company's impacts on ecosystems and biodiversity through activities including, but not limited to, land use for exploration, natural resource extraction, and cultivation, as well as project development, construction, and siting. The impacts include, but are not limited to, biodiversity loss, habitat destruction, and deforestation at all stages planning, land acquisition, permitting, development, operations, and site remediation. The category does not cover impacts of climate change on ecosystems and biodiversity.|\n|**EMPENGDIVANDINC**|**Employee Engagement Diversity and Inclusion** - the category addresses a company's ability to ensure that its culture and hiring and promotion practices embrace the building of a diverse and inclusive workforce that reflects the makeup of local talent pools and its customer base. It addresses the issues of discriminatory practices on the bases of race, gender, ethnicity, religion, sexual orientation, and other factors.|\n|**EMPHEALTHANDSAFETY**|**Employee Health and Safety** - the category addresses a company's ability to create and maintain a safe and healthy workplace environment that is free of injuries, fatalities, and illness (both chronic and acute). It is traditionally accomplished through implementing safety management plans, developing training requirements for employees and contractors, and conducting regular audits of their own practices as well as those of their subcontractors. The category further captures how companies ensure physical and mental health of workforce through technology, training, corporate culture, regulatory compliance, monitoring and testing, and personal protective equipment.|\n|**ENERGYMGT**|**Energy Management** - the category addresses environmental impacts associated with energy consumption. It addresses the company's management of energy in manufacturing and/or for provision of products and services derived from utility providers (grid energy) not owned or controlled by the company. More specifically, it includes management of energy efficiency and intensity, energy mix, as well as grid reliance. Upstream (e.g., suppliers) and downstream (e.g., product use) energy use is not included in the scope.|\n|**GHGEMISSIONS**|**Greenhouse Gas Emissions** - the category addresses direct (Scope 1) greenhouse gas (GHG) emissions that a company generates through its operations. This includes GHG emissions from stationary (e.g., factories, power plants) and mobile sources (e.g., trucks, delivery vehicles, planes), whether a result of combustion of fuel or non-combusted direct releases during activities such as natural resource extraction, power generation, land use, or biogenic processes. The category further includes management of regulatory risks, environmental compliance, and reputational risks and opportunities, as they related to direct GHG emissions. The seven GHGs covered under the Kyoto Protocol are included within the category carbon dioxide (CO2 ), methane (CH4), nitrous oxide (N2O), hydrofluorocarbons (HFCs), perfluorocarbons (PFCs), sulfur hexafluoride (SF6), and nitrogen trifluoride (NF3).|\n|**HUMANRIGHTSANDCOMRELS**|**Human Rights and Community Relations** - the category addresses management of the relationship between businesses and the communities in which they operate, including, but not limited to, management of direct and indirect impacts on core human rights and the treatment of indigenous peoples. More specifically, such management may cover socio-economic community impacts, community engagement, environmental justice, cultivation of local workforces, impact on local businesses, license to operate, and environmental/social impact assessments. The category does not include environmental impacts such as air pollution or waste which, although they may impact the health and safety of members of local communities, are addressed in separate categories.|\n|**LABORPRACTICES**|**Labor Practices** - the category addresses the company's ability to uphold commonly accepted labor standards in the workplace, including compliance with labor laws and internationally accepted norms and standards. This includes, but is not limited to, ensuring basic human rights related to child labor, forced or bonded labor, exploitative labor, fair wages and overtime pay, and other basic workers' rights. It also includes minimum wage policies and provision of benefits, which may influence how a workforce is attracted, retained, and motivated. The category further addresses a company's relationship with organized labor and freedom of association.|\n|**MGTOFLEGALANDREGENV**|**Management of the Legal and Regulatory Environment** - the category addresses a company's approach to engaging with regulators in cases where conflicting corporate and public interests may have the potential for long-term adverse direct or indirect environmental and social impacts. The category addresses a company's level of reliance upon regulatory policy or monetary incentives (such as subsidies and taxes), actions to influence industry policy (such as through lobbying), overall reliance on a favorable regulatory environment for business competitiveness, and ability to comply with relevant regulations. It may relate to the alignment of management and investor views of regulatory engagement and compliance at large.|\n|**MATSOURCINGANDEFF**|**Materials Sourcing and Efficiency** - the category addresses issues related to the resilience of materials supply chains to impacts of climate change and other external environmental and social factors. It captures the impacts of such external factors on operational activity of suppliers, which can further affect availability and pricing of key resources. It addresses a company's ability to manage these risks through product design, manufacturing, and end-of-life management, such as by using of recycled and renewable materials, reducing the use of key materials (dematerialization), maximizing resource efficiency in manufacturing, and making R&D investments in substitute materials. Additionally, companies can manage these issues by screening, selection, monitoring, and engagement with suppliers to ensure their resilience to external risks. It does not address issues associated with environmental and social externalities created by operational activity of individual suppliers, which is covered in a separate category.|\n|**PHYIMPACTSOFCLIMATECHG**|**Physical Impacts of Climate Change** - the category addresses the company's ability to manage risks and opportunities associated with direct exposure of its owned or controlled assets and operations to actual or potential physical impacts of climate change. It captures environmental and social issues that may arise from operational disruptions due to physical impacts of climate change. It further captures socioeconomic issues resulting from companies failing to incorporate climate change consideration in products and services sold, such as insurance policies and mortgages. The category relates to the company's ability to adapt to increased frequency and severity of extreme weather, shifting climate, sea level risk, and other expected physical impacts of climate change. Management may involve enhancing resiliency of physical assets and/or surrounding infrastructure as well as incorporation of climate change-related considerations into key business activities (e.g., mortgage and insurance underwriting, planning and development of real estate projects).|\n|**PDANDLIFECYCLEMGT**|**Product Design and Lifecycle Management** - the category addresses incorporation of environmental, social, and governance (ESG) considerations in characteristics of products and services provided or sold by the company. It includes, but is not limited to, managing the lifecycle impacts of products and services, such as those related to packaging, distribution, use-phase resource intensity, and other environmental and social externalities that may occur during their use-phase or at the end of life. The category captures a company's ability to address customer and societal demand for more sustainable products and services as well as to meet evolving environmental and social regulation. It does not address direct environmental or social impacts of the company's operations nor does it address health and safety risks to consumers from product use, which are covered in other categories.|\n|**PRODQUALITYANDSFTY**|**Product Quality and Safety** - the category addresses issues involving unintended characteristics of products sold or services provided that may create health or safety risks to end-users. It addresses a company's ability to offer manufactured products and/or services that meet customer expectations with respect to their health and safety characteristics. It includes, but is not limited to, issues involving liability, management of recalls and market withdrawals, product testing, and chemicals/content/ ingredient management in products.|\n|**SELLPRACANDPRODLABEL**|**Selling Practices and Product Labeling** - the category addresses social issues that may arise from a failure to manage the transparency, accuracy, and comprehensibility of marketing statements, advertising, and labeling of products and services. It includes, but is not limited to, advertising standards and regulations, ethical and responsible marketing practices, misleading or deceptive labeling, as well as discriminatory or predatory selling and lending practices. This may include deceptive or aggressive selling practices in which incentive structures for employees could encourage the sale of products or services that are not in the best interest of customers or clients.|\n|**SUPPLYCHAINMGT**|**Supply Chain Management** - the category addresses management of environmental, social, and governance (ESG) risks within a company's supply chain. It addresses issues associated with environmental and social externalities created by suppliers through their operational activities. Such issues include, but are not limited to, environmental responsibility, human rights, labor practices, and ethics and corruption. Management may involve screening, selection, monitoring, and engagement with suppliers on their environmental and social impacts. The category does not address the impacts of external factors such as climate change and other environmental and social factors on suppliers' operations and/or on the availability and pricing of key resources, which is covered in a separate category.|\n|**SYSTEMICRISKMGT**|**Systemic Risk Management** - the category addresses the company's contributions to, or management of systemic risks resulting from large-scale weakening or collapse of systems upon which the economy and society depend. This includes financial systems, natural resource systems, and technological systems. It addresses the mechanisms a company has in place to reduce its contributions to systemic risks and to improve safeguards that may mitigate the impacts of systemic failure. For financial institutions, the category also captures the company's ability to absorb shocks arising from financial and economic stress and meet stricter regulatory requirements related to the complexity and interconnectedness of companies in the industry.|\n|**WASTEANDHZRDMATSMGT**|**Waste and Hazardous Materials Management** - the category addresses environmental issues associated with hazardous and non-hazardous waste generated by companies. It addresses a company's management of solid wastes in manufacturing, agriculture, and other industrial processes. It covers treatment, handling, storage, disposal, and regulatory compliance. The category does not cover emissions to air or wastewater, nor does it cover waste from end-of-life of products, which are addressed in separate categories.|\n|**WATERANDWASTEWATERMGT**|**Water and Wastewater Management** - the category addresses a company's water use, water consumption, wastewater generation, and other impacts of operations on water resources, which may be influenced by regional differences in the availability and quality of and competition for water resources. More specifically, it addresses management strategies including, but not limited to, water efficiency, intensity, and recycling. Lastly, the category also addresses management of wastewater treatment and discharge, including groundwater and aquifer pollution.|\n" example: - AIRQUALITY - BUSINESSETHICS - HUMANRIGHTSANDCOMRELS fieldsSdgSpotlights: name: fields in: query description: "Request available SDG Spotlights data fields to be included in the response.\n Default is all fields. _fsymId_,_orgId_, _date_, _spotlightId_, _groupId_ and _requestId_ are always included.\n \n***metrics limit** = 38 per 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.
* ' schema: type: array items: type: string example: - PEX - LTD_EQ - DEBT_EQ minItems: 1 maxItems: 38 examples: Single Metric: summary: LTD_EQ value: - LTD_EQ Multiple Metrics: summary: PEX, LTD_EQ, DEBT_EQ value: - PEX - LTD_EQ - DEBT_EQ subcategory: name: subcategory in: query schema: type: string enum: - AIRLINES - BALANCE_SHEET - BANKS - CASH_FLOW - COMMODITIES - COMPUTER_HARDWARE - CONSUMER_SERVICES - EDUCATION - FINANCIAL_SERVICE_PROVIDER - HOME_BUILDERS - HOSPITALS - HOTELS - INCOME_STATEMENT - INSURANCE - MARIJUANA - MINING - MISCELLANEOUS - MULTIFINANCIAL - OIL_AND_GAS - OTHER - REITS - RESTAURANTS - RETAILERS - TELECOMMUNICATIONS - TRANSPORTATION required: false description: "Sub-Category Filter for the Primary Category Requested. Choose a related sub-category for the Category requested. For methodology, visit [OA 16038](https://my.apps.factset.com/oa/pages/16038)Financial Statement - \n * **BALANCE_SHEET** - Balance Sheet line items, such as Assets, Long-term Debt, and more.\n * **CASH_FLOW** - Cash Flow Statement line items, such as Free Cash Flow and Share Repurchases\n * **INCOME_STATEMENT** - Income Statement line items, such as EPS, Sales, DPS, and more.\n * **MISCELLANEOUS** - EPS Long Term Growth\n
Industry Metrics - \n\n * **AIRLINES** - Including items such as Revenue Passenger, Total Revenue per ASK, Available Seats, and more.\n * **BANKS** - Including items such as Net Interest Income, Trading Income, Net Loans, and more. SUPPLEMENTAL\n * **COMMODITIES** - Including items such as Average Target Price.\n * **COMPUTER_HARDWARE** - Including items such as Total Addressable Market.\n * **CONSUMER_SERVICES** - Including items such as Gross Merchandise Volume\n * **EDUCATION** - Including Items such as Total Student Enrollment\n * **FINANCIAL_SERVICE_PROVIDER** - Including items such as Annual Subscription Value\n * **HOME_BUILDERS** - Including items such as Home Sales, Land Sales, Cancellation Rates, and more.\n * **HOSPITALS** - Including items such as Bad Debt Provisions, Medical Cost Ratio, SS Admissions and more.\n * **HOTELS** - Including items such as Average Daily Rate, Occupancy %, RevPAR, and more.\n * **INSURANCE** - Including items such as Gross Premiums Written, Underwriting Income, and Claims.\n * **HOSPITALS** - Including items such as Bad Debt Provisions, Medical Cost Ratio, SS Admissions and more.\n * **HOTELS** - Including items such as Average Daily Rate, Occupancy %, RevPAR, and more.\n * **INSURANCE** - Including items such as Gross Premiums Written, Underwriting Income, and Claims.\n * **MARIJUANA** - Including items such as Cost per Gram and Kg of Cannabis Sold.\n * **MINING** - Including items such as Realized Price and Total Production\n * **MULTIFINANCIAL** - Including items such as AUM, Net Flows, and Fee Related Earnings.\n * **OIL_AND_GAS** - Including items such as Downstream Income, Production per Day, and Exploration Expense.\n * **OTHER** - Target Price\n * **REITS** - Including items such as Funds from Operations, Implied Cap Rate, and LTV.\n * **RESTAURANTS** - Including items such as Restaurant Margin.\n * **RETAILERS** - Including items such as Stores Information, Selling Space and Net sales per square foot.\n * **TELECOMMUNICATIONS** - Including items such as Gross Adds, Monthly Revenue Per User, Churn, and more.\n * **TRANSPORTATION** - Including items such as Revenue Per Unit, Volume Growth, and Operating Ratio.
\n \n" fiscalPeriodEnd: name: fiscalPeriodEnd in: query schema: type: string description: 'Fiscal period end is expressed in YYYY formats. The input start date must be before the input end date. Future dates (T+1) are not accepted in this endpoint. ' example: '2021' includeAll: name: includeAll in: query schema: type: boolean default: false required: false description: "Include All filter is used to identify included and excluded broker details from the consensus\n By default the service would return only the brokers included in the consensus-\n * **TRUE** = Returns all the brokers included and excluded in the consensus\n * **FALSE** = Returns only the broker details included in the consensus\n \n" periodicityDetail: name: periodicity in: query required: false schema: type: string enum: - ANN - QTR - SEMI default: ANN description: "The periodicity for the estimates requested, allowing you to fetch Quarterly, Semi-Annual, and Annual Estimates.\n * **ANN** - Annual\n * **QTR** - Quarterly\n * **SEMI** - Semi-Annual \n" metrics_2: name: metrics in: query required: true schema: type: array items: type: string example: SALES minItems: 1 explode: false description: 'Requested metrics. Use the /metrics endpoint to return a list of available estimate items. Note, the number of metrics you are allowed to supply is limited to 1 for now. **Top 10** most used metrics are **EPS, SALES, DPS, EBITDA,EBIT, PRICE_TGT, CFPS, BPS, NET_INC, and ASSETS**. For more details, visit [Online Assistant Page #15034](https://oa.apps.factset.com/pages/15034). ' examples: Metric: summary: Metrics value: - SALES indexIds: name: ids in: query required: true explode: false schema: type: array items: type: string minItems: 1 maxItems: 500 description: Benchmark Identifiers. Reference the helper endpoint **/id-list** to get a sample list of valid identifiers.***ids limit** = 500 per 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.
* endDate_3: name: endDate in: query required: false schema: type: string description: End date for point in time of estimates expressed in YYYY-MM-DD format. example: '2020-07-30' fieldsSasbSpotlights: name: fields in: query description: "Request available SASB Spotlights data fields to be included in the response.\n Default is all fields. _fsymId_,_orgId_, _date_, _spotlightId_, _groupId_ and _requestId_ are always included.\n \nThese scores use the same underlying data and 100-point scale, except for ranks and percentiles. The cognitive computing system behind FactSet''s Truvalue Platform uses natural language processing to interpret semantic content and generate analytics. It does so by applying criteria that are consistent with established sustainability and ESG frameworks, scoring data points on performance using a 0 to 100 scale. A score of 50 represents a neutral impact. Scores above 50 indicate positive performance, and scores below reflect negative performance.
### SDG Score Types |**SDG Category Input**|**Description**| ||| |**PULSE**|*Pulse Score*, is a measure of near-term performance changes that highlights opportunities and controversies, enabling real-time monitoring of companies. It focuses on events of the day and provides a responsive signal to alert investors to dynamic moves.| |**INSIGHT**|*Insight Score*, a measure of a company''s longer-term SDG track record, similar to a ratings system. Scores are less sensitive to daily events and reflect the enduring performance record of a company over time. Scores are derived using an exponentially-weighted moving average of the Pulse, defined below, and the half-life of an event''s influence on the overall score is 6 months.| |**MOMENTUM**|*Momentum Score*, measures the trend of a company''s Insight score. It is a unique ESG metric in the industry that gives investors a high-precision view of the trajectory of a company''s SDG performance, relative to peers. It does so by precisely articulating upward or downward movement, relative to that of all others in the universe, making it a measure that enhances quantitative workflows.| |**DYNAMIC_MAT**|*Dynamic Materiality Score*, shows the percentage value of data flow by category compared with the total data flow for the organization | |**ADJ_INSIGHT**|*Adjusted Insight*, Measures company SDG performance, generating scores for lower-volume and zero-volume firms by blending company scores with industry medians. **(ONLY Vaild for `IMPACT` category)**.**Adjusted Insight Score = (# of articles / 5) x Company Insight Score + ((5 - # of articles) / 5) x Industry (or Sector) Median Insight Score.
| |**IND_PCTL**|*Industry Percentile*, offers context on company Adjusted Insight scores relative to peers in the same SICS Industry. This value is used to establish the textual ESG Rank. **(ONLY Vaild for `IMPACT` category).**| |**TTM_VOLUME**|*TTM Volume*, measures the data flow over a trailing twelve month period.| |**SDG_RANK**|*SDG Rank*, offers rank leveraging the 16 ESG categories defined by Sustainable Development Goals (SDG).The datatype for the data returned when this score types is requested is String**(ONLY Vaild for `IMPACT` category)**.| ' example: - PULSE - INSIGHT - MOMENTUM primaryOnly: name: primaryOnly in: query schema: type: boolean default: true description: 'This parameter would return only primary spotlights when set to `true` ' frequency: name: frequency in: query schema: type: string enum: - D - W - M - AM - CQ - AY - CY default: D description: "Controls the display frequency of the data returned.\n * **D** = Daily\n * **W** = Weekly, based on the last day of the week of the start date.\n * **M** = Monthly, based on the last trading day of the month.\n * **AM** = Monthly, based on the start date (e.g., if the start date is June 16, data is displayed for June 16, May 16, April 16 etc.).\n * **CQ** = Quarterly based on the last trading day of the calendar quarter (March, June, September, or December).\n * **AY** = Actual Annual, based on the start date.\n * **CY** = Calendar Annual, based on the last trading day of the calendar year.\n" examples: Daily: summary: D - Daily frequency display based on trading calendar value: D Weekly: summary: W - Weekly - based on the last day of the week of the start date value: W Monthly: summary: M - Monthly - based on the last trading day of the month. value: M Actual Month: summary: AM - Actual Month - based on the startDate (e.g., if the start date is June 16, data is displayed for June 16, May 16, April 16 etc.). value: AM Calendar Quarterly: summary: CQ - Calendar Quarterly - based on the last day of the week of the startDate value: CQ Actual Annual: summary: AY - Actual Annual - based on the startDate value: AY Calendar Annual: summary: CY - Calendar Annual - based on the last trading day of the calendar year. value: CY fiscalPeriodStart: name: fiscalPeriodStart in: query schema: type: string description: 'Fiscal period start is expressed in YYYY formats. The input start date must be before the input end date. Future dates (T+1) are not accepted in this endpoint. ' example: '2020' calculation: name: calculation in: query schema: type: boolean default: true description: 'This parameter would return the PAI data based on the input provided. All the data for indicators or subtopics requested are returned when the input is `true` and the SFDR required metrics are only returned when the input is`false` ' startDate: name: startDate in: query required: false schema: type: string description: Requested start date expressed in YYYY-MM-DD format. frequency_2: name: frequency in: query schema: type: string enum: - D - W - M - CY - '' default: D description: "Controls the display frequency of the data returned.\n * **D** = Daily\n * **W** = Weekly, based on the last day of the week of the start date.\n * **M** = Monthly, based on the last trading day of the month.\n * **CY** = Calendar Annual, based on the last trading day of the calendar year.\n \n" sdgFrequency: name: frequency in: query schema: type: string enum: - D - W - M - CY - '' default: M description: "Controls the display frequency of the data returned.\n * **D** = Daily data (to receive most recent day's values, you must use daily frequency).\n * **W** = Weekly, End of week as of UTC Sunday at 12 AM.\n * **M** = Monthly, End of month as of UTC 12 AM.\n * **CY** = Yearly, End of year as of UTC 12 AM.\n \n" frequency_3: name: frequency in: query schema: type: string enum: - D - W - AM - AQ - AY default: D description: "Controls the frequency of the data returned.\n * **D** = Daily\n * **W** = Weekly, based on the last day of the week of the start date.\n * **AM** = Monthly, based on the start date (e.g., if the start date is June 16, data is displayed for June 16, May 16, April 16 etc.). \n * **AQ** = Quarterly, based on the start date.\n * **AY** = Actual Annual, based on the start date. \n" examples: Daily: summary: D - Daily frequency display based on trading calendar value: D Weekly: summary: W - Weekly - based on the last day of the week of the start date value: W Actual Month: summary: AM - Actual Month - based on the startDate (e.g., if the start date is June 16, data is displayed for June 16, May 16, April 16 etc.). value: AM Actual Annual: summary: AY - Actual Annual - based on the startDate value: AY currency_2: name: currency in: query required: false schema: type: string description: 'Currency code for adjusting the data. Use ''ESTIMATE'' as input value for the values in Estimate Currency. For a list of currency ISO codes, visit [Online Assistant Page #1470](https://oa.apps.factset.com/pages/1470).' example: USD sdgArticlesCategories: name: categories in: query schema: type: array default: - IMPACT items: type: string required: false explode: false description: 'The SDG Categories specified for the Truvalue Scores being requested. To specify select categories returned in the response, provide a comma-separated list of the scores using the description below. |**SDG Category Input**|**Description**| ||| |**IMPACT**|**Impact** - Provides Articles tagged to all SDG categories| |**GOAL1NOPOVERTY**|**No Poverty** - Goal 1 focuses on poverty in all its manifestations and also aims to ensure social protection for the poor and vulnerable, increase access to basic services and support people harmed by climate related extreme events and other economic, social and environmental shocks and disasters.**Company-Level Issue Examples** *- Financial services access and affordability, Underserved groups,Unethical pricing.*| |**GOAL2ZEROHUNGER**|**Zero Hunger** - Goal 2 aims to end hunger and all forms of malnutrition and commits to universal access to safe, nutritious and sufficient food at all times of the year, particularly for the poor and people in vulnerable situations (e.g., infants). This will require sustainable food production systems and resilient agricultural practices, equal access to land, technology, and markets and international cooperation on investments in infrastructure and technology to boost agricultural productivity.
**Company-Level Issue Examples** *- Sustainable agricultural practices, Agricultural ingredients sourcing and certifications, Food safety concerns, Animal welfare.*| |**GOAL3GOODHEALTHANDWELLBEING**|**Good Health and Wellbeing** - Goal 3 seeks to ensure health and wellbeing for all, at every stage of life and addresses all major health priorities, including reproductive, maternal, and child health; communicable, noncommunicable and environmental diseases; universal health coverage; and access for all to safe, effective, quality, and affordable medicines and vaccines.
**Company-Level Issue Examples** *- Harmful Chemicals in Products, Product Recalls, Healthcare Access and Affordability.*| |**GOAL4QUALITYEDUCATION**|**Quality Education** - Goal 4 addresses access and affordability of education and skills development starting from childhood development and continuing through adulthood, including for girls, persons with disabilities, indigenous peoples and children in vulnerable situations, Improvements to the access to education it hopes to ensure that all youth and a substantial proportion of adults achieve literacy and numeracy. It also seeks to build and upgrade education facilities and to increase the supply of qualified teachers.
**Company-Level Issue Examples** *- Mentorship and training, Education company quality, Education company ethics.*| |**GOAL5GENDEREQUALITY**|**Gender Equality** - Goal 5 emphasizes eliminating discrimination and violence against women and girls. The Goal emphasizes ensuring women''s full and effective participation and equal opportunities for leadership at all levels of decision-making in political, economic and public life. Access to sexual and reproductive health and reproductive rights and access to economic resources (e.g., land ownership, financial services) are also emphasized.
**Company-Level Issue Examples** *- Board Diversity, Gender Discrimination, Sexual Harassment.*| |**GOAL6CLEANWATERANDSANITATION**|**Clean Water and Sanitation** - Goal 6 not only addresses issues relating to drinking water, sanitation and hygiene, but also the quality and sustainability of water resources worldwide. It strives to achieve universal and equitable access to safe and affordable drinking water for all. It also focuses on adequate and equitable sanitation and hygiene and reducing pollution, minimizing release of hazardous chemicals and materials, and protection of water-related ecosystems. It also highlights increasing water-use efficiency across all sectors, recycling, and ensuring sustainable withdrawals and supply of freshwater.
**Company-Level Issue Examples** *- Water Pollution, Water Recycling and Stewardship, Water Infrastructure.*| |**GOAL7AFFORDABLEANDCLEANENERGY**|**Goal 7 Affordable and Clean Energy** - Goal 7 seeks to ensure access to affordable, reliable, and modern energy services for all. It aims to increase renewable energy in the global energy mix and improve energy efficiency significantly. It also calls for more access to clean energy research, technology, and infrastructure for renewable energy, energy efficiency, and advanced and cleaner fossil-fuel technology, and promoting investment in energy infrastructure and clean energy technology.
**Company-Level Issue Examples** *- Green Buildings, Renewable Energy, Unethical Utility Pricing.*| |**GOAL8DECENTWORKANDECONOMICGROWTH**|**Decent Work and Economic Growth** - Goal 8 focuses on economic productivity and supports policies for entrepreneurship, creativity and innovation that assist micro, small, and medium-sized enterprises. The Goal also seeks to reduce unemployment, the proportion of youth not working or in school, child labor, and forced labor. Also covered are the protection of labor rights, migrant workers, safe and secure working environments, sustainable tourism, and increasing the capacity of domestic financial institutions in regards to access to banking, insurance, and financial services.
**Company-Level Issue Examples** *- Job Creation, Labor Exploitation, Employee Health and Safety, Workplace Turnover, Supplier Transparency.*| |**GOAL9INDUSTRYINNOVATIONANDINFRASTRUCTURE**|**Industry Innovation and Infrastructure** - Goal 9 focuses on three important aspects of sustainable development, infrastructure, industrialization and innovation, including considerations for resiliency, equity, quality, reliability, access and affordability, and regional and transborder infrastructure. The Goal focuses on infrastructure upgrades and retrofitting of industries with increased resource-use efficiency and clean and environmentally sound technologies and industrial processes.
**Company-Level Issue Examples** *- Digital Divide, ESG integration in financial services, Engineering Structural Integrity.*| |**GOAL10REDUCEDINEQUALITIES**|**Reduced Inequalities** - Goal 10 calls for reducing inequalities in income as well as those based on age, sex, disability, race, ethnicity, origin, religion, or economic or other status within a country. The Goal addresses inequalities among countries, including those related to representation, migration, and development assistance. It aims to empower and promote social, economic, and political inclusion of all. The Goal stresses regulation and monitoring of global financial markets and institutions.
**Company-Level Issue Examples** *- Responsible Lending, Worker Discrimination, CEO Pay Gap, Worker Pay Gap, Workplace Diversity and Inclusion.*| |**GOAL11SUSTAINABLECITIESANDCOMMUNITIES**|**Sustainable Cities and Communities** - Goal 11 seeks to ensure access for all to adequate, safe, and affordable housing and basic services, and green and public spaces, and to upgrade slums. It focuses on improving transportation, air quality and municipal and other waste management, and creating inclusive and sustainable urbanization through participatory urban planning. The Goal also supports safeguarding the world''s cultural and natural heritage, while aiming to increase the number of cities and human settlements adopting and implementing integrated policies and plans towards inclusion, resource efficiency, mitigation and adaptation to climate change, and resilience to disasters.
**Company-Level Issue Examples** *- Air Pollution, Environmental Justice, Human Rights Violations, Affordable Housing.*| |**GOAL12RESPONSIBLECONSUMPTIONANDPRODUCTION**|**Responsible Consumption and Production** - Goal 12 aims to achieve the sustainable management and efficient use of natural resources through both the public and private sector. It specifically addresses global food waste in consumption, production, and distribution, sustainable tourism, waste and chemicals management. Goal 12 encourages sustainability reporting in the private sector, while in the public sector it encourages restructuring taxation and subsidies for fossil fuels and promoting sustainable public procurement practices.
**Company-Level Issue Examples** *- Sustainability Reporting, Circular Economy, Hazardous Waste Management, Waste Reduction.*| |**GOAL13CLIMATEACTION**|**Climate Action** - While Goal 13 is focused on actions by countries towards climate mitigation and adaptation, the private sector can also play a role in these areas. The goal seeks to strengthen resilience and adaptive capacity to climate-related hazards and natural disasters in all countries. It calls for integrating climate change measures, including those related to climate resilience and low GHG development, into national policies, strategies, and planning. It aims to improve education and awareness of climate change mitigation, adaptation, impact reduction, and early warning.
**Company-Level Issue Examples** *- GHG Emissions, Sustainable Transportation, Physical Climate Impacts.*| |**GOAL14LIFEBELOWWATER**|**Life Below Water** - Goal 14 focuses on preventing marine pollution of all kinds, particularly from land-based activities, and to minimize and address the impacts of ocean acidification. The Goal also aims to achieve sustainable yields in fisheries, through regulation of harvesting, controlling subsidies, and ending overfishing. It seeks to sustainably manage and protect marine and coastal ecosystems to avoid significant adverse impacts, including by strengthening their resilience, and take action for their restoration in order to achieve healthy and productive oceans.
**Company-Level Issue Examples** *- Impacts on water-related endangered species and habitats, Oil Spills, Seafood Sourcing.*| |**GOAL15LIFEONLAND**|**Life On Land** - Goal 15 seeks to ensure the conservation, restoration, and sustainable use of terrestrial and inland freshwater ecosystems and their services, in order to preserve biodiversity. It focuses specifically on sustainably managing forests, halting deforestation, restoring degraded lands and successfully combating desertification, reducing degraded natural habitats and ending biodiversity loss, with an emphasis on threatened species and invasive alien species.
**Company-Level Issue Examples** *- Impacts on land-related endangered species and habitats, Sustainable forestry practices and certifications, Project lifecycle environmental impacts.*| |**GOAL16PEACEJUSTICEANDSTRONGINSTITUTIONS**|**Peace, Justice, and Strong Institutions** - Goal 16 aims to significantly reduce all forms of violence, and also focuses specifically on reducing violence against children in the forms of abuse, exploitation, trafficking, and torture. It also aims to significantly reduce illicit financial and arms flows and to substantially reduce corruption and bribery in all their forms. The Goal also emphasizes effective and transparent institutions at all levels, inclusive and participatory decision-making, ensuring public access to information, and protection of fundamental freedoms.
**Company-Level Issue Examples** *- Tax Avoidance, Anti-Competitive Behavior, Cyber Security, Corruption, ESG Resolutions.*| ' example: IMPACT sasbScoreTypes: name: scoreTypes in: query schema: type: array default: - ALL items: type: string minItems: 1 maxItems: 8 required: false explode: false description: 'The FactSet Truvalue Score types being requested. Score Types include the Pulse, Insight, Momentum, Article Volume, Category Volume, Dynamic Materiality Score, Adjusted Insight, and Industry Percentile. When left blank all score types will be returned for the requested Id. To specify select scores returned in the response, provide a comma-separated list of the scores using the description below.
These scores use the same underlying data and 100-point scale, except for ranks and percentiles. The cognitive computing system behind FactSet''s Truvalue Platform uses natural language processing to interpret semantic content and generate analytics. It does so by applying criteria that are consistent with established sustainability and ESG frameworks, scoring data points on performance using a 0 to 100 scale. A score of 50 represents a neutral impact. Scores above 50 indicate positive performance, and scores below reflect negative performance.
### ESG Score Types |**SASB Category Input**|**Description**| ||| |**PULSE**|*Pulse Score*, is a measure of near-term performance changes that highlights opportunities and controversies, enabling real-time monitoring of companies. It focuses on events of the day and provides a responsive signal to alert investors to dynamic moves.| |**INSIGHT**|*Insight Score*, a measure of a companys longer-term ESG track record, similar to a ratings system. Scores are less sensitive to daily events and reflect the enduring performance record of a company over time. Scores are derived using an exponentially-weighted moving average of the Pulse, defined below, and the half-life of an events influence on the overall score is 6 months.| |**MOMENTUM**|*Momentum Score*, measures the trend of a company''s Insight score. It is a unique ESG metric in the industry that gives investors a high-precision view of the trajectory of a companys ESG performance, relative to peers. It does so by precisely articulating upward or downward movement, relative to that of all others in the universe, making it a measure that enhances quantitative workflows.| |**ART_VOL_TTM**|*Article Volume Score*, measures the information flow or number of articles about a company over the past 12 months.| |**CAT_VOL_TTM**|*Category Volume Score*, returns the total number of times any of the 26 categories received a score over a trailing twelve-month (TTM) period of time.| |**DYNAMIC_MAT**|*Dynamic Materiality Score*, shows the percentage value of data flow by category compared with the total data flow for the organization **(NOT VALID for `ALLCATEGORIES` and `MATERIALITY` category types).**| |**ADJ_INSIGHT**|*Adjusted Insight*, Measures company ESG performance, generating scores for lower-volume and zero-volume firms by blending company scores with industry medians. **(ONLY Vaild for `ALLCATEGORIES` and `MATERIALITY` categories).**Adjusted Insight Score = (# of articles / 5) x Company Insight Score + ((5 - # of articles) / 5) x Industry (or Sector) Median Insight Score.
| |**IND_PCTL**|*Industry Percentile*, offers context on company Adjusted Insight scores relative to peers in the same SICS Industry. This value is used to establish the textual ESG Rank. **(ONLY Vaild for `ALLCATEGORIES` and `MATERIALITY` categories).**| ### Helper Input **ALL**= *Ability to fetch all of the "scoreTypes" listed above in a simplified query.* This is used by default and removes the need to explitly request each scoreType in the list. ' example: - PULSE - INSIGHT - MOMENTUM sasbSpotlightsCategories: name: categories in: query schema: type: array default: - ALLCATEGORIES items: type: string required: false explode: false description: "The SASB Categories requested for the respective scoreType(s). The default value is **ALLCATEGORIES**, which represents all 26 categories in a single overall score. To request a specifc category or list of categories, simply input the category names below. \n\n### SASB Categories\n|**SASB Category Inputs**|**Description**|\n|||\n|**ALLCATEGORIES**|**All Categories** - this category represents a company's overall SASB Score for the specific 'scoreType'. This value is equal to the cumulative average of all 26 SASB categories for the specific 'scoreType'.*Note that category is not available for the Dynamic Materiality 'scoreType'.|\n|**ACCESSANDAFFORDABILITY**|**Access and Affordability** - The category addresses a company's ability to ensure broad access to its products and services, specifically in the context of underserved markets and/or population groups. It includes the management of issues related to universal needs, such as the accessibility and affordability of health care, financial services, utilities , education, and telecommunications.|\n|**AIRQUALITY**|**Air Quality** - the category addresses management of air quality impacts resulting from stationary (e.g., factories, power plants) and mobile sources (e.g., trucks, delivery vehicles, planes) as well as industrial emissions. Relevant airborne pollutants include, but are not limited to, oxides of nitrogen (NOx), oxides of sulfur (SOx), volatile organic compounds (VOCs), heavy metals, particulate matter, and chlorofluorocarbons. The category does not include GHG emissions, which are addressed in a separate category.|\n|**BUSINESSETHICS**|**Business Ethics** - the category addresses the company's approach to managing risks and opportunities surrounding ethical conduct of business, including fraud, corruption, bribery and facilitation payments, fiduciary responsibilities, and other behavior that may have an ethical component. This includes sensitivity to business norms and standards as they shift over time, jurisdiction, and culture. It addresses the company's ability to provide services that satisfy the highest professional and ethical standards of the industry, which means to avoid conflicts of interest, misrepresentation, bias, and negligence through training employees adequately and implementing policies and procedures to ensure employees provide services free from bias and error.|\n|**BUSMODELRESILIENCE**|**Business Model Resilience** - the category addresses an industry's capacity to manage risks and opportunities associated with incorporating social, environmental, and political transitions into long-term business model planning. This includes responsiveness to the transition to a low-carbon and climate-constrained economy, as well as growth and creation of new markets among unserved and underserved socioeconomic populations. The category highlights industries in which evolving environmental and social realities may challenge companies to fundamentally adapt or may put their business models at risk.|\n|**COMPETITIVEBEHAVIOR**|**Competitive Behavior** - the category covers social issues associated with existence of monopolies, which may include, but are not limited to, excessive prices, poor quality of service, and inefficiencies. It addresses a company's management of legal and social expectation around monopolistic and anti-competitive practices, including issues related to bargaining power, collusion, price fixing or manipulation, and protection of patents and intellectual property (IP).|\n|**CRITINCIDENTRISKMGT**|**Critical Incident Risk Management** - the category addresses the company's use of management systems and scenario planning to identify, understand, and prevent or minimize the occurrence of low-probability, high-impact accidents and emergencies with significant potential environmental and social externalities. It relates to the culture of safety at a company, its relevant safety management systems and technological controls, the potential human, environmental, and social implications of such events occurring, and the long-term effects to an organization, its workers, and society should these events occur.|\n|**CUSTOMERPRIVACY**|**Customer Privacy** - the category addresses management of risks related to the use of personally identifiable information (PII) and other customer or user data for secondary purposes including but not limited to marketing through affiliates and non-affiliates. The scope of the category includes social issues that may arise from a company's approach to collecting data, obtaining consent (e.g., opt-in policies), managing user and customer expectations regarding how their data is used, and managing evolving regulation. It excludes social issues arising from cybersecurity risks, which are covered in a separate category.|\n|**CUSTWELFARE**|**Customer Welfare** - the category addresses customer welfare concerns over issues including, but not limited to, health and nutrition of foods and beverages, antibiotic use in animal production, and management of controlled substances. The category addresses the company's ability to provide consumers with manufactured products and services that are aligned with societal expectations. It does not include issues directly related to quality and safety malfunctions of manufactured products and services, but instead addresses qualities inherent to the design and delivery of products and services where customer welfare may be in question. The scope of the category also captures companies' ability to prevent counterfeit products.|\n|**DATASECURITY**|**Data Security** - the category addresses management of risks related to collection, retention, and use of sensitive, confidential, and/or proprietary customer or user data. It includes social issues that may arise from incidents such as data breaches in which personally identifiable information (PII) and other user or customer data may be exposed. It addresses a company's strategy, policies, and practices related to IT infrastructure, staff training, record keeping, cooperation with law enforcement, and other mechanisms used to ensure security of customer or user data.|\n|**ECOLOGICALIMPACTS**|**Ecological Impacts** - the category addresses management of the company's impacts on ecosystems and biodiversity through activities including, but not limited to, land use for exploration, natural resource extraction, and cultivation, as well as project development, construction, and siting. The impacts include, but are not limited to, biodiversity loss, habitat destruction, and deforestation at all stages planning, land acquisition, permitting, development, operations, and site remediation. The category does not cover impacts of climate change on ecosystems and biodiversity.|\n|**EMPENGDIVANDINC**|**Employee Engagement Diversity and Inclusion** - the category addresses a company's ability to ensure that its culture and hiring and promotion practices embrace the building of a diverse and inclusive workforce that reflects the makeup of local talent pools and its customer base. It addresses the issues of discriminatory practices on the bases of race, gender, ethnicity, religion, sexual orientation, and other factors.|\n|**EMPHEALTHANDSAFETY**|**Employee Health and Safety** - the category addresses a company's ability to create and maintain a safe and healthy workplace environment that is free of injuries, fatalities, and illness (both chronic and acute). It is traditionally accomplished through implementing safety management plans, developing training requirements for employees and contractors, and conducting regular audits of their own practices as well as those of their subcontractors. The category further captures how companies ensure physical and mental health of workforce through technology, training, corporate culture, regulatory compliance, monitoring and testing, and personal protective equipment.|\n|**ENERGYMGT**|**Energy Management** - the category addresses environmental impacts associated with energy consumption. It addresses the company's management of energy in manufacturing and/or for provision of products and services derived from utility providers (grid energy) not owned or controlled by the company. More specifically, it includes management of energy efficiency and intensity, energy mix, as well as grid reliance. Upstream (e.g., suppliers) and downstream (e.g., product use) energy use is not included in the scope.|\n|**GHGEMISSIONS**|**Greenhouse Gas Emissions** - the category addresses direct (Scope 1) greenhouse gas (GHG) emissions that a company generates through its operations. This includes GHG emissions from stationary (e.g., factories, power plants) and mobile sources (e.g., trucks, delivery vehicles, planes), whether a result of combustion of fuel or non-combusted direct releases during activities such as natural resource extraction, power generation, land use, or biogenic processes. The category further includes management of regulatory risks, environmental compliance, and reputational risks and opportunities, as they related to direct GHG emissions. The seven GHGs covered under the Kyoto Protocol are included within the category carbon dioxide (CO2 ), methane (CH4), nitrous oxide (N2O), hydrofluorocarbons (HFCs), perfluorocarbons (PFCs), sulfur hexafluoride (SF6), and nitrogen trifluoride (NF3).|\n|**HUMANRIGHTSANDCOMRELS**|**Human Rights and Community Relations** - the category addresses management of the relationship between businesses and the communities in which they operate, including, but not limited to, management of direct and indirect impacts on core human rights and the treatment of indigenous peoples. More specifically, such management may cover socio-economic community impacts, community engagement, environmental justice, cultivation of local workforces, impact on local businesses, license to operate, and environmental/social impact assessments. The category does not include environmental impacts such as air pollution or waste which, although they may impact the health and safety of members of local communities, are addressed in separate categories.|\n|**LABORPRACTICES**|**Labor Practices** - the category addresses the company's ability to uphold commonly accepted labor standards in the workplace, including compliance with labor laws and internationally accepted norms and standards. This includes, but is not limited to, ensuring basic human rights related to child labor, forced or bonded labor, exploitative labor, fair wages and overtime pay, and other basic workers' rights. It also includes minimum wage policies and provision of benefits, which may influence how a workforce is attracted, retained, and motivated. The category further addresses a company's relationship with organized labor and freedom of association.|\n|**MGTOFLEGALANDREGENV**|**Management of the Legal and Regulatory Environment** - the category addresses a company's approach to engaging with regulators in cases where conflicting corporate and public interests may have the potential for long-term adverse direct or indirect environmental and social impacts. The category addresses a company's level of reliance upon regulatory policy or monetary incentives (such as subsidies and taxes), actions to influence industry policy (such as through lobbying), overall reliance on a favorable regulatory environment for business competitiveness, and ability to comply with relevant regulations. It may relate to the alignment of management and investor views of regulatory engagement and compliance at large.|\n|**MATSOURCINGANDEFF**|**Materials Sourcing and Efficiency** - the category addresses issues related to the resilience of materials supply chains to impacts of climate change and other external environmental and social factors. It captures the impacts of such external factors on operational activity of suppliers, which can further affect availability and pricing of key resources. It addresses a company's ability to manage these risks through product design, manufacturing, and end-of-life management, such as by using of recycled and renewable materials, reducing the use of key materials (dematerialization), maximizing resource efficiency in manufacturing, and making R&D investments in substitute materials. Additionally, companies can manage these issues by screening, selection, monitoring, and engagement with suppliers to ensure their resilience to external risks. It does not address issues associated with environmental and social externalities created by operational activity of individual suppliers, which is covered in a separate category.|\n|**MATERIALITY**|**Materiality** - this category represents a composite score of all 'material' SASB categories for the given entity. For more information on SASB's Materiality Map, visit [materiality.sasb.org](https://materiality.sasb.org/)|\n|**PHYIMPACTSOFCLIMATECHG**|**Physical Impacts of Climate Change** - the category addresses the company's ability to manage risks and opportunities associated with direct exposure of its owned or controlled assets and operations to actual or potential physical impacts of climate change. It captures environmental and social issues that may arise from operational disruptions due to physical impacts of climate change. It further captures socioeconomic issues resulting from companies failing to incorporate climate change consideration in products and services sold, such as insurance policies and mortgages. The category relates to the company's ability to adapt to increased frequency and severity of extreme weather, shifting climate, sea level risk, and other expected physical impacts of climate change. Management may involve enhancing resiliency of physical assets and/or surrounding infrastructure as well as incorporation of climate change-related considerations into key business activities (e.g., mortgage and insurance underwriting, planning and development of real estate projects).|\n|**PDANDLIFECYCLEMGT**|**Product Design and Lifecycle Management** - the category addresses incorporation of environmental, social, and governance (ESG) considerations in characteristics of products and services provided or sold by the company. It includes, but is not limited to, managing the lifecycle impacts of products and services, such as those related to packaging, distribution, use-phase resource intensity, and other environmental and social externalities that may occur during their use-phase or at the end of life. The category captures a company's ability to address customer and societal demand for more sustainable products and services as well as to meet evolving environmental and social regulation. It does not address direct environmental or social impacts of the company's operations nor does it address health and safety risks to consumers from product use, which are covered in other categories.|\n|**PRODQUALITYANDSFTY**|**Product Quality and Safety** - the category addresses issues involving unintended characteristics of products sold or services provided that may create health or safety risks to end-users. It addresses a company's ability to offer manufactured products and/or services that meet customer expectations with respect to their health and safety characteristics. It includes, but is not limited to, issues involving liability, management of recalls and market withdrawals, product testing, and chemicals/content/ ingredient management in products.|\n|**SELLPRACANDPRODLABEL**|**Selling Practices and Product Labeling** - the category addresses social issues that may arise from a failure to manage the transparency, accuracy, and comprehensibility of marketing statements, advertising, and labeling of products and services. It includes, but is not limited to, advertising standards and regulations, ethical and responsible marketing practices, misleading or deceptive labeling, as well as discriminatory or predatory selling and lending practices. This may include deceptive or aggressive selling practices in which incentive structures for employees could encourage the sale of products or services that are not in the best interest of customers or clients.|\n|**SUPPLYCHAINMGT**|**Supply Chain Management** - the category addresses management of environmental, social, and governance (ESG) risks within a company's supply chain. It addresses issues associated with environmental and social externalities created by suppliers through their operational activities. Such issues include, but are not limited to, environmental responsibility, human rights, labor practices, and ethics and corruption. Management may involve screening, selection, monitoring, and engagement with suppliers on their environmental and social impacts. The category does not address the impacts of external factors such as climate change and other environmental and social factors on suppliers' operations and/or on the availability and pricing of key resources, which is covered in a separate category.|\n|**SYSTEMICRISKMGT**|**Systemic Risk Management** - the category addresses the company's contributions to, or management of systemic risks resulting from large-scale weakening or collapse of systems upon which the economy and society depend. This includes financial systems, natural resource systems, and technological systems. It addresses the mechanisms a company has in place to reduce its contributions to systemic risks and to improve safeguards that may mitigate the impacts of systemic failure. For financial institutions, the category also captures the company's ability to absorb shocks arising from financial and economic stress and meet stricter regulatory requirements related to the complexity and interconnectedness of companies in the industry.|\n|**WASTEANDHZRDMATSMGT**|**Waste and Hazardous Materials Management** - the category addresses environmental issues associated with hazardous and non-hazardous waste generated by companies. It addresses a company's management of solid wastes in manufacturing, agriculture, and other industrial processes. It covers treatment, handling, storage, disposal, and regulatory compliance. The category does not cover emissions to air or wastewater, nor does it cover waste from end-of-life of products, which are addressed in separate categories.|\n|**WATERANDWASTEWATERMGT**|**Water and Wastewater Management** - the category addresses a company's water use, water consumption, wastewater generation, and other impacts of operations on water resources, which may be influenced by regional differences in the availability and quality of and competition for water resources. More specifically, it addresses management strategies including, but not limited to, water efficiency, intensity, and recycling. Lastly, the category also addresses management of wastewater treatment and discharge, including groundwater and aquifer pollution.|\n" example: - AIRQUALITY - BUSINESSETHICS - HUMANRIGHTSANDCOMRELS dateOf: name: dateOf in: query required: false schema: type: string enum: - PUBLICATION - INGESTION default: PUBLICATION description: "Date of Publication or Ingestion \n * **Publication:** use for startDate and endDate the articles publication date \n * **Ingestion:** use for startDate and endDate the articles TVL first processing date \n \n" example: PUBLICATION endDate_2: name: endDate in: query required: false schema: type: string description: 'The end date requested for a given date range in **YYYY-MM-DD** format. If left blank, the API will default to latest available completed period. ' example: '2019-12-31' requestedDate: name: date in: query required: false schema: type: string description: Date of holding expressed in YYYY-MM-DD format. endDate: name: endDate in: query required: false schema: type: string description: Requested End Date for Range expressed in YYYY-MM-DD format. relativeFiscalEnd: name: relativeFiscalEnd in: query required: false schema: type: integer description: Relative fiscal period, expressed as an integer, used to filter results. This is combined with the periodicity parameter to specify a relative estimate period. For example, set to 2 and periodicity to ANN to ask for relative Fiscal Year 1 (FY2). example: 3 currency: name: currency in: query required: false schema: type: string description: Currency for response. tvlIds: name: ids in: query schema: type: array items: type: string minItems: 1 maxItems: 1500 required: true explode: false description: 'Security or Entity identifiers. ISIN, Truvalue Identifiers, instrumentTvlId, instrumentPermId, and Tickers are accepted inputs.***ids limit** = 1500 per 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.
* ' examples: oneId: summary: One Market Identifier value: - AAPL-USA multipleIds: summary: Multiple Market Identifiers value: - AAPL-US - GOOGL-US - MSFT-US ids_2: name: ids in: query schema: type: array items: type: string minItems: 1 maxItems: 3000 required: true explode: false description: 'Security or Entity identifiers. FactSet Identifiers, tickers, CUSIP and SEDOL are accepted input.***ids limit** = 3000 per request*
* Make Note - id limit of 3000 for defaults, otherwise the service is limited to a 30 second duration. This can be reached when increasing total number of metrics requested and depth of history. * ' examples: oneId: summary: One Market Identifier value: - AAPL-USA multipleIds: summary: Multiple Market Identifiers value: - FDS-US - AAPL-US - MSFT-US calendar: name: calendar in: query schema: type: string enum: - FIVEDAY - SEVENDAY default: FIVEDAY description: Calendar of data returned. SEVENDAY includes weekends. example: FIVEDAY segmentIds: name: ids in: query schema: type: array items: type: string minItems: 1 maxItems: 50 required: true explode: false description: 'Security or Entity identifiers. FactSet Identifiers, tickers, CUSIP and SEDOL are accepted input.***ids limit** = 50 per request*
* Make Note - id limit of 50 for defaults, otherwise the service is limited to a 30 second duration. This can be reached when increasing total number of metrics requested and depth of history. * ' examples: oneId: summary: One Market Identifier value: - AAPL-USA multipleIds: summary: Multiple Market Identifiers value: - FDS-US - AAPL-US - MSFT-US articlesFields: name: fields in: query description: "Request available Articles data fields to be included in the response.\n Default is all fields. _fsymId_ and _articleId_ are always included.\n \n