openapi: 3.0.3 info: title: Factset Analytics Datastore About Search 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: Search paths: /analytics/pub-datastore/tag-search/v1/documents/search: post: tags: - Search summary: Factset Gets a List of Documents That a User Has Access To. description: "Retrieves metadata around documents stored in the Analytics Datastore Service. Each Document will have a 'url' property which will act as a re-direct to the underlying document data\r\n\r\nThis end point supports pagination and filtering through the use of the request body listed below.\r\n\r\nTo discover what tags are available to filter on, see GET /tags and GET /tags/{name}/values to retrieve these filter values.\r\n\r\nSimilarly, to discover what product types are available to filter on, see POST /product-types/search to retrieve a list of product types." operationId: getDocumentsEndPoint requestBody: description: Example request of a filtered Documents search call required: true content: application/json: schema: $ref: '#/components/schemas/DocumentRequest' responses: '200': description: Expected response, a list of documents the user has access to. content: application/json: schema: $ref: '#/components/schemas/DocumentListResponse' '400': description: Invalid parameter provided. headers: X-DataDirect-Request-Key: description: FactSets request key header. schema: type: string '401': description: Missing or invalid authentication. headers: X-DataDirect-Request-Key: description: FactSets request key header. schema: type: string '403': description: User is forbidden with current credentials headers: X-DataDirect-Request-Key: description: FactSets request key header. schema: type: string '404': description: The provided request does not exist. headers: X-DataDirect-Request-Key: description: FactSets request key header. schema: type: string '500': description: Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting headers: X-DataDirect-Request-Key: description: FactSets request key header. schema: type: string '503': description: Request timed out. Retry the request in sometime. headers: X-RateLimit-Remaining: description: Number of requests left for the time window. schema: type: string X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string X-RateLimit-Reset: description: Number of seconds remaining till rate limit resets. schema: type: string X-RateLimit-Limit: description: Number of allowed requests for the time window. schema: type: string X-DataDirect-Request-Key: description: FactSets request key header. schema: type: string x-microcks-operation: delay: 0 dispatcher: FALLBACK /analytics/pub-datastore/tag-search/v1/tags: get: tags: - Search summary: Factset Gets a List of Tag Definitions for the User. description: Tag definitions consist of a name and a type. Use this end point to see a list of pre-existing tags that can be used to filter on the Documents end point. operationId: getTagsEndPoint parameters: - name: _paginationOffset in: query description: The offset integer on where to begin paginating schema: type: integer default: 0 - name: _paginationLimit in: query description: The limit of records to return when paginating schema: maximum: 1000 minimum: 1 type: integer default: 50 responses: '200': description: Expected response, returns a list of tag definitions the user has access to. content: application/json: schema: $ref: '#/components/schemas/TagListResponse' '400': description: Invalid parameter provided. headers: X-DataDirect-Request-Key: description: FactSets request key header. schema: type: string '401': description: Missing or invalid authentication. headers: X-DataDirect-Request-Key: description: FactSets request key header. schema: type: string '403': description: User is forbidden with current credentials headers: X-DataDirect-Request-Key: description: FactSets request key header. schema: type: string '404': description: The provided request does not exist. headers: X-DataDirect-Request-Key: description: FactSets request key header. schema: type: string '500': description: Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting headers: X-DataDirect-Request-Key: description: FactSets request key header. schema: type: string '503': description: Request timed out. Retry the request in sometime. headers: X-RateLimit-Remaining: description: Number of requests left for the time window. schema: type: string X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string X-RateLimit-Reset: description: Number of seconds remaining till rate limit resets. schema: type: string X-RateLimit-Limit: description: Number of allowed requests for the time window. schema: type: string X-DataDirect-Request-Key: description: FactSets request key header. schema: type: string x-microcks-operation: delay: 0 dispatcher: FALLBACK /analytics/pub-datastore/tag-search/v1/tags/{name}: get: tags: - Search summary: Factset Get a Single Tag Definition Based on Its Name description: Retrieve a tag definition based on its name operationId: getSingleTagEndPoint parameters: - name: name in: path description: The name of the tag required: true schema: type: string responses: '200': description: Expected response, returns the tag requested content: application/json: schema: $ref: '#/components/schemas/TagResponse' '400': description: Invalid parameter provided. headers: X-DataDirect-Request-Key: description: FactSets request key header. schema: type: string '401': description: Missing or invalid authentication. headers: X-DataDirect-Request-Key: description: FactSets request key header. schema: type: string '403': description: User is forbidden with current credentials headers: X-DataDirect-Request-Key: description: FactSets request key header. schema: type: string '404': description: The provided request does not exist. headers: X-DataDirect-Request-Key: description: FactSets request key header. schema: type: string '500': description: Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting headers: X-DataDirect-Request-Key: description: FactSets request key header. schema: type: string '503': description: Request timed out. Retry the request in sometime. headers: X-RateLimit-Remaining: description: Number of requests left for the time window. schema: type: string X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string X-RateLimit-Reset: description: Number of seconds remaining till rate limit resets. schema: type: string X-RateLimit-Limit: description: Number of allowed requests for the time window. schema: type: string X-DataDirect-Request-Key: description: FactSets request key header. schema: type: string x-microcks-operation: delay: 0 dispatcher: FALLBACK /analytics/pub-datastore/tag-search/v1/tags/{name}/values: post: tags: - Search summary: Factset Gets a List of Tag Values for the Given Name description: Returns a list of tag values depending on the name provided. Supports filtering on additional tag name value pairs, which operates as an 'AND' where the Document must have the tag name specified in the path AND the filtered parameter. operationId: getTagValuesEndPoint parameters: - name: name in: path description: The name of the tag required: true schema: type: string requestBody: description: Request body to apply when filtering on this end point. Pagination controls are applied through the pagination object and additional tag filters can be used by supplying the tag name and its value in the tags object. required: true content: application/json: schema: $ref: '#/components/schemas/TagFilterModel' responses: '200': description: Expected response, returns a list of tag definitions the user has access to. content: application/json: schema: $ref: '#/components/schemas/TagValuesListResponse' '400': description: Invalid parameter provided. headers: X-DataDirect-Request-Key: description: FactSets request key header. schema: type: string '401': description: Missing or invalid authentication. headers: X-DataDirect-Request-Key: description: FactSets request key header. schema: type: string '403': description: User is forbidden with current credentials headers: X-DataDirect-Request-Key: description: FactSets request key header. schema: type: string '404': description: The provided request does not exist. headers: X-DataDirect-Request-Key: description: FactSets request key header. schema: type: string '500': description: Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting headers: X-DataDirect-Request-Key: description: FactSets request key header. schema: type: string '503': description: Request timed out. Retry the request in sometime. headers: X-RateLimit-Remaining: description: Number of requests left for the time window. schema: type: string X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string X-RateLimit-Reset: description: Number of seconds remaining till rate limit resets. schema: type: string X-RateLimit-Limit: description: Number of allowed requests for the time window. schema: type: string X-DataDirect-Request-Key: description: FactSets request key header. schema: type: string x-microcks-operation: delay: 0 dispatcher: FALLBACK /analytics/pub-datastore/tag-search/v1/product-types/search: post: tags: - Search summary: Factset Gets a List of Product Types That a User Has Access To. description: Retrieves a list of product types that have been specified across all documents the user has access to operationId: getProductTypes requestBody: description: Request body to apply when filtering on this end point. Pagination controls are applied through the pagination object and additional tag filters can be used by supplying the tag name and its value in the tags object. required: true content: application/json: schema: $ref: '#/components/schemas/TagFilterModel' responses: '200': description: Expected response, a list of product types the user has access to. content: application/json: schema: $ref: '#/components/schemas/ProductTypeListResponse' '400': description: Invalid parameter provided. headers: X-DataDirect-Request-Key: description: FactSets request key header. schema: type: string '401': description: Missing or invalid authentication. headers: X-DataDirect-Request-Key: description: FactSets request key header. schema: type: string '403': description: User is forbidden with current credentials headers: X-DataDirect-Request-Key: description: FactSets request key header. schema: type: string '404': description: The provided request does not exist. headers: X-DataDirect-Request-Key: description: FactSets request key header. schema: type: string '500': description: Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting headers: X-DataDirect-Request-Key: description: FactSets request key header. schema: type: string '503': description: Request timed out. Retry the request in sometime. headers: X-RateLimit-Remaining: description: Number of requests left for the time window. schema: type: string X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string X-RateLimit-Reset: description: Number of seconds remaining till rate limit resets. schema: type: string X-RateLimit-Limit: description: Number of allowed requests for the time window. schema: type: string X-DataDirect-Request-Key: description: FactSets request key header. schema: type: string x-microcks-operation: delay: 0 dispatcher: FALLBACK /debtInstrument/issuer/search: post: tags: - Search operationId: post/debtInstrument/issuer/search 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 summary: Factset Search for Issuers of Debt Instruments. description: Search for issuers of debt instruments. FactSet does not consolidate the data provided by different suppliers, therefore the result may contain more than one identifier for a given issuer. The response is limited to 100 results. requestBody: content: application/json: schema: $ref: '#/components/schemas/PostDebtInstrumentIssuerSearchRequest' responses: '200': $ref: '#/components/responses/PostDebtInstrumentIssuerSearch200Response' parameters: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK /debtInstrument/notation/screener/search: post: tags: - Search operationId: post/debtInstrument/notation/screener/search 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 summary: Factset Screener for Debt Instruments' Notations Based on Debt Instrument-specific Parameters. description: Screener for debt instruments' notations based on debt instrument-specific parameters. The result is limited to the notations that satisfy all the selected filters. If more than one notation of an instrument matches the parameters, and no market priority has been specified, only the notation with the highest trading volume, averaged over one month, is considered. requestBody: content: application/json: schema: $ref: '#/components/schemas/PostDebtInstrumentNotationScreenerSearchRequest' responses: '200': $ref: '#/components/responses/PostDebtInstrumentNotationScreenerSearch200Response' parameters: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK /search: get: summary: Returns the Filings Documents and Related Metadata Within Factset Coverage. tags: - Search responses: '200': description: Array of downloadable URLs consisting of Filings documents with related metadata. content: application/json: schema: $ref: '#/components/schemas/InvestmentResearch' examples: Sample Response: value: data: - headline: Zukin's Next Week Today 4/7/2023 (Wolfe Research) 97 pages source: EDG allIds: - IBM-US primaryIds: - IBM-US filingsDate: '20230307' filingsTime: '194026' categories: - CN:US,DT:AN-FILNS,DT:FILNS, DT:FILNS filingsLink: https://api.factset.com/v0/filings?report=story&key=U2FsdGVkX18b15tR%2bV9L1xvjo6Vnz7C7PhIbUvoMrgF%2f43aEWomYlhVruC6G6874fEX documentId: 20230307-5b36f2cf-49bd-ed11-abc3-12bc89a8f273_0 meta: pagination: isEstimatedTotal: false '400': description: Bad request. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: default400ResponseExample: $ref: '#/components/examples/ErrorDetails' '401': description: Unauthenticated USERNAME-SERIAL. Ensure you are logged in and have successfully generated an API KEY for the IP range you are connecting from. For more help, select the Report Issue in the top right corner of this Developer Portal specification card and choose Connectivity 401 or 403 Responses. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: default401ResponseExample: $ref: '#/components/examples/AuthErrorDetails' '403': description: The USERNAME-SERIAL attempted to request the endpoint is not authorized to access. The request was a legal request, but the server is refusing to respond. Please reach out to FactSet Account Team for assistance with authorization. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: default403ResponseExample: $ref: '#/components/examples/AuthorizationErrorDetails' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: default500ResponseExample: $ref: '#/components/examples/ServerErrorDetails' operationId: getFilings description: Returns the filings documents within FactSet coverage along with other response fields parameters: - $ref: '#/components/parameters/ids' - $ref: '#/components/parameters/startDate' - $ref: '#/components/parameters/endDate' - $ref: '#/components/parameters/paginationLimit' - $ref: '#/components/parameters/paginationOffset' - $ref: '#/components/parameters/timezone' - $ref: '#/components/parameters/sort' - $ref: '#/components/parameters/sourcesOne' - $ref: '#/components/parameters/categories' - $ref: '#/components/parameters/primaryId' - $ref: '#/components/parameters/searchText' - $ref: '#/components/parameters/formType' - $ref: '#/components/parameters/accession' x-microcks-operation: delay: 0 dispatcher: FALLBACK /ofs/v2/attributes/search: post: summary: Factset Retrieve a Collection of Attribute Records. parameters: - name: body in: body schema: $ref: '#/definitions/PostAttributeSearchDto' type: json responses: '200': description: A JSON representation of collection of Attribute records. Might be empty. schema: items: allOf: - $ref: '#/definitions/GetAttributeDto' type: array headers: X-Pagination: description: A JSON containing pagination information. (e.g totalCount,pageSize,currentPage,totalPages,previousPageLink and nextPageLink) type: string '422': description: Unprocessable entity. Validation error response containing the errors in a human readable form. schema: items: type: string type: array tags: - Search x-microcks-operation: delay: 0 dispatcher: FALLBACK /ofs/v2/attributes/groups/search: post: summary: Factset Retrieve a Collection of Attributes Group Records. parameters: - name: body in: body schema: $ref: '#/definitions/PostAttributesGroupSearchDto' type: json responses: '200': description: A JSON representation of collection of Attributes Group records. Might be empty. schema: items: allOf: - $ref: '#/definitions/GetAttributesGroupDto' type: array headers: X-Pagination: description: A JSON containing pagination information. (e.g totalCount,pageSize,currentPage,totalPages,previousPageLink and nextPageLink) type: string '422': description: Unprocessable entity. Validation error response containing the errors in a human readable form. schema: items: type: string type: array tags: - Search x-microcks-operation: delay: 0 dispatcher: FALLBACK /ofs/v2/partners/search: post: summary: Factset Retrieve a Collection of Partner Records. parameters: - name: body in: body schema: $ref: '#/definitions/PostPartnerSearchDto' type: json responses: '200': description: A JSON representation of collection of Partner records. Might be empty. schema: items: allOf: - $ref: '#/definitions/GetPartnerDto' type: array headers: X-Pagination: description: A JSON containing pagination information. (e.g totalCount,pageSize,currentPage,totalPages,previousPageLink and nextPageLink) type: string '422': description: Unprocessable entity. Validation error response containing the errors in a human readable form. schema: items: type: string type: array tags: - Search x-microcks-operation: delay: 0 dispatcher: FALLBACK /ofs/v2/products/search: post: summary: Factset Retrieve a Collection of Product Records. parameters: - name: body in: body schema: $ref: '#/definitions/PostProductSearchDto' type: json responses: '200': description: A JSON representation of collection of Product records. Might be empty. schema: items: allOf: - $ref: '#/definitions/GetProductDto' type: array headers: X-Pagination: description: A JSON containing pagination information. (e.g totalCount,pageSize,currentPage,totalPages,previousPageLink and nextPageLink) type: string '422': description: Unprocessable entity. Validation error response containing the errors in a human readable form. schema: items: type: string type: array tags: - Search x-microcks-operation: delay: 0 dispatcher: FALLBACK /ofs/v2/resources/search: post: summary: Factset Retrieve a Collection of Resource Records. parameters: - name: body in: body schema: $ref: '#/definitions/PostResourceSearchDto' type: json responses: '200': description: A JSON representation of collection of Resource records. Might be empty. schema: items: allOf: - $ref: '#/definitions/GetResourceDto' type: array headers: X-Pagination: description: A JSON containing pagination information. (e.g totalCount,pageSize,currentPage,totalPages,previousPageLink and nextPageLink) type: string '422': description: Unprocessable entity. Validation error response containing the errors in a human readable form. schema: items: type: string type: array tags: - Search x-microcks-operation: delay: 0 dispatcher: FALLBACK /ofs/v2/resources/sections/search: post: summary: Factset Retrieve a Collection of Resources Section Records. parameters: - name: body in: body schema: $ref: '#/definitions/PostResourcesSectionSearchDto' type: json responses: '200': description: A JSON representation of collection of Resources Section records. Might be empty. schema: items: allOf: - $ref: '#/definitions/GetResourcesSectionDto' type: array headers: X-Pagination: description: A JSON containing pagination information. (e.g totalCount,pageSize,currentPage,totalPages,previousPageLink and nextPageLink) type: string '422': description: Unprocessable entity. Validation error response containing the errors in a human readable form. schema: items: type: string type: array tags: - Search x-microcks-operation: delay: 0 dispatcher: FALLBACK /news/article/searchByText: post: tags: - Search operationId: post/news/article/searchByText x-supportsOffsetBasedPaging: false x-supportsOffsetBasedPagingWithoutTotal: false x-supportsCursorBasedPaging: false x-supportsCursorBasedPagingWithoutTotal: true x-supportsPush: true x-requiresUser: false x-requiresInternalClient: false x-disallowUser: false x-no-merge: false x-maxSortParameterCount: 10 x-supportsPermissionDeniedResponse: false summary: Factset Search for News Articles Using a Fulltext Search. description: Search for news articles using a fulltext search. All specified criteria need to be fulfilled for an article to match. Each criterion is handled according to its selectionType; "include" requires the criterion to evaluate to true, "exclude" requires the criterion to evaluate to false. A criterion is fulfilled when at least one of its values is found. requestBody: description: Request Body content: application/json: schema: $ref: '#/components/schemas/PostNewsArticleSearchByTextRequest' required: false responses: '200': $ref: '#/components/responses/PostNewsArticleSearchByText200Response' parameters: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK /news/publisher/searchByName: post: tags: - Search operationId: post/news/publisher/searchByName 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: 1 x-supportsPermissionDeniedResponse: false summary: Factset Search for Publishers. description: Search for publishers by the name of the publisher. requestBody: description: Request Body content: application/json: schema: $ref: '#/components/schemas/PostNewsPublisherSearchByNameRequest' required: true responses: '200': $ref: '#/components/responses/PostNewsPublisherSearchByName200Response' parameters: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK /instrument/search/basic: get: tags: - Search operationId: get/instrument/search/basic 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 summary: Factset Basic Search for Instruments. description: Search for instruments whose ISIN, specified NSINs, or name match the search value according to a tolerant full-text match algorithm. Better matching results appear in the response before less relevant matches. parameters: - name: searchValue in: query schema: type: string minLength: 3 exclusiveMinimum: false maxLength: 200 exclusiveMaximum: false pattern: ^[ -!#-&(-+--/0-:=?-Za-z\w"]*$ description: The search value of the instruments searching for. It may be enclosed in double quotes ("). No escaping is provided, therefore it is impossible to specify a search string containing double quotes. Relevance of word starts is indicated by a phrase starting with a space character, such as " daimler". required: true - name: nsins in: query schema: description: A set of NSIN kinds to consider in the search. If the parameter is absent or the value is empty, all valid NSIN kinds are searched. type: array nullable: false items: type: string x-enum-description: - The WKN (Wertpapierkennnummer, German for Securities Identification Number) of the instrument. The WKN is a 6-character code of digits and upper-case letters that uniquely identifies an instrument. - 'The Valor number (German: Valorennummer) of the instrument. The Valor number is an integer number that uniquely identifies an instrument.' - The CUSIP (Committee on Uniform Security Identification Procedures) or CINS (CUSIP International Numbering System) identifier of the instrument. These numbers are 9-character codes of digits and upper-case letters that uniquely identify an instrument. - The SEDOL or IDII for the instrument; see entity class "SEDOL or IDII" for details. enum: - wkn - valor - cusip - sedol uniqueItems: true style: form explode: false - name: assetClass in: query schema: type: string description: A parameter to limit the output to a particular asset class. x-enum-description: - An index is an instrument representing a statistical measure of changes in a group of data points. An index has a well-defined calculation method. An index may have index constituents, selected according to a well-defined set of rules. - A stock, also known as stock certificate or share, represents the partitioned capital stock of a company. The capital stock of a company constitutes the equity stake of its owners. - A fund is a supply of capital belonging to numerous investors that is used to collectively purchase securities while each investor retains ownership and control of his or her own shares. - An exchange traded fund (ETF) is a security that tracks an index, a commodity or a basket of assets like an index fund, but trades like a stock on an exchange. ETFs experience price changes throughout the day as they are bought and sold. - A debt instrument is an interest-bearing or interest-earning financial instrument, which is generally used for long-term debt financing and investment. - An investment product is a securitized derivatives product which allows the investor to participate in the performance of the underlying financial instrument. - A leveraged product is a securitized derivatives product which allows the investor to participate with a leverage in the performance of the underlying financial instrument. - A currency cross rate is an exchange rate between two main currencies. - A commodity is a marketable item produced to satisfy market requirements. Economic commodities comprise both goods and services. - An option is a derivatives contract that represents a contract sold by one party (the option writer) to another party (the option holder). The contract offers the buyer the right, but not the obligation, to buy (call) or sell (put) a particular underlying asset at an agreed price (the strike price) on a specific exercise date (European-style option) or during a period of time up to that exercise date (American-style option). - A future is a derivatives contract that represents a contractual agreement to buy or sell a particular underlying asset at a pre-determined price on a specific date in the future. A future contract details the quality and quantity of the underlying asset. Some future contracts may require a physical delivery of the asset, whereas others are settled in cash. In contrast to a forward (traded over-the-counter (OTC)), a future is a standardized derivative traded on a futures exchange. - An interest rate is the rate at which interest is paid by borrowers for the use of money borrowed from a lender. Specifically, the interest rate is a percentage of the principal. - Rights are securities that allow the owner to participate at the securitized right. enum: - index - stock - fund - etf - debt - investmentProduct - leveragedProduct - currency - commodity - option - future - interestRate - right - name: onlyActive in: query schema: type: boolean description: If true, restricts the result to active instruments. default: true required: false - name: _attributes in: query schema: type: array items: type: string maxLength: 100 exclusiveMaximum: false uniqueItems: true maxItems: 50 style: form explode: false description: Limit the attributes returned in the response to the specified set. - name: _language in: query schema: type: string format: isoLanguage description: ISO 639-1 code of the language. maxLength: 2 minLength: 2 exclusiveMinimum: false exclusiveMaximum: false - description: Non-negative number of entries to skip, or 0 (default). name: _paginationOffset in: query schema: type: number format: int32 minimum: 0 exclusiveMinimum: false default: 0 - description: Non-negative maximum number of entries to return. name: _paginationLimit in: query schema: type: number format: int32 minimum: 0 exclusiveMinimum: false maximum: 500 exclusiveMaximum: false default: 20 responses: '200': $ref: '#/components/responses/GetInstrumentSearchBasic200Response' x-microcks-operation: delay: 0 dispatcher: FALLBACK /notation/search/basic: get: tags: - Search operationId: get/notation/search/basic 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 summary: Factset Basic Search for Notations. description: Search for a notation whose ISIN, specified NSINs, name, or symbol match the search value according to a tolerant full-text match algorithm. If more than one notation of an instrument matches, only the notation with the highest monetary trading volume, averaged over one month, is considered. Better matching results appear in the response before less relevant matches. If the parameter popularity is set to true, the popularity of the notation is the primary sort criterion. Popularity is affected mostly by the request frequency of the notation. parameters: - name: searchValue in: query schema: type: string minLength: 3 exclusiveMinimum: false maxLength: 200 exclusiveMaximum: false pattern: ^[ -!#-&(-+--/0-:=?-Za-z\w"]*$ description: Full-text search string. It may be enclosed in double quotes ("). No escaping is provided, therefore it is impossible to specify a search string containing double quotes. Relevance of word starts is indicated by a phrase starting with a space character, such as " daimler". required: true - name: nsins in: query schema: description: A set of NSIN kinds to consider in the search. If the parameter is absent or the value is empty, all valid NSIN kinds are searched. type: array nullable: false items: type: string x-enum-description: - The WKN (Wertpapierkennnummer, German for Securities Identification Number) of the instrument. The WKN is a 6-character code of digits and upper-case letters that uniquely identifies an instrument. - 'The Valor number (German: Valorennummer) of the instrument. The Valor number is an integer number that uniquely identifies an instrument.' - The CUSIP (Committee on Uniform Security Identification Procedures) or CINS (CUSIP International Numbering System) identifier of the instrument. These numbers are 9-character codes of digits and upper-case letters that uniquely identify an instrument. - The SEDOL or IDII for the notation; see entity class "SEDOL or IDII" for details. enum: - wkn - valor - cusip - sedol uniqueItems: true style: form explode: false - name: assetClass in: query schema: type: string description: A parameter to limit the output to a particular asset class. x-enum-description: - An index is an instrument representing a statistical measure of changes in a group of data points. An index has a well-defined calculation method. An index may have index constituents, selected according to a well-defined set of rules. - A stock, also known as stock certificate or share, represents the partitioned capital stock of a company. The capital stock of a company constitutes the equity stake of its owners. - A fund is a supply of capital belonging to numerous investors that is used to collectively purchase securities while each investor retains ownership and control of his or her own shares. - An exchange traded fund (ETF) is a security that tracks an index, a commodity or a basket of assets like an index fund, but trades like a stock on an exchange. ETFs experience price changes throughout the day as they are bought and sold. - A debt instrument is an interest-bearing or interest-earning financial instrument, which is generally used for long-term debt financing and investment. - An investment product is a securitized derivatives product which allows the investor to participate in the performance of the underlying financial instrument. - A leveraged product is a securitized derivatives product which allows the investor to participate with a leverage in the performance of the underlying financial instrument. - A currency cross rate is an exchange rate between two main currencies. - A commodity is a marketable item produced to satisfy market requirements. Economic commodities comprise both goods and services. - An option is a derivatives contract that represents a contract sold by one party (the option writer) to another party (the option holder). The contract offers the buyer the right, but not the obligation, to buy (call) or sell (put) a particular underlying asset at an agreed price (the strike price) on a specific exercise date (European-style option) or during a period of time up to that exercise date (American-style option). - A future is a derivatives contract that represents a contractual agreement to buy or sell a particular underlying asset at a pre-determined price on a specific date in the future. A future contract details the quality and quantity of the underlying asset. Some future contracts may require a physical delivery of the asset, whereas others are settled in cash. In contrast to a forward (traded over-the-counter (OTC)), a future is a standardized derivative traded on a futures exchange. - An interest rate is the rate at which interest is paid by borrowers for the use of money borrowed from a lender. Specifically, the interest rate is a percentage of the principal. - Rights are securities that allow the owner to participate at the securitized right. enum: - index - stock - fund - etf - debt - investmentProduct - leveragedProduct - currency - commodity - option - future - interestRate - right - name: onlyActive in: query schema: type: boolean description: If true, restricts the result to active notations. default: true required: false - name: popularity in: query schema: type: boolean default: false description: If true, the results are sorted by descending popularity. required: false - name: _attributes in: query schema: type: array items: type: string maxLength: 100 exclusiveMaximum: false uniqueItems: true maxItems: 50 style: form explode: false description: Limit the attributes returned in the response to the specified set. - name: _language in: query schema: type: string format: isoLanguage description: ISO 639-1 code of the language. maxLength: 2 minLength: 2 exclusiveMinimum: false exclusiveMaximum: false - description: Non-negative number of entries to skip, or 0 (default). name: _paginationOffset in: query schema: type: number format: int32 minimum: 0 exclusiveMinimum: false default: 0 - description: Non-negative maximum number of entries to return. name: _paginationLimit in: query schema: type: number format: int32 minimum: 0 exclusiveMinimum: false maximum: 500 exclusiveMaximum: false default: 20 responses: '200': $ref: '#/components/responses/GetNotationSearchBasic200Response' x-microcks-operation: delay: 0 dispatcher: FALLBACK /notation/searchByText: post: tags: - Search operationId: post/notation/searchByText 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: 6 x-supportsPermissionDeniedResponse: false summary: Factset Text-based Search for Notations. description: "Text-based search for notations in selected identifier and name attributes according to a tolerant full-text match algorithm. The results satisfy all selected filters; sorting by various attributes is possible. If more than one notation of an instrument matches, only the notation with the best market priority (according to the parameter `market.priority`) or, in the absence of market priorities, only the notation with the highest trading volume, averaged over one month, is considered. \n All identifiers used as parameters must be valid and entitled." requestBody: description: Request Body content: application/json: schema: $ref: '#/components/schemas/PostNotationSearchByTextRequest' required: true responses: '200': $ref: '#/components/responses/PostNotationSearchByText200Response' parameters: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK /recommendationList/search: get: tags: - Search operationId: get/recommendationList/search 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 summary: Factset Search for Recommendation Lists. description: Search for recommendation lists, delivering an array of recommendation lists matching the specified filter criteria. The data provided for each recommendation list includes the currently active revision (or null in case no active revision exists). parameters: - name: name in: query schema: type: string description: Restricts the search to recommendation lists, which contain the provided string in their name attribute. The filter is a case-insensitive substring match. required: false - name: onlyActive in: query schema: type: boolean description: Restrict the search to recommendation lists, which are currently active (e.g., current date is before the recommendation list's activeRange.end date). If set to false, recommendation lists will be returned regardless of their state. required: false - name: _attributes in: query schema: type: array items: type: string maxLength: 100 exclusiveMaximum: false uniqueItems: true maxItems: 50 style: form explode: false description: Limit the attributes returned in the response to the specified set. - name: _language in: query schema: type: string format: isoLanguage description: ISO 639-1 code of the language. maxLength: 2 minLength: 2 exclusiveMinimum: false exclusiveMaximum: false responses: '200': $ref: '#/components/responses/GetRecommendationListSearch200Response' x-microcks-operation: delay: 0 dispatcher: FALLBACK /recommendationList/revision/search: get: tags: - Search operationId: get/recommendationList/revision/search 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 summary: Factset Search for Revisions of a Recommendation List. description: Search for revisions of a recommendation list. parameters: - name: idNotation in: query schema: type: string format: id64 x-positive: true description: Restrict the search to revisions containing an element associated with the identified notation. required: false - name: idInstrument in: query schema: type: string format: id64 x-positive: true description: Restrict the search to revisions pointing to the identified instrument. required: false - name: _attributes in: query schema: type: array items: type: string maxLength: 100 exclusiveMaximum: false uniqueItems: true maxItems: 50 style: form explode: false description: Limit the attributes returned in the response to the specified set. - name: _language in: query schema: type: string format: isoLanguage description: ISO 639-1 code of the language. maxLength: 2 minLength: 2 exclusiveMinimum: false exclusiveMaximum: false responses: '200': $ref: '#/components/responses/GetRecommendationListRevisionSearch200Response' x-microcks-operation: delay: 0 dispatcher: FALLBACK /search/answers/v1/data: get: summary: Fetch Factset Answer in Data Format tags: - Search description: Returns an answer to the specified query (if a valid answer exists). Returns the answer data only (as JSON), without any markup information. operationId: searchForDataAnswer parameters: - $ref: '#/components/parameters/Query' - $ref: '#/components/parameters/ConsumingApplication' responses: '200': description: Request was successful. content: application/json: schema: $ref: '#/components/schemas/DataAnswerSuccessResponse' '400': description: Missing or empty query. content: application/json: schema: $ref: '#/components/schemas/AnswerFailureResponse' '401': description: Missing or invalid authentication. content: application/json: schema: $ref: '#/components/schemas/AnswerFailureResponse' '500': description: Unhandled error occurred while processing the request. content: application/json: schema: $ref: '#/components/schemas/AnswerFailureResponse' x-microcks-operation: delay: 0 dispatcher: FALLBACK /search/answers/v1/adaptive-card: get: summary: Fetch Factset Answer in Adaptive Card Format tags: - Search description: Returns an answer to the specified query (if valid answer exists) in the Adaptive Card format (https://adaptivecards.io/). operationId: searchForAdaptiveCardAnswer parameters: - $ref: '#/components/parameters/Query' - $ref: '#/components/parameters/IncludeThumbnail' - $ref: '#/components/parameters/DisableNoAnswerResponses' - $ref: '#/components/parameters/Theme' responses: '200': description: Request was successful. content: application/json: schema: $ref: '#/components/schemas/AdaptiveCardAnswerSuccessResponse' '400': description: Missing or empty query. content: application/json: schema: $ref: '#/components/schemas/AnswerFailureResponse' '401': description: Missing or invalid authentication. content: application/json: schema: $ref: '#/components/schemas/AnswerFailureResponse' '500': description: Unhandled error occurred while processing the request. content: application/json: schema: $ref: '#/components/schemas/AnswerFailureResponse' x-microcks-operation: delay: 0 dispatcher: FALLBACK /securitizedDerivative/issuer/search: post: tags: - Search operationId: post/securitizedDerivative/issuer/search 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 summary: Factset Search for Issuers of Securitized Derivatives. description: Search for issuers of securitized derivatives, including issuer groups, which do not represent actual juristic persons, but are defined by FactSet to facilitate searching. FactSet does not consolidate the data provided by different suppliers, therefore the result may contain more than one identifier for a given issuer. The response is limited to 100 results. requestBody: content: application/json: schema: $ref: '#/components/schemas/PostSecuritizedDerivativeIssuerSearchRequest' responses: '200': $ref: '#/components/responses/PostSecuritizedDerivativeIssuerSearch200Response' parameters: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK /securitizedDerivative/notation/screener/search: post: tags: - Search operationId: post/securitizedDerivative/notation/screener/search 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 summary: Factset Screener for Securitized Derivatives's Notations Based on Securitized Derivatives-specific Parameters. description: "Screener for securitized derivatives's notations based on securitized derivatives-specific parameters. The result is limited to the notations that satisfy all the selected filters. If more than one notation of an instrument matches the parameters, and no market priority has been specified, only the notation with the highest trading volume, averaged over one month, is considered. All identifiers used as parameters must be valid and entitled.\n\n Since some underlyings, e.g. an index or a performance difference of a stock and an index (alpha structure), do not represent a directly tradable asset, they do not have a price in the classical\nsense. Therefore, the term \"level\" is used instead of \"price\", e.g. underlying level instead of underlying price.\n\n The endpoint does not support the search for securitized derivatives with multiple underlyings, thus only securitized derivatives with a single underlying are returned in the result.\n\n The search can be restricted to a specific set of products by using customer-specific instrument or notation lists. Such restriction lists are set up by FactSet upon request." requestBody: content: application/json: schema: $ref: '#/components/schemas/PostSecuritizedDerivativeNotationScreenerSearchRequest' responses: '200': $ref: '#/components/responses/PostSecuritizedDerivativeNotationScreenerSearch200Response' parameters: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK /stock/notation/screener/search: post: tags: - Search operationId: post/stock/notation/screener/search 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 summary: Screener for stocks' notations based on stock-specific parameters. description: 'Screener for stocks'' notations based on stock-specific parameters. The result is limited to the notations that satisfy all the selected filters. If more than one notation of an instrument matches the parameters, and no market priority has been specified, only the notation with the highest trading volume, averaged over one month, is considered. Currency dependent current figures on company level (see attribute `currentKeyFigures.company.currencyDependent`) or on share instrument level (see attribute `currentKeyFigures.shareInstrument.currencyDependent`) are only returned if the currency (see parameter `currentKeyFigures.company.currencyDependent.currency.isoCode` or parameter `currentKeyFigures.shareInstrument.currencyDependent.currency.isoCode` respectively) are set. Parameters for up to three fiscal years might be used in one request, see attribute `reportedKeyFigures`; data is available for the ten most recent completed fiscal years. Estimates are available for the current and two consecutive fiscal years; parameters for all three might be used in one request, see attribute `estimates`. The estimated values are calculated as the average of the most recent estimates provided by all analysts in a fixed time frame of 100 days. Screening and sorting by a currency-dependent attribute is not possible if the currency (see parameter `reportedKeyFigures.currencyDependentKeyFigures.currency.isoCode` and parameter `estimates.currencyDependentEstimates.currency.isoCode` respectively) is not set. If a fiscal year for the data as of the end of a fiscal year (see parameter `reportedKeyFigures.fiscalYear`) or for the estimates (see parameter `estimates.fiscalYear`) has been selected but no currency has been set, the respective data will be returned in the currency in which it was originally reported. A specific set of stocks can be restricted to or excluded by using customer-specific instrument or notation selection lists. Such selection lists are set up by FactSet upon request. All identifiers used as parameters must be valid and entitled.' requestBody: content: application/json: schema: $ref: '#/components/schemas/PostStockNotationScreenerSearchRequest' responses: '200': $ref: '#/components/responses/PostStockNotationScreenerSearch200Response' parameters: [] components: schemas: PartialOutputObject: type: object properties: isPartial: type: boolean description: Flag indicating that the response is a possibly incomplete array or an object containing a possibly incomplete array, due to hitting a processing time limit. If `true`, some matching results might be missing from the array, or elements for matching results might be incorrectly included (for example, when priority sorting would have removed the element). Depending on the use case, such a response may be unsuitable. example: true description: Object denoting that the endpoint response is possibly incomplete. required: - isPartial x-property-sort: - isPartial TagResponse: type: object description: Response object for a single tag properties: data: $ref: '#/components/schemas/TagModel' PostDebtInstrumentIssuerSearchRequest: type: object properties: data: type: object x-property-sort: - name - minimumRatingGrade - country - market description: The data member contains the request's primary data. properties: name: type: object x-property-sort: - searchValue description: Issuer name. properties: searchValue: type: string pattern: ^[ -!#-&(-+--/0-:=?-Za-zw"]*$ minLength: 3 exclusiveMinimum: false maxLength: 100 exclusiveMaximum: false description: Text string to be searched for. minimumRatingGrade: type: object x-property-sort: - debtInstrument description: Minimum rating grade requirements for the issuers or their debt instruments. In either case, only one identifier per rating system is allowed. See endpoint `/rating/grade/listBySystem` for valid values. properties: debtInstrument: type: object x-property-sort: - ids description: Debt instrument rating. Only issuers whose debt instruments are rated higher than or equal to the rating grades in the provided list are returned. properties: ids: type: array nullable: false items: type: number format: id32 x-positive: true maxItems: 5 uniqueItems: true description: List of rating grade identifiers. country: type: object x-property-sort: - ids description: List of countries of registration of the issuers. Only issuers that are registered in a country in the provided list are returned. properties: ids: type: array nullable: false items: type: number format: id32 x-positive: true maxItems: 20 uniqueItems: true description: List of country identifiers. See endpoint `/basic/region/country/list` for valid values. market: type: object x-property-sort: - ids description: List of markets where debt instruments are traded. Only issuers that have issued at least one debt instrument traded on a market in the provided list are returned. properties: ids: type: array nullable: false items: type: number format: id32 x-positive: true maxItems: 20 uniqueItems: true description: List of market identifiers. See endpoint `/basic/market/list` for valid values. example: example_value meta: type: object description: The meta member contains the meta information of the request. properties: attributes: $ref: '#/components/schemas/AttributesMember' x-property-sort: - attributes example: example_value CountryID: type: object properties: ISOALPHA2: type: string example: example_value PercentChange: type: object properties: change: type: string example: example_value color: $ref: '#/components/schemas/ChangeColor' RankedTable: type: object required: - rows properties: headers: type: array items: type: string example: [] rows: type: array items: $ref: '#/components/schemas/RankedTableRow' example: [] ValueChangeDateLabelAnswer: allOf: - $ref: '#/components/schemas/AnswerWithTitle' - type: object required: - templateData properties: templateData: $ref: '#/components/schemas/ValueChangeDateLabelTemplateData' ColoredValueLabelDateTemplateData: allOf: - $ref: '#/components/schemas/TemplateWithLinks' - type: object properties: value: $ref: '#/components/schemas/ColoredValue' label: type: string date: type: string AnswerWithTitle: allOf: - $ref: '#/components/schemas/DataAnswer' - type: object required: - title properties: title: type: string StringOrNumberTagValue: oneOf: - type: string - type: number TableAnswer: allOf: - $ref: '#/components/schemas/AnswerWithTitle' - type: object required: - templateData properties: templateData: $ref: '#/components/schemas/TableTemplateData' TagValuesListResponse: type: object description: Response object for a list of tag values properties: meta: $ref: '#/components/schemas/MetaModel' data: type: array items: type: string description: Array of tag values example: - TEST_ACCOUNT.ACCT - CLIENT.ACCT ValueLabelAnswer: allOf: - $ref: '#/components/schemas/AnswerWithTitle' - type: object required: - templateData properties: templateData: $ref: '#/components/schemas/ValueLabelTemplateData' AdaptiveCardWithThumbnail: type: object properties: adaptiveCard: $ref: '#/components/schemas/AdaptiveCard' thumbnail: $ref: '#/components/schemas/ThumbnailCard' PercentChangeLabelAnswer: allOf: - $ref: '#/components/schemas/AnswerWithTitle' - type: object required: - templateData properties: templateData: $ref: '#/components/schemas/PercentChangeLabelTemplateData' PostStockNotationScreenerSearchRequest: type: object properties: data: type: object x-property-sort: - validation - stockType - industryClassification - company - indexMembership - esg - compliance - currentKeyFigures - reportedKeyFigures - benchmark - performance - volatility - tradingValue - simpleMovingAverage - rsiWilder - recommendation - estimates description: The data member contains the request's primary data. properties: validation: description: Validation parameters. type: object x-property-sort: - onlyActive - onlyNotSuspended - prices - valueUnit - market - instrumentSelectionList - notationSelectionList properties: onlyActive: description: If `true`, only active notations will be returned. The term "active" reflects the fact that notations and related data are not being deleted immediately after becoming irrelevant (e.g. because the source does not provide a price anymore), but remains in general retrievable for up to 6 months. type: boolean default: true onlyNotSuspended: description: If `true`, only notations not suspended from trading will be returned. type: boolean default: false prices: description: Price-related parameters. type: object x-property-sort: - quality - latest - previous properties: quality: type: string description: Quality of the price. default: DLY x-enum-description: - 'Delayed: intraday prices with an exchange-imposed delay of usually 15 to 30 minutes.' - 'End-of-day: prices updated once per day after the close of trading, possibly with an exchange-imposed delay of several hours or days.' enum: - DLY - EOD latest: description: Parameters related to the presence and age of the most recent trade price. type: object x-property-sort: - availableOnly - minimumDate properties: availableOnly: description: If `true`, only notations for which a trade price (even an outdated one) is available will be returned. type: boolean minimumDate: description: Earliest admissible date of the most recent trade price. type: string format: date previous: description: Parameters related to the presence and age of a trade price from a preceding trading day. type: object x-property-sort: - availableOnly - minimumDate properties: availableOnly: description: If `true`, only notations for which a trade price from a preceding trading day is available will be returned. type: boolean minimumDate: description: Earliest admissible date of the trade price from a preceding trading day. type: string format: date valueUnit: description: Value unit selection. See endpoint `/basic/valueUnit/list` for valid values. type: object x-property-sort: - restrict - exclude x-atMostOne: true properties: restrict: description: Specifies the value units a notation may have. type: object x-property-sort: - ids properties: ids: description: Set of value unit identifiers. type: array nullable: false items: type: number format: id32 x-positive: true uniqueItems: true maxItems: 50 exclude: description: Specifies the value units a notation may not have. type: object x-property-sort: - ids properties: ids: description: Set of value unit identifiers. type: array nullable: false items: type: number format: id32 x-positive: true uniqueItems: true maxItems: 50 market: description: Market-related notation selection. See endpoint `/basic/market/list` for valid values. type: object x-property-sort: - selection - priority properties: selection: description: Market selection. type: object x-property-sort: - restrict - exclude x-atMostOne: true properties: restrict: description: Specifies the markets from which a notation may originate. type: object x-property-sort: - ids properties: ids: description: Set of market identifiers. type: array nullable: false items: type: number format: id32 x-positive: true uniqueItems: true maxItems: 100 exclude: description: Specifies the markets from which a notation may not originate. type: object x-property-sort: - ids properties: ids: description: Set of market identifiers. type: array nullable: false items: type: number format: id32 x-positive: true uniqueItems: true maxItems: 100 priority: description: "Sequence of markets specifying the priority order of the markets for the selection of one notation per instrument. If for a given instrument with two matching notations, A and B, the market of notation A precedes the market of notation B in this list or if the market of notation B is not in this list, A is selected. If neither of the markets is in this list, the notation with the highest trading volume, averaged over one month, is selected. \n The list does not restrict the request to only those markets (use the parameter `market.selection` for that purpose)." type: object x-property-sort: - ids properties: ids: description: List of market identifiers. type: array nullable: false items: type: number format: id32 x-positive: true uniqueItems: true maxItems: 100 instrumentSelectionList: description: Instrument-level restriction or exclusion. type: object x-property-sort: - restrict - exclude x-atMostOne: true properties: restrict: description: Restriction lists. If present, the result contains only notations belonging to stock instruments that are a member of any of the provided lists. type: object x-property-sort: - ids properties: ids: description: Set of identifiers of restriction lists. type: array nullable: false items: type: number format: id32 x-positive: true uniqueItems: true maxItems: 3 exclude: description: Exclusion lists. If present, the result does not contain notations belonging to stock instruments that are a member of any of the provided lists. type: object x-property-sort: - ids properties: ids: description: Set of identifiers of exclusion lists. type: array nullable: false items: type: number format: id32 x-positive: true uniqueItems: true maxItems: 3 notationSelectionList: description: Notation-level restriction or exclusion. type: object x-property-sort: - restrict - exclude x-atMostOne: true properties: restrict: description: Restriction lists. If present, the result contains only stock notations that are a member of any of the provided lists. type: object x-property-sort: - ids properties: ids: description: Set of identifiers of restriction lists. type: array nullable: false items: type: number format: id32 x-positive: true uniqueItems: true maxItems: 3 exclude: description: Exclusion lists. If present, the result does not contain stock notations that are a member of any of the provided lists. type: object x-property-sort: - ids properties: ids: description: Set of identifiers of exclusion lists. type: array nullable: false items: type: number format: id32 x-positive: true uniqueItems: true maxItems: 3 stockType: description: Type of stock. type: array nullable: false items: type: string x-enum-description: - Common stock - Preferred stock - Depository receipt - Other stock enum: - common - preferred - depositoryReceipt - other uniqueItems: true industryClassification: description: Industry classification. Here, an industry is a category from any level of category system FactSet Revere Business Industry Classification System (RBICS), see endpoint `/category/listBySystem` with `id=48` for valid values. type: object x-property-sort: - restrict - exclude x-atMostOne: true properties: restrict: description: Restriction list. Only stocks that belong to a category in the provided list are returned. type: object x-property-sort: - ids properties: ids: description: Set of category identifiers. type: array nullable: false items: type: number format: id32 x-positive: true maxItems: 100 exclude: description: Exclusion list. Stocks that belong to a category in the provided list are not returned. type: object x-property-sort: - ids properties: ids: description: 'Set of category identifiers. ' type: array nullable: false items: type: number format: id32 x-positive: true maxItems: 100 company: description: Company-related parameters. type: object x-property-sort: - country properties: country: description: Country of the head office of a company. See endpoint `/basic/region/country/list` for valid values. type: object x-property-sort: - restrict - exclude x-atMostOne: true properties: restrict: description: Restriction list. Only stocks issued by a company whose head office is located in a country in the provided list are returned. type: object x-property-sort: - ids properties: ids: description: Set of country identifiers. type: array nullable: false items: type: number format: id32 x-positive: true maxItems: 50 exclude: description: Exclusion list. Stocks issued by a company whose head office is located in a country in the provided list are not returned. type: object x-property-sort: - ids properties: ids: description: Set of country identifiers. type: array nullable: false items: type: number format: id32 x-positive: true maxItems: 50 indexMembership: description: List of indices of which a stock is a constituent. The list restricts the request to return only those stocks that are a constituent of one of the specified indices. type: object x-property-sort: - ids properties: ids: description: List of index instrument identifiers. type: array nullable: false items: type: string format: id64 x-positive: true maxItems: 20 esg: description: Parameters related to Environmental, Social, and Governance (ESG) data. type: object x-property-sort: - truvalueLabs properties: truvalueLabs: description: ESG data provided by FactSet's Truvalue Labs. type: object x-property-sort: - sasb - sdg properties: sasb: description: ESG data for categories as defined by the Sustainability Accounting Standards Board (SASB). type: object x-property-sort: - allCategories - materiality properties: allCategories: description: ESG data for all 26 SASB categories. type: object x-property-sort: - insight - momentum - ranking properties: insight: description: Value range for the insight score which is a measure of a company's longer-term ESG track record. The score is less sensitive to daily events and reflect the enduring performance record of a company over time. The ESG impact of a company is scored on 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. type: object format: realRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: real description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: real description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true x-allowNullValue: true x-property-sort: - minimum - maximum momentum: description: Value range for the momentum score which is a trajectory based on the upward or downward movement of the company's insight score, relative to that of all others in the universe. The ESG impact of a company is scored on 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. type: object format: realRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: real description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: real description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true x-allowNullValue: true x-property-sort: - minimum - maximum ranking: description: ESG rank. type: object x-property-sort: - minimum properties: minimum: description: Minimum ESG rank. type: string x-enum-description: - Indicates that the company's ESG rating is within the percentile range of 90% to 100% of all companies. - Indicates that the company's ESG rating is within the percentile range of 70% to 90% (exclusive) of all companies. - Indicates that the company's ESG rating is within the percentile range of 30% to 70% (exclusive) of all companies. - Indicates that the company's ESG rating is within the percentile range of 10% to 30% (exclusive) of all companies. - Indicates that the company's ESG rating is within the percentile range of 0% to 10% (exclusive) of all companies. enum: - leader - aboveAverage - average - belowAverage - laggard materiality: description: ESG data for all materiality categories. type: object x-property-sort: - insight - momentum - ranking properties: insight: description: Value range for the insight score which is a measure of a company's longer-term ESG track record. The score is less sensitive to daily events and reflect the enduring performance record of a company over time. The ESG impact of a company is scored on 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. type: object format: realRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: real description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: real description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true x-allowNullValue: true x-property-sort: - minimum - maximum momentum: description: Value range for the momentum score which is a trajectory based on the upward or downward movement of the company's insight score, relative to that of all others in the universe. The ESG impact of a company is scored on 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. type: object format: realRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: real description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: real description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true x-allowNullValue: true x-property-sort: - minimum - maximum ranking: description: ESG rank. type: object x-property-sort: - minimum properties: minimum: description: Minimum ESG rank. type: string x-enum-description: - Indicates that the company's ESG rating is within the percentile range of 90% to 100% of all companies. - Indicates that the company's ESG rating is within the percentile range of 70% to 90% (exclusive) of all companies. - Indicates that the company's ESG rating is within the percentile range of 30% to 70% (exclusive) of all companies. - Indicates that the company's ESG rating is within the percentile range of 10% to 30% (exclusive) of all companies. - Indicates that the company's ESG rating is within the percentile range of 0% to 10% (exclusive) of all companies. enum: - leader - aboveAverage - average - belowAverage - laggard sdg: description: ESG data for categories based on the Sustainable Development Goals (SDG) as defined by the United Nations. type: object x-property-sort: - impact properties: impact: description: ESG data for the category impact which is a weighted average of individual category scores, where the weight utilized is the category score volume. type: object x-property-sort: - insight - momentum properties: insight: description: Value range for the insight score which is a measure of a company's longer-term ESG track record. The score is less sensitive to daily events and reflect the enduring performance record of a company over time. The ESG impact of a company is scored on 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. type: object format: realRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: real description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: real description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true x-allowNullValue: true x-property-sort: - minimum - maximum momentum: description: Value range for the momentum score which is a measure of the trend of a company's insight score. The ESG impact of a company is scored on 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. type: object format: realRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: real description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: real description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true x-allowNullValue: true x-property-sort: - minimum - maximum compliance: description: Compliance properties. See endpoint `/instrument/complianceProperty/list` for the full list of compliance properties associated with instruments (across all asset classes). type: object x-property-sort: - france properties: france: description: Compliance properties in accordance with the French law. type: object x-property-sort: - or properties: or: description: List of conditions representing a combination of compliance properties joined by a logical OR operator. type: array nullable: false items: type: object x-property-sort: - and properties: and: description: List of combinations of compliance properties joined by a logical AND operator. type: array nullable: false items: type: object x-property-sort: - id - negate properties: id: description: 'Identifier of a compliance property. The compliance properties with `id=4` (SRD) and `id=10` (SRD long only) are mutually exclusive. ⁣ Examples: ⁣ ⁣1. Retrieve only stocks which are compliant to all of the following: PEA, PEAPME, and SRD `"compliance":{ "france": { "or": [{ "and": [{ "id":2, "negate":false }, {"id":3, "negate":false}, {"id":4, "negate":false}]}]}}` ⁣ ⁣2. Retrieve only stocks which are compliant to PEA or to PEAPME `"compliance":{ "france": { "or": [{ "and": [{ "id":2, "negate":false }]}, {"and": [{ "id":3, "negate":false }]}]}}` ⁣ ⁣3. Retrieve only stocks which are compliant to PEA or to PEAPME, but are not compliant to SRD long only. `"compliance":{ "france": { "or": [{ "and": [{ "id":2, "negate":false },{"id":10, "negate":true}]}, {"and": [{ "id":3, "negate":false},{"id":10, "negate":true}]}]}}`' type: number format: id32 x-positive: true x-enum-description: - PEA - PEAPME - SRD - SRD long only enum: - 2 - 3 - 4 - 10 negate: description: 'If `true`, the condition excludes stocks compliant to the compliance property. ' type: boolean uniqueItems: true uniqueItems: true currentKeyFigures: description: Parameters for stock-specific current key figures. type: object x-property-sort: - company - shareInstrument properties: company: description: Company key figures. type: object x-property-sort: - sharesOutstanding - freeFloat - currencyDependent properties: sharesOutstanding: description: Value range for the number of outstanding shares. type: object format: int64Range properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: string format: int64 description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: string format: int64 description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true x-allowNullValue: true x-property-sort: - minimum - maximum freeFloat: description: Value range for the number of free float shares. type: object format: int64Range properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: string format: int64 description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: string format: int64 description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true x-allowNullValue: true x-property-sort: - minimum - maximum currencyDependent: description: Currency-dependent key figures. type: object x-property-sort: - currency - marketCapitalizationSharesOutstanding - perShare properties: currency: description: Main currency of the currency-dependent attributes. type: object x-property-sort: - isoCode properties: isoCode: description: ISO 4217 code of the currency. type: string x-enum-description: - Euro - US Dollar - British Pound Sterling - Swiss Franc enum: - EUR - USD - GBP - CHF required: - isoCode marketCapitalizationSharesOutstanding: description: Value range for the market capitalization based on the number of outstanding shares. type: object format: realRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: real description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: real description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true x-allowNullValue: true x-property-sort: - minimum - maximum perShare: description: Per-share key figures. type: object x-property-sort: - earnings - bookValue - cashFlow - sales properties: earnings: description: Value range for the earnings per share, which is the company's net income from continuing operations divided by the number of shares. The earnings per share might be based on either the diluted or basic number of shares outstanding depending on how the company reports and may follow country-specific reporting patterns. type: object format: realRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: real description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: real description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true x-allowNullValue: true x-property-sort: - minimum - maximum bookValue: description: Value range for the book value per share, which is the common equity divided by the number of common shares outstanding. type: object format: realRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: real description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: real description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true x-allowNullValue: true x-property-sort: - minimum - maximum cashFlow: description: Value range for the cash flow per share, which is the company's gross cash flow from operating activities divided by the number of outstanding shares. The calculation method of the cash flow depends on the accounting standard used by the company. type: object format: realRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: real description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: real description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true x-allowNullValue: true x-property-sort: - minimum - maximum sales: description: Value range for the sales per share, which is the total sales revenue divided by the diluted shares outstanding. type: object format: realRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: real description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: real description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true x-allowNullValue: true x-property-sort: - minimum - maximum required: - currency shareInstrument: description: Share instrument key figures. type: object x-property-sort: - sharesOutstanding - freeFloat - ratios - currencyDependent properties: sharesOutstanding: description: Value range for the number of outstanding shares. type: object format: int64Range properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: string format: int64 description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: string format: int64 description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true x-allowNullValue: true x-property-sort: - minimum - maximum freeFloat: description: Value range for the number of free float shares. type: object format: int64Range properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: string format: int64 description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: string format: int64 description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true x-allowNullValue: true x-property-sort: - minimum - maximum ratios: description: Ratios. type: object x-property-sort: - priceEarnings - priceBookValue - priceCashFlow - priceSales - dividendYield - earningsYield properties: priceEarnings: description: Value range for the price earnings ratio, which is the most recent available end-of-day close price divided by the earnings per share. type: object format: realRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: real description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: real description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true x-allowNullValue: true x-property-sort: - minimum - maximum priceBookValue: description: Value range for the price book value ratio, which is the most recent available end-ofday close price divided by the book value per share. type: object format: realRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: real description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: real description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true x-allowNullValue: true x-property-sort: - minimum - maximum priceCashFlow: description: Value range for the price cash flow ratio, which is the most recent available end-ofday close price divided by the cash flow per share. type: object format: realRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: real description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: real description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true x-allowNullValue: true x-property-sort: - minimum - maximum priceSales: description: Value range for the price sales ratio, which is the most recent available end-of-day close price divided by the sales per share. type: object format: realRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: real description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: real description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true x-allowNullValue: true x-property-sort: - minimum - maximum dividendYield: description: Value range for the dividend yield, which is the dividend per share divided by the most recent available end-of-day close price. type: object format: realRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: real description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: real description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true x-allowNullValue: true x-property-sort: - minimum - maximum earningsYield: description: Value range for the earnings yield, which is the earnings per share divided by the most recent available end-of-day close price. type: object format: realRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: real description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: real description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true x-allowNullValue: true x-property-sort: - minimum - maximum currencyDependent: description: Currency-dependent key figures. type: object x-property-sort: - currency - marketCapitalizationSharesOutstanding - perShare properties: currency: description: Main currency of the currency-dependent attributes. type: object x-property-sort: - isoCode properties: isoCode: description: ISO 4217 code of the currency. type: string x-enum-description: - Euro - US Dollar - British Pound Sterling - Swiss Franc enum: - EUR - USD - GBP - CHF required: - isoCode marketCapitalizationSharesOutstanding: description: Value range for the market capitalization based on the number of outstanding shares. type: object format: realRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: real description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: real description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true x-allowNullValue: true x-property-sort: - minimum - maximum perShare: description: Per-share key figures. type: object x-property-sort: - dividend properties: dividend: description: Value range for the dividend per share. type: object format: realRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: real description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: real description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true x-allowNullValue: true x-property-sort: - minimum - maximum required: - currency reportedKeyFigures: description: Parameters for stock-specific key figures as reported for a fiscal year. type: array nullable: false items: type: object x-property-sort: - fiscalYear - currencyDependentKeyFigures - ebitMargin - ebitdaMargin - netIncomeMargin - grossIncomeMargin - operatingMargin - returnOnAssets - returnOnEquity - ratios properties: fiscalYear: description: Since a fiscal year and a calendar year do not necessarily match with regard to their start and end dates, the year is derived as the calendar year occupied to a larger extent by the fiscal year, using a June through May fiscal year assignment. That means, fiscal years ending from the 1st of June onwards are assigned to the same calendar year. Either must be at most ten years in the past. type: object x-property-sort: - yearEnd - year x-atMostOne: true properties: yearEnd: description: Calendar year of the ending date of the fiscal year. type: number format: int32 year: description: Derived fiscal year. type: number format: int32 currencyDependentKeyFigures: description: Currency-dependent parameters. Selection of a currency is required to use these parameters. type: object x-property-sort: - currency - marketCapitalization - ebit - ebitda - perShare properties: currency: description: Currency in which the currency-dependent fiscal year key figures are expressed. type: object x-property-sort: - isoCode properties: isoCode: description: ISO 4217 code of the currency. type: string x-enum-description: - Euro - US Dollar - British Pound Sterling - Swiss Franc enum: - EUR - USD - GBP - CHF required: - isoCode marketCapitalization: description: Value range for the market capitalization, which is the market value of the shares outstanding over all types of shares of the company. type: object format: realRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: real description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: real description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true x-allowNullValue: true x-property-sort: - minimum - maximum ebit: description: Value range for the EBIT (earnings before interest and taxes). type: object format: realRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: real description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: real description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true x-allowNullValue: true x-property-sort: - minimum - maximum ebitda: description: Value range for the EBITDA (earnings before interest, taxes, depreciation, and amortization). type: object format: realRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: real description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: real description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true x-allowNullValue: true x-property-sort: - minimum - maximum perShare: description: Per-share parameters. type: object x-property-sort: - sales - recurringDilutedEarnings - dividends - bookValue - cashFlow properties: sales: description: Value range for the total sales revenue per share. type: object format: realRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: real description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: real description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true x-allowNullValue: true x-property-sort: - minimum - maximum recurringDilutedEarnings: description: Value range for the recurring (excluding extraordinary items) diluted earnings per share, which is the ratio of the net income excluding extraordinary items, divided by the diluted shares outstanding. An extraordinary item is an atypical and infrequent gain or loss due to an unforeseeable event. type: object format: realRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: real description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: real description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true x-allowNullValue: true x-property-sort: - minimum - maximum dividends: description: Value range for the dividends per share, which is the ratio of the total dividends paid out, divided by the shares outstanding. In general, the figure is based on the gross dividend, i.e. before taxes, except for countries with special tax regimes. type: object format: realRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: real description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: real description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true x-allowNullValue: true x-property-sort: - minimum - maximum bookValue: description: Value range for the book value per share, which is the ratio of the book value (common equity), divided by the shares outstanding. type: object format: realRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: real description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: real description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true x-allowNullValue: true x-property-sort: - minimum - maximum cashFlow: description: Value range for the cash flow per share, which is the ratio of the net operating cash flow, divided by the diluted shares outstanding. type: object format: realRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: real description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: real description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true x-allowNullValue: true x-property-sort: - minimum - maximum required: - currency ebitMargin: description: Value range for the EBIT margin, which is the ratio of the EBIT, divided by the total sales revenue. type: object format: relativeValueRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: relativeValue description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: relativeValue description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true x-allowNullValue: true x-property-sort: - minimum - maximum ebitdaMargin: description: Value range for the EBITDA margin, which is the ratio of the EBITDA, divided by the total sales revenue. type: object format: relativeValueRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: relativeValue description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: relativeValue description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true x-allowNullValue: true x-property-sort: - minimum - maximum netIncomeMargin: description: Value range for the net income margin, which is the ratio of the net income, divided by the total sales revenue. type: object format: relativeValueRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: relativeValue description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: relativeValue description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true x-allowNullValue: true x-property-sort: - minimum - maximum grossIncomeMargin: description: Value range for the gross income margin, which is the ratio of the gross income, divided by the total sales revenue. type: object format: relativeValueRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: relativeValue description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: relativeValue description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true x-allowNullValue: true x-property-sort: - minimum - maximum operatingMargin: description: Value range for the operating margin, which is the ratio of the operating income, divided by the sales revenue. type: object format: relativeValueRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: relativeValue description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: relativeValue description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true x-allowNullValue: true x-property-sort: - minimum - maximum returnOnAssets: description: Value range for the return on assets, which is the ratio of the net income, divided by the two-fiscal-year average of the total assets. type: object format: relativeValueRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: relativeValue description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: relativeValue description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true x-allowNullValue: true x-property-sort: - minimum - maximum returnOnEquity: description: Value range for the return on equity (ROE), which is the ratio of the net income, divided by the two-fiscal-year average of the total shareholder's equity. type: object format: relativeValueRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: relativeValue description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: relativeValue description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true x-allowNullValue: true x-property-sort: - minimum - maximum ratios: description: Ratio parameters. type: object x-property-sort: - priceSales - priceEarnings - priceBookValue - priceCashFlow - priceFreeCashFlow - dividendYield - enterpriseValueEbit - enterpriseValueEbitda - enterpriseValueSales - debtEquity properties: priceSales: description: Value range for the ratio of the price, divided by the total sales revenue per share. type: object format: realRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: real description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: real description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true x-allowNullValue: true x-property-sort: - minimum - maximum priceEarnings: description: Value range for the ratio of the price, divided by the reported earnings per share (basic or diluted) by the company. type: object format: realRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: real description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: real description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true x-allowNullValue: true x-property-sort: - minimum - maximum priceBookValue: description: Value range for the ratio of the price, divided by the book value per share. type: object format: realRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: real description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: real description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true x-allowNullValue: true x-property-sort: - minimum - maximum priceCashFlow: description: Value range for the ratio of the price, divided by the cash flow per share. type: object format: realRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: real description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: real description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true x-allowNullValue: true x-property-sort: - minimum - maximum priceFreeCashFlow: description: Value range for the ratio of the price, divided by the free (i.e. without subtraction of dividends) cash flow per share. type: object format: realRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: real description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: real description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true x-allowNullValue: true x-property-sort: - minimum - maximum dividendYield: description: Value range for the ratio of the dividend per share, divided by the price. type: object format: relativeValueRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: relativeValue description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: relativeValue description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true x-allowNullValue: true x-property-sort: - minimum - maximum enterpriseValueEbit: description: Value range for the ratio of the enterprise value, divided by the EBIT. type: object format: realRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: real description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: real description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true x-allowNullValue: true x-property-sort: - minimum - maximum enterpriseValueEbitda: description: Value range for the ratio of the enterprise value, divided by the EBITDA. type: object format: realRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: real description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: real description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true x-allowNullValue: true x-property-sort: - minimum - maximum enterpriseValueSales: description: Value range for the ratio of the enterprise value, divided by the total amount of sales revenue. type: object format: realRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: real description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: real description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true x-allowNullValue: true x-property-sort: - minimum - maximum debtEquity: description: Value range for the ratio of the total debt, divided by the total shareholder's equity. type: object format: realRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: real description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: real description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true x-allowNullValue: true x-property-sort: - minimum - maximum required: - fiscalYear maxItems: 3 benchmark: description: Benchmark-related data. type: object x-property-sort: - type - beta - correlation - outperformance properties: type: description: Type of benchmark. type: string x-enum-description: - Key figures calculated against a local index. See the group description of `/stock/notation/keyFigures/benchmark` for the list of countries and the respective local index per country. This value restricts the result to only stocks with headquarters in those countries. - Key figures calculated against MSCI World Index (notation 3193857), available for all stocks, regardless of the location of their headquarters. enum: - local - global beta: description: Beta of the stock notation with respect to the benchmark notation. type: object x-property-sort: - week1 - month1 - months3 - months6 - year1 - years3 - years5 properties: week1: description: Value range for the time range one week. type: object format: realRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: real description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: real description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true x-allowNullValue: true x-property-sort: - minimum - maximum month1: description: Value range for the time range one month. type: object format: realRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: real description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: real description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true x-allowNullValue: true x-property-sort: - minimum - maximum months3: description: Value range for the time range three months. type: object format: realRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: real description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: real description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true x-allowNullValue: true x-property-sort: - minimum - maximum months6: description: Value range for the time range six months. type: object format: realRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: real description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: real description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true x-allowNullValue: true x-property-sort: - minimum - maximum year1: description: Value range for the time range one year. type: object format: realRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: real description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: real description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true x-allowNullValue: true x-property-sort: - minimum - maximum years3: description: Value range for the time range three years. type: object format: realRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: real description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: real description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true x-allowNullValue: true x-property-sort: - minimum - maximum years5: description: Value range for the time range five years. type: object format: realRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: real description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: real description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true x-allowNullValue: true x-property-sort: - minimum - maximum correlation: description: Correlation of the stock notation with respect to the benchmark notation. type: object x-property-sort: - week1 - month1 - months3 - months6 - year1 - years3 - years5 properties: week1: description: Value range for the time range one week. type: object format: realRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: real description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: real description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true x-allowNullValue: true x-property-sort: - minimum - maximum month1: description: Value range for the time range one month. type: object format: realRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: real description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: real description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true x-allowNullValue: true x-property-sort: - minimum - maximum months3: description: Value range for the time range three months. type: object format: realRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: real description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: real description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true x-allowNullValue: true x-property-sort: - minimum - maximum months6: description: Value range for the time range six months. type: object format: realRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: real description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: real description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true x-allowNullValue: true x-property-sort: - minimum - maximum year1: description: Value range for the time range one year. type: object format: realRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: real description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: real description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true x-allowNullValue: true x-property-sort: - minimum - maximum years3: description: Value range for the time range three years. type: object format: realRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: real description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: real description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true x-allowNullValue: true x-property-sort: - minimum - maximum years5: description: Value range for the time range five years. type: object format: realRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: real description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: real description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true x-allowNullValue: true x-property-sort: - minimum - maximum outperformance: description: Outperformance of the stock notation with respect to the benchmark notation. type: object x-property-sort: - week1 - month1 - months3 - months6 - year1 - years3 - years5 properties: week1: description: Value range for the time range one week. type: object format: relativeValueRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: relativeValue description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: relativeValue description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true x-allowNullValue: true x-property-sort: - minimum - maximum month1: description: Value range for the time range one month. type: object format: relativeValueRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: relativeValue description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: relativeValue description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true x-allowNullValue: true x-property-sort: - minimum - maximum months3: description: Value range for the time range three months. type: object format: relativeValueRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: relativeValue description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: relativeValue description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true x-allowNullValue: true x-property-sort: - minimum - maximum months6: description: Value range for the time range six months. type: object format: relativeValueRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: relativeValue description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: relativeValue description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true x-allowNullValue: true x-property-sort: - minimum - maximum year1: description: Value range for the time range one year. type: object format: relativeValueRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: relativeValue description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: relativeValue description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true x-allowNullValue: true x-property-sort: - minimum - maximum years3: description: Value range for the time range three years. type: object format: relativeValueRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: relativeValue description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: relativeValue description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true x-allowNullValue: true x-property-sort: - minimum - maximum years5: description: Value range for the time range five years. type: object format: relativeValueRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: relativeValue description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: relativeValue description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true x-allowNullValue: true x-property-sort: - minimum - maximum required: - type performance: description: Relative performance for different time ranges. type: object x-property-sort: - intraday - endOfDay properties: intraday: description: Value range for the time range intraday. That is the difference of a notation's most recent price from the current trading day against the most recent EOD closing price. The parameter can be used only with the quality `DLY`, see parameter `prices.quality`. type: object format: relativeValueRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: relativeValue description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: relativeValue description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true x-allowNullValue: true x-property-sort: - minimum - maximum endOfDay: description: End-of-day (EOD) relative performance for different time ranges. The relative performance is the difference of a notation's most recent EOD closing price against the EOD closing price on the reference date, relative to the EOD closing price on the reference date. type: object x-property-sort: - day1 - week1 - month1 - months3 - months6 - year1 - years3 - years5 - yearToDate properties: day1: description: Value range for the time range one day. type: object format: relativeValueRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: relativeValue description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: relativeValue description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true x-allowNullValue: true x-property-sort: - minimum - maximum week1: description: Value range for the time range one week. type: object format: relativeValueRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: relativeValue description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: relativeValue description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true x-allowNullValue: true x-property-sort: - minimum - maximum month1: description: Value range for the time range one month. type: object format: relativeValueRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: relativeValue description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: relativeValue description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true x-allowNullValue: true x-property-sort: - minimum - maximum months3: description: Value range for the time range three months. type: object format: relativeValueRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: relativeValue description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: relativeValue description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true x-allowNullValue: true x-property-sort: - minimum - maximum months6: description: Value range for the time range six months. type: object format: relativeValueRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: relativeValue description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: relativeValue description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true x-allowNullValue: true x-property-sort: - minimum - maximum year1: description: Value range for the time range one year. type: object format: relativeValueRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: relativeValue description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: relativeValue description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true x-allowNullValue: true x-property-sort: - minimum - maximum years3: description: Value range for the time range three years. type: object format: relativeValueRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: relativeValue description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: relativeValue description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true x-allowNullValue: true x-property-sort: - minimum - maximum years5: description: Value range for the time range five years. type: object format: relativeValueRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: relativeValue description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: relativeValue description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true x-allowNullValue: true x-property-sort: - minimum - maximum yearToDate: description: Value range for the time range year-to-date (YTD). type: object format: relativeValueRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: relativeValue description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: relativeValue description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true x-allowNullValue: true x-property-sort: - minimum - maximum volatility: description: Volatility of the daily logarithmic returns, annualized assuming 256 trading days per year for different time ranges. type: object x-property-sort: - week1 - month1 - months3 - months6 - year1 - years3 - years5 - yearToDate properties: week1: description: Value range for the time range one week. type: object format: relativeValueRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: relativeValue description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: relativeValue description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true x-allowNullValue: true x-property-sort: - minimum - maximum month1: description: Value range for the time range one month. type: object format: relativeValueRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: relativeValue description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: relativeValue description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true x-allowNullValue: true x-property-sort: - minimum - maximum months3: description: Value range for the time range three months. type: object format: relativeValueRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: relativeValue description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: relativeValue description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true x-allowNullValue: true x-property-sort: - minimum - maximum months6: description: Value range for the time range six months. type: object format: relativeValueRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: relativeValue description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: relativeValue description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true x-allowNullValue: true x-property-sort: - minimum - maximum year1: description: Value range for the time range one year. type: object format: relativeValueRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: relativeValue description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: relativeValue description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true x-allowNullValue: true x-property-sort: - minimum - maximum years3: description: Value range for the time range three years. type: object format: relativeValueRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: relativeValue description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: relativeValue description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true x-allowNullValue: true x-property-sort: - minimum - maximum years5: description: Value range for the time range five years. type: object format: relativeValueRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: relativeValue description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: relativeValue description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true x-allowNullValue: true x-property-sort: - minimum - maximum yearToDate: description: Value range for the time range year-to-date (YTD). type: object format: relativeValueRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: relativeValue description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: relativeValue description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true x-allowNullValue: true x-property-sort: - minimum - maximum tradingValue: description: Sum of the cash flow for all transactions of a notation over a certain time range. The cash flow of a transaction is its volume multiplied by its trade price. type: object x-property-sort: - average properties: average: description: Arithmetic mean of the trading value for different time ranges. type: object x-property-sort: - days5 - days30 properties: days5: description: Value range for the time range five trading days. type: object format: realRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: real description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: real description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true x-allowNullValue: true x-property-sort: - minimum - maximum days30: description: Value range for the time range 30 trading days. type: object format: realRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: real description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: real description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true x-allowNullValue: true x-property-sort: - minimum - maximum simpleMovingAverage: description: Simple moving average (SMA), that is the arithmetic mean of a notation�"s EOD closing price, for different time ranges. type: object x-property-sort: - days20 - days50 - days200 - tradingDaysSinceCrossover properties: days20: description: Value range for the time range 20 trading days. type: object format: realRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: real description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: real description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true x-allowNullValue: true x-property-sort: - minimum - maximum days50: description: Value range for the time range 50 trading days. type: object format: realRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: real description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: real description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true x-allowNullValue: true x-property-sort: - minimum - maximum days200: description: Value range for the time range 200 trading days. type: object format: realRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: real description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: real description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true x-allowNullValue: true x-property-sort: - minimum - maximum tradingDaysSinceCrossover: description: Number of trading days since a simple moving average crossed another one. All SMAs are calculated with EOD prices, thus the value 0 for the number of days means the crossover occurred on the most recent trading day for which such prices are available. type: object x-property-sort: - sma20vs50 - sma50vs200 properties: sma20vs50: description: Number of trading days since the crossover and direction thereof of the SMA 20 (see parameter `simpleMovingAverage.days20`) and the SMA 50 (see parameter `simpleMovingAverage.days50`). Only crossovers which occurred in the most recent 100 trading days are considered. type: object x-property-sort: - numberDays - direction properties: numberDays: description: Value range for the number of trading days. type: object format: int32Range properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: int32 description: The minimum value. minimum: 0 exclusiveMinimum: false maximum: 100 exclusiveMaximum: false inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: int32 description: The maximum value. minimum: 0 exclusiveMinimum: false maximum: 100 exclusiveMaximum: false inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true x-allowNullValue: true x-property-sort: - minimum - maximum direction: description: Direction of the crossing. type: string default: up x-enum-description: - The SMA 20 crossed the SMA 50 from below, hence the SMA 20 has currently a higher value. - The SMA 20 crossed the SMA 50 from above, hence the SMA 20 has currently a lower value. enum: - up - down required: - numberDays sma50vs200: description: Number of trading days since the crossover and direction thereof of the SMA 50 (see parameter `simpleMovingAverage.days50`) and the SMA 200 (see parameter `simpleMovingAverage.days200`). Only crossovers which occurred in the most recent 300 trading days are considered. type: object x-property-sort: - numberDays - direction properties: numberDays: description: Value range for the number of trading days. type: object format: int32Range properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: int32 description: The minimum value. minimum: 0 exclusiveMinimum: false maximum: 300 exclusiveMaximum: false inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: int32 description: The maximum value. minimum: 0 exclusiveMinimum: false maximum: 300 exclusiveMaximum: false inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true x-allowNullValue: true x-property-sort: - minimum - maximum direction: description: Direction of the crossing. type: string default: up x-enum-description: - The SMA 50 crossed the SMA 200 from below, hence the SMA 50 has currently a higher value. - The SMA 50 crossed the SMA 200 from above, hence the SMA 50 has currently a lower value. enum: - up - down required: - numberDays rsiWilder: description: Relative strength index (RSI) by Wilder for different time ranges. This is the ratio of smoothed moving averages of the upwards and downwards daily returns over the given period, normalized to the range between 0 and 100. The RSI by Wilder measures the magnitude of the price changes in a given time period evaluating whether an asset is overbought or oversold and deriving a respective sell or buy signal. type: object x-property-sort: - days14 properties: days14: description: Value range of the RSI by Wilder for the time range 14 trading days. type: object format: realRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: real description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: real description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true x-allowNullValue: true x-property-sort: - minimum - maximum recommendation: description: Aggregated recommendation. type: object x-property-sort: - counts - consensus properties: counts: description: Number of recommendations. type: object x-property-sort: - total properties: total: description: Value range for the total number of recommendations included in the current recommendation consensus (see parameter `recommendation.consensus`). type: object format: int32Range properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: int32 description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: int32 description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true x-allowNullValue: true x-property-sort: - minimum - maximum consensus: description: Recommendation consensus, which is the average value of all provided recommendations. type: object x-property-sort: - range - change properties: range: description: Values range for recommendation consensus. Values are in the range from 1.0 to 5.0, whereby 1 represents the strongest buy recommendation, 3 a hold (neutral) recommendation and 5 the strongest sell recommendation. type: object format: realRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: real description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: real description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true x-allowNullValue: true x-property-sort: - minimum - maximum change: description: Recommendation change as the difference of the current recommendation value minus the historic recommendation value. Values are in the range from -4.0 to 4.0, whereby -4 represents a recommendation change from 5.0 to 1.0 and 4 represents a recommendation change from 1 to 5. type: object x-property-sort: - week1 - month1 - months3 - months6 - year1 properties: week1: description: Value range for the time range one week. type: object format: realRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: real description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: real description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true x-allowNullValue: true x-property-sort: - minimum - maximum month1: description: Value range for the time range one month. type: object format: realRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: real description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: real description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true x-allowNullValue: true x-property-sort: - minimum - maximum months3: description: Value range for the time range three months. type: object format: realRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: real description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: real description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true x-allowNullValue: true x-property-sort: - minimum - maximum months6: description: Value range for the time range six months. type: object format: realRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: real description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: real description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true x-allowNullValue: true x-property-sort: - minimum - maximum year1: description: Value range for the time range one year. type: object format: realRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: real description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: real description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true x-allowNullValue: true x-property-sort: - minimum - maximum estimates: description: Parameters for stock-specific consolidated estimates for a fiscal year. type: array nullable: false items: type: object x-property-sort: - fiscalYear - currencyDependentEstimates - returnOnAssets - returnOnEquity - ratios properties: fiscalYear: description: Since a fiscal year and a calendar year do not necessarily match with regard to their start and end dates, the year is derived as the calendar year occupied to a larger extent by the fiscal year, using a June through May fiscal year assignment. That means, fiscal years ending from the 1st of June onwards are assigned to the same calendar year. Either must be at most two years in the future. type: object x-property-sort: - yearEnd - year x-atMostOne: true properties: yearEnd: description: Calendar year of the ending date of the fiscal year. type: number format: int32 year: description: Derived fiscal year. type: number format: int32 currencyDependentEstimates: description: Currency-dependent estimates. Selection of a currency is required to use these parameters. type: object x-property-sort: - currency - ebit - ebitda - perShare properties: currency: description: Currency in which the currency-dependent estimates are expressed. type: object x-property-sort: - isoCode properties: isoCode: description: ISO 4217 code of the currency. type: string x-enum-description: - Euro - US Dollar - British Pound Sterling - Swiss Franc enum: - EUR - USD - GBP - CHF required: - isoCode ebit: description: EBIT (earnings before interest and taxes). type: object x-property-sort: - mean properties: mean: description: Value range for the mean value. type: object format: realRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: real description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: real description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true x-allowNullValue: true x-property-sort: - minimum - maximum ebitda: description: EBITDA (earnings before interest, taxes, depreciation, and amortization). type: object x-property-sort: - mean properties: mean: description: Value range for the mean value. type: object format: realRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: real description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: real description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true x-allowNullValue: true x-property-sort: - minimum - maximum perShare: description: Per-share parameters. type: object x-property-sort: - sales - earnings - dividends - cashFlow properties: sales: description: Total sales revenue per share. type: object x-property-sort: - mean properties: mean: description: Value range for the mean value. type: object format: realRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: real description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: real description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true x-allowNullValue: true x-property-sort: - minimum - maximum earnings: description: Earnings per share (EPS), which is ratio of the net income, divided by the shares outstanding. For European equities, EPS is adjusted for exceptional and any non-recurring items. For Asian equities, EPS is as reported (as per local accounting standards). For US, Canada & South Africa, EPS reflects the analysts�" and company�"s standards. type: object x-property-sort: - mean properties: mean: description: Value range for the mean value. type: object format: realRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: real description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: real description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true x-allowNullValue: true x-property-sort: - minimum - maximum dividends: description: Dividends per share, which is the ratio of the total dividends paid out, divided by the shares outstanding. type: object x-property-sort: - mean properties: mean: description: Value range for the mean value. type: object format: realRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: real description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: real description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true x-allowNullValue: true x-property-sort: - minimum - maximum cashFlow: description: Cash flow per share, which is the ratio of the net operating cash flow, divided by the shares outstanding. type: object x-property-sort: - mean properties: mean: description: Value range for the mean value. type: object format: realRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: real description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: real description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true x-allowNullValue: true x-property-sort: - minimum - maximum required: - currency returnOnAssets: description: Return on assets (ROA), which is the ratio of the net income, divided by the total assets. type: object x-property-sort: - mean properties: mean: description: Value range for the mean value. type: object format: relativeValueRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: relativeValue description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: relativeValue description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true x-allowNullValue: true x-property-sort: - minimum - maximum returnOnEquity: description: Return on equity (ROE), which is the ratio of the net income, divided by the total shareholders' equity. type: object x-property-sort: - mean properties: mean: description: Value range for the mean value. type: object format: relativeValueRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: relativeValue description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: relativeValue description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true x-allowNullValue: true x-property-sort: - minimum - maximum ratios: description: Ratio parameters. type: object x-property-sort: - priceSales - priceEarnings - priceEarningsGrowth - priceBookValue - priceCashFlow - priceFreeCashFlow - dividendYield - enterpriseValueEbit - enterpriseValueEbitda - enterpriseValueSales properties: priceSales: description: Ratio of the price, divided by the total sales revenue per share. type: object x-property-sort: - mean properties: mean: description: Value range for the mean value. type: object format: realRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: real description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: real description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true x-allowNullValue: true x-property-sort: - minimum - maximum priceEarnings: description: Ratio of the price, divided by the earnings per share. type: object x-property-sort: - mean properties: mean: description: Value range for the mean value. type: object format: realRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: real description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: real description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true x-allowNullValue: true x-property-sort: - minimum - maximum priceEarningsGrowth: description: Price-earnings ratio divided by the growth rate of the earnings. type: object x-property-sort: - mean properties: mean: description: Value range for the mean value type: object format: realRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: real description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: real description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true x-allowNullValue: true x-property-sort: - minimum - maximum priceBookValue: description: Ratio of the price, divided by the book value per share. type: object x-property-sort: - mean properties: mean: description: Value range for the mean value type: object format: realRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: real description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: real description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true x-allowNullValue: true x-property-sort: - minimum - maximum priceCashFlow: description: Ratio of the price, divided by the cash flow per share. type: object x-property-sort: - mean properties: mean: description: Value range for the mean value. type: object format: realRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: real description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: real description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true x-allowNullValue: true x-property-sort: - minimum - maximum priceFreeCashFlow: description: Ratio of the price, divided by the free (i.e. without subtraction of dividends) cash flow per share. type: object x-property-sort: - mean properties: mean: description: Value range for the mean value. type: object format: realRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: real description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: real description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true x-allowNullValue: true x-property-sort: - minimum - maximum dividendYield: description: Ratio of the dividend per share, divided by the price. type: object x-property-sort: - mean properties: mean: description: Value range for the mean value. type: object format: relativeValueRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: relativeValue description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: relativeValue description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true x-allowNullValue: true x-property-sort: - minimum - maximum enterpriseValueEbit: description: Ratio of the enterprise value, divided by the EBIT. type: object x-property-sort: - mean properties: mean: description: Value range for the mean value type: object format: realRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: real description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: real description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true x-allowNullValue: true x-property-sort: - minimum - maximum enterpriseValueEbitda: description: Ratio of the enterprise value, divided by the EBITDA. type: object x-property-sort: - mean properties: mean: description: Value range for the mean value. type: object format: realRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: real description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: real description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true x-allowNullValue: true x-property-sort: - minimum - maximum enterpriseValueSales: description: Ratio of the enterprise value, divided by the total amount of sales revenue. type: object x-property-sort: - mean properties: mean: description: Value range for the mean value. type: object format: realRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: real description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: real description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true x-allowNullValue: true x-property-sort: - minimum - maximum required: - fiscalYear maxItems: 3 meta: type: object description: The meta member contains the meta information of the request. properties: attributes: $ref: '#/components/schemas/AttributesMember' language: $ref: '#/components/schemas/LanguageMember' sort: description: Sortable attributes. The sort order is ascending unless it is prefixed with a minus sign, in which case it is descending. A list of at most 10 (possibly prefixed) attribute name(s) is allowed. type: array items: type: string enum: - valueUnit.code - -valueUnit.code - market.name - -market.name - symbol - -symbol - instrument.name - -instrument.name - instrument.shortName - -instrument.shortName - instrument.stockType - -instrument.stockType - instrument.industryClassification.rbics.level1.name - -instrument.industryClassification.rbics.level1.name - instrument.industryClassification.rbics.level2.name - -instrument.industryClassification.rbics.level2.name - instrument.industryClassification.rbics.level3.name - -instrument.industryClassification.rbics.level3.name - instrument.industryClassification.rbics.level4.name - -instrument.industryClassification.rbics.level4.name - instrument.industryClassification.rbics.level5.name - -instrument.industryClassification.rbics.level5.name - instrument.industryClassification.rbics.level6.name - -instrument.industryClassification.rbics.level6.name - instrument.company.name - -instrument.company.name - instrument.company.country.name - -instrument.company.country.name - esg.truvalueLabs.sasb.allCategories.insight - -esg.truvalueLabs.sasb.allCategories.insight - esg.truvalueLabs.sasb.allCategories.momentum - -esg.truvalueLabs.sasb.allCategories.momentum - esg.truvalueLabs.sasb.allCategories.ranking - -esg.truvalueLabs.sasb.allCategories.ranking - esg.truvalueLabs.sasb.materiality.insight - -esg.truvalueLabs.sasb.materiality.insight - esg.truvalueLabs.sasb.materiality.momentum - -esg.truvalueLabs.sasb.materiality.momentum - esg.truvalueLabs.sasb.materiality.ranking - -esg.truvalueLabs.sasb.materiality.ranking - esg.truvalueLabs.sdg.impact.insight - -esg.truvalueLabs.sdg.impact.insight - esg.truvalueLabs.sdg.impact.momentum - -esg.truvalueLabs.sdg.impact.momentum - currentKeyFigures.company.sharesOutstanding - -currentKeyFigures.company.sharesOutstanding - currentKeyFigures.company.freeFloat - -currentKeyFigures.company.freeFloat - currentKeyFigures.company.currencyDependent.marketCapitalizationSharesOutstanding - -currentKeyFigures.company.currencyDependent.marketCapitalizationSharesOutstanding - currentKeyFigures.company.currencyDependent.perShare.earnings - -currentKeyFigures.company.currencyDependent.perShare.earnings - currentKeyFigures.company.currencyDependent.perShare.bookValue - -currentKeyFigures.company.currencyDependent.perShare.bookValue - currentKeyFigures.company.currencyDependent.perShare.cashFlow - -currentKeyFigures.company.currencyDependent.perShare.cashFlow - currentKeyFigures.company.currencyDependent.perShare.sales - -currentKeyFigures.company.currencyDependent.perShare.sales - currentKeyFigures.shareInstrument.sharesOutstanding - -currentKeyFigures.shareInstrument.sharesOutstanding - currentKeyFigures.shareInstrument.freeFloat - -currentKeyFigures.shareInstrument.freeFloat - currentKeyFigures.shareInstrument.ratios.priceEarnings - -currentKeyFigures.shareInstrument.ratios.priceEarnings - currentKeyFigures.shareInstrument.ratios.priceBookValue - -currentKeyFigures.shareInstrument.ratios.priceBookValue - currentKeyFigures.shareInstrument.ratios.priceCashFlow - -currentKeyFigures.shareInstrument.ratios.priceCashFlow - currentKeyFigures.shareInstrument.ratios.priceSales - -currentKeyFigures.shareInstrument.ratios.priceSales - currentKeyFigures.shareInstrument.ratios.dividendYield - -currentKeyFigures.shareInstrument.ratios.dividendYield - currentKeyFigures.shareInstrument.ratios.earningsYield - -currentKeyFigures.shareInstrument.ratios.earningsYield - currentKeyFigures.shareInstrument.currencyDependent.marketCapitalizationSharesOutstanding - -currentKeyFigures.shareInstrument.currencyDependent.marketCapitalizationSharesOutstanding - currentKeyFigures.shareInstrument.currencyDependent.perShare.dividend - -currentKeyFigures.shareInstrument.currencyDependent.perShare.dividend - reportedKeyFigures.firstFiscalYear.currencyDependentKeyFigures.currency.isoCode - -reportedKeyFigures.firstFiscalYear.currencyDependentKeyFigures.currency.isoCode - reportedKeyFigures.firstFiscalYear.currencyDependentKeyFigures.marketCapitalization - -reportedKeyFigures.firstFiscalYear.currencyDependentKeyFigures.marketCapitalization - reportedKeyFigures.firstFiscalYear.currencyDependentKeyFigures.ebit - -reportedKeyFigures.firstFiscalYear.currencyDependentKeyFigures.ebit - reportedKeyFigures.firstFiscalYear.currencyDependentKeyFigures.ebitda - -reportedKeyFigures.firstFiscalYear.currencyDependentKeyFigures.ebitda - reportedKeyFigures.firstFiscalYear.currencyDependentKeyFigures.perShare.sales - -reportedKeyFigures.firstFiscalYear.currencyDependentKeyFigures.perShare.sales - reportedKeyFigures.firstFiscalYear.currencyDependentKeyFigures.perShare.recurringDilutedEarnings - -reportedKeyFigures.firstFiscalYear.currencyDependentKeyFigures.perShare.recurringDilutedEarnings - reportedKeyFigures.firstFiscalYear.currencyDependentKeyFigures.perShare.dividends - -reportedKeyFigures.firstFiscalYear.currencyDependentKeyFigures.perShare.dividends - reportedKeyFigures.firstFiscalYear.currencyDependentKeyFigures.perShare.bookValue - -reportedKeyFigures.firstFiscalYear.currencyDependentKeyFigures.perShare.bookValue - reportedKeyFigures.firstFiscalYear.currencyDependentKeyFigures.perShare.cashFlow - -reportedKeyFigures.firstFiscalYear.currencyDependentKeyFigures.perShare.cashFlow - reportedKeyFigures.firstFiscalYear.ebitMargin - -reportedKeyFigures.firstFiscalYear.ebitMargin - reportedKeyFigures.firstFiscalYear.ebitdaMargin - -reportedKeyFigures.firstFiscalYear.ebitdaMargin - reportedKeyFigures.firstFiscalYear.netIncomeMargin - -reportedKeyFigures.firstFiscalYear.netIncomeMargin - reportedKeyFigures.firstFiscalYear.grossIncomeMargin - -reportedKeyFigures.firstFiscalYear.grossIncomeMargin - reportedKeyFigures.firstFiscalYear.operatingMargin - -reportedKeyFigures.firstFiscalYear.operatingMargin - reportedKeyFigures.firstFiscalYear.returnOnAssets - -reportedKeyFigures.firstFiscalYear.returnOnAssets - reportedKeyFigures.firstFiscalYear.returnOnEquity - -reportedKeyFigures.firstFiscalYear.returnOnEquity - reportedKeyFigures.firstFiscalYear.ratios.priceSales - -reportedKeyFigures.firstFiscalYear.ratios.priceSales - reportedKeyFigures.firstFiscalYear.ratios.priceEarnings - -reportedKeyFigures.firstFiscalYear.ratios.priceEarnings - reportedKeyFigures.firstFiscalYear.ratios.priceBookValue - -reportedKeyFigures.firstFiscalYear.ratios.priceBookValue - reportedKeyFigures.firstFiscalYear.ratios.priceCashFlow - -reportedKeyFigures.firstFiscalYear.ratios.priceCashFlow - reportedKeyFigures.firstFiscalYear.ratios.priceFreeCashFlow - -reportedKeyFigures.firstFiscalYear.ratios.priceFreeCashFlow - reportedKeyFigures.firstFiscalYear.ratios.dividendYield - -reportedKeyFigures.firstFiscalYear.ratios.dividendYield - reportedKeyFigures.firstFiscalYear.ratios.enterpriseValueEbit - -reportedKeyFigures.firstFiscalYear.ratios.enterpriseValueEbit - reportedKeyFigures.firstFiscalYear.ratios.enterpriseValueEbitda - -reportedKeyFigures.firstFiscalYear.ratios.enterpriseValueEbitda - reportedKeyFigures.firstFiscalYear.ratios.enterpriseValueSales - -reportedKeyFigures.firstFiscalYear.ratios.enterpriseValueSales - reportedKeyFigures.firstFiscalYear.ratios.debtEquity - -reportedKeyFigures.firstFiscalYear.ratios.debtEquity - reportedKeyFigures.secondFiscalYear.currencyDependentKeyFigures.currency.isoCode - -reportedKeyFigures.secondFiscalYear.currencyDependentKeyFigures.currency.isoCode - reportedKeyFigures.secondFiscalYear.currencyDependentKeyFigures.marketCapitalization - -reportedKeyFigures.secondFiscalYear.currencyDependentKeyFigures.marketCapitalization - reportedKeyFigures.secondFiscalYear.currencyDependentKeyFigures.ebit - -reportedKeyFigures.secondFiscalYear.currencyDependentKeyFigures.ebit - reportedKeyFigures.secondFiscalYear.currencyDependentKeyFigures.ebitda - -reportedKeyFigures.secondFiscalYear.currencyDependentKeyFigures.ebitda - reportedKeyFigures.secondFiscalYear.currencyDependentKeyFigures.perShare.sales - -reportedKeyFigures.secondFiscalYear.currencyDependentKeyFigures.perShare.sales - reportedKeyFigures.secondFiscalYear.currencyDependentKeyFigures.perShare.recurringDilutedEarnings - -reportedKeyFigures.secondFiscalYear.currencyDependentKeyFigures.perShare.recurringDilutedEarnings - reportedKeyFigures.secondFiscalYear.currencyDependentKeyFigures.perShare.dividends - -reportedKeyFigures.secondFiscalYear.currencyDependentKeyFigures.perShare.dividends - reportedKeyFigures.secondFiscalYear.currencyDependentKeyFigures.perShare.bookValue - -reportedKeyFigures.secondFiscalYear.currencyDependentKeyFigures.perShare.bookValue - reportedKeyFigures.secondFiscalYear.currencyDependentKeyFigures.perShare.cashFlow - -reportedKeyFigures.secondFiscalYear.currencyDependentKeyFigures.perShare.cashFlow - reportedKeyFigures.secondFiscalYear.ebitMargin - -reportedKeyFigures.secondFiscalYear.ebitMargin - reportedKeyFigures.secondFiscalYear.ebitdaMargin - -reportedKeyFigures.secondFiscalYear.ebitdaMargin - reportedKeyFigures.secondFiscalYear.netIncomeMargin - -reportedKeyFigures.secondFiscalYear.netIncomeMargin - reportedKeyFigures.secondFiscalYear.grossIncomeMargin - -reportedKeyFigures.secondFiscalYear.grossIncomeMargin - reportedKeyFigures.secondFiscalYear.operatingMargin - -reportedKeyFigures.secondFiscalYear.operatingMargin - reportedKeyFigures.secondFiscalYear.returnOnAssets - -reportedKeyFigures.secondFiscalYear.returnOnAssets - reportedKeyFigures.secondFiscalYear.returnOnEquity - -reportedKeyFigures.secondFiscalYear.returnOnEquity - reportedKeyFigures.secondFiscalYear.ratios.priceSales - -reportedKeyFigures.secondFiscalYear.ratios.priceSales - reportedKeyFigures.secondFiscalYear.ratios.priceEarnings - -reportedKeyFigures.secondFiscalYear.ratios.priceEarnings - reportedKeyFigures.secondFiscalYear.ratios.priceBookValue - -reportedKeyFigures.secondFiscalYear.ratios.priceBookValue - reportedKeyFigures.secondFiscalYear.ratios.priceCashFlow - -reportedKeyFigures.secondFiscalYear.ratios.priceCashFlow - reportedKeyFigures.secondFiscalYear.ratios.priceFreeCashFlow - -reportedKeyFigures.secondFiscalYear.ratios.priceFreeCashFlow - reportedKeyFigures.secondFiscalYear.ratios.dividendYield - -reportedKeyFigures.secondFiscalYear.ratios.dividendYield - reportedKeyFigures.secondFiscalYear.ratios.enterpriseValueEbit - -reportedKeyFigures.secondFiscalYear.ratios.enterpriseValueEbit - reportedKeyFigures.secondFiscalYear.ratios.enterpriseValueEbitda - -reportedKeyFigures.secondFiscalYear.ratios.enterpriseValueEbitda - reportedKeyFigures.secondFiscalYear.ratios.enterpriseValueSales - -reportedKeyFigures.secondFiscalYear.ratios.enterpriseValueSales - reportedKeyFigures.secondFiscalYear.ratios.debtEquity - -reportedKeyFigures.secondFiscalYear.ratios.debtEquity - reportedKeyFigures.thirdFiscalYear.currencyDependentKeyFigures.currency.isoCode - -reportedKeyFigures.thirdFiscalYear.currencyDependentKeyFigures.currency.isoCode - reportedKeyFigures.thirdFiscalYear.currencyDependentKeyFigures.marketCapitalization - -reportedKeyFigures.thirdFiscalYear.currencyDependentKeyFigures.marketCapitalization - reportedKeyFigures.thirdFiscalYear.currencyDependentKeyFigures.ebit - -reportedKeyFigures.thirdFiscalYear.currencyDependentKeyFigures.ebit - reportedKeyFigures.thirdFiscalYear.currencyDependentKeyFigures.ebitda - -reportedKeyFigures.thirdFiscalYear.currencyDependentKeyFigures.ebitda - reportedKeyFigures.thirdFiscalYear.currencyDependentKeyFigures.perShare.sales - -reportedKeyFigures.thirdFiscalYear.currencyDependentKeyFigures.perShare.sales - reportedKeyFigures.thirdFiscalYear.currencyDependentKeyFigures.perShare.recurringDilutedEarnings - -reportedKeyFigures.thirdFiscalYear.currencyDependentKeyFigures.perShare.recurringDilutedEarnings - reportedKeyFigures.thirdFiscalYear.currencyDependentKeyFigures.perShare.dividends - -reportedKeyFigures.thirdFiscalYear.currencyDependentKeyFigures.perShare.dividends - reportedKeyFigures.thirdFiscalYear.currencyDependentKeyFigures.perShare.bookValue - -reportedKeyFigures.thirdFiscalYear.currencyDependentKeyFigures.perShare.bookValue - reportedKeyFigures.thirdFiscalYear.currencyDependentKeyFigures.perShare.cashFlow - -reportedKeyFigures.thirdFiscalYear.currencyDependentKeyFigures.perShare.cashFlow - reportedKeyFigures.thirdFiscalYear.ebitMargin - -reportedKeyFigures.thirdFiscalYear.ebitMargin - reportedKeyFigures.thirdFiscalYear.ebitdaMargin - -reportedKeyFigures.thirdFiscalYear.ebitdaMargin - reportedKeyFigures.thirdFiscalYear.netIncomeMargin - -reportedKeyFigures.thirdFiscalYear.netIncomeMargin - reportedKeyFigures.thirdFiscalYear.grossIncomeMargin - -reportedKeyFigures.thirdFiscalYear.grossIncomeMargin - reportedKeyFigures.thirdFiscalYear.operatingMargin - -reportedKeyFigures.thirdFiscalYear.operatingMargin - reportedKeyFigures.thirdFiscalYear.returnOnAssets - -reportedKeyFigures.thirdFiscalYear.returnOnAssets - reportedKeyFigures.thirdFiscalYear.returnOnEquity - -reportedKeyFigures.thirdFiscalYear.returnOnEquity - reportedKeyFigures.thirdFiscalYear.ratios.priceSales - -reportedKeyFigures.thirdFiscalYear.ratios.priceSales - reportedKeyFigures.thirdFiscalYear.ratios.priceEarnings - -reportedKeyFigures.thirdFiscalYear.ratios.priceEarnings - reportedKeyFigures.thirdFiscalYear.ratios.priceBookValue - -reportedKeyFigures.thirdFiscalYear.ratios.priceBookValue - reportedKeyFigures.thirdFiscalYear.ratios.priceCashFlow - -reportedKeyFigures.thirdFiscalYear.ratios.priceCashFlow - reportedKeyFigures.thirdFiscalYear.ratios.priceFreeCashFlow - -reportedKeyFigures.thirdFiscalYear.ratios.priceFreeCashFlow - reportedKeyFigures.thirdFiscalYear.ratios.dividendYield - -reportedKeyFigures.thirdFiscalYear.ratios.dividendYield - reportedKeyFigures.thirdFiscalYear.ratios.enterpriseValueEbit - -reportedKeyFigures.thirdFiscalYear.ratios.enterpriseValueEbit - reportedKeyFigures.thirdFiscalYear.ratios.enterpriseValueEbitda - -reportedKeyFigures.thirdFiscalYear.ratios.enterpriseValueEbitda - reportedKeyFigures.thirdFiscalYear.ratios.enterpriseValueSales - -reportedKeyFigures.thirdFiscalYear.ratios.enterpriseValueSales - reportedKeyFigures.thirdFiscalYear.ratios.debtEquity - -reportedKeyFigures.thirdFiscalYear.ratios.debtEquity - benchmark.beta.week1 - -benchmark.beta.week1 - benchmark.beta.month1 - -benchmark.beta.month1 - benchmark.beta.months3 - -benchmark.beta.months3 - benchmark.beta.months6 - -benchmark.beta.months6 - benchmark.beta.year1 - -benchmark.beta.year1 - benchmark.beta.years3 - -benchmark.beta.years3 - benchmark.beta.years5 - -benchmark.beta.years5 - benchmark.correlation.week1 - -benchmark.correlation.week1 - benchmark.correlation.month1 - -benchmark.correlation.month1 - benchmark.correlation.months3 - -benchmark.correlation.months3 - benchmark.correlation.months6 - -benchmark.correlation.months6 - benchmark.correlation.year1 - -benchmark.correlation.year1 - benchmark.correlation.years3 - -benchmark.correlation.years3 - benchmark.correlation.years5 - -benchmark.correlation.years5 - benchmark.outperformance.week1 - -benchmark.outperformance.week1 - benchmark.outperformance.month1 - -benchmark.outperformance.month1 - benchmark.outperformance.months3 - -benchmark.outperformance.months3 - benchmark.outperformance.months6 - -benchmark.outperformance.months6 - benchmark.outperformance.year1 - -benchmark.outperformance.year1 - benchmark.outperformance.years3 - -benchmark.outperformance.years3 - benchmark.outperformance.years5 - -benchmark.outperformance.years5 - performance.intraday - -performance.intraday - performance.endOfDay.day1 - -performance.endOfDay.day1 - performance.endOfDay.week1 - -performance.endOfDay.week1 - performance.endOfDay.month1 - -performance.endOfDay.month1 - performance.endOfDay.months3 - -performance.endOfDay.months3 - performance.endOfDay.months6 - -performance.endOfDay.months6 - performance.endOfDay.year1 - -performance.endOfDay.year1 - performance.endOfDay.years3 - -performance.endOfDay.years3 - performance.endOfDay.years5 - -performance.endOfDay.years5 - performance.endOfDay.yearToDate - -performance.endOfDay.yearToDate - volatility.week1 - -volatility.week1 - volatility.month1 - -volatility.month1 - volatility.months3 - -volatility.months3 - volatility.months6 - -volatility.months6 - volatility.year1 - -volatility.year1 - volatility.years3 - -volatility.years3 - volatility.years5 - -volatility.years5 - volatility.yearToDate - -volatility.yearToDate - tradingValue.average.days5 - -tradingValue.average.days5 - tradingValue.average.days30 - -tradingValue.average.days30 - simpleMovingAverage.tradingDaysSinceCrossover.sma20vs50.numberDays - -simpleMovingAverage.tradingDaysSinceCrossover.sma20vs50.numberDays - simpleMovingAverage.tradingDaysSinceCrossover.sma20vs50.direction - -simpleMovingAverage.tradingDaysSinceCrossover.sma20vs50.direction - simpleMovingAverage.tradingDaysSinceCrossover.sma50vs200.numberDays - -simpleMovingAverage.tradingDaysSinceCrossover.sma50vs200.numberDays - simpleMovingAverage.tradingDaysSinceCrossover.sma50vs200.direction - -simpleMovingAverage.tradingDaysSinceCrossover.sma50vs200.direction - rsiWilder.days14 - -rsiWilder.days14 - recommendation.counts.total - -recommendation.counts.total - recommendation.consensus.change.week1 - -recommendation.consensus.change.week1 - recommendation.consensus.change.month1 - -recommendation.consensus.change.month1 - recommendation.consensus.change.months3 - -recommendation.consensus.change.months3 - recommendation.consensus.change.months6 - -recommendation.consensus.change.months6 - recommendation.consensus.change.year1 - -recommendation.consensus.change.year1 - estimates.firstFiscalYear.currencyDependentEstimates.currency.isoCode - -estimates.firstFiscalYear.currencyDependentEstimates.currency.isoCode - estimates.firstFiscalYear.currencyDependentEstimates.ebit.mean - -estimates.firstFiscalYear.currencyDependentEstimates.ebit.mean - estimates.firstFiscalYear.currencyDependentEstimates.ebitda.mean - -estimates.firstFiscalYear.currencyDependentEstimates.ebitda.mean - estimates.firstFiscalYear.currencyDependentEstimates.perShare.sales.mean - -estimates.firstFiscalYear.currencyDependentEstimates.perShare.sales.mean - estimates.firstFiscalYear.currencyDependentEstimates.perShare.earnings.mean - -estimates.firstFiscalYear.currencyDependentEstimates.perShare.earnings.mean - estimates.firstFiscalYear.currencyDependentEstimates.perShare.dividends.mean - -estimates.firstFiscalYear.currencyDependentEstimates.perShare.dividends.mean - estimates.firstFiscalYear.currencyDependentEstimates.perShare.cashFlow.mean - -estimates.firstFiscalYear.currencyDependentEstimates.perShare.cashFlow.mean - estimates.firstFiscalYear.returnOnAssets.mean - -estimates.firstFiscalYear.returnOnAssets.mean - estimates.firstFiscalYear.returnOnEquity.mean - -estimates.firstFiscalYear.returnOnEquity.mean - estimates.firstFiscalYear.ratios.priceSales.mean - -estimates.firstFiscalYear.ratios.priceSales.mean - estimates.firstFiscalYear.ratios.priceEarnings.mean - -estimates.firstFiscalYear.ratios.priceEarnings.mean - estimates.firstFiscalYear.ratios.priceEarningsGrowth.mean - -estimates.firstFiscalYear.ratios.priceEarningsGrowth.mean - estimates.firstFiscalYear.ratios.priceBookValue.mean - -estimates.firstFiscalYear.ratios.priceBookValue.mean - estimates.firstFiscalYear.ratios.priceCashFlow.mean - -estimates.firstFiscalYear.ratios.priceCashFlow.mean - estimates.firstFiscalYear.ratios.priceFreeCashFlow.mean - -estimates.firstFiscalYear.ratios.priceFreeCashFlow.mean - estimates.firstFiscalYear.ratios.dividendYield.mean - -estimates.firstFiscalYear.ratios.dividendYield.mean - estimates.firstFiscalYear.ratios.enterpriseValueEbit.mean - -estimates.firstFiscalYear.ratios.enterpriseValueEbit.mean - estimates.firstFiscalYear.ratios.enterpriseValueEbitda.mean - -estimates.firstFiscalYear.ratios.enterpriseValueEbitda.mean - estimates.firstFiscalYear.ratios.enterpriseValueSales.mean - -estimates.firstFiscalYear.ratios.enterpriseValueSales.mean - estimates.secondFiscalYear.currencyDependentEstimates.currency.isoCode - -estimates.secondFiscalYear.currencyDependentEstimates.currency.isoCode - estimates.secondFiscalYear.currencyDependentEstimates.ebit.mean - -estimates.secondFiscalYear.currencyDependentEstimates.ebit.mean - estimates.secondFiscalYear.currencyDependentEstimates.ebitda.mean - -estimates.secondFiscalYear.currencyDependentEstimates.ebitda.mean - estimates.secondFiscalYear.currencyDependentEstimates.perShare.sales.mean - -estimates.secondFiscalYear.currencyDependentEstimates.perShare.sales.mean - estimates.secondFiscalYear.currencyDependentEstimates.perShare.earnings.mean - -estimates.secondFiscalYear.currencyDependentEstimates.perShare.earnings.mean - estimates.secondFiscalYear.currencyDependentEstimates.perShare.dividends.mean - -estimates.secondFiscalYear.currencyDependentEstimates.perShare.dividends.mean - estimates.secondFiscalYear.currencyDependentEstimates.perShare.cashFlow.mean - -estimates.secondFiscalYear.currencyDependentEstimates.perShare.cashFlow.mean - estimates.secondFiscalYear.returnOnAssets.mean - -estimates.secondFiscalYear.returnOnAssets.mean - estimates.secondFiscalYear.returnOnEquity.mean - -estimates.secondFiscalYear.returnOnEquity.mean - estimates.secondFiscalYear.ratios.priceSales.mean - -estimates.secondFiscalYear.ratios.priceSales.mean - estimates.secondFiscalYear.ratios.priceEarnings.mean - -estimates.secondFiscalYear.ratios.priceEarnings.mean - estimates.secondFiscalYear.ratios.priceEarningsGrowth.mean - -estimates.secondFiscalYear.ratios.priceEarningsGrowth.mean - estimates.secondFiscalYear.ratios.priceBookValue.mean - -estimates.secondFiscalYear.ratios.priceBookValue.mean - estimates.secondFiscalYear.ratios.priceCashFlow.mean - -estimates.secondFiscalYear.ratios.priceCashFlow.mean - estimates.secondFiscalYear.ratios.priceFreeCashFlow.mean - -estimates.secondFiscalYear.ratios.priceFreeCashFlow.mean - estimates.secondFiscalYear.ratios.dividendYield.mean - -estimates.secondFiscalYear.ratios.dividendYield.mean - estimates.secondFiscalYear.ratios.enterpriseValueEbit.mean - -estimates.secondFiscalYear.ratios.enterpriseValueEbit.mean - estimates.secondFiscalYear.ratios.enterpriseValueEbitda.mean - -estimates.secondFiscalYear.ratios.enterpriseValueEbitda.mean - estimates.secondFiscalYear.ratios.enterpriseValueSales.mean - -estimates.secondFiscalYear.ratios.enterpriseValueSales.mean - estimates.thirdFiscalYear.currencyDependentEstimates.currency.isoCode - -estimates.thirdFiscalYear.currencyDependentEstimates.currency.isoCode - estimates.thirdFiscalYear.currencyDependentEstimates.ebit.mean - -estimates.thirdFiscalYear.currencyDependentEstimates.ebit.mean - estimates.thirdFiscalYear.currencyDependentEstimates.ebitda.mean - -estimates.thirdFiscalYear.currencyDependentEstimates.ebitda.mean - estimates.thirdFiscalYear.currencyDependentEstimates.perShare.sales.mean - -estimates.thirdFiscalYear.currencyDependentEstimates.perShare.sales.mean - estimates.thirdFiscalYear.currencyDependentEstimates.perShare.earnings.mean - -estimates.thirdFiscalYear.currencyDependentEstimates.perShare.earnings.mean - estimates.thirdFiscalYear.currencyDependentEstimates.perShare.dividends.mean - -estimates.thirdFiscalYear.currencyDependentEstimates.perShare.dividends.mean - estimates.thirdFiscalYear.currencyDependentEstimates.perShare.cashFlow.mean - -estimates.thirdFiscalYear.currencyDependentEstimates.perShare.cashFlow.mean - estimates.thirdFiscalYear.returnOnAssets.mean - -estimates.thirdFiscalYear.returnOnAssets.mean - estimates.thirdFiscalYear.returnOnEquity.mean - -estimates.thirdFiscalYear.returnOnEquity.mean - estimates.thirdFiscalYear.ratios.priceSales.mean - -estimates.thirdFiscalYear.ratios.priceSales.mean - estimates.thirdFiscalYear.ratios.priceEarnings.mean - -estimates.thirdFiscalYear.ratios.priceEarnings.mean - estimates.thirdFiscalYear.ratios.priceEarningsGrowth.mean - -estimates.thirdFiscalYear.ratios.priceEarningsGrowth.mean - estimates.thirdFiscalYear.ratios.priceBookValue.mean - -estimates.thirdFiscalYear.ratios.priceBookValue.mean - estimates.thirdFiscalYear.ratios.priceCashFlow.mean - -estimates.thirdFiscalYear.ratios.priceCashFlow.mean - estimates.thirdFiscalYear.ratios.priceFreeCashFlow.mean - -estimates.thirdFiscalYear.ratios.priceFreeCashFlow.mean - estimates.thirdFiscalYear.ratios.dividendYield.mean - -estimates.thirdFiscalYear.ratios.dividendYield.mean - estimates.thirdFiscalYear.ratios.enterpriseValueEbit.mean - -estimates.thirdFiscalYear.ratios.enterpriseValueEbit.mean - estimates.thirdFiscalYear.ratios.enterpriseValueEbitda.mean - -estimates.thirdFiscalYear.ratios.enterpriseValueEbitda.mean - estimates.thirdFiscalYear.ratios.enterpriseValueSales.mean - -estimates.thirdFiscalYear.ratios.enterpriseValueSales.mean maxItems: 10 uniqueItems: true default: - instrument.name pagination: type: object description: Pagination attributes for the offset-based pagination strategy. properties: offset: type: number format: int32 minimum: 0 exclusiveMinimum: false default: 0 description: Non-negative number of entries to skip, or 0 (default). limit: type: number format: int32 minimum: 0 exclusiveMinimum: false maximum: 500 exclusiveMaximum: false default: 20 description: Non-negative maximum number of entries to return. x-property-sort: - offset - limit x-property-sort: - attributes - language - sort - pagination ErrorLink: type: object required: - about properties: about: type: string example: example_value ChangeColor: type: string enum: - colorNeutral - colorPositive - colorNegative ValueLabelTemplateData: allOf: - $ref: '#/components/schemas/TemplateWithLinks' - type: object properties: value: type: string label: type: string DataPair: type: object required: - value - label properties: value: type: string example: example_value label: type: string example: Example Title NoAnswersFound: allOf: - $ref: '#/components/schemas/NoAnswersBase' - type: object required: - querySuggestions properties: querySuggestions: type: array items: type: string ValueLabelDateTextBlockAnswer: allOf: - $ref: '#/components/schemas/AnswerWithTitle' - type: object required: - templateData properties: templateData: $ref: '#/components/schemas/ValueLabelDateTextBlockTemplateData' ThumbnailCard: type: object description: JSON that matches [Thumbnail Card](https://docs.microsoft.com/en-us/microsoftteams/platform/task-modules-and-cards/cards/cards-reference#thumbnail-card) format. nullable: true MetaRequestModel: type: object description: Meta request model which includes pagination controls properties: pagination: type: object properties: offset: type: integer example: 0 limit: type: integer example: 10 example: example_value LinkTextBlockTemplateData: allOf: - $ref: '#/components/schemas/TemplateWithLinks' - type: object properties: link: type: string text: type: string TagListResponse: type: object description: Response object for a list of tags properties: meta: $ref: '#/components/schemas/MetaModel' data: type: array description: Array of tags items: $ref: '#/components/schemas/TagModel' example: [] TitledTextBlock: type: object properties: title: type: string example: Example Title content: type: string example: example_value AdaptiveCardDataItem: oneOf: - $ref: '#/components/schemas/AdaptiveCard' - $ref: '#/components/schemas/AdaptiveCardWithThumbnail' InvestmentResearch: description: Filings Response Object type: object properties: data: type: array description: Data Array Object items: $ref: '#/components/schemas/InvestmentResearchObject' example: [] meta: type: object description: Meta Object properties: pagination: type: object description: Pagination Object properties: isEstimatedTotal: type: boolean description: This field acts as a flag for the exact count of results and is defaulted to false as the API should always return the exact count of results. example: example_value Fdc3Instrument: type: object required: - type - name properties: type: type: string example: example_value name: type: string example: Example Title exchangeMic: type: string example: example_value exchangeMicFds: type: string example: example_value id: $ref: '#/components/schemas/InstrumentID' StatusObject: type: object properties: code: type: number format: int32 description: The HTTP status code of the response, mirroring the code from the Status-Line of the HTTP response message (see [RFC2616] section 6.1). example: 42.5 description: The status member contains the status code of the response. required: - code InstrumentID: type: object properties: BBG: type: string example: example_value CUSIP: type: string example: example_value FDS_ID: type: string example: '500123' FDS_TICKER_REGION: type: string example: example_value FDS_TICKER_EXCHANGE: type: string example: example_value FIGI: type: string example: example_value ISIN: type: string example: example_value PERMID: type: string example: '500123' RIC: type: string example: example_value SEDOL: type: string example: example_value ticker: type: string example: example_value AnswerWithoutData: allOf: - $ref: '#/components/schemas/NoAnswersBase' - type: object required: - title - templateData properties: title: type: string templateData: type: object properties: fdc3Context: $ref: '#/components/schemas/Fdc3Context' MetaModel: type: object description: Meta model which includes pagination information properties: pagination: type: object properties: total: type: integer description: Total number of entries in the result set example: 1 isEstimatedTotal: type: boolean description: Flag indicating that the value of total is estimated example: false description: Pagination attributes for the offset-based pagination strategy example: example_value DocumentListResponse: type: object description: Response object for a list of documents properties: meta: $ref: '#/components/schemas/MetaModel' data: type: array description: Array of documents items: $ref: '#/components/schemas/DocumentModel' example: [] PostNewsArticleSearchByTextRequest: x-property-sort: - data - meta description: Request Body type: object properties: data: type: object x-property-sort: - text - criteria description: The data member contains the request's primary data. properties: text: description: Restrict the response of news articles to given include and exclude text criteria. type: object x-property-sort: - criteria properties: criteria: description: '' type: object x-property-sort: - selectionType - phrases - minimumMatchScore - scope properties: selectionType: description: Specify how the criteria should be applied to the search. type: string default: include x-enum-description: - Articles covering the given criteria are included in the result. - Articles covering the given criteria are excluded from the result. enum: - include - exclude phrases: description: Phrases to be used in the criteria. type: array nullable: false items: type: string maxLength: 100 exclusiveMaximum: true minItems: 1 maxItems: 16 minimumMatchScore: type: number format: real default: 0.7 description: Minimum match score for words in the news article. scope: description: Restrict fulltext search to specific scope. type: string default: all x-enum-description: - Headline of the news article. - Text body of the news article. - Search in both headline and body. enum: - headline - body - all criteria: description: Restrict the response of news articles to given include and exclude criteria. type: array nullable: false items: type: object x-property-sort: - selectionType - range - indices - instruments - types - categories - regions - distributor - publisher - language properties: selectionType: description: Specify how the criteria should be applied to the search. type: string default: include x-enum-description: - Articles covering the given criteria are included in the result. - Articles covering the given criteria are excluded from the result. enum: - include - exclude range: type: object format: timeRange properties: start: type: string format: datetime description: The starting point of the time range (inclusive), or `null` to indicate that the time range extends indefinitely into the past. x-allowNullValue: true end: type: string format: datetime description: The ending point of the time range (exclusive), or `null` to indicate that the time range extends indefinitely into the future. x-allowNullValue: true x-property-sort: - start - end required: - start - end description: Time range for matching the news article's date. At most one of the attributes `start` or `end` may be `null`. indices: type: object x-property-sort: - ids description: Set of index notations that each represent an index. Articles that cover at least one instrument contained in one of the specified indices are found. properties: ids: type: array nullable: false items: type: string format: id64 x-positive: true minItems: 1 maxItems: 500 uniqueItems: true description: Identifiers of the index notations. instruments: type: object x-property-sort: - ids description: Set of stock instruments related to the article. The set is not updated in the course of corporate actions, e.g. when the related company obtains a new instrument after a spin-off. properties: ids: type: array nullable: false items: type: string format: id64 x-positive: true minItems: 1 maxItems: 1000 uniqueItems: true description: Identifiers of the instruments. types: type: object x-property-sort: - ids description: Types of the news article. A news article is found if one or more of the specified news article types match. See endpoint `/news/article/type/list` for valid values. properties: ids: type: array nullable: false items: type: number format: id32 x-positive: true minItems: 1 maxItems: 100 uniqueItems: true description: Identifiers of the article types. categories: type: object x-property-sort: - ids description: Categories of the news article. A news article is found if one or more of the specified categories match. Use a category system of type news with endpoint /category/listBySystem for valid values. properties: ids: type: array nullable: false items: type: number format: id32 x-positive: true minItems: 1 maxItems: 100 uniqueItems: true description: Identifiers of the categories. regions: type: object x-property-sort: - ids description: Regions of the content of the news article. A news article is found if one or more of the specified regions match. See endpoint `/basic/region/list` for valid values. properties: ids: type: array nullable: false items: type: number format: id32 x-positive: true minItems: 1 maxItems: 100 uniqueItems: true description: Identifiers of the regions. distributor: type: object x-property-sort: - ids description: Distributors of the news article. A news article is found if one of the specified distributors matches. See endpoint `/news/distributor/list` for valid values. properties: ids: type: array nullable: false items: type: number format: id32 x-positive: true minItems: 1 maxItems: 100 uniqueItems: true description: Identifiers of the distributors. publisher: type: object x-property-sort: - ids description: Publishers of the news article. A news article is found if one of the specified publishers matches. See endpoint `/news/publishers/list` for valid values. properties: ids: type: array nullable: false items: type: number format: id32 x-positive: true minItems: 1 maxItems: 100 uniqueItems: true description: Identifiers of the publishers. language: type: object x-property-sort: - ids description: Languages of the news article. A news article is found if one of the specified languages matches. See endpoint `/basic/language/list` for valid values. properties: ids: type: array nullable: false items: type: number format: id32 x-positive: true minItems: 1 maxItems: 100 uniqueItems: true description: Identifiers of the languages. maxItems: 8 example: example_value meta: type: object description: The meta member contains the meta information of the request. properties: attributes: $ref: '#/components/schemas/AttributesMember' subscription: type: object description: Object defining the subscription attributes. properties: minimumInterval: type: number format: int32 minimum: 0 exclusiveMinimum: false maximum: 5000 exclusiveMaximum: false default: 0 description: Non-negative number of milliseconds to throttle the update rate from 0ms to 5000ms. Set to 0 for sending updates immediately. x-property-sort: - minimumInterval pagination: type: object description: Pagination attributes for the cursor-based pagination strategy. properties: cursor: type: string maxLength: 50 exclusiveMaximum: false description: Starting point as returned in the attributes `pagination.next` or `pagination.previous` by a prior invocation of this endpoint, or undefined (default). limit: type: number format: int32 minimum: 1 exclusiveMinimum: false maximum: 500 exclusiveMaximum: false default: 20 description: Non-negative maximum number of entries to return. x-property-sort: - cursor - limit x-property-sort: - attributes - subscription - pagination example: example_value AdaptiveCard: type: object description: JSON that matches [Adaptive Card](https://adaptivecards.io/explorer/) format. TableTemplateData: allOf: - $ref: '#/components/schemas/TemplateWithLinks' - type: object properties: table: $ref: '#/components/schemas/Table' TextBlockFootingAnswer: allOf: - $ref: '#/components/schemas/AnswerWithTitle' - type: object required: - templateData properties: templateData: $ref: '#/components/schemas/TextBlockFootingTemplateData' DocumentRequest: type: object description: '' properties: meta: $ref: '#/components/schemas/MetaRequestModel' data: type: object properties: path: type: string description: 'The Document path to filter on. For example: path=Client:/Test/Publisher/Example.pdf' example: Client:/Publisher/TEST_ACCOUNT.ACCT productType: type: string description: 'The Document path to filter on. For example: path=Client:/Test/Publisher/Example.pdf' example: Publisher tags: type: object description: The documents tags, represented in a key value format with the tag name as the key; and the tag's value as the value example: account: TEST_ACCOUNT.ACCT benchmark: TEST_BENCHMARK additionalProperties: type: string example: example_value LinkTextBlockAnswer: allOf: - $ref: '#/components/schemas/AnswerWithTitle' - type: object required: - templateData properties: templateData: $ref: '#/components/schemas/LinkTextBlockTemplateData' Fdc3Context: oneOf: - $ref: '#/components/schemas/Fdc3Instrument' - $ref: '#/components/schemas/Fdc3Country' discriminator: propertyName: type mapping: fdc3.instrument: '#/components/schemas/Fdc3Instrument' fdc3.country: '#/components/schemas/Fdc3Country' OffsetBasedPaginationOutputObject: type: object description: Pagination attributes for the offset-based pagination strategy. properties: total: type: number format: int32 description: Total number of entries in the result set. example: 42.5 isEstimatedTotal: type: boolean description: Flag indicating that the value of "total" is estimated. example: true required: - total - isEstimatedTotal x-property-sort: - total - isEstimatedTotal ValueColor: type: string enum: - colorNone - colorBuy - colorHold - colorSell - colorOverweight - colorUnderweight ValueLabelDateAnswer: allOf: - $ref: '#/components/schemas/AnswerWithTitle' - type: object required: - templateData properties: templateData: $ref: '#/components/schemas/ValueLabelDateTemplateData' OffsetBasedPaginationOutputObject_2: type: object description: Pagination attributes for the offset-based pagination strategy. properties: total: type: number format: int32 description: Total number of entries in the result set. isEstimatedTotal: type: boolean description: Flag indicating that the value of "total" is estimated. required: - total - isEstimatedTotal x-property-sort: - total - isEstimatedTotal LabelValueChangeLabelValueChangeTemplateData: allOf: - $ref: '#/components/schemas/TemplateWithLinks' - type: object properties: value: type: string label: type: string valueChange: $ref: '#/components/schemas/ValueChange' value2: type: string label2: type: string PostSecuritizedDerivativeNotationScreenerSearchRequest: type: object properties: data: type: object x-property-sort: - validation - category - registrationCountry - lifeCycle - issuer - exercise - settlement - collateralized - quanto - capitalProtection - underlying - cashFlowCurrency - singleBarriers - rangeBarriers - factorCertificates - nominalCurrency - currentInterestRate - keyFigures - performance - volatility description: The data member contains the request's primary data. properties: validation: description: Validation parameters. type: object x-property-sort: - onlyActive - prices - valueUnit - market - instrumentRestrictionList - notationRestrictionList properties: onlyActive: description: If `true`, only active notations will be returned. The term "active" reflects the fact that notations and related data is not being deleted immediately after becoming irrelevant (e.g. because the source does not provide a price anymore), but remains in general retrievable for up to 6 months. type: boolean default: true prices: description: Price-related parameters. type: object x-property-sort: - quality - latest - previous properties: quality: type: string description: Quality of the price. default: DLY x-enum-description: - 'Delayed: intraday prices with an exchange-imposed delay of usually 15 to 30 minutes.' - 'End-of-day: prices updated once per day after the close of trading, possibly with an exchange-imposed delay of several hours or days.' enum: - DLY - EOD latest: description: Parameters related to the presence and age of the most recent trade price. type: object x-property-sort: - availableOnly - minimumDate properties: availableOnly: description: If `true`, only notations for which a trade price (even an outdated one) is available will be returned. type: boolean minimumDate: description: Earliest admissible date of the most recent trade price. type: string format: date previous: description: Parameters related to the presence and age of a trade price from a preceding trading day. type: object x-property-sort: - availableOnly - minimumDate properties: availableOnly: description: If `true`, only notations for which a trade price from a preceding trading day is available will be returned. type: boolean minimumDate: description: Earliest admissible date of the trade price from a preceding trading day. type: string format: date valueUnit: description: Value unit-related parameters. See endpoint `/basic/valueUnit/list` for valid values. type: object x-property-sort: - selection properties: selection: description: Value unit selection. type: object x-property-sort: - restrict - exclude x-atMostOne: true properties: restrict: description: Specifies the value units a notation may have. type: object x-property-sort: - ids properties: ids: description: Set of value unit identifiers. type: array nullable: false items: type: number format: id32 x-positive: true uniqueItems: true maxItems: 100 exclude: description: Specifies the value units a notation may not have. type: object x-property-sort: - ids properties: ids: description: Set of value unit identifiers. type: array nullable: false items: type: number format: id32 x-positive: true uniqueItems: true maxItems: 100 market: description: Market-related notation selection. See endpoint `/basic/market/list` for valid values. type: object x-property-sort: - selection - priority properties: selection: description: Market selection. type: object x-property-sort: - restrict - exclude x-atMostOne: true properties: restrict: description: Specifies the markets from which a notation may originate. type: object x-property-sort: - ids properties: ids: description: Set of market identifiers. type: array nullable: false items: type: number format: id32 x-positive: true uniqueItems: true maxItems: 100 exclude: description: Specifies the markets from which a notation may not originate. type: object x-property-sort: - ids properties: ids: description: Set of market identifiers. type: array nullable: false items: type: number format: id32 x-positive: true uniqueItems: true maxItems: 100 priority: description: "Sequence of markets specifying the priority order of the markets for the selection of one notation per instrument. If for a given instrument with two matching notations, A and B, the market of notation A precedes the market of notation B in this list or if the market of notation B is not in this list, A is selected. If neither of the markets is in this list, the notation with the highest trading volume, averaged over one month, is selected. \n The list does not restrict the request to only those markets (use the parameter `market.selection` for that purpose)." type: object x-property-sort: - ids properties: ids: description: List of market identifiers. type: array nullable: false items: type: number format: id32 x-positive: true uniqueItems: true maxItems: 100 instrumentRestrictionList: description: Instrument-level restriction. If present, the result contains only securitized derivatives that are a member of at least one of the provided lists. type: object x-property-sort: - ids properties: ids: type: array nullable: false items: type: number format: id32 x-positive: true description: List of identifieres of restriction lists. uniqueItems: true maxItems: 3 notationRestrictionList: description: Notation-level restriction. If present, the result contains only securitized derivatives that are a member of at least one of the provided lists. type: object x-property-sort: - ids properties: ids: type: array nullable: false items: type: number format: id32 x-positive: true description: List of identifieres of restriction lists. uniqueItems: true maxItems: 3 category: description: Only securitized derivatives that belong to at least one category in the provided list will be returned. type: object x-property-sort: - ids properties: ids: description: List of category identifiers. See endpoint `/category/listBySystem` for category systems 18 and 23 for valid values. type: array nullable: false items: type: number format: id32 x-positive: true uniqueItems: true maxItems: 20 registrationCountry: description: Only securitized derivatives registered for trading in a country in the provided list are returned. type: object x-property-sort: - ids properties: ids: description: List of country identifiers. See endpoint `/basic/region/country/list` for valid values. type: array nullable: false items: type: number format: id32 x-positive: true uniqueItems: true maxItems: 20 lifeCycle: description: Parameters related to important dates. type: object x-property-sort: - issue - maturity - callable - valuation - repayment properties: issue: type: object format: dateRange x-isClosedInterval: true properties: start: type: string format: date description: The starting point of the date range (inclusive), or `null` to indicate that the date range extends indefinitely into the past. x-allowNullValue: true end: type: string format: date description: The ending point of the date range (inclusive), or `null` to indicate that the date range extends indefinitely into the future. x-allowNullValue: true x-property-sort: - start - end required: - start - end description: Date range of the issue date. maturity: description: Parameters related to the maturity. type: object x-property-sort: - restriction - perpetual properties: restriction: description: The maturity can be restricted by using one of the parameters `date` or `remainingTermDays` but not both at the same time. If a maturity restriction is set, perpetual instruments, i.e. such that do not mature, are not included in the result unless the parameter `perpetual` is set to `include`. type: object x-property-sort: - date - remainingTermDays x-atMostOne: true properties: date: type: object format: dateRange x-isClosedInterval: true properties: start: type: string format: date description: The starting point of the date range (inclusive), or `null` to indicate that the date range extends indefinitely into the past. x-allowNullValue: true end: type: string format: date description: The ending point of the date range (inclusive), or `null` to indicate that the date range extends indefinitely into the future. x-allowNullValue: true x-property-sort: - start - end required: - start - end description: Date range of the maturity date. remainingTermDays: description: Value range for the remaining term to maturity expressed in days. type: object format: realRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: real description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: real description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true x-allowNullValue: true x-property-sort: - minimum - maximum perpetual: type: string description: Defines whether or not perpetual securitized derivatives, i.e. such that do not mature, are included in the result. The value `only` can be used if both parameters `maturity.restriction.date` and `maturity.restriction.remainingTermDays` are not set. x-enum-description: - Only perpetual securitized derivatives are included in the result. - Perpetual securitized derivatives are included in the result even if one of the parameters `maturity.restriction.date` or `maturity.restriction.remainingTermDays` is set. - Perpetual securitized derivatives are excluded from the result. enum: - only - include - exclude callable: type: boolean description: Restricts the result to securitized derivatives that are callable (`true`) or are not callable (`false`). A callable instrument is one that may be redeemed by the issuer prior to maturity. valuation: description: Date range of the valuation date. type: object format: dateRange x-isClosedInterval: true properties: start: type: string format: date description: The starting point of the date range (inclusive), or `null` to indicate that the date range extends indefinitely into the past. x-allowNullValue: true end: type: string format: date description: The ending point of the date range (inclusive), or `null` to indicate that the date range extends indefinitely into the future. x-allowNullValue: true x-property-sort: - start - end required: - start - end repayment: description: Date range of the repayment date. type: object format: dateRange x-isClosedInterval: true properties: start: type: string format: date description: The starting point of the date range (inclusive), or `null` to indicate that the date range extends indefinitely into the past. x-allowNullValue: true end: type: string format: date description: The ending point of the date range (inclusive), or `null` to indicate that the date range extends indefinitely into the future. x-allowNullValue: true x-property-sort: - start - end required: - start - end issuer: description: Parameters related to the issuer. type: object x-property-sort: - ids properties: ids: description: List of identifiers of legal entities in the role of an issuer, including issuer groups. FactSet defines issuer groups to facilitate searching; they do not represent actual juristic persons. See endpoint `/securitizedDerivative/issuer/search` for valid values. type: array nullable: false items: type: number format: id32 x-positive: true uniqueItems: true maxItems: 20 exercise: description: Parameters related to the exercise. type: object x-property-sort: - right - style properties: right: type: string description: Code of the exercise right. x-enum-description: - A put option gives buyer the right, but not the obligation, to sell an asset at a specified price within a specific time period. Put is synonymous to short or bear and is used in a broader sense for products that make profits from falling underlying levels. - A call option gives buyer the right, but not the obligation, to buy an asset at a specified price within a specific time period. Call is synonymous to long or bull and is used in a broader sense for products that make profits from rising underlying levels. enum: - put - call style: type: string description: Code of the exercise style. x-enum-description: - An American-style securitized derivative can be exercised anytime during its life. - An European-style securitized derivative can be exercised at maturity only. - A Bermudan-style securitized derivative can be exercised only on predetermined dates. enum: - american - european - bermudan settlement: type: string description: Settlement of the securitized derivative. It concerns the fulfillment of the issuer's contractual obligations arising from the securitized derivative. Depending on the terms, the underlying asset may be delivered physically or its equivalent monetary value may be payed out. x-enum-description: - Transfer of a cash amount - Phyiscal delivery of the underlying asset. - Cash or physical, at the discretion of the issuer. enum: - cash - physical - either collateralized: type: boolean description: Restricts the result to securitized derivatives that are collateralized (`true`) or are not collateralized (`false`). A collateralized securitized derivative is protected against an issuer default by collateral. quanto: type: boolean description: Restricts the result to securitized derivatives that are hedged (`true`) or are not hedged (`false`) against fluctuations of the foreign exchange rate between the value unit of the underlying and the value unit of the cash flows. capitalProtection: type: object format: relativeValueRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: relativeValue description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true required: - value x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: relativeValue description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true required: - value x-allowNullValue: true x-property-sort: - minimum - maximum description: Value range of the proportion of the nominal amount protected against loss. underlying: description: "Underlying selection. A list of underlyings can be selected by either using their instrument identifiers, see parameter `underlying.instrument.ids` or by using their notation identifiers, see parameter `underlying.notation.ids` but not both at the same time. Only one of the provided identifiers needs to be matched in order for a securitized derivative to be returned in the result.\n\n The list of underlyings is particularly useful to search for securitized derivatives that have very similar but not exactly the same underlyings such as futures with different maturities\non a given commodity, e.g. brent crude oil. For such a list of underlyings, a barrier restriction in absolute terms, see for example parameter `singleBarriers.level.absolute` or `rangeBarriers.upper.level.absolute`, will provide a meaningful result, whereas for a list of non-similar underlyings, such as different stocks, a barrier restriction in absolute terms will not provide a meaningful result. This is due to the fact that futures on the same commodity are comparable in regards to their prices while two different stocks are not comparable.\n\n Parameters in relative terms, see for example parameter `singleBarriers.distance.relative`, are generally comparable and will provide meaningful result for a list of similar as well as\nfor a list of non-similar underlyings.\n\n For the selection of the effective underling of factor certificates, use `factorCertificates.effectiveUnderlying.instrument.ids`." type: object x-property-sort: - instrument - notation x-atMostOne: true properties: instrument: description: Underlying selection using instrument identifiers. type: object x-property-sort: - ids properties: ids: description: List of instrument identifiers. type: array nullable: false items: type: string format: id64 x-positive: true uniqueItems: true maxItems: 100 notation: description: Underlying selection using notation identifiers. type: object x-property-sort: - ids properties: ids: description: List of notation identifiers. type: array nullable: false items: type: string format: id64 x-positive: true uniqueItems: true maxItems: 100 cashFlowCurrency: description: Main currency of the cash flows. A cash flow is a payout dependent on whether or not the underlying level, e.g. a stock's price, will reach a given threshold, called barrier, at a given time. type: object x-property-sort: - id properties: id: description: Identifier of the currency. See endpoint `/basic/valueUnit/currency/main/list` for valid values. type: number format: id32 x-positive: true singleBarriers: type: array nullable: false items: type: object x-property-sort: - type - observation - level - distance - breach - cashFlow properties: type: description: The type of the barrier. See endpoint `/securitizedDerivative/barrier/type/list` for additional information. Note that not all barrier types listed in the mentioned endpoint can be used as a parameter. type: string x-enum-description: - Represents the underlying level that needs to be reached in order for the securitized derivative to yield a profit; particularly relevant for reverse convertible bonds, sprint/outperformance certificates, capital-protection certificates, warrants and knock-out certificates. - Represents the underlying level considered for repayment if the knock-in barrier is intact; particularly relevant for bonus certificates. - Represents the maximum underlying level considered for repayment; particularly relevant for discount certificates, bonus certificates, and capital-protection certificates. - Represents the underlying level where a securitized derivative is terminated and becomes (nearly) worthless; particularly relevant for knock-out certificates. - Represents the underling level at which a certain product feature (such as a bonus payment) is lost; particularly relevant for bonus certificates but also for securitized derivatives that might have additional protection such as reverse convertible bonds, discount certificates, and capital-protection certificates. - Represents the underlying level at which the securitized derivative is terminated yielding a predefined amount; particularly relevant for capital-protection certificates and express certificates but currently not supported for the latter. - Represents the underlying level at which a certain repayment at maturity is ensured; particularly relevant for capital-protection certificates and express certificates but currently not supported for the latter. - Represents the underlying level corresponding to a guranteed repayment; particularly relevant for capital-protection certificates. - Represents the underlying level at which a partial payment (such as a conditional coupon) is lost; particularly relevant for capital-protection certificates and express certificates but currently not supported for the latter. enum: - strike - bonusLevel - cap - knockOut - knockIn - lockOut - lockIn - capitalGuarantee - couponTriggerLevel observation: type: object x-property-sort: - type description: 'Barrier observation modality; applicable to the following barrier types: `knockIn`, `knockOut`, `lockIn`, and `lockOut`.' properties: type: type: string description: Type of the barrier observation. x-enum-description: - The barrier is observed on a continuous basis (intraday prices are relevant). - The barrier is observed only at the end of the final auction for the underlying on the relevant exchange (intraday prices are of no relevance). enum: - continuous - eod level: type: object x-property-sort: - absolute description: Barrier level. properties: absolute: type: object format: realRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: real description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true required: - value x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: real description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true required: - value x-allowNullValue: true x-property-sort: - minimum - maximum description: Value range of the absolute barrier level. distance: type: object x-property-sort: - absolute - relative description: Distance of the current underlying level to the barrier level. properties: absolute: type: object format: realRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: real description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true required: - value x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: real description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true required: - value x-allowNullValue: true x-property-sort: - minimum - maximum description: Value range of the absolute distance. relative: type: object format: relativeValueRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: relativeValue description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true required: - value x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: relativeValue description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true required: - value x-allowNullValue: true x-property-sort: - minimum - maximum description: Value range of the distance in relative terms. breach: description: 'Parameters related to a barrier breach; applicable to the following barrier types: `knockIn` and `knockOut`' type: object x-property-sort: - breached properties: breached: type: string description: Defines whether or not securitized derivatives for which the barrier has been breached are included in the result. default: exclude x-enum-description: - The result is not limited with regard to whether the barrier has been breached or not. - The result is limited to securitized derivatives for which the barrier has been breached. - The result is limited to securitized derivatives for which the barrier has not been breached. enum: - all - only - exclude cashFlow: type: object format: realRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: real description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true required: - value x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: real description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true required: - value x-allowNullValue: true x-property-sort: - minimum - maximum description: 'Value range of the cash flow related to the barrier; applicable to the following barrier types: `cap`, `knockIn`, `lockOut`, `lockIn`, `capitalGuarantee`, and `couponTriggerLevel`.' description: Single barriers. Barriers of this kind represent either a lower or an upper bound derived from the exercise right of the securitized derivative. Multiple barrier types may be used in one request. rangeBarriers: type: array nullable: false items: type: object x-property-sort: - type - observation - upper - lower - breach - cashFlow properties: type: description: The type of the barrier. See endpoint `/securitizedDerivative/barrier/type/list` for additional information. Note that not all barrier types listed in the mentioned endpoint can be used as a parameter. type: string x-enum-description: - Represents the upper and lower bound of the underlying level where a securitized derivative is terminated and becomes (nearly) worthless; particularly relevant for range knock-out certificates such as inline certificates. enum: - rangeKnockOut observation: type: object x-property-sort: - type description: Barrier observation modality. properties: type: type: string description: Type of the barrier observation. x-enum-description: - The barrier is observed on a continuous basis (intraday prices are relevant). - The barrier is observed only at the end of the final auction for the underlying on the relevant exchange (intraday prices are of no relevance). enum: - continuous - eod upper: type: object x-property-sort: - level description: Parameters related to the upper bound. properties: level: type: object x-property-sort: - absolute description: Barrier level. properties: absolute: type: object format: realRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: real description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true required: - value x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: real description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true required: - value x-allowNullValue: true x-property-sort: - minimum - maximum description: Value range of the absolute barrier level. lower: type: object x-property-sort: - level description: Parameters related to the lower bound. properties: level: type: object x-property-sort: - absolute description: Barrier level. properties: absolute: type: object format: realRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: real description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true required: - value x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: real description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true required: - value x-allowNullValue: true x-property-sort: - minimum - maximum description: Value range of the absolute barrier level. breach: description: 'Parameters related to a barrier breach; applicable to the following barrier types: `knockIn` and `knockOut`' type: object x-property-sort: - breached properties: breached: type: string description: Defines whether or not securitized derivatives for which the barrier has been breached are included in the result. default: exclude x-enum-description: - The result is not limited with regard to whether the barrier has been breached or not. - The result is limited to securitized derivatives for which the barrier has been breached. - The result is limited to securitized derivatives for which the barrier has not been breached. enum: - all - only - exclude cashFlow: type: object format: realRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: real description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true required: - value x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: real description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true required: - value x-allowNullValue: true x-property-sort: - minimum - maximum description: 'Value range of the cash flow related to the barrier; applicable to the following barrier types: `cap`, `knockIn`, `lockOut`, `lockIn`, `capitalGuarantee`, and `couponTriggerLevel`.' description: Range barriers. Barriers of this kind represent a range with a lower and an upper bound. factorCertificates: type: object x-property-sort: - effectiveUnderlying - participation - constantLeverage description: Parameters for factor certificates. properties: effectiveUnderlying: type: object x-property-sort: - instrument description: Selection of the effective underlying. The underlying of a factor certificate is usually a factor index which is an artificial index used to calculate the leveraged daily performance of another financial instrument called its effective underlying. properties: instrument: description: Selection of the effective underlying using instrument identifiers. type: object x-property-sort: - ids properties: ids: description: List of instrument identifiers. type: array nullable: false items: type: string format: id64 x-positive: true uniqueItems: true maxItems: 100 participation: type: string description: Participation direction of the factor certificate at the level movement of its effective underlying. x-enum-description: - The factor certificate participates positively with rising levels of its effective underlying. - The factor certificate participates negatively with rising levels of its effective underlying. enum: - long - short constantLeverage: type: object format: realRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: real description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true required: - value x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: real description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true required: - value x-allowNullValue: true x-property-sort: - minimum - maximum description: Value range of the constant leverage. nominalCurrency: type: object x-property-sort: - id description: Main currency of the nominal and of the coupon payments. properties: id: type: number format: id32 x-positive: true description: Identifier of the currency. See endpoint `/basic/valueUnit/currency/main/list` for valid values. currentInterestRate: type: object x-property-sort: - type - value description: Parameters regarding the interest rate of the current coupon period. properties: type: type: string description: Type of the interest rate. x-enum-description: - The interest rate is fixed for all periods and remains unchanged throughout the lifetime of the securitized derivative. - The interest rate is variable and might change from period to period throughout the lifetime of the securitized derivative. enum: - fixed - variable value: type: object format: relativeValueRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: relativeValue description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true required: - value x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: relativeValue description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true required: - value x-allowNullValue: true x-property-sort: - minimum - maximum description: Value range for the interest rate of the current coupon period. For coupon periods different than one year, the value is annualized. Not available for securitized derivatives with a current interest rate type other than `fixed`. keyFigures: type: object x-property-sort: - bonusYield - sidewaysYield - maximumYield - agio - discount - breakEven - spread - delta - thetaOneWeek - vega - leverage - omega - impliedVolatility - intrinsicValue - timeValue - outperformancePoint - parity description: Key figures specific to securitized derivatives; based on ask prices. properties: bonusYield: type: object x-property-sort: - absolute - relative - annualized description: Bonus yield. It represents the bonus level adjusted for the cover ratio and currency cross rate minus the ask price of the securitized derivative. The value can become negative (e.g. for uncapped products), which does not mean that the investor will necessarily suffer a loss buying it. This key figure is calculated for bonus certificates with an intact knock-in barrier only. To restrict the result to bonus certificates with an intact knock in barrier, the parameter `singleBarriers.type` must be set to `knockIn` and the parameter `singleBarriers.breach.breached` must be set to `false`. properties: absolute: type: object format: realRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: real description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true required: - value x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: real description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true required: - value x-allowNullValue: true x-property-sort: - minimum - maximum description: Value range of the bonus yield in absolute terms. relative: type: object format: relativeValueRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: relativeValue description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true required: - value x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: relativeValue description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true required: - value x-allowNullValue: true x-property-sort: - minimum - maximum description: Value range of the bonus yield relative to the ask price. annualized: type: object format: relativeValueRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: relativeValue description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true required: - value x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: relativeValue description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true required: - value x-allowNullValue: true x-property-sort: - minimum - maximum description: Value range of the annualized bonus yield relative to the ask price. sidewaysYield: type: object x-property-sort: - absolute - relative - annualized description: Sideways yield. It represents a hypothetical payout at maturity minus the ask price of the securitized derivative, under the assumption that all payout-influencing factors remain unchanged until maturity. properties: absolute: type: object format: realRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: real description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true required: - value x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: real description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true required: - value x-allowNullValue: true x-property-sort: - minimum - maximum description: Value range of the sideways yield in absolute terms. relative: type: object format: relativeValueRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: relativeValue description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true required: - value x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: relativeValue description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true required: - value x-allowNullValue: true x-property-sort: - minimum - maximum description: Value range of the sideways yield relative to the ask price. annualized: type: object format: relativeValueRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: relativeValue description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true required: - value x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: relativeValue description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true required: - value x-allowNullValue: true x-property-sort: - minimum - maximum description: Value range of the annualized sideways yield relative to the ask price. maximumYield: type: object x-property-sort: - absolute - relative - annualized description: Maximum yield. It represents a hypothetical maximum payout at maturity minus the ask price of the derivative. This key figure represents a theoretically possible best-case scenario, disregarding the probability of occurrence. It is calculated only for securitized derivatives with a limited payout (e.g. capped products). properties: absolute: type: object format: realRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: real description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true required: - value x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: real description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true required: - value x-allowNullValue: true x-property-sort: - minimum - maximum description: Value range of the maximum yield in absolute terms. relative: type: object format: relativeValueRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: relativeValue description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true required: - value x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: relativeValue description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true required: - value x-allowNullValue: true x-property-sort: - minimum - maximum description: Value range of the maximum yield relative to the ask price. annualized: type: object format: relativeValueRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: relativeValue description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true required: - value x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: relativeValue description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true required: - value x-allowNullValue: true x-property-sort: - minimum - maximum description: Value range of the annualized maximum yield relative to the ask price. agio: type: object x-property-sort: - absolute - relative - annualized description: Agio. For plain vanilla warrants, it represents the difference between the ask price of the derivative and its parity (see attribute `parity`). Thus, for those with exercise right `call`, the agio indicates how much more expensive would it be to obtain the underlying through purchasing and exercising the warrant compared to directly purchasing the underlying. For those with exercise right `put`, the above consideration is applied inversely. For other types of securitized derivatives, the calculation and interpretation of the agio depends on their category. Negative values are possible. properties: absolute: type: object format: realRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: real description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true required: - value x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: real description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true required: - value x-allowNullValue: true x-property-sort: - minimum - maximum description: Value range of the agio in absolute terms. relative: type: object format: relativeValueRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: relativeValue description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true required: - value x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: relativeValue description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true required: - value x-allowNullValue: true x-property-sort: - minimum - maximum description: Value range of the agio relative to the underlying level. annualized: type: object format: relativeValueRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: relativeValue description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true required: - value x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: relativeValue description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true required: - value x-allowNullValue: true x-property-sort: - minimum - maximum description: Value range of the annualized agio relative to the underlying level. discount: type: object x-property-sort: - absolute - relative description: Discount. It represents the difference between the ask price of the securitized derivative and the underlying level, adjusted for the cover ratio and the currency cross rate. This key figure is calculated only for discount certificates. properties: absolute: type: object format: realRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: real description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true required: - value x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: real description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true required: - value x-allowNullValue: true x-property-sort: - minimum - maximum description: Value range of the discount in absolute terms. relative: type: object format: relativeValueRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: relativeValue description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true required: - value x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: relativeValue description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true required: - value x-allowNullValue: true x-property-sort: - minimum - maximum description: Value range of the discount relative to the underlying level. breakEven: type: object x-property-sort: - breakEvenPoint - distance description: Break even point. It represents the underlying level that has to be reached at maturity, such that no loss or profit occurs for the holder of the securitized derivative. properties: breakEvenPoint: type: object format: realRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: real description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true required: - value x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: real description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true required: - value x-allowNullValue: true x-property-sort: - minimum - maximum description: Value range of the break even point. distance: type: object x-property-sort: - absolute - relative description: Distance from the underlying level to the break even point. properties: absolute: type: object format: realRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: real description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true required: - value x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: real description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true required: - value x-allowNullValue: true x-property-sort: - minimum - maximum description: Value range of the distance in absolute terms. relative: type: object format: relativeValueRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: relativeValue description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true required: - value x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: relativeValue description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true required: - value x-allowNullValue: true x-property-sort: - minimum - maximum description: Value range of the distance relative to the underlying level. spread: type: object x-property-sort: - harmonized - relative description: Spread. It represents the difference between the ask and bid price. properties: harmonized: type: object format: realRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: real description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true required: - value x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: real description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true required: - value x-allowNullValue: true x-property-sort: - minimum - maximum description: Value range of the spread in absolute terms, adjusted for the cover ratio. relative: type: object format: relativeValueRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: relativeValue description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true required: - value x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: relativeValue description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true required: - value x-allowNullValue: true x-property-sort: - minimum - maximum description: Value range of the spread relative to the ask price. delta: type: object x-property-sort: - effective - unadjusted description: Delta. It represents the first partial derivative of the function determining the derivative notation's theoretical price with respect to the underlying level, evaluated at the underlying level. Delta indicates the ratio of the absolute change of the price of a derivative for an indefinitely small absolute change in the underlying level, thus it represents the price sensitivity of the derivative relative to changes in the underlying level. This key figure is calculated for plain vanilla warrants only. properties: effective: type: object format: realRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: real description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true required: - value x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: real description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true required: - value x-allowNullValue: true x-property-sort: - minimum - maximum description: Value range of the delta calculated using the actual cover ratio of the securitized derivative. unadjusted: type: object format: realRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: real description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true required: - value x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: real description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true required: - value x-allowNullValue: true x-property-sort: - minimum - maximum description: Value range of the delta calculated using a (hypothetical) cover ratio of 1:1. thetaOneWeek: type: object x-property-sort: - effective - unadjusted description: Weekly theta. It represents the first partial derivative of the function determining the derivative notation's theoretical price with respect to the residual term, evaluated at the current residual term and multiplied by 7/365. Weekly theta indicates the absolute change (decrease) of the price of a derivative for a reduction of the residual term by one week (seven calendar days), thus it represents the price sensitivity of the derivative relative to changes in the residual term. This key figure is calculated for plain vanilla warrants only. properties: effective: type: object format: realRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: real description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true required: - value x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: real description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true required: - value x-allowNullValue: true x-property-sort: - minimum - maximum description: Value range of the weekly theta calculated using the actual cover ratio of the securitized derivative. unadjusted: type: object format: realRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: real description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true required: - value x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: real description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true required: - value x-allowNullValue: true x-property-sort: - minimum - maximum description: Value range of the weekly theta calculated using a (hypothetical) cover ratio of 1:1. vega: type: object x-property-sort: - effective - unadjusted description: Vega. It represents the first partial derivative of the function determining the derivative notation's theoretical price with respect to the implied volatility, evaluated at the current implied volatility. Vega indicates the ratio of the absolute change of the price of a derivative for an absolute change of the implied volatility, thus it represents the price sensitivity of the derivative relative to changes in the implied volatility. This key figure is calculated for plain vanilla warrants only. properties: effective: type: object format: realRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: real description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true required: - value x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: real description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true required: - value x-allowNullValue: true x-property-sort: - minimum - maximum description: Value range of the vega calculated using the actual cover ratio of the securitized derivative. unadjusted: type: object format: realRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: real description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true required: - value x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: real description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true required: - value x-allowNullValue: true x-property-sort: - minimum - maximum description: Value range of the vega calculated using a (hypothetical) cover ratio of 1:1. leverage: type: object format: relativeValueRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: relativeValue description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true required: - value x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: relativeValue description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true required: - value x-allowNullValue: true x-property-sort: - minimum - maximum description: Value range of the leverage. It represents the ratio of the underlying level to the ask price of the securitized derivative, adjusted for the cover ratio and the currency cross rate. This key figure is calculated only for leveraged securitized derivatives (e.g. warrants, knock-out certificates). omega: type: object format: realRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: real description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true required: - value x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: real description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true required: - value x-allowNullValue: true x-property-sort: - minimum - maximum description: Value range of the omega. It represents unadjusted delta (see attribute `delta.unadjusted`) multiplied with the leverage (see attribute `leverage`), both calculated based on the ask price of the derivative. Omega indicates the elasticity of the securitized derivative's price regarding the underlying level. This key figure is calculated for plain vanilla warrants only. impliedVolatility: type: object format: relativeValueRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: relativeValue description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true required: - value x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: relativeValue description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true required: - value x-allowNullValue: true x-property-sort: - minimum - maximum description: Value range of the implied volatility. It represents the volatility of the underlying that justifies the ask price of the derivative, when used as a parameter in the derivative's pricing model (such as Black - Scholes). Its value is a result of the pricing process, thus it represents the annual volatility of the underlying expected by the market participants until maturity of the derivative. This key figure is calculated for plain vanilla warrants only. intrinsicValue: type: object format: realRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: real description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true required: - value x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: real description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true required: - value x-allowNullValue: true x-property-sort: - minimum - maximum description: Value range of the intrinsic value. It represents the difference between the underlying level and the strike of the securitized derivative, adjusted for the cover ratio and the currency cross rate. If the difference is negative, the intrinsic value is given as 0. The intrinsic value represents the theoretical profit from an immediate exercise of the derivative. This key figure is calculated for plain vanilla warrants only. timeValue: type: object format: realRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: real description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true required: - value x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: real description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true required: - value x-allowNullValue: true x-property-sort: - minimum - maximum description: Value range of the time value. It represents the difference between the ask price of the securitized derivative and its intrinsic value. This key figure is calculated for plain vanilla warrants only. outperformancePoint: type: object format: realRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: real description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true required: - value x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: real description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true required: - value x-allowNullValue: true x-property-sort: - minimum - maximum description: Value range of the outperformance point. It represents the underlying level from which the underlying starts to outperform the securitized derivative, thus the investor would be better off investing directly in the underlying. It is calculated only for securitized derivatives with a limited payout (e.g. capped products). parity: type: object format: realRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: real description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true required: - value x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: real description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true required: - value x-allowNullValue: true x-property-sort: - minimum - maximum description: Value range of the parity. It represents the difference between the underlying level and the strike of the derivative, adjusted for the cover ratio and the currency cross rate. Negative values are possible. It is the gain or loss that would result from the immediate exercise of an already present warrant and a simultaneously executed compensation transaction on the spot markets. This key figure is calculated for plain vanilla warrants only. performance: type: object x-property-sort: - intraday - sinceIssue - endOfDay description: Relative performance for different time ranges. properties: intraday: type: object format: relativeValueRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: relativeValue description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true required: - value x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: relativeValue description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true required: - value x-allowNullValue: true x-property-sort: - minimum - maximum description: Value range for the time range intraday. That is the difference of a notation's most recent price from the current trading day against the most recent EOD closing price. sinceIssue: type: object x-property-sort: - ask - bid description: Relative performance since issue. That is the difference of a notation's most recent price against the price on the issue date, relative to the price on the issue date. properties: ask: type: object format: relativeValueRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: relativeValue description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true required: - value x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: relativeValue description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true required: - value x-allowNullValue: true x-property-sort: - minimum - maximum description: Value range for the ask-based relative performance since issue. bid: type: object format: relativeValueRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: relativeValue description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true required: - value x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: relativeValue description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true required: - value x-allowNullValue: true x-property-sort: - minimum - maximum description: Value range for the bid-based relative performance since issue. endOfDay: type: object x-property-sort: - day1 - week1 - month1 - months3 - months6 - year1 - years3 - years5 - yearToDate description: End-of-day (EOD) relative performance for different time ranges. The relative performance is the difference of a notation's most recent EOD closing price against the EOD closing price on the reference date, relative to the EOD closing price on the reference date. properties: day1: type: object format: relativeValueRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: relativeValue description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true required: - value x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: relativeValue description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true required: - value x-allowNullValue: true x-property-sort: - minimum - maximum description: Value range for the time range one day. week1: type: object format: relativeValueRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: relativeValue description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true required: - value x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: relativeValue description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true required: - value x-allowNullValue: true x-property-sort: - minimum - maximum description: Value range for the time range one week. month1: type: object format: relativeValueRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: relativeValue description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true required: - value x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: relativeValue description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true required: - value x-allowNullValue: true x-property-sort: - minimum - maximum description: Value range for the time range one month. months3: type: object format: relativeValueRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: relativeValue description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true required: - value x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: relativeValue description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true required: - value x-allowNullValue: true x-property-sort: - minimum - maximum description: Value range for the time range three months. months6: type: object format: relativeValueRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: relativeValue description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true required: - value x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: relativeValue description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true required: - value x-allowNullValue: true x-property-sort: - minimum - maximum description: Value range for the time range six months. year1: type: object format: relativeValueRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: relativeValue description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true required: - value x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: relativeValue description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true required: - value x-allowNullValue: true x-property-sort: - minimum - maximum description: Value range for the time range one year. years3: type: object format: relativeValueRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: relativeValue description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true required: - value x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: relativeValue description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true required: - value x-allowNullValue: true x-property-sort: - minimum - maximum description: Value range for the time range three years. years5: type: object format: relativeValueRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: relativeValue description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true required: - value x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: relativeValue description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true required: - value x-allowNullValue: true x-property-sort: - minimum - maximum description: Value range for the time range five years. yearToDate: type: object format: relativeValueRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: relativeValue description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true required: - value x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: relativeValue description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true required: - value x-allowNullValue: true x-property-sort: - minimum - maximum description: Value range for the time range year-to-date (YTD). volatility: type: object x-property-sort: - week1 - month1 - months3 - months6 - year1 - years3 - years5 - yearToDate description: Volatility of the daily logarithmic returns, annualized assuming 256 trading days per year for different time ranges. properties: week1: type: object format: relativeValueRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: relativeValue description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true required: - value x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: relativeValue description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true required: - value x-allowNullValue: true x-property-sort: - minimum - maximum description: Value range for the time range one week. month1: type: object format: relativeValueRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: relativeValue description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true required: - value x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: relativeValue description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true required: - value x-allowNullValue: true x-property-sort: - minimum - maximum description: Value range for the time range one month. months3: type: object format: relativeValueRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: relativeValue description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true required: - value x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: relativeValue description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true required: - value x-allowNullValue: true x-property-sort: - minimum - maximum description: Value range for the time range three months. months6: type: object format: relativeValueRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: relativeValue description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true required: - value x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: relativeValue description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true required: - value x-allowNullValue: true x-property-sort: - minimum - maximum description: Value range for the time range six months. year1: type: object format: relativeValueRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: relativeValue description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true required: - value x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: relativeValue description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true required: - value x-allowNullValue: true x-property-sort: - minimum - maximum description: Value range for the time range one year. years3: type: object format: relativeValueRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: relativeValue description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true required: - value x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: relativeValue description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true required: - value x-allowNullValue: true x-property-sort: - minimum - maximum description: Value range for the time range three years. years5: type: object format: relativeValueRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: relativeValue description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true required: - value x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: relativeValue description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true required: - value x-allowNullValue: true x-property-sort: - minimum - maximum description: Value range for the time range five years. yearToDate: type: object format: relativeValueRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: relativeValue description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true required: - value x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: relativeValue description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true required: - value x-allowNullValue: true x-property-sort: - minimum - maximum description: Value range for the time range year-to-date (YTD). example: example_value meta: type: object description: The meta member contains the meta information of the request. properties: attributes: $ref: '#/components/schemas/AttributesMember' language: $ref: '#/components/schemas/LanguageMember' sort: description: Sortable attributes. The sort order is ascending unless it is prefixed with a minus sign, in which case it is descending. A list of at most 10 (possibly prefixed) attribute name(s) is allowed. type: array items: type: string enum: - symbol - -symbol - market.name - -market.name - instrument.name - -instrument.name - instrument.shortName - -instrument.shortName - instrument.categorization.ddv.level1.name - -instrument.categorization.ddv.level1.name - instrument.categorization.ddv.level2.name - -instrument.categorization.ddv.level2.name - instrument.categorization.ddv.level3.name - -instrument.categorization.ddv.level3.name - instrument.categorization.eusipa.level1.name - -instrument.categorization.eusipa.level1.name - instrument.categorization.eusipa.level2.name - -instrument.categorization.eusipa.level2.name - instrument.categorization.eusipa.level3.name - -instrument.categorization.eusipa.level3.name - instrument.lifeCycle.maturity.date - -instrument.lifeCycle.maturity.date - instrument.lifeCycle.maturity.remainingTermDays - -instrument.lifeCycle.maturity.remainingTermDays - instrument.lifeCycle.maturity.perpetual - -instrument.lifeCycle.maturity.perpetual - instrument.lifeCycle.callable - -instrument.lifeCycle.callable - instrument.lifeCycle.valuation - -instrument.lifeCycle.valuation - instrument.lifeCycle.repayment - -instrument.lifeCycle.repayment - instrument.issuer.name - -instrument.issuer.name - instrument.issuer.group.name - -instrument.issuer.group.name - instrument.exercise.right - -instrument.exercise.right - instrument.exercise.style - -instrument.exercise.style - instrument.settlement - -instrument.settlement - instrument.quanto - -instrument.quanto - instrument.capitalProtection - -instrument.capitalProtection - instrument.underlying.name - -instrument.underlying.name - instrument.underlying.valueUnit.code - -instrument.underlying.valueUnit.code - instrument.underlying.notation.instrument.typeComposite - -instrument.underlying.notation.instrument.typeComposite - instrument.strike.value - -instrument.strike.value - instrument.strike.distance.absolute - -instrument.strike.distance.absolute - instrument.strike.distance.relative - -instrument.strike.distance.relative - instrument.bonusLevel.value - -instrument.bonusLevel.value - instrument.bonusLevel.distance.absolute - -instrument.bonusLevel.distance.absolute - instrument.bonusLevel.distance.relative - -instrument.bonusLevel.distance.relative - instrument.cap.value - -instrument.cap.value - instrument.cap.distance.absolute - -instrument.cap.distance.absolute - instrument.cap.distance.relative - -instrument.cap.distance.relative - instrument.cap.cashFlow - -instrument.cap.cashFlow - instrument.knockOut.observation.type - -instrument.knockOut.observation.type - instrument.knockOut.value - -instrument.knockOut.value - instrument.knockOut.distance.absolute - -instrument.knockOut.distance.absolute - instrument.knockOut.distance.relative - -instrument.knockOut.distance.relative - instrument.knockOut.breach.breached - -instrument.knockOut.breach.breached - instrument.knockOut.breach.datetime - -instrument.knockOut.breach.datetime - instrument.knockIn.observation.type - -instrument.knockIn.observation.type - instrument.knockIn.value - -instrument.knockIn.value - instrument.knockIn.distance.absolute - -instrument.knockIn.distance.absolute - instrument.knockIn.distance.relative - -instrument.knockIn.distance.relative - instrument.knockIn.breach.breached - -instrument.knockIn.breach.breached - instrument.knockIn.breach.datetime - -instrument.knockIn.breach.datetime - instrument.lockOut.observation.type - -instrument.lockOut.observation.type - instrument.lockOut.value - -instrument.lockOut.value - instrument.lockOut.distance.absolute - -instrument.lockOut.distance.absolute - instrument.lockOut.distance.relative - -instrument.lockOut.distance.relative - instrument.lockOut.cashFlow - -instrument.lockOut.cashFlow - instrument.lockIn.observation.type - -instrument.lockIn.observation.type - instrument.lockIn.value - -instrument.lockIn.value - instrument.lockIn.distance.absolute - -instrument.lockIn.distance.absolute - instrument.lockIn.distance.relative - -instrument.lockIn.distance.relative - instrument.lockIn.cashFlow - -instrument.lockIn.cashFlow - instrument.capitalGuarantee.value - -instrument.capitalGuarantee.value - instrument.capitalGuarantee.distance.absolute - -instrument.capitalGuarantee.distance.absolute - instrument.capitalGuarantee.distance.relative - -instrument.capitalGuarantee.distance.relative - instrument.capitalGuarantee.cashFlow - -instrument.capitalGuarantee.cashFlow - instrument.couponTriggerLevel.value - -instrument.couponTriggerLevel.value - instrument.couponTriggerLevel.distance.absolute - -instrument.couponTriggerLevel.distance.absolute - instrument.couponTriggerLevel.distance.relative - -instrument.couponTriggerLevel.distance.relative - instrument.couponTriggerLevel.cashFlow - -instrument.couponTriggerLevel.cashFlow - instrument.rangeKnockOut.observation.type - -instrument.rangeKnockOut.observation.type - instrument.rangeKnockOut.upper.value - -instrument.rangeKnockOut.upper.value - instrument.rangeKnockOut.lower.value - -instrument.rangeKnockOut.lower.value - instrument.rangeKnockOut.breach.breached - -instrument.rangeKnockOut.breach.breached - instrument.rangeKnockOut.breach.datetime - -instrument.rangeKnockOut.breach.datetime - instrument.rangeKnockOut.cashFlow - -instrument.rangeKnockOut.cashFlow - instrument.participation - -instrument.participation - instrument.constantLeverage - -instrument.constantLeverage - instrument.nominalCurrency.isoCode - -instrument.nominalCurrency.isoCode - instrument.currentInterestRate.type - -instrument.currentInterestRate.type - instrument.currentInterestRate.value - -instrument.currentInterestRate.value - keyFigures.bonusYield.absolute - -keyFigures.bonusYield.absolute - keyFigures.bonusYield.relative - -keyFigures.bonusYield.relative - keyFigures.bonusYield.annualized - -keyFigures.bonusYield.annualized - keyFigures.sidewaysYield.absolute - -keyFigures.sidewaysYield.absolute - keyFigures.sidewaysYield.relative - -keyFigures.sidewaysYield.relative - keyFigures.sidewaysYield.annualized - -keyFigures.sidewaysYield.annualized - keyFigures.maximumYield.absolute - -keyFigures.maximumYield.absolute - keyFigures.maximumYield.relative - -keyFigures.maximumYield.relative - keyFigures.maximumYield.annualized - -keyFigures.maximumYield.annualized - keyFigures.agio.absolute - -keyFigures.agio.absolute - keyFigures.agio.relative - -keyFigures.agio.relative - keyFigures.agio.annualized - -keyFigures.agio.annualized - keyFigures.discount.absolute - -keyFigures.discount.absolute - keyFigures.discount.relative - -keyFigures.discount.relative - keyFigures.breakEven.breakEvenPoint - -keyFigures.breakEven.breakEvenPoint - keyFigures.spread.harmonized - -keyFigures.spread.harmonized - keyFigures.spread.relative - -keyFigures.spread.relative - keyFigures.delta.effective - -keyFigures.delta.effective - keyFigures.delta.unadjusted - -keyFigures.delta.unadjusted - keyFigures.thetaOneWeek.effective - -keyFigures.thetaOneWeek.effective - keyFigures.thetaOneWeek.unadjusted - -keyFigures.thetaOneWeek.unadjusted - keyFigures.vega.effective - -keyFigures.vega.effective - keyFigures.vega.unadjusted - -keyFigures.vega.unadjusted - keyFigures.leverage - -keyFigures.leverage - keyFigures.omega - -keyFigures.omega - keyFigures.impliedVolatility - -keyFigures.impliedVolatility - keyFigures.intrinsicValue - -keyFigures.intrinsicValue - keyFigures.timeValue - -keyFigures.timeValue - keyFigures.outperformancePoint - -keyFigures.outperformancePoint - keyFigures.parity - -keyFigures.parity - performance.intraday - -performance.intraday - performance.sinceIssue.ask - -performance.sinceIssue.ask - performance.sinceIssue.bid - -performance.sinceIssue.bid - performance.endOfDay.day1 - -performance.endOfDay.day1 - performance.endOfDay.week1 - -performance.endOfDay.week1 - performance.endOfDay.month1 - -performance.endOfDay.month1 - performance.endOfDay.months3 - -performance.endOfDay.months3 - performance.endOfDay.months6 - -performance.endOfDay.months6 - performance.endOfDay.year1 - -performance.endOfDay.year1 - performance.endOfDay.years3 - -performance.endOfDay.years3 - performance.endOfDay.years5 - -performance.endOfDay.years5 - performance.endOfDay.yearToDate - -performance.endOfDay.yearToDate - volatility.week1 - -volatility.week1 - volatility.month1 - -volatility.month1 - volatility.months3 - -volatility.months3 - volatility.months6 - -volatility.months6 - volatility.year1 - -volatility.year1 - volatility.years3 - -volatility.years3 - volatility.years5 - -volatility.years5 - volatility.yearToDate - -volatility.yearToDate maxItems: 10 uniqueItems: true default: - instrument.name pagination: type: object description: Pagination attributes for the offset-based pagination strategy. properties: offset: type: number format: int32 minimum: 0 exclusiveMinimum: false default: 0 description: Non-negative number of entries to skip, or 0 (default). limit: type: number format: int32 minimum: 0 exclusiveMinimum: false maximum: 500 exclusiveMaximum: false default: 20 description: Non-negative maximum number of entries to return. x-property-sort: - offset - limit x-property-sort: - attributes - language - sort - pagination example: example_value ColoredValue: type: object properties: text: type: string example: example_value color: $ref: '#/components/schemas/ValueColor' AdaptiveCardAnswerSuccessResponse: type: object required: - data properties: data: type: array items: $ref: '#/components/schemas/AdaptiveCardDataItem' example: [] RankedTableTemplateData: allOf: - $ref: '#/components/schemas/Template' - type: object properties: table: $ref: '#/components/schemas/RankedTable' StatusObject_2: type: object properties: code: type: number format: int32 description: The HTTP status code of the response, mirroring the code from the Status-Line of the HTTP response message (see [RFC2616] section 6.1). description: The status member contains the status code of the response. required: - code RankedTableAnswer: allOf: - $ref: '#/components/schemas/AnswerWithTitle' - type: object required: - templateData properties: templateData: $ref: '#/components/schemas/RankedTableTemplateData' AttributesMember: type: array description: Limit the attributes returned in the response to the specified set. items: type: string maxLength: 100 exclusiveMaximum: false maxItems: 50 uniqueItems: true ColoredValueLabelDateAnswer: allOf: - $ref: '#/components/schemas/AnswerWithTitle' - type: object required: - templateData properties: templateData: $ref: '#/components/schemas/ColoredValueLabelDateTemplateData' TableTableTemplateData: allOf: - $ref: '#/components/schemas/TemplateWithLinks' - type: object properties: table1: $ref: '#/components/schemas/Table' table2: $ref: '#/components/schemas/Table' ValueLabelDateTemplateData: allOf: - $ref: '#/components/schemas/TemplateWithLinks' - type: object properties: value: type: string label: type: string date: type: string Error: type: object required: - id - code - title properties: id: type: string example: abc123 code: type: string example: example_value title: type: string example: Example Title links: $ref: '#/components/schemas/ErrorLink' detail: type: string example: example_value source: $ref: '#/components/schemas/ErrorSource' PostNewsPublisherSearchByNameRequest: x-property-sort: - data - meta description: Request Body required: - data type: object properties: data: type: object x-property-sort: - searchValue - matchType - filter description: The data member contains the request's primary data. properties: searchValue: type: string minLength: 2 exclusiveMinimum: false maxLength: 50 exclusiveMaximum: true description: Restricts the search to publishers, which match the search value. The comparison for a match is case sensitive. matchType: type: string description: The match type that is applied to the search. x-enum-description: - Publisher name must begin with the searchValue. - Publisher name must end with the searchValue. - Publisher name must begin, end, or contain the searchValue. enum: - begins - ends - contains filter: description: Criteria that filter the items in the response list; only items that match all of the criteria are returned. type: object x-property-sort: - distributor - delivery properties: distributor: type: object x-property-sort: - id description: Filter for distributors. See endpoint `/news/distributor/list` for valid values. properties: id: type: number format: id32 x-positive: true description: Identifier of distributor. delivery: type: object x-property-sort: - id description: Filter for deliveries. See endpoint `/basic/delivery/list` for valid values. properties: id: type: number format: id32 x-positive: true description: Identifier of delivery. required: - searchValue - matchType example: example_value meta: type: object description: The meta member contains the meta information of the request. properties: attributes: $ref: '#/components/schemas/AttributesMember' sort: description: Sortable attributes. The sort order is ascending unless it is prefixed with a minus sign, in which case it is descending. A list of at most 1 (possibly prefixed) attribute name(s) is allowed. type: array items: type: string enum: - id - -id - name - -name maxItems: 1 uniqueItems: true default: - name x-property-sort: - attributes - sort example: example_value ErrorExample: type: object description: Error Example Object properties: code: description: Specifies the error code. type: string example: example_value title: description: ' Specifies the error message.' type: string example: Example Title id: description: Specifies the id. type: string example: abc123 ErrorSource: type: object properties: pointer: type: string example: example_value parameter: type: string example: example_value TemplateWithLinks: allOf: - $ref: '#/components/schemas/Template' - type: object required: - headline properties: applicationLinks: type: array items: $ref: '#/components/schemas/ApplicationLink' DocumentModel: type: object properties: url: type: string description: The resolved URL pointing to the location of the underlying report example: https://api.factset.com/analytics/datastore/cargo/v1/groups/a4186c50f8e74f979d271dd22298c901/objects/fe875bc4150542dea6bc237663a01a0d productType: type: string description: string property to denote what Product created this document. example: Publisher tags: type: object description: The documents tags, represented in a key value format with the tag name as the key; and the tag's value as the value example: account: TEST_ACCOUNT.ACCT benchmark: TEST_BENCHMARK additionalProperties: $ref: '#/components/schemas/StringOrNumberTagValue' description: Document model Fdc3Country: type: object required: - type - name properties: type: type: string example: example_value name: type: string example: Example Title id: $ref: '#/components/schemas/CountryID' PartialOutputObject_2: type: object properties: isPartial: type: boolean description: Flag indicating that the response is a possibly incomplete array or an object containing a possibly incomplete array, due to hitting a processing time limit. If `true`, some matching results might be missing from the array, or elements for matching results might be incorrectly included (for example, when priority sorting would have removed the element). Depending on the use case, such a response may be unsuitable. description: Object denoting that the endpoint response is possibly incomplete. required: - isPartial x-property-sort: - isPartial PostSecuritizedDerivativeIssuerSearchRequest: type: object properties: data: type: object x-property-sort: - role - name - category - underlying - factorCertificates - registrationCountry - market description: The data member contains the request's primary data. properties: role: type: string description: Specify whether legal entities in the role of an issuer or in the role of an issuer group are returned. default: issuerGroup x-enum-description: - Legal entities defined by FactSet and thus not representing an actual juristic person. - Legal entities in the role of an issuer representing an actual juristic person. enum: - issuerGroup - issuer name: type: object x-property-sort: - searchValue description: Issuer name. properties: searchValue: type: string pattern: ^[ -!#-&(-+--/0-:=?-Za-zw"]*$ minLength: 3 exclusiveMinimum: false maxLength: 100 exclusiveMaximum: false description: Text string to be searched for. category: type: object x-property-sort: - ids description: List of categories of securitized derivatives. Only issuers that have issued securitized derivatives belonging to at least one category in the provided list are returned. properties: ids: type: array nullable: false items: type: number format: id32 x-positive: true maxItems: 20 uniqueItems: true description: List of category identifiers. See endpoint `/category/listBySystem` for category systems 18 and 23 for valid values. underlying: type: object x-property-sort: - instrument description: List of underlyings of securitized derivatives. Only issuers that have issued at least one securitized derivative on an underlying in the provided list are returned. properties: instrument: type: object x-property-sort: - ids description: Underlying instrument. properties: ids: type: array nullable: false items: type: string format: id64 x-positive: true maxItems: 100 uniqueItems: true description: List of instrument identifiers. factorCertificates: type: object x-property-sort: - effectiveUnderlying description: Parameters for factor certificates. properties: effectiveUnderlying: type: object x-property-sort: - instrument description: Selection of the effective underlying. The underlying of a factor certificate is usually a factor index which is an artificial index used to calculate the leveraged daily performance of another financial instrument called its effective underlying. Only issuers that have issued at least one factor certificate on an effective underlying in the provided list are returned. properties: instrument: type: object x-property-sort: - ids description: Selection of the effective underlying using instrument identifiers. properties: ids: type: array nullable: false items: type: string format: id64 x-positive: true maxItems: 100 uniqueItems: true description: List of instrument identifiers. registrationCountry: type: object x-property-sort: - ids description: List of countries of registration for trading of securitized derivatives. Only issuers that have registered at least one securitized derivative in a country in the provided list are returned. properties: ids: type: array nullable: false items: type: number format: id32 x-positive: true maxItems: 20 uniqueItems: true description: List of country identifiers. See endpoint `/basic/region/country/list` for valid values. market: type: object x-property-sort: - ids description: List of markets where securitized derivatives are traded. Only issuers that have issued at least one securitized derivative traded on a market in the provided list are returned. properties: ids: type: array nullable: false items: type: number format: id32 x-positive: true maxItems: 20 uniqueItems: true description: List of market identifiers. See endpoint `/basic/market/list` for valid values. example: example_value meta: type: object description: The meta member contains the meta information of the request. properties: attributes: $ref: '#/components/schemas/AttributesMember' x-property-sort: - attributes example: example_value ValueChange: type: object properties: absoluteChange: type: string example: example_value percentageChange: type: string example: example_value color: $ref: '#/components/schemas/ChangeColor' LabelValueChangeLabelValueChangeAnswer: allOf: - $ref: '#/components/schemas/AnswerWithTitle' - type: object required: - templateData properties: templateData: $ref: '#/components/schemas/LabelValueChangeLabelValueChangeTemplateData' NoAnswersBase: allOf: - $ref: '#/components/schemas/DataAnswer' - type: object required: - message properties: message: type: string ValueLabelDateDataPairListTemplateData: allOf: - $ref: '#/components/schemas/TemplateWithLinks' - type: object properties: value: type: string label: type: string date: type: string list: type: array items: $ref: '#/components/schemas/DataPair' TagModel: type: object properties: name: type: string description: The name of the tag example: account type: type: string description: The type of the tag example: string enum: - string - date - datetime description: Tags model DataAnswer: type: object required: - template properties: template: type: string example: example_value LanguageMember: type: string format: isoLanguage description: ISO 639-1 code of the language. maxLength: 2 minLength: 2 exclusiveMinimum: false exclusiveMaximum: false PercentChangeLabelTemplateData: allOf: - $ref: '#/components/schemas/TemplateWithLinks' - type: object properties: percentChange: $ref: '#/components/schemas/PercentChange' label: type: string ErrorResponse: type: object description: Error Response Object properties: errors: type: array description: Errors Array Object items: $ref: '#/components/schemas/ErrorExample' example: [] TableTableAnswer: allOf: - $ref: '#/components/schemas/AnswerWithTitle' - type: object required: - templateData properties: templateData: $ref: '#/components/schemas/TableTableTemplateData' Template: type: object required: - headline properties: headline: type: string example: example_value footer: type: string example: example_value fdc3Context: $ref: '#/components/schemas/Fdc3Context' DataAnswerSuccessResponse: type: object required: - data properties: data: $ref: '#/components/schemas/DataAnswerData' TextBlockFootingTemplateData: allOf: - $ref: '#/components/schemas/TemplateWithLinks' - type: object properties: body: type: string footing: $ref: '#/components/schemas/TitledTextBlock' InvestmentResearchObject: type: object properties: headline: type: string description: Headline of the story, actual time and date of the event. example: example_value source: type: string description: Provides source of the document. example: example_value primaryIds: type: array items: type: string description: Refers to the main company a particular document refers to. example: [] allIds: type: array items: type: string description: Refers to all companies mentioned in the document. This could also include the primary company id as well. example: [] filingsDate: type: string description: Publish date of the latest version (in ET). example: example_value filingsTime: type: string description: Publish time of the latest version (in ET). example: example_value categories: type: array items: type: string description: Categories are country, industry, and subject codes. This is a comma-separated list. example: [] filingsLink: type: string description: The link to download the document. example: example_value documentId: type: string description: Unique identifier for a document. example: '500123' Table: type: object required: - tableRows properties: tableHeaders: type: array items: type: string example: [] tableRows: type: array items: type: array items: type: string example: [] tableFooters: type: array items: type: string example: [] ValueChangeDateLabelTemplateData: allOf: - $ref: '#/components/schemas/TemplateWithLinks' - type: object properties: value: type: string valueChange: $ref: '#/components/schemas/ValueChange' date: type: string label: type: string ProductTypeListResponse: type: object description: Response object for a list of documents properties: meta: $ref: '#/components/schemas/MetaModel' data: type: array items: type: string description: Array of product types example: - adf PostNotationSearchByTextRequest: x-property-sort: - data - meta description: Request Body required: - data type: object properties: data: type: object x-property-sort: - text - validation - assetClass - instrumentCategory - market description: The data member contains the request's primary data. properties: text: description: Text-related parameters. type: object x-property-sort: - attributes - value - minimumMatchScore properties: attributes: description: List of attributes to be searched in. The value `allEntitled` cannot appear with any other value. type: array nullable: false items: type: string x-enum-description: - All entitled attributes are searched in. - International Securities Identification Number of the instrument. - The WKN (Wertpapierkennnummer, German for Securities Identification Number) of the instrument. The WKN is a 6-character code of digits and upper-case letters that uniquely identifies an instrument. - 'The Valor number (German: Valorennummer) of the instrument. The Valor number is an integer number that uniquely identifies an instrument.' - The SEDOL or IDII for the notation; see entity class "SEDOL or IDII" for details. - The CUSIP (Committee on Uniform Security Identification Procedures) or CINS (CUSIP International Numbering System) identifier of the instrument. These numbers are 9-character codes of digits and upper-case letters that uniquely identify an instrument. - The symbol of the notation. It is a market-specific code to identify the notation. Which characters can be part of a symbol depends on the market. If a market does not define a proprietary symbol, but uses a different identifier (for example, the ISIN or the WKN) to identify instruments, no symbol will be set for the notations of that market. - Symbol of an option or a future, as normalized by FactSet. - Long name of the instrument. - Short name of the instrument. enum: - allEntitled - isin - wkn - valor - sedol - cusip - symbol - normalizedSymbol - longName - shortName uniqueItems: true maxItems: 8 default: - allEntitled value: type: string minLength: 2 exclusiveMinimum: false maxLength: 50 exclusiveMaximum: false pattern: ^[ -+--/0-:=?@\p{L}]*$ description: Full-text search string. It may be enclosed in double quotes ("). No escaping is provided, therefore it is impossible to specify a search string containing double quotes. Relevance of word starts is indicated by a phrase starting with a space character, such as " daimler". If only two characters are submitted, the search is executed as an exact search. minimumMatchScore: type: number format: real minimum: 0.1 exclusiveMinimum: false maximum: 1 exclusiveMaximum: false description: "Minimum match score for the text string. The match score has a value between 0 and 1 (inclusive), where a higher value indicates a better match than a lower one. \nExamples for the two most relevant thresholds: \n0.25: Exact substring match after case-folding and modifier elimination - \"Mnchner Rck\" is a match for the search string \"Munch\" but not for \"Muench\". \n 0.50: Exact substring match - \"Mnchner Rck\" is a match for the search string \"Mnch\" but not for \"Munch\" or \"mnch\"." default: 0.25 required: - value validation: description: Validation parameters. type: object x-property-sort: - onlyActive - prices - valueUnit - market - instrumentSelectionList - notationSelectionList properties: onlyActive: description: If `true`, only active notations will be returned. The term "active" reflects the fact that notations and related data is not being deleted immediately after becoming irrelevant (e.g. because the source does not provide a price anymore), but remains in general retrievable for up to 6 months. type: boolean default: true prices: description: Price-related parameters. type: object x-property-sort: - quality - latest - previous properties: quality: type: string description: Quality of the price. default: EOD x-enum-description: - 'Delayed: intraday prices with an exchange-imposed delay of usually 15 to 30 minutes.' - 'End-of-day: prices updated once per day after the close of trading, possibly with an exchange-imposed delay of several hours or days.' enum: - DLY - EOD latest: description: Parameters related to the presence and age of the most recent trade price. type: object x-property-sort: - availableOnly - minimumDate properties: availableOnly: description: If `true`, only notations for which a trade price (even an outdated one) is available will be returned. type: boolean minimumDate: description: Earliest admissible date of the most recent trade price. type: string format: date previous: description: Parameters related to the presence and age of a trade price from a preceding trading day. type: object x-property-sort: - availableOnly - minimumDate properties: availableOnly: description: If `true`, only notations for which a trade price from a preceding trading day is available will be returned. type: boolean minimumDate: description: Earliest admissible date of the trade price from a preceding trading day. type: string format: date valueUnit: description: Value unit-related parameters. See endpoint `/basic/valueUnit/list` for valid values. type: object x-property-sort: - restrict - exclude x-atMostOne: true properties: restrict: description: Specifies the value units a notation may have. type: object x-property-sort: - ids properties: ids: description: Set of value unit identifiers. type: array nullable: false items: type: number format: id32 x-positive: true uniqueItems: true maxItems: 100 exclude: description: Specifies the value units a notation may not have. type: object x-property-sort: - ids properties: ids: description: Set of value unit identifiers. type: array nullable: false items: type: number format: id32 x-positive: true uniqueItems: true maxItems: 100 market: description: Market-related parameters. See endpoint `/basic/market/list` for valid values. type: object x-property-sort: - selection - priority properties: selection: description: Market selection. type: object x-property-sort: - restrict - exclude x-atMostOne: true properties: restrict: description: Specifies the markets from which a notation may originate. type: object x-property-sort: - ids properties: ids: description: Set of market identifiers. type: array nullable: false items: type: number format: id32 x-positive: true uniqueItems: true maxItems: 100 exclude: description: Specifies the markets from which a notation may not originate. type: object x-property-sort: - ids properties: ids: description: Set of market identifiers. type: array nullable: false items: type: number format: id32 x-positive: true uniqueItems: true maxItems: 100 priority: description: "Sequence of markets specifying the priority order of the markets for the selection of one notation per instrument. If for a given instrument with two matching notations, A and B, the market of notation A precedes the market of notation B in this list or if the market of notation B is not in this list, A is selected. If neither of the markets is in this list, the notation with the highest trading volume, averaged over one month, is selected. \n The list does not restrict the request to only those markets (use the parameter `market.selection` for that purpose)." type: object x-property-sort: - ids properties: ids: description: List of market identifiers. type: array nullable: false items: type: number format: id32 x-positive: true uniqueItems: true maxItems: 100 instrumentSelectionList: description: Instrument-level restriction or exclusion. type: object x-property-sort: - restrict - exclude x-atMostOne: true properties: restrict: description: Restriction lists. If present, the result contains only notations of instruments that are a member of any of the provided lists. type: object x-property-sort: - ids properties: ids: description: Set of identifiers of restriction lists. type: array nullable: false items: type: number format: id32 x-positive: true uniqueItems: true maxItems: 3 exclude: description: Exclusion lists. If present, the result does not contain notations belonging to instruments that are a member of any of the provided lists. type: object x-property-sort: - ids properties: ids: description: Set of identifiers of exclusion lists. type: array nullable: false items: type: number format: id32 x-positive: true uniqueItems: true maxItems: 3 notationSelectionList: description: Notation-level restriction or exclusion. type: object x-property-sort: - restrict - exclude x-atMostOne: true properties: restrict: description: Restriction lists. If present, the result contains only notations that are a member of any of the provided lists. type: object x-property-sort: - ids properties: ids: description: Set of identifiers of restriction lists. type: array nullable: false items: type: number format: id32 x-positive: true uniqueItems: true maxItems: 3 exclude: description: Exclusion lists. If present, the result does not contain notations that are a member of any of the provided lists. type: object x-property-sort: - ids properties: ids: description: Set of identifiers of exclusion lists. type: array nullable: false items: type: number format: id32 x-positive: true uniqueItems: true maxItems: 3 assetClass: description: Asset class restriction. type: object x-property-sort: - ids properties: ids: description: Set of asset class identifiers. See endpoint `/basic/assetClass/list` for valid values. type: array nullable: false items: type: number format: id32 x-positive: true exclusiveMaximum: false uniqueItems: true maxItems: 12 instrumentCategory: description: Category selection. Identifiers from all entitled category systems can be used, see endpoint `/category/system/list` with `idType=1` for the list of category systems. type: object x-property-sort: - restrict - exclude x-atMostOne: true properties: restrict: description: Specifies the instrument categories that the instruments of the notations may have type: object x-property-sort: - ids properties: ids: description: Set of category identifiers. type: array nullable: false items: type: number format: id32 x-positive: true maxItems: 20 uniqueItems: true exclude: description: Specifies the instrument categories that the instruments of the notations may not have. type: object x-property-sort: - ids properties: ids: description: Set of category identifiers. type: array nullable: false items: type: number format: id32 x-positive: true maxItems: 20 uniqueItems: true market: description: Market-related notation sorting. type: object x-property-sort: - order properties: order: description: "Sequence of market identifiers specifying the first-order sort criterion for the resulting notation list; if the market of notation A precedes the market of notation B in this list, A precedes B in the result. Notations whose market is not in this list sort last. The second-order sorting of the result is given by the attribute `meta.sort`. \n The list does not restrict the request to only those markets (use the parameter `market.selection` for that purpose) and does not specify the priority order of the markets for selecting\none notation per instrument (use the parameter `market.priority` for that purpose)." type: object x-property-sort: - ids properties: ids: description: List of market identifiers. See endpoint `/basic/market/list` for valid values. type: array nullable: false items: type: number format: id32 x-positive: true uniqueItems: true maxItems: 100 required: - text example: example_value meta: type: object description: The meta member contains the meta information of the request. properties: attributes: $ref: '#/components/schemas/AttributesMember' language: $ref: '#/components/schemas/LanguageMember' sort: description: Sortable attributes. The sort order is ascending unless it is prefixed with a minus sign, in which case it is descending. A list of at most 6 (possibly prefixed) attribute name(s) is allowed. type: array items: type: string enum: - instrument.name.default.long - -instrument.name.default.long - instrument.name.default.short - -instrument.name.default.short - instrument.name.assetClassSpecific.long - -instrument.name.assetClassSpecific.long - instrument.name.assetClassSpecific.short - -instrument.name.assetClassSpecific.short - match.score - -match.score - averageIndicativeTradingValue30TD - -averageIndicativeTradingValue30TD maxItems: 6 uniqueItems: true default: - -match.score pagination: type: object description: Pagination attributes for the offset-based pagination strategy. properties: offset: type: number format: int32 minimum: 0 exclusiveMinimum: false default: 0 description: Non-negative number of entries to skip, or 0 (default). limit: type: number format: int32 minimum: 0 exclusiveMinimum: false maximum: 500 exclusiveMaximum: false default: 20 description: Non-negative maximum number of entries to return. x-property-sort: - offset - limit x-property-sort: - attributes - language - sort - pagination example: example_value ApplicationLink: type: object required: - name - webLink properties: name: type: string example: Example Title workstationLink: type: string example: example_value webLink: type: string example: example_value DataAnswerData: oneOf: - $ref: '#/components/schemas/LinkTextBlockAnswer' - $ref: '#/components/schemas/TextBlockFootingAnswer' - $ref: '#/components/schemas/PercentChangeLabelAnswer' - $ref: '#/components/schemas/ValueChangeDateLabelAnswer' - $ref: '#/components/schemas/RankedTableAnswer' - $ref: '#/components/schemas/TableAnswer' - $ref: '#/components/schemas/TableTableAnswer' - $ref: '#/components/schemas/ValueLabelAnswer' - $ref: '#/components/schemas/ValueLabelDateAnswer' - $ref: '#/components/schemas/ColoredValueLabelDateAnswer' - $ref: '#/components/schemas/ValueLabelDateTextBlockAnswer' - $ref: '#/components/schemas/ValueLabelDateDataPairListAnswer' - $ref: '#/components/schemas/LabelValueChangeLabelValueChangeAnswer' - $ref: '#/components/schemas/AnswerWithoutData' - $ref: '#/components/schemas/NoAnswersFound' discriminator: propertyName: template mapping: LinkTextBlockTemplate: '#/components/schemas/LinkTextBlockAnswer' TextBlockFootingTemplate: '#/components/schemas/TextBlockFootingAnswer' PercentChangeLabelTemplate: '#/components/schemas/PercentChangeLabelAnswer' ValueChangeDateLabelTemplate: '#/components/schemas/ValueChangeDateLabelAnswer' RankedTableTemplate: '#/components/schemas/RankedTableAnswer' TableTemplate: '#/components/schemas/TableAnswer' TableTableTemplate: '#/components/schemas/TableTableAnswer' ValueLabelTemplate: '#/components/schemas/ValueLabelAnswer' ValueLabelDateTemplate: '#/components/schemas/ValueLabelDateAnswer' ColoredValueLabelDateTemplate: '#/components/schemas/ColoredValueLabelDateAnswer' ValueLabelDateTextBlockTemplate: '#/components/schemas/ValueLabelDateTextBlockAnswer' ValueLabelDateDataPairListTemplate: '#/components/schemas/ValueLabelDateDataPairListAnswer' LabelValueChangeLabelValueChangeTemplate: '#/components/schemas/LabelValueChangeLabelValueChangeAnswer' AnswerWithoutDataTemplate: '#/components/schemas/AnswerWithoutData' NoAnswerTemplate: '#/components/schemas/NoAnswersFound' RankedTableEntity: type: object properties: name: type: string example: Example Title identifier: type: string example: example_value PostDebtInstrumentNotationScreenerSearchRequest: type: object properties: data: type: object x-property-sort: - validation - lifeCycle - subordinated - rating - issuer - issue - tradingVolume - compliance - coupon - yield - macaulayDuration - sensitivities - tradedValue description: The data member contains the request's primary data. properties: validation: description: Validation parameters. type: object x-property-sort: - onlyActive - onlyNotSuspended - prices - valueUnit - market - instrumentSelectionList - notationSelectionList - categorization properties: onlyActive: description: If `true`, only active notations will be returned. The term "active" reflects the fact that notations and related data is not being deleted immediately after becoming irrelevant (e.g. because the source does not provide a price anymore), but remains in general retrievable for up to 6 months. type: boolean default: true onlyNotSuspended: description: If `true`, only notations not suspended from trading will be returned. type: boolean default: false prices: description: Price-related parameters. type: object x-property-sort: - quality - latest - previous properties: quality: type: string description: Quality of the price. default: DLY x-enum-description: - 'Delayed: intraday prices with an exchange-imposed delay of usually 15 to 30 minutes.' - 'End-of-day: prices updated once per day after the close of trading, possibly with an exchange-imposed delay of several hours or days.' enum: - DLY - EOD latest: description: Parameters related to the presence and age of the most recent trade price. type: object x-property-sort: - availableOnly - minimumDate properties: availableOnly: description: If `true`, only notations for which a trade price (even an outdated one) is available will be returned. type: boolean minimumDate: description: Earliest admissible date of the most recent trade price. type: string format: date previous: description: Parameters related to the presence and age of a trade price from a preceding trading day. type: object x-property-sort: - availableOnly - minimumDate properties: availableOnly: description: If `true`, only notations for which a trade price from a preceding trading day is available will be returned. type: boolean minimumDate: description: Earliest admissible date of the trade price from a preceding trading day. type: string format: date valueUnit: description: Value unit selection. See endpoint `/basic/valueUnit/list` for valid values. type: object x-property-sort: - restrict - exclude x-atMostOne: true properties: restrict: description: Specifies the value units a notation may have. type: object x-property-sort: - ids properties: ids: description: Set of value unit identifiers. type: array nullable: false items: type: number format: id32 x-positive: true uniqueItems: true maxItems: 50 exclude: description: Specifies the value units a notation may not have. type: object x-property-sort: - ids properties: ids: description: Set of value unit identifiers. type: array nullable: false items: type: number format: id32 x-positive: true uniqueItems: true maxItems: 50 market: description: Market-related notation selection. See endpoint `/basic/market/list` for valid values. type: object x-property-sort: - selection - priority properties: selection: description: Market selection. type: object x-property-sort: - restrict - exclude x-atMostOne: true properties: restrict: description: Specifies the markets from which a notation may originate. type: object x-property-sort: - ids properties: ids: description: Set of market identifiers. type: array nullable: false items: type: number format: id32 x-positive: true uniqueItems: true maxItems: 100 exclude: description: Specifies the markets from which a notation may not originate. type: object x-property-sort: - ids properties: ids: description: Set of market identifiers. type: array nullable: false items: type: number format: id32 x-positive: true uniqueItems: true maxItems: 100 priority: description: "Sequence of markets specifying the priority order of the markets for the selection of one notation per instrument. If for a given instrument with two matching notations, A and B, the market of notation A precedes the market of notation B in this list or if the market of notation B is not in this list, A is selected. If neither of the markets is in this list, the notation with the highest trading volume, averaged over one month, is selected. \n The list does not restrict the request to only those markets (use the parameter `market.selection` for that purpose)." type: object x-property-sort: - ids properties: ids: description: List of market identifiers. type: array nullable: false items: type: number format: id32 x-positive: true uniqueItems: true maxItems: 100 instrumentSelectionList: description: Instrument-level restriction or exclusion. type: object x-property-sort: - restrict - exclude x-atMostOne: true properties: restrict: description: Restriction lists. If present, the result contains only notations belonging to debt instruments that are a member of any of the provided lists. type: object x-property-sort: - ids properties: ids: description: Set of identifiers of restriction lists. type: array nullable: false items: type: number format: id32 x-positive: true uniqueItems: true maxItems: 3 exclude: description: Exclusion lists. If present, the result does not contain notations belonging to debt instruments that are a member of any of the provided lists. type: object x-property-sort: - ids properties: ids: description: Set of identifiers of exclusion lists. type: array nullable: false items: type: number format: id32 x-positive: true uniqueItems: true maxItems: 3 notationSelectionList: description: Notation-level restriction or exclusion. type: object x-property-sort: - restrict - exclude x-atMostOne: true properties: restrict: description: Restriction lists. If present, the result contains only debt instrument notations that are a member of any of the provided lists. type: object x-property-sort: - ids properties: ids: description: Set of identifiers of restriction lists. type: array nullable: false items: type: number format: id32 x-positive: true uniqueItems: true maxItems: 3 exclude: description: Exclusion lists. If present, the result does not contain debt instrument notations that are a member of any of the provided lists. type: object x-property-sort: - ids properties: ids: description: Set of identifiers of exclusion lists. type: array nullable: false items: type: number format: id32 x-positive: true uniqueItems: true maxItems: 3 categorization: description: Debt instrument categorization. See endpoint `/category/listBySystem` with `id=18` for valid values. type: object x-property-sort: - restrict - exclude x-atMostOne: true properties: restrict: description: Restriction list. Only debt instruments that belong to a category in the provided list are returned. type: object x-property-sort: - ids properties: ids: description: Set of category identifiers. type: array nullable: false items: type: number format: id32 x-positive: true uniqueItems: true maxItems: 20 exclude: description: Exclusion lists. Debt instruments that belong to a category in the provided list are not returned. type: object x-property-sort: - ids properties: ids: description: Set of category identifiers. type: array nullable: false items: type: number format: id32 x-positive: true uniqueItems: true maxItems: 20 lifeCycle: description: Parameters related to important dates. type: object x-property-sort: - issue - maturity - callable properties: issue: type: object format: dateRange x-isClosedInterval: true properties: start: type: string format: date description: The starting point of the date range (inclusive), or `null` to indicate that the date range extends indefinitely into the past. x-allowNullValue: true end: type: string format: date description: The ending point of the date range (inclusive), or `null` to indicate that the date range extends indefinitely into the future. x-allowNullValue: true x-property-sort: - start - end required: - start - end description: Date range of the issue date. maturity: description: Parameters related to the maturity. type: object x-property-sort: - restriction - perpetual properties: restriction: description: The maturity can be restricted by using one of the parameters `date` or `remainingTermYears` but not both at the same time. If a maturity restriction is set, perpetual instruments, i.e. such that do not mature, are not included in the result unless the parameter `perpetual` is set to "include". type: object x-property-sort: - date - remainingTermYears x-atMostOne: true properties: date: type: object format: dateRange x-isClosedInterval: true properties: start: type: string format: date description: The starting point of the date range (inclusive), or `null` to indicate that the date range extends indefinitely into the past. x-allowNullValue: true end: type: string format: date description: The ending point of the date range (inclusive), or `null` to indicate that the date range extends indefinitely into the future. x-allowNullValue: true x-property-sort: - start - end required: - start - end description: Date range of the maturity date. remainingTermYears: description: Value range for the remaining term to maturity expressed in years. type: object format: realRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: real description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: real description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true x-allowNullValue: true x-property-sort: - minimum - maximum perpetual: type: string description: Defines whether or not perpetual debt instruments, i.e. such that do not mature, are included in the result. The value "only" can be used if both parameters `maturity.restriction.date` and `maturity.restriction.remainingTermYears` are not set. x-enum-description: - Only perpetual debt instruments are included in the result. - Perpetual debt instruments are included in the result even if one of the parameters `maturity.restriction.date` or `maturity.restriction.remainingTermYears` is set. - Perpetual debt instruments are excluded from the result. enum: - only - include - exclude callable: type: boolean description: Restricts the result to debt instruments that are callable (`true`) or are not callable (`false`). A callable instrument is one that may be redeemed by the issuer prior to maturity. subordinated: description: Restricts the result to debt instruments that are subordinated (`true`) or are not subordinated (`false`). In case of default, subordinated debt instruments are redeemed with a lower priority than non-subordinated. type: boolean rating: description: Parameters related to a rating of a debt instrument. type: object x-property-sort: - grade properties: grade: description: Rating grade. type: object x-property-sort: - minimum properties: minimum: description: Minimum rating grade. type: object x-property-sort: - ids properties: ids: description: List of rating grade identifiers. Allowed are at most two identifiers which must refer to rating grades originating from different rating systems. Only debt instruments that satisfy all conditions, i.e. are rated higher than or equal to all provided rating grades, are returned. The sequence of the provided identifiers corresponds to the response attributes `ratingSystem1` and `ratingSystem2` respectively, i.e. the rating grade of a debt instrument in the rating system of which the first identifier in the provided list is a member, is represented by the attribute `ratingSystem1.rating.grade` (and `ratingSystem1.rating.id` for the identifier of the rating grade). type: array nullable: false items: type: number format: id32 x-positive: true uniqueItems: true maxItems: 2 issuer: description: Parameters related to the issuer. type: object x-property-sort: - selection - country properties: selection: description: Issuer selection. See endpoint `/debtInstrument/issuer/search` for valid values. type: object x-property-sort: - restrict - exclude x-atMostOne: true properties: restrict: description: Restriction list. Only debt instruments issued by an issuer in the provided list are returned. type: object x-property-sort: - ids properties: ids: description: Set of identifiers of legal entities in the role of an issuer. type: array nullable: false items: type: number format: id32 x-positive: true uniqueItems: true maxItems: 100 exclude: description: Exclusion list. Debt instruments issued by an issuer in the provided list are not returned. type: object x-property-sort: - ids properties: ids: description: Set of identifiers of legal entities in the role of an issuer. type: array nullable: false items: type: number format: id32 x-positive: true uniqueItems: true maxItems: 100 country: description: Selection of the country of registration of the debt instrtuments' issuer. See endpoint `/basic/region/country/list` for valid values. type: object x-property-sort: - restrict - exclude x-atMostOne: true properties: restrict: description: Restriction list. Only debt instruments issued by an issuer whose country of registration is in the provided list are returned. type: object x-property-sort: - ids properties: ids: description: Set of country identifiers. type: array nullable: false items: type: number format: id32 x-positive: true uniqueItems: true maxItems: 50 exclude: description: Exclusion list. Debt instruments issued by an issuer whose country of registration is in the provided list are not returned. type: object x-property-sort: - ids properties: ids: description: Set of country identifiers. type: array nullable: false items: type: number format: id32 x-positive: true uniqueItems: true maxItems: 50 issue: description: Parameters related to the issue. type: object x-property-sort: - volume properties: volume: description: Issue volume. type: object x-property-sort: - currency properties: currency: description: Selection of the main currency of denomination of the issue volume. See endpoint `/basic/valueUnit/currency/main/list` for valid values. type: object x-property-sort: - restrict - exclude x-atMostOne: true properties: restrict: description: Restriction list. Only debt instruments with a main currency of denomination in the provided list are returned. type: object x-property-sort: - ids properties: ids: description: Set of main currency identifiers. type: array nullable: false items: type: number format: id32 x-positive: true uniqueItems: true maxItems: 50 exclude: description: Exclusion list. Debt instruments with a main currency of denomination in the provided list are not returned. type: object x-property-sort: - ids properties: ids: description: Set of main currency identifiers. type: array nullable: false items: type: number format: id32 x-positive: true uniqueItems: true maxItems: 50 tradingVolume: description: Parameters regarding the trading volume. The issuer of a debt instrument may define a minimum trading volume, and an increment over that minimum, per market place and for the over-the-counter (e.g. interbank) trade. Orders that do not match the defined volumes cannot be (fully) executed. The currency is the currency of denomination, thus the parameter `issue.volume.currency.restrict.ids` must be set to exactly one currency in order to use this parameter. type: object x-property-sort: - otc properties: otc: description: Volume applicable to the over-the-counter (non-exchange based) trading. type: object x-property-sort: - minimum properties: minimum: description: Value range for the minimum trading volume. type: object format: realRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: real description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: real description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true x-allowNullValue: true x-property-sort: - minimum - maximum compliance: description: Compliance properties. type: object x-property-sort: - germany properties: germany: description: Compliance properties in accordance with the German law. type: object x-property-sort: - trusteeEligible properties: trusteeEligible: type: boolean description: Defines whether or not the debt instruments are eligible for investment by trustees according to §§1806ff of the BGB (German Civil Code). The German legislative has declared such debt instruments to be virtually free of the risk of loss, such as government and state bonds. Eligible are primarily German debt instruments. coupon: description: Parameters regarding the interest rate. type: object x-property-sort: - occurrence - currentInterestRate properties: occurrence: description: Parameters regarding the occurrence and frequency of the coupon payments. type: object x-property-sort: - type - frequency properties: type: type: array nullable: false items: type: string x-enum-description: - Include debt instruments that do not pay a coupon. - Include debt instruments that pay a coupon only once. - Include debt instruments that pay a coupon on a repeated basis, possibly further limited by `occurrence.frequency`. enum: - never - once - repeated description: Occurrence type of the coupon payments. uniqueItems: true frequency: description: Frequency of the coupon payments. This filter is only applied to debt instruments whose `coupon.occurrence.type` is `repeated`. If this parameter is set, `occurrence.type` must include the value `repeated` or must not be set (in which case `repeated` is implied). type: object x-property-sort: - ids properties: ids: description: List of frequency identifiers. See endpoint `/basic/frequency/type/list` for valid values. type: array nullable: false items: type: number format: id32 x-positive: true uniqueItems: true maxItems: 9 currentInterestRate: description: Interest rate of the current coupon period. Not available for debt instruments with an occurrence type of the coupon payments "never". type: object x-property-sort: - type - value properties: type: description: Type of the interest rate. type: object x-property-sort: - ids properties: ids: description: List of interest rate type identifiers. See endpoint `/instrument/coupon/interestRate/type/list` for valid values. type: array nullable: false items: type: number format: id32 x-positive: true uniqueItems: true maxItems: 5 value: description: Value range for the interest rate of the current coupon period; annualized if the payment frequency is not "annually". Not available for debt instruments with a current interest rate type other than "fixed rate" (`id=2`) or "step/reset" (`id=5`). type: object format: relativeValueRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: relativeValue description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: relativeValue description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true x-allowNullValue: true x-property-sort: - minimum - maximum yield: description: Parameters related to the yield. type: object x-property-sort: - current - toMaturity - spread properties: current: description: Value range for the current yield, which is the next annual interest payment divided by the price. If the coupon period is different than a year, the interest payment is annualized. type: object format: relativeValueRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: relativeValue description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: relativeValue description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true x-allowNullValue: true x-property-sort: - minimum - maximum toMaturity: description: Value range for the yield to maturity, which is the annual rate of return, assuming the instrument is held until maturity. type: object format: relativeValueRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: relativeValue description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: relativeValue description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true x-allowNullValue: true x-property-sort: - minimum - maximum spread: description: Value range for the credit spread (the difference in yield to maturity) between a debt instrument and its benchmark bond. See endpoint `/instrument/benchmark/list` for the benchmark bond. type: object format: relativeValueRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: relativeValue description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: relativeValue description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true x-allowNullValue: true x-property-sort: - minimum - maximum macaulayDuration: description: Value range for the Macaulay duration, which is the average period (in years) of capital commitment. type: object format: realRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: real description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: real description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true x-allowNullValue: true x-property-sort: - minimum - maximum sensitivities: description: Parameters related to the price sensitivities of debt instruments with respect to the prevailing market interest rate. type: object x-property-sort: - basePointValue - modifiedDuration - elasticity - convexity properties: basePointValue: description: Value range for the base point value, which is the change of the debt instrument's price for a one base point change (nominally, not relatively) of the prevailing market interest rate. One base point is equivalent to 0.01 percent (1/100 of a percent). The unit of the base point value is the value unit of the notation, thus the parameter `validation.valueUnit.restrict.ids` must be set to exactly one value unit in order to use the parameter. type: object format: realRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: real description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: real description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true x-allowNullValue: true x-property-sort: - minimum - maximum modifiedDuration: description: Value range for the modified duration, which is the percentage change of the debt instrument's price for a one percent change (nominally, not relatively) of the prevailing market interest rate. type: object format: relativeValueRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: relativeValue description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: relativeValue description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true x-allowNullValue: true x-property-sort: - minimum - maximum elasticity: description: Value range for the yield elasticity, which is the ratio of the percentage change of the debt instrument's price for a one percent change (relatively, not nominally) of the prevailing market interest rate. type: object format: relativeValueRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: relativeValue description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: relativeValue description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true x-allowNullValue: true x-property-sort: - minimum - maximum convexity: description: Value range for the convexity, which is a measure for the change of the modified duration as the prevailing market interest rate changes. type: object format: realRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: real description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: real description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true x-allowNullValue: true x-property-sort: - minimum - maximum tradedValue: description: Parameters regarding the cash flow for all transactions over a certain time range. The currency is the currency of denomination, thus the parameter `issue.volume.currency.restrict.ids` must be set to exactly one currency in order to use these parameters. type: object x-property-sort: - days30 properties: days30: description: Cash flow for the time range 30 trading days. type: object x-property-sort: - sum - average properties: sum: description: Value range for the sum of the cash flow. type: object format: realRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: real description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: real description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true x-allowNullValue: true x-property-sort: - minimum - maximum average: description: Value range for the average daily cash flow. type: object format: realRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: real description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: real description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true x-allowNullValue: true x-property-sort: - minimum - maximum example: example_value meta: type: object description: The meta member contains the meta information of the request. properties: attributes: $ref: '#/components/schemas/AttributesMember' language: $ref: '#/components/schemas/LanguageMember' sort: description: Sortable attributes. The sort order is ascending unless it is prefixed with a minus sign, in which case it is descending. A list of at most 10 (possibly prefixed) attribute name(s) is allowed. type: array items: type: string enum: - valueUnit.code - -valueUnit.code - market.name - -market.name - symbol - -symbol - instrument.name - -instrument.name - instrument.shortName - -instrument.shortName - instrument.categorization.level1.name - -instrument.categorization.level1.name - instrument.categorization.level2.name - -instrument.categorization.level2.name - instrument.categorization.level3.name - -instrument.categorization.level3.name - instrument.lifeCycle.issue - -instrument.lifeCycle.issue - instrument.lifeCycle.maturity.date - -instrument.lifeCycle.maturity.date - instrument.lifeCycle.maturity.remainingTermYears - -instrument.lifeCycle.maturity.remainingTermYears - instrument.lifeCycle.maturity.perpetual - -instrument.lifeCycle.maturity.perpetual - instrument.lifeCycle.callable - -instrument.lifeCycle.callable - instrument.subordinated - -instrument.subordinated - instrument.ratingSystem1.rating.grade - -instrument.ratingSystem1.rating.grade - instrument.ratingSystem2.rating.grade - -instrument.ratingSystem2.rating.grade - instrument.issuer.name - -instrument.issuer.name - instrument.issuer.country.name - -instrument.issuer.country.name - instrument.issue.volume.currency.isoCode - -instrument.issue.volume.currency.isoCode - instrument.tradingVolume.otc.minimum - -instrument.tradingVolume.otc.minimum - instrument.compliance.germany.trusteeEligible - -instrument.compliance.germany.trusteeEligible - instrument.coupon.occurrence.frequency.name - -instrument.coupon.occurrence.frequency.name - instrument.coupon.currentInterestRate.type.name - -instrument.coupon.currentInterestRate.type.name - instrument.coupon.currentInterestRate.value - -instrument.coupon.currentInterestRate.value - yield.current - -yield.current - yield.toMaturity - -yield.toMaturity - yield.spread - -yield.spread - macaulayDuration - -macaulayDuration - sensitivities.basePointValue - -sensitivities.basePointValue - sensitivities.modifiedDuration - -sensitivities.modifiedDuration - sensitivities.elasticity - -sensitivities.elasticity - sensitivities.convexity - -sensitivities.convexity - tradedValue.days30.sum - -tradedValue.days30.sum - tradedValue.days30.average - -tradedValue.days30.average maxItems: 10 uniqueItems: true default: - instrument.name pagination: type: object description: Pagination attributes for the offset-based pagination strategy. properties: offset: type: number format: int32 minimum: 0 exclusiveMinimum: false default: 0 description: Non-negative number of entries to skip, or 0 (default). limit: type: number format: int32 minimum: 0 exclusiveMinimum: false maximum: 500 exclusiveMaximum: false default: 20 description: Non-negative maximum number of entries to return. x-property-sort: - offset - limit x-property-sort: - attributes - language - sort - pagination example: example_value ValueLabelDateDataPairListAnswer: allOf: - $ref: '#/components/schemas/AnswerWithTitle' - type: object required: - templateData properties: templateData: $ref: '#/components/schemas/ValueLabelDateDataPairListTemplateData' ValueLabelDateTextBlockTemplateData: allOf: - $ref: '#/components/schemas/TemplateWithLinks' - type: object properties: value: type: string label: type: string date: type: string text: type: string TagFilterModel: type: object description: Request object for requesting product types properties: meta: $ref: '#/components/schemas/MetaRequestModel' data: type: object properties: tags: type: object description: The documents tags, represented in a key value format with the tag name as the key; and the tag's value as the value example: account: TEST_ACCOUNT.ACCT benchmark: TEST_BENCHMARK additionalProperties: type: string example: example_value RankedTableRow: type: object required: - rank properties: rank: type: number example: 42.5 entity: $ref: '#/components/schemas/RankedTableEntity' applicationLink: $ref: '#/components/schemas/ApplicationLink' additionalData: type: array items: type: string example: [] AnswerFailureResponse: type: object required: - errors properties: errors: type: array items: $ref: '#/components/schemas/Error' example: [] CursorBasedPaginationOutputObjectWithoutTotal: type: object description: Pagination attributes for the cursor-based pagination strategy; a total element count is not supported. properties: next: type: string description: The next cursor position to use in the parameter `pagination.cursor` for an endpoint that supports cursor-based pagination, otherwise `null`. example: example_value previous: type: string description: The previous cursor position to use in the parameter `pagination.cursor` for an endpoint that supports cursor-based pagination. If a previous cursor position is not supported or available, `previous` is `null`. example: example_value required: - next - previous x-property-sort: - next - previous responses: PostDebtInstrumentNotationScreenerSearch200Response: description: Successful Response content: application/json: schema: type: object properties: data: description: List of notations. nullable: false type: array items: type: object nullable: false x-property-sort: - id - valueUnit - market - symbol - nsin - fsym - instrument - yield - macaulayDuration - sensitivities - tradedValue properties: id: nullable: true description: Identifier of the notation. type: string format: id64 x-positive: true valueUnit: nullable: false description: Value unit of the notation such as a main or fractional currency for equities, a percentage for debt instruments, or points for indices. See endpoint `/basic/valueUnit/list` for possible values. type: object x-property-sort: - id - code properties: id: nullable: true description: Identifier of the value unit. type: number format: id32 x-positive: true code: nullable: true description: 'Code of the value unit: If assigned, a code according to ISO 4217, otherwise a local code, for a main currency; a code such as GBp (for British pence) for a fractional currency; or a code such as PT (points) for non-currency value units.' x-sortable: true type: string market: nullable: false description: Market of the notation. type: object x-property-sort: - id - name properties: id: nullable: true description: Identifier of the market. type: number format: id32 x-positive: true name: nullable: true description: Name of the market. x-sortable: true type: string format: localizedString symbol: nullable: true description: The symbol of the notation. It is a market-specific code to identify the notation. Which characters can be part of a symbol depends on the market. If a market does not define a proprietary symbol, but uses a different identifier (for example, the ISIN or the WKN) to identify instruments, no symbol will be set for the notations of that market. x-sortable: true type: string nsin: nullable: false description: NSIN data of the notation. type: object x-property-sort: - sedol properties: sedol: nullable: true description: The SEDOL or IDII for the notation. type: string fsym: nullable: false type: object x-property-sort: - listing - regional description: Notation-level FactSet identifiers of the financial instrument used primarily in FactSet products other than the MDG. properties: listing: nullable: false type: object x-property-sort: - permanentIdentifier - tickerExchange - isPrimary description: Listing-level identifiers. properties: permanentIdentifier: nullable: true type: string description: FactSet Permanent Identifier for a notation. The format is six alpha numeric characters, excluding vowels, with an L suffix (XXXXXX-L). tickerExchange: nullable: true type: string description: 'FactSet market symbol of the notation, usually consisting of the ticker (e.g. "DAI" for Daimler AG) and the three-character code of the exchange on which the listing is traded (example: DAI-ETR).' isPrimary: nullable: true type: boolean description: Indicates whether the notation is the primary notation among all notations within the same region (`true`) or not (`false`). regional: nullable: false type: object x-property-sort: - permanentIdentifier - tickerRegion - isPrimary description: Regional-level identifiers. properties: permanentIdentifier: nullable: true type: string description: FactSet Permanent Identifier for a set of one or more notations of the same region with the same value unit. The format is six alpha numeric characters, excluding vowels, with an R suffix (XXXXXX-R). tickerRegion: nullable: true type: string description: 'FactSet regional symbol of the notation, consisting of the ticker and the two-character code of the country or region where the listing is traded (example: DAI-DE).' isPrimary: nullable: true type: boolean description: Indicates whether the notation is in the primary region of the security (`true`) or not (`false`). instrument: nullable: false description: Instrument data of the notation. type: object x-property-sort: - id - name - shortName - isin - nsin - fsym - categorization - lifeCycle - subordinated - ratingSystem1 - ratingSystem2 - issuer - issue - tradingVolume - compliance - coupon properties: id: nullable: true description: Identifier of the instrument. type: string format: id64 x-positive: true name: nullable: true description: Name of the instrument. x-sortable: true x-default-sort-attribute: true x-default-sort-direction: 1 type: string format: localizedString shortName: nullable: true description: Short name of the instrument. x-sortable: true type: string format: localizedString isin: nullable: true description: The International Securities Identification Number (ISIN) of the instrument. The ISIN is a 12-character code of digits and upper-case letters that uniquely identifies an instrument. type: string format: isin nsin: nullable: false description: NSIN data of the instrument. type: object x-property-sort: - wkn - valor - cusip properties: wkn: nullable: true description: The WKN (Wertpapierkennnummer, German for Securities Identification Number) of the instrument. The WKN is a 6-character code of digits and upper-case letters that uniquely identifies an instrument. type: string valor: nullable: true description: 'The Valor number (German: Valorennummer) of the instrument. The Valor number is an integer number that uniquely identifies an instrument.' type: string cusip: nullable: true description: The CUSIP (Committee on Uniform Security Identification Procedures) or CINS (CUSIP International Numbering System) identifier of the instrument. These numbers are 9-character codes of digits and upper-case letters that uniquely identify an instrument. type: string fsym: nullable: false type: object x-property-sort: - security description: Instrument-level FactSet identifier of the financial instrument used primarily in FactSet products other than the MDG. properties: security: nullable: false type: object x-property-sort: - permanentIdentifier description: Security-level identifier. properties: permanentIdentifier: nullable: true type: string description: FactSet Permanent Identifier for an instrument. The format is six alpha numeric characters, excluding vowels, with an S suffix (XXXXXX-S). categorization: nullable: false type: object x-property-sort: - level1 - level2 - level3 description: Debt instrument categorization. See endpoint `/category/listBySystem` with `id=18` for valid values. properties: level1: nullable: false type: object x-property-sort: - id - name description: First, most coarse, level of categorization. properties: id: nullable: true description: Identifier of the category. type: number format: id32 x-positive: true name: nullable: true description: Name of the category. x-sortable: true type: string format: localizedString level2: nullable: false type: object x-property-sort: - id - name description: Second level of categorization. properties: id: nullable: true description: Identifier of the category. type: number format: id32 x-positive: true name: nullable: true description: Name of the category. x-sortable: true type: string format: localizedString level3: nullable: false type: object x-property-sort: - id - name description: Third, most detailed, level of categorization. properties: id: nullable: true description: Identifier of the category. type: number format: id32 x-positive: true name: nullable: true description: Name of the category. x-sortable: true type: string format: localizedString lifeCycle: nullable: false description: Important dates of the debt instrument. type: object x-property-sort: - issue - maturity - callable properties: issue: nullable: true description: Date of the issue. x-sortable: true type: string format: date maturity: nullable: false description: Maturity data. type: object x-property-sort: - date - remainingTermYears - perpetual properties: date: nullable: true description: Date of the debt instrument's maturity. The value is empty if the instrument is perpetual. x-sortable: true type: string format: date remainingTermYears: nullable: true description: Remaining term to maturity expressed in years. x-sortable: true type: number format: real perpetual: nullable: true description: If `true`, the debt instrument is perpetual, i.e. it does not mature, therefore the attribute `date` is `null`. x-sortable: true type: boolean callable: nullable: true description: If `true`, the issuer may redeem the instrument prior to maturity. x-sortable: true type: boolean subordinated: nullable: true description: If `true`, the debt instrument is subordinated. x-sortable: true type: boolean ratingSystem1: nullable: false description: Rating of the debt instrument according to the rating system of the first identifier in the list provided in the parameter `rating.grade.minimum.ids`. type: object x-property-sort: - rating properties: rating: nullable: false description: Rating of the debt instrument. See endpoint `/rating/grade/listBySystem` with the identifier of the respective rating system for possible values. See endpoint `/rating/grade/get` with the identifier of the rating grade for the identifier of the rating system. type: object x-property-sort: - id - grade properties: id: nullable: true description: Identifier of the rating grade. type: number format: id32 x-positive: true grade: nullable: true description: Rating grade. x-sortable: true type: string ratingSystem2: nullable: false description: Rating of the debt instrument according to the rating system of the second identifier in the list provided in the parameter `rating.grade.minimum.ids`. type: object x-property-sort: - rating properties: rating: nullable: false description: Rating of the debt instrument. See endpoint `/rating/grade/listBySystem` with the identifier of the respective rating system for possible values. See endpoint `/rating/grade/get` with the identifier of the rating grade for the identifier of the rating system. type: object x-property-sort: - id - grade properties: id: nullable: true description: Identifier of the rating grade. type: number format: id32 x-positive: true grade: nullable: true description: Rating grade. x-sortable: true type: string issuer: nullable: false description: Issuer of the debt instrument. See endpoint `/legalEntity/list` for possible values. type: object x-property-sort: - id - name - country properties: id: nullable: true description: Identifier of the issuer. type: number format: id32 x-positive: true name: nullable: true description: Name of the issuer. x-sortable: true type: string country: nullable: false description: Country of registration of the issuer. See endpoint `/basic/region/country/list` for possible values. type: object x-property-sort: - id - name properties: id: nullable: true description: Identifier of the country. type: number format: id32 x-positive: true name: nullable: true description: Name of the country. x-sortable: true type: string format: localizedString issue: nullable: false description: Issue data of the debt instrument. type: object x-property-sort: - volume properties: volume: nullable: false description: Issue volume data. type: object x-property-sort: - currency properties: currency: nullable: false description: Main currency of denomination of the issue volume. See endpoint `/basic/valueUnit/currency/main/list` for possible values. type: object x-property-sort: - id - isoCode properties: id: nullable: true description: Identifier of the currency. type: number format: id32 x-positive: true isoCode: nullable: true description: ISO 4217 code of the currency. x-sortable: true type: string tradingVolume: nullable: false description: Requirements regarding the trading volume. The currency is the currency of denomination (see attribute `issue.volume.currency`), thus the values are not comparable if debt instruments with different currencies of denomination are among the results. type: object x-property-sort: - otc properties: otc: nullable: false description: Volume applicable to the over-the-counter (non-exchange based) trading. type: object x-property-sort: - minimum properties: minimum: nullable: true description: Minimum trading volume. x-sortable: true type: number format: real compliance: nullable: false description: Compliance properties. type: object x-property-sort: - germany properties: germany: nullable: false description: Compliance properties in accordance with the German law. type: object x-property-sort: - trusteeEligible properties: trusteeEligible: nullable: true x-sortable: true type: boolean description: If `true`, the debt instrument is eligible for investments by trustees according to §§1806ff of the BGB (German Civil Code). The German legislative has declared it to be virtually free of the risk of loss, such as government and state bonds. Eligible are primarily German debt instruments. coupon: nullable: false description: Interest rate details. type: object x-property-sort: - occurrence - currentInterestRate properties: occurrence: nullable: false description: Occurrence and frequency of the coupon payments. type: object x-property-sort: - type - frequency properties: type: nullable: true type: string description: Occurrence type of the coupon payments. x-enum-description: - The debt instrument does not pay out a coupon. - The debt instrument pays out a coupon only once. - The debt instrument pays out a coupon on a repeated basis. enum: - never - once - repeated frequency: nullable: false description: Frequency of the coupon payments. Information about the frequency is available only if the attribute `occurrence.type` is set to `repeated`. See endpoint `/basic/frequency/type/list` for possible values of the frequency. type: object x-property-sort: - id - name properties: id: nullable: true description: Identifier of the frequency. type: number format: id32 x-positive: true name: nullable: true description: Name of the frequency. x-sortable: true type: string format: localizedString currentInterestRate: nullable: false description: Details of the current coupon period. type: object x-property-sort: - type - value properties: type: nullable: false description: Type of the interest rate, see endpoint `/instrument/coupon/interestRate/type/list` for possible values. type: object x-property-sort: - id - name properties: id: nullable: true description: Identifier of the type. type: number format: id32 x-positive: true name: nullable: true description: Name of the type. x-sortable: true type: string format: localizedString value: nullable: true x-sortable: true type: number format: relativeValue description: Value of the interest rate; annualized if the payment frequency is not "annually". See endpoint `/instrument/coupon/keyData/get` for details regarding the current period. yield: nullable: false description: Yield-related key figures. type: object x-property-sort: - current - toMaturity - spread properties: current: nullable: true x-sortable: true type: number format: relativeValue description: Current yield, which is the next annual interest payment divided by the price. If the coupon period is different than a year, the interest payment is annualized. toMaturity: nullable: true x-sortable: true type: number format: relativeValue description: Yield to maturity, which is the annual rate of return, assuming the instrument is held until maturity. spread: nullable: true x-sortable: true type: number format: relativeValue description: Credit spread, which is the difference in yield to maturity between a highest-quality debt instrument, also called a benchmark bond, and the debt instrument. See endpoint `/instrument/benchmark/list` for the benchmark bond. macaulayDuration: nullable: true x-sortable: true type: number format: real description: Macaulay duration, which is the average period (in years) of capital commitment. sensitivities: nullable: false description: Price sensitivities of the debt instrument with respect to the prevailing market interest rate. type: object x-property-sort: - basePointValue - modifiedDuration - elasticity - convexity properties: basePointValue: nullable: true x-sortable: true type: number format: real description: Base point value, which is the change of the debt instrument's price for a one base point change (nominally, not relatively) of the prevailing market interest rate. One base point is equivalent to 0.01 percent (1/100 of a percent). The unit of the base point value is the value unit of the notation (see attribute `valueUnit`), thus the values are not comparable if notations with different value units are among the results. modifiedDuration: nullable: true x-sortable: true type: number format: relativeValue description: Modified duration, which is the percentage change of the debt instrument's price for a one percent change (nominally, not relatively) of the prevailing market interest rate. elasticity: nullable: true x-sortable: true type: number format: real description: Yield elasticity, which is the ratio of the percentage change of the debt instrument's price for a one percent change (relatively, not nominally) of the prevailing market interest rate. convexity: nullable: true x-sortable: true type: number format: real description: Convexity, which is a measure for the change of the modified duration as the prevailing market interest rate changes. tradedValue: nullable: false description: Cash flow for all transactions over a certain time range. The currency is the currency of denomination (see attribute `issue.volume.currency`), thus the values are not comparable if debt instruments with different currencies of denomination are among the results. type: object x-property-sort: - days30 properties: days30: nullable: false description: Cash flow for the time range 30 trading days. type: object x-property-sort: - sum - average properties: sum: nullable: true x-sortable: true type: number format: real description: Sum of the cash flow. average: nullable: true x-sortable: true type: number format: real description: Average daily cash flow. x-partial: true meta: type: object description: The meta member contains the meta information of the response. properties: status: $ref: '#/components/schemas/StatusObject' pagination: $ref: '#/components/schemas/OffsetBasedPaginationOutputObject' partial: $ref: '#/components/schemas/PartialOutputObject' x-property-sort: - status - pagination - partial GetRecommendationListSearch200Response: description: Successful Response content: application/json: schema: type: object properties: data: description: List of recommendation lists. nullable: false type: array items: type: object nullable: false x-property-sort: - id - name - activeRange - numberRevisions - activeRevision description: Recommendation list. properties: id: nullable: true type: number format: id32 x-positive: true description: Identifier of the recommendation list. name: nullable: true type: string description: Name of the recommendation list. activeRange: nullable: true type: object format: timeRange properties: start: nullable: true type: string format: datetime description: The starting point of the time range (inclusive), or `null` to indicate that the time range extends indefinitely into the past. end: nullable: true type: string format: datetime description: The ending point of the time range (exclusive), or `null` to indicate that the time range extends indefinitely into the future. x-property-sort: - start - end required: - start - end description: Time range during which the recommendation list is active or has been active. numberRevisions: nullable: true type: number format: int32 x-positive: true description: Number of all revisions of this recommendation list. activeRevision: nullable: false type: object x-property-sort: - id - title - activeRange description: Information on the active revision of this recommendation list, or null. properties: id: nullable: true type: number format: id32 x-positive: true description: Identifier of the currently active revision. title: nullable: true type: string format: localizedString description: The language specific name assigned to the recommendation list as of the given revision. activeRange: nullable: true type: object format: timeRange properties: start: nullable: true type: string format: datetime description: The starting point of the time range (inclusive), or `null` to indicate that the time range extends indefinitely into the past. end: nullable: true type: string format: datetime description: The ending point of the time range (exclusive), or `null` to indicate that the time range extends indefinitely into the future. x-property-sort: - start - end required: - start - end description: Time range during which the revision is, was, or will be active. meta: type: object description: The meta member contains the meta information of the response. properties: status: $ref: '#/components/schemas/StatusObject' x-property-sort: - status GetInstrumentSearchBasic200Response: description: Successful Response content: application/json: schema: type: object properties: data: type: array description: List of instruments. nullable: false items: type: object nullable: false x-property-sort: - id - name - isin - nsin - fsym - assetClass - type description: The data member contains a list of the matching instruments properties: id: nullable: true type: string format: id64 x-positive: true description: Identifier of the instrument. name: nullable: true type: string description: Asset class-unspecific name in English. isin: nullable: true type: string format: isin description: The International Securities Identification Number (ISIN) of the instrument. The ISIN is a 12-character code of digits and upper-case letters that uniquely identifies an instrument. nsin: nullable: false type: object x-property-sort: - wkn - valor - cusip - sedol description: NSIN data of the instrument. properties: wkn: nullable: true type: string description: The WKN (Wertpapierkennnummer, German for Securities Identification Number) of the instrument. The WKN is a 6-character code of digits and upper-case letters that uniquely identifies an instrument. valor: nullable: true type: string description: 'The Valor number (German: Valorennummer) of the instrument. The Valor number is an integer number that uniquely identifies an instrument.' cusip: nullable: true type: string description: The CUSIP (Committee on Uniform Security Identification Procedures) or CINS (CUSIP International Numbering System) identifier of the instrument. These numbers are 9-character codes of digits and upper-case letters that uniquely identify an instrument. sedol: nullable: true type: string description: The SEDOL or IDII for the instrument. fsym: nullable: false type: object x-property-sort: - security description: Instrument-level FactSet identifier of the financial instrument used primarily in FactSet products other than the MDG. properties: security: nullable: false type: object x-property-sort: - permanentIdentifier description: Security-level identifier. properties: permanentIdentifier: nullable: true type: string description: FactSet Permanent Identifier for an instrument. The format is six alpha numeric characters, excluding vowels, with an S suffix (XXXXXX-S). assetClass: nullable: true type: string description: Name of the asset class of the instrument. Possible values are listed in the enumeration in the parameter description. type: nullable: false description: Instrument type as defined by FactSet Digital Solutions. Instrument categories are arranged in a hierarchy, with level 1 representing the most coarse granularity and further levels successively refining the granularity (see MDG category system 18). type: array items: type: object nullable: false x-property-sort: - id - name properties: id: nullable: true type: number format: id32 x-positive: true description: Identifier of the category. name: nullable: true type: string format: localizedString description: Name of the category. x-partial: true meta: type: object description: The meta member contains the meta information of the response. properties: status: $ref: '#/components/schemas/StatusObject' pagination: $ref: '#/components/schemas/OffsetBasedPaginationOutputObject' partial: $ref: '#/components/schemas/PartialOutputObject' x-property-sort: - status - pagination - partial x-property-sort: - data - meta PostNotationSearchByText200Response: description: Successful Response content: application/json: schema: type: object properties: data: type: array description: List of matching and selected notations. nullable: false items: type: object nullable: false x-property-sort: - id - valueUnit - market - symbol - nsin - fsym - instrument - match - averageIndicativeTradingValue30TD properties: id: nullable: true type: string format: id64 x-positive: true description: Identifier of a notation. valueUnit: nullable: false description: Value unit of the notation such as a main or fractional currency for equities, a percentage for debt instruments, or points for indices. See endpoint `/basic/valueUnit/list` for possible values. type: object x-property-sort: - id - code properties: id: nullable: true type: number format: id32 x-positive: true description: Identifier of the value unit. code: nullable: true type: string description: 'Code of the value unit: If assigned, a code according to ISO 4217, otherwise a local code, for a main currency; a code such as GBp (for British pence) for a fractional currency; or a code such as PT (points) for non-currency value units.' market: nullable: false description: Market of the notation. See endpoint `/basic/market/list` for possible values. type: object x-property-sort: - id - name properties: id: nullable: true type: number format: id32 x-positive: true description: Identifier of the market. name: nullable: true type: string format: localizedString description: Name of the market. symbol: nullable: true type: string description: The symbol of the notation. It is a market-specific code to identify the notation. Which characters can be part of a symbol depends on the market. If a market does not define a proprietary symbol, but uses a different identifier (for example, the ISIN or the WKN) to identify instruments, no symbol will be set for the notations of that market. nsin: nullable: false type: object x-property-sort: - sedol description: NSIN data of the notation. properties: sedol: nullable: true type: string description: The SEDOL or IDII for the notation. fsym: nullable: false type: object x-property-sort: - listing - regional description: Notation-level FactSet identifiers of the financial instrument used primarily in FactSet products other than the MDG. properties: listing: nullable: false type: object x-property-sort: - permanentIdentifier - tickerExchange - isPrimary description: Listing-level identifiers. properties: permanentIdentifier: nullable: true type: string description: FactSet Permanent Identifier for a notation. The format is six alpha numeric characters, excluding vowels, with an L suffix (XXXXXX-L). tickerExchange: nullable: true type: string description: 'FactSet market symbol of the notation, usually consisting of the ticker (e.g. "DAI" for Daimler AG) and the three-character code of the exchange on which the listing is traded (example: DAI-ETR).' isPrimary: nullable: true type: boolean description: Indicates whether the notation is the primary notation among all notations within the same region (`true`) or not (`false`). regional: nullable: false type: object x-property-sort: - permanentIdentifier - tickerRegion - isPrimary description: Regional-level identifiers. properties: permanentIdentifier: nullable: true type: string description: FactSet Permanent Identifier for a set of one or more notations of the same region with the same value unit. The format is six alpha numeric characters, excluding vowels, with an R suffix (XXXXXX-R). tickerRegion: nullable: true type: string description: 'FactSet regional symbol of the notation, consisting of the ticker and the two-character code of the country or region where the listing is traded (example: DAI-DE).' isPrimary: nullable: true type: boolean description: Indicates whether the notation is in the primary region of the security (`true`) or not (`false`). instrument: nullable: false type: object x-property-sort: - id - name - isin - nsin - normalizedSymbol - fsym - assetClass - instrumentCategory description: Instrument data of the notation. properties: id: nullable: true type: string format: id64 x-positive: true description: Identifier of the instrument. name: nullable: false description: Instrument names. type: object x-property-sort: - default - assetClassSpecific properties: default: nullable: false description: Default instrument names. Sorting does not require an asset class selection, see parameter `assetClass.ids`. type: object x-property-sort: - long - short properties: long: nullable: true x-sortable: true type: string format: localizedString description: Long name. short: nullable: true x-sortable: true type: string format: localizedString description: Short name. assetClassSpecific: nullable: false type: object x-property-sort: - long - short description: Asset class-specific instrument names. Sorting requires that a single asset-class has been selected, see parameter `assetClass.ids`. properties: long: nullable: true x-sortable: true type: string format: localizedString description: Long name. short: nullable: true x-sortable: true type: string format: localizedString description: Short name. isin: nullable: true type: string description: International Securities Identification Number of the instrument. nsin: nullable: false type: object x-property-sort: - wkn - valor - cusip description: NSIN data of the instrument. properties: wkn: nullable: true type: string description: The WKN (Wertpapierkennnummer, German for Securities Identification Number) of the instrument. The WKN is a 6-character code of digits and upper-case letters that uniquely identifies an instrument. valor: nullable: true type: string description: 'The Valor number (German: Valorennummer) of the instrument. The Valor number is an integer number that uniquely identifies an instrument.' cusip: nullable: true type: string description: The CUSIP (Committee on Uniform Security Identification Procedures) or CINS (CUSIP International Numbering System) identifier of the instrument. These numbers are 9-character codes of digits and upper-case letters that uniquely identify an instrument. normalizedSymbol: nullable: true type: string description: Symbol of an option or a future, as normalized by FactSet. fsym: nullable: false type: object x-property-sort: - security description: Instrument-level FactSet identifier of the financial instrument used primarily in FactSet products other than the MDG. properties: security: nullable: false type: object x-property-sort: - permanentIdentifier description: Security-level identifier. properties: permanentIdentifier: nullable: true type: string description: FactSet Permanent Identifier for an instrument. The format is six alpha numeric characters, excluding vowels, with an S suffix (XXXXXX-S). assetClass: nullable: false type: object x-property-sort: - id - name description: Asset class of the instrument. See endpoint `/basic/assetClass/list` for possible values. properties: id: nullable: true type: number format: id32 x-positive: true description: Identifier of the asset class. name: nullable: true type: string description: English name of the asset class. instrumentCategory: nullable: false description: Set of categories assigned to the instrument. The set of returned categories is limited to the values provided in the request parameter `category.restrict.ids`. Empty, if `category.restrict.ids` has not been used. type: array items: type: object nullable: false x-property-sort: - id - name properties: id: nullable: true type: number format: id32 x-positive: true description: Identifier of the category. name: nullable: true type: string format: localizedString description: Name of the category. match: nullable: false description: Details of the match. type: object x-property-sort: - value - score properties: value: nullable: true type: string description: Value matched by the search string. score: nullable: true description: Match score of the string used for the search. x-sortable: true x-default-sort-attribute: true x-default-sort-direction: 2 type: number format: real averageIndicativeTradingValue30TD: nullable: true x-sortable: true type: number format: real description: Indicative daily average trading value in US dollars for the past 30 trading days. The average cash flow is converted from the notation's trading currency to US dollars using a single exchange rate determined at the end of the period. x-partial: true meta: type: object description: The meta member contains the meta information of the response. properties: status: $ref: '#/components/schemas/StatusObject' pagination: $ref: '#/components/schemas/OffsetBasedPaginationOutputObject' partial: $ref: '#/components/schemas/PartialOutputObject' x-property-sort: - status - pagination - partial x-property-sort: - data - meta PostNewsArticleSearchByText200Response: description: Successful Response content: application/json: schema: type: object properties: data: type: array description: News articles that match the filter criteria ordered by descending article time. nullable: false items: type: object nullable: false x-property-sort: - code - time - headline - summary - types - language - distributor - publisher - categories - chain - instruments properties: code: nullable: true description: Identifier of the news article. type: string time: nullable: true x-pushable: true description: Date and time of the news article. type: string format: datetime headline: nullable: true x-pushable: true description: Headline of the news article represented as text with HTML entity encoding but without HTML tags. type: string summary: nullable: true x-pushable: true description: Textual summary of the body of the news article or `null` if no summary was provided by the news article distributor. type: string types: nullable: false description: Types of news article. See endpoint `/news/article/type/list` for possible values. type: array items: type: object nullable: false x-property-sort: - id properties: id: nullable: true description: Identifier of the type of news article. type: number format: id32 x-positive: true language: nullable: false description: Language of the news article. See endpoint `/basic/language/list` for possible values. type: object x-property-sort: - id properties: id: nullable: true description: Identifier of the language. type: number format: id32 x-positive: true distributor: nullable: false description: Distributor of the news article. See endpoint `/news/distributor/list` for possible values. type: object x-property-sort: - id properties: id: nullable: true description: Identifier of the distributor. type: number format: id32 x-positive: true publisher: nullable: false description: Publisher of the news article. See endpoint `/news/publisher/list` for possible values. type: object x-property-sort: - id properties: id: nullable: true description: Identifier of the publisher. type: number format: id32 x-positive: true categories: nullable: false description: Categories related to the news article. See endpoint `/category/list` for possible values. type: array items: type: object nullable: false x-property-sort: - id properties: id: nullable: true x-pushable: true description: Identifier of the category. type: number format: id32 x-positive: true chain: nullable: false description: Article chain. type: object x-property-sort: - id properties: id: nullable: true x-pushable: true description: Identifier of the news article chain. type: string format: id64 x-positive: true instruments: nullable: false description: Set of stock instruments related to the article. The set is not updated in the course of corporate actions, e.g. when the related company obtains a new instrument after a spin-off. type: array items: type: object nullable: false x-property-sort: - id - fsym properties: id: nullable: true x-pushable: true description: Identifier of the instrument. type: string format: id64 x-positive: true fsym: nullable: false type: object x-property-sort: - security description: Instrument-level FactSet identifier of the financial instrument used primarily in FactSet products other than the MDG. properties: security: nullable: false type: object x-property-sort: - permanentIdentifier description: Security-level identifier. properties: permanentIdentifier: nullable: true x-pushable: true description: FactSet Permanent Identifier for an instrument. The format is six alpha numeric characters, excluding vowels, with an S suffix (XXXXXX-S). type: string meta: type: object description: The meta member contains the meta information of the response. properties: status: $ref: '#/components/schemas/StatusObject' pagination: $ref: '#/components/schemas/CursorBasedPaginationOutputObjectWithoutTotal' x-property-sort: - status - pagination x-property-sort: - data - meta GetRecommendationListRevisionSearch200Response: description: Successful Response content: application/json: schema: type: object properties: data: description: List of revisions. nullable: false type: array items: type: object nullable: false x-property-sort: - id - recommendationList - types - title - description - activeRange - instrument description: Revision properties: id: nullable: true type: number format: id32 x-positive: true description: Identifier of the revision. recommendationList: nullable: false type: object x-property-sort: - id - name description: The recommendation list to which this revision belongs. properties: id: nullable: true type: number format: id32 x-positive: true description: Identifier of the recommendation list. name: nullable: true type: string description: Name of the recommendation list. types: nullable: false type: array items: type: object nullable: false x-property-sort: - id - name description: Type assigned to the recommendation list as of the given revision. properties: id: nullable: true type: number format: id32 x-positive: true description: Identifier of the type. name: nullable: true type: string description: Name of the type. description: Set of types assigned to the recommendation list as of the given revision. The customer maintains a list of valid types for all of its recommendation lists. title: nullable: true type: string format: localizedString description: Title assigned to the recommendation list as of the given revision. description: nullable: true type: string format: localizedString description: Description assigned to the recommendation list as of the given revision. activeRange: nullable: true type: object format: timeRange properties: start: nullable: true type: string format: datetime description: The starting point of the time range (inclusive), or `null` to indicate that the time range extends indefinitely into the past. end: nullable: true type: string format: datetime description: The ending point of the time range (exclusive), or `null` to indicate that the time range extends indefinitely into the future. x-property-sort: - start - end required: - start - end description: Time range during which the revision is, was, or will be active. instrument: nullable: false type: object x-property-sort: - id description: Instrument to which the recommendation list points, as of the given revision. properties: id: nullable: true type: string format: id64 x-positive: true description: Identifier of the instrument. meta: type: object description: The meta member contains the meta information of the response. properties: status: $ref: '#/components/schemas/StatusObject' x-property-sort: - status PostSecuritizedDerivativeNotationScreenerSearch200Response: description: Successful Response content: application/json: schema: type: object properties: data: description: List of notations. nullable: false type: array items: type: object nullable: false x-property-sort: - id - symbol - fsym - valueUnit - market - instrument - keyFigures - performance - volatility properties: id: nullable: true type: string format: id64 x-positive: true description: Identifier of the notation. symbol: nullable: true x-sortable: true type: string description: The symbol of the notation. It is a market-specific code to identify the notation. Which characters can be part of a symbol depends on the market. If a market does not define a proprietary symbol, but uses a different identifier (for example, the ISIN or the WKN) to identify instruments, no symbol will be set for the notations of that market. fsym: nullable: false type: object x-property-sort: - listing - regional description: Notation-level FactSet identifiers of the financial instrument used primarily in FactSet products other than the MDG. properties: listing: nullable: false type: object x-property-sort: - permanentIdentifier - tickerExchange - isPrimary description: Listing-level identifiers. properties: permanentIdentifier: nullable: true type: string description: FactSet Permanent Identifier for a notation. The format is six alpha numeric characters, excluding vowels, with an L suffix (XXXXXX-L). tickerExchange: nullable: true type: string description: 'FactSet market symbol of the notation, usually consisting of the ticker (e.g. "DAI" for Daimler AG) and the three-character code of the exchange on which the listing is traded (example: DAI-ETR).' isPrimary: nullable: true type: boolean description: Indicates whether the notation is the primary notation among all notations within the same region (`true`) or not (`false`). regional: nullable: false type: object x-property-sort: - permanentIdentifier - tickerRegion - isPrimary description: Regional-level identifiers. properties: permanentIdentifier: nullable: true type: string description: FactSet Permanent Identifier for a set of one or more notations of the same region with the same value unit. The format is six alpha numeric characters, excluding vowels, with an R suffix (XXXXXX-R). tickerRegion: nullable: true type: string description: 'FactSet regional symbol of the notation, consisting of the ticker and the two-character code of the country or region where the listing is traded (example: DAI-DE).' isPrimary: nullable: true type: boolean description: Indicates whether the notation is in the primary region of the security (`true`) or not (`false`). valueUnit: nullable: false type: object x-property-sort: - id - code description: Value unit of the notation such as a main or fractional currency for equities, a percentage for debt instruments, or points for indices. See endpoint `/basic/valueUnit/list` for possible values. properties: id: nullable: true type: number format: id32 x-positive: true description: Identifier of the value unit. code: nullable: true type: string description: 'Code of the value unit: If assigned, a code according to ISO 4217, otherwise a local code, for a main currency; a code such as GBp (for British pence) for a fractional currency; or a code such as PT (points) for non-currency value units.' market: nullable: false type: object x-property-sort: - id - name description: Market of the notation. properties: id: nullable: true type: number format: id32 x-positive: true description: Identifier of the market. name: nullable: true x-sortable: true type: string format: localizedString description: Name of the market. instrument: nullable: false type: object x-property-sort: - id - name - shortName - isin - nsin - fsym - categorization - lifeCycle - issuer - exercise - settlement - collateralized - quanto - capitalProtection - underlying - strike - bonusLevel - cap - knockOut - knockIn - lockOut - lockIn - capitalGuarantee - couponTriggerLevel - rangeKnockOut - participation - constantLeverage - nominalCurrency - currentInterestRate description: Instrument data of the notation. properties: id: nullable: true type: string format: id64 x-positive: true description: Identifier of the instrument. name: nullable: true x-sortable: true x-default-sort-attribute: true x-default-sort-direction: 1 type: string format: localizedString description: Name of the instrument. shortName: nullable: true x-sortable: true type: string format: localizedString description: Short name of the instrument. isin: nullable: true type: string description: The International Securities Identification Number (ISIN) of the instrument.The ISIN is a 12-character code of digits and upper-case letters that uniquely identifiesan instrument. nsin: nullable: false type: object x-property-sort: - wkn - valor description: NSIN data of the instrument. properties: wkn: nullable: true type: string description: The WKN (Wertpapierkennnummer, German for Securities Identification Number) of the instrument. The WKN is a 6-character code of digits and upper-case letters that uniquely identifies an instrument. valor: nullable: true type: string description: 'The Valor number (German: Valorennummer) of the instrument. The Valor number is an integer number that uniquely identifies an instrument.' fsym: nullable: false type: object x-property-sort: - security description: Instrument-level FactSet identifier of the financial instrument used primarily in FactSet products other than the MDG. properties: security: nullable: false type: object x-property-sort: - permanentIdentifier description: Security-level identifier. properties: permanentIdentifier: nullable: true type: string description: FactSet Permanent Identifier for an instrument. The format is six alpha numeric characters, excluding vowels, with an S suffix (XXXXXX-S). categorization: nullable: false type: object x-property-sort: - ddv - eusipa description: Categorization of the securitized derivative. Not all securitized derivatives have an assignement to all category systems. properties: ddv: nullable: false type: object x-property-sort: - level1 - level2 - level3 description: Categorization based on the DDV (Deutscher Derivate Verband, German for German Derivatives Association) product classification. This category system (id=23) covers securitized derivatives traded in Germany except exchange trade commodities (ETC) and exchange traded notes (ETN). properties: level1: nullable: false type: object x-property-sort: - id - name description: First, most coarse, level of categorization. properties: id: nullable: true type: number format: id32 x-positive: true description: Identifier of the category. name: nullable: true x-sortable: true type: string format: localizedString description: Name of the category. level2: nullable: false type: object x-property-sort: - id - name description: Second level of categorization. properties: id: nullable: true type: number format: id32 x-positive: true description: Identifier of the category. name: nullable: true x-sortable: true type: string format: localizedString description: Name of the category. level3: nullable: false type: object x-property-sort: - id - name description: Third, most detailed, level of categorization. properties: id: nullable: true type: number format: id32 x-positive: true description: Identifier of the category. name: nullable: true x-sortable: true type: string format: localizedString description: Name of the category. eusipa: nullable: false type: object x-property-sort: - level1 - level2 - level3 description: Categorization based on the EUSIPA (European Structured Investment Products Association) product classification. This category system (id=18) covers all securitized derivatives. properties: level1: nullable: false type: object x-property-sort: - id - name description: First, most coarse, level of categorization. properties: id: nullable: true type: number format: id32 x-positive: true description: Identifier of the category. name: nullable: true x-sortable: true type: string format: localizedString description: Name of the category. level2: nullable: false type: object x-property-sort: - id - name description: Second level of categorization. properties: id: nullable: true type: number format: id32 x-positive: true description: Identifier of the category. name: nullable: true x-sortable: true type: string format: localizedString description: Name of the category. level3: nullable: false type: object x-property-sort: - id - name description: Third, most detailed, level of categorization. properties: id: nullable: true type: number format: id32 x-positive: true description: Identifier of the category. name: nullable: true x-sortable: true type: string format: localizedString description: Name of the category. lifeCycle: nullable: false type: object x-property-sort: - issue - maturity - callable - valuation - repayment description: Important dates of the securitized derivative. properties: issue: nullable: true type: string format: date description: Date of the issue. maturity: nullable: false type: object x-property-sort: - date - remainingTermDays - perpetual description: Maturity data. properties: date: nullable: true x-sortable: true type: string format: date description: Date of the securitized derivative's maturity. The value is empty if the instrument is perpetual. remainingTermDays: nullable: true x-sortable: true type: number format: real description: Remaining term to maturity expressed in days. The value is empty if the instrument is perpetual. perpetual: nullable: true x-sortable: true type: boolean description: If `true`, the securitized derivative is perpetual, i.e. it does not mature, therefore the attributes `date` and `remainingTermDays` are `null`. callable: nullable: true x-sortable: true type: boolean description: If `true`, the issuer may redeem the instrument prior to maturity. valuation: nullable: true x-sortable: true type: string format: date description: Date of the valuation. repayment: nullable: true x-sortable: true type: string format: date description: Date of the repayment. issuer: nullable: false type: object x-property-sort: - id - name - group description: Issuer data of the securitized derivative. properties: id: nullable: true type: number format: id32 x-positive: true description: Identifier of the issuer. See endpoint `/securitizedDerivative/issuer/search` for possible values. name: nullable: true x-sortable: true type: string description: Name of the issuer. group: nullable: false type: object x-property-sort: - id - name description: Issuer group. The issuer group is defined by FactSet and does not represent an actual juristic person. properties: id: nullable: true type: number format: id32 x-positive: true description: Identifier of the issuer group. See endpoint `/securitizedDerivative/issuer/search` for possible values. name: nullable: true x-sortable: true type: string description: Name of the issuer group. exercise: nullable: false type: object x-property-sort: - right - style description: Exercise data of the securitized derivative. properties: right: nullable: true x-sortable: true type: string description: Exercise right. x-enum-description: - A put option gives buyer the right, but not the obligation, to sell an asset at a specified price within a specific time period. Put is synonymous to short or bear and is used in a broader sense for products that make profits from falling underlying levels. - A call option gives buyer the right, but not the obligation, to buy an asset at a specified price within a specific time period. Call is synonymous to long or bull and is used in a broader sense for products that make profits from rising underlying levels. enum: - put - call style: nullable: true x-sortable: true type: string description: Exercise style. x-enum-description: - An American-style securitized derivative can be exercised anytime during its life. - An European-style securitized derivative can be exercised at maturity only. - A Bermudan-style securitized derivative can be exercised only on predetermined dates . enum: - american - european - bermudan settlement: nullable: true x-sortable: true type: string description: Settlement of the securitized derivative. It concerns the fulfillment of the issuer's contractual obligations arising from the securitized derivative. Depending on the terms, the underlying asset may be delivered physically or its equivalent monetary value may be payed out. x-enum-description: - Transfer of a cash amount. - Physical delivery of the underlying asset. - Cash or physical, at the discretion of the issuer. enum: - cash - physical - either collateralized: nullable: true type: boolean description: If `true`, this instrument is protected against an issuer default by collateral (e.g. COSI collateralization by SIX Swiss Exchange). quanto: nullable: true x-sortable: true type: boolean description: If `true`, the risk of exchange rate fluctuations between the value unit of the underlying and the value unit of the cash flows is hedged. capitalProtection: nullable: true x-sortable: true type: number format: relativeValue description: Proportion of the nominal amount protected against loss. underlying: nullable: false type: object x-property-sort: - name - valueUnit - coverRatio - notation - effectiveUnderlying description: Underlying data of the securitized derivative. properties: name: nullable: true x-sortable: true type: string description: Name of the underlying, provided also if there is no notation for the underlying. valueUnit: nullable: false type: object x-property-sort: - id - code description: Value unit of the underlying, provided also if there is no notation for the underlying. See endpoint `/basic/valueUnit/list` for possible values. properties: id: nullable: true type: number format: id32 x-positive: true description: Identifier of the value unit. code: nullable: true x-sortable: true type: string description: Code of the value unit. coverRatio: nullable: true type: number format: real description: 'Cover ratio. It indicates the number of units of the underlying to which the securitized derivative refers. If the underlying is a bond the cover ratio represents the value of one percentage point. ' notation: nullable: false type: object x-property-sort: - id - instrument description: Notation of the underlying. All contained attributes are null if there is no notation for the underlying. properties: id: nullable: true type: string format: id64 x-positive: true description: Identifier of the notation. instrument: nullable: false type: object x-property-sort: - id - typeComposite description: Instrument of the underlying. properties: id: nullable: true type: string format: id64 x-positive: true description: Identifier of the instrument. typeComposite: nullable: true x-sortable: true type: string description: Type of composite instrument, in case the underlying is a composite instrument. x-enum-description: - A basket is a composite instrument which consists of several components. Its value is calculated as the weighted combination of the levels of the components. All weights are positive. - An alpha structure is a composite instrument which consists of two components. Its value is calculated as the difference of the performances of the components. The performances are measured starting at the date specified in the conditions of the securitized derivative. - A futures spread is a composite instrument which is built of two or more different futures contracts as its components. - A factor index is a composite instrument that reflects the day-to-day performance of its component, multiplied with a constant factor. The related capital costs and fees for calculation and administration are not represented. enum: - basket - alphaStructure - futuresSpread - factorIndex effectiveUnderlying: nullable: false type: object x-property-sort: - instrument description: Effective underlying of a factor certificate. properties: instrument: nullable: false type: object x-property-sort: - id - name description: Instrument of the effective underlying. properties: id: nullable: true type: string format: id64 x-positive: true description: Identifier of the instrument. name: nullable: true type: string format: localizedString description: Name of the instrument. strike: nullable: false type: object x-property-sort: - value - distance description: Strike of the securitized derivative. properties: value: nullable: true x-sortable: true type: number format: real description: Value of the strike. distance: nullable: false type: object x-property-sort: - absolute - relative description: Distance of the current underlying level to the strike. properties: absolute: nullable: true x-sortable: true type: number format: real description: Distance in absolute terms. relative: nullable: true x-sortable: true type: number format: relativeValue description: Distance relative to the current underlying level. bonusLevel: nullable: false type: object x-property-sort: - value - distance description: Bonus level of the securitized derivative. properties: value: nullable: true x-sortable: true type: number format: real description: Value of the bonus level. distance: nullable: false type: object x-property-sort: - absolute - relative description: Distance of the current underlying level to the bonus level. properties: absolute: nullable: true x-sortable: true type: number format: real description: Distance in absolute terms. relative: nullable: true x-sortable: true type: number format: relativeValue description: Distance relative to the current underlying level. cap: nullable: false type: object x-property-sort: - value - distance - cashFlow description: Cap of the securitized derivative. properties: value: nullable: true x-sortable: true type: number format: real description: Value of the cap. distance: nullable: false type: object x-property-sort: - absolute - relative description: Distance of the current underlying level to the cap. properties: absolute: nullable: true x-sortable: true type: number format: real description: Distance in absolute terms. relative: nullable: true x-sortable: true type: number format: relativeValue description: Distance relative to the current underlying level. cashFlow: nullable: true x-sortable: true type: number format: real description: Cash flow amount. knockOut: nullable: false type: object x-property-sort: - observation - value - distance - breach description: Knock-out of the securitized derivative. properties: observation: nullable: false type: object x-property-sort: - type description: Barrier observation modality. properties: type: nullable: true x-sortable: true type: string description: Type of the barrier observation. x-enum-description: - The barrier is observed on a continuous basis (intraday prices are relevant). - The barrier is observed only at the end of the final auction for the underlying on the relevant exchange (intraday prices are of no relevance). enum: - continuous - eod value: nullable: true x-sortable: true type: number format: real description: Value of the knock-out. distance: nullable: false type: object x-property-sort: - absolute - relative description: Distance of the current underlying level to the knock-out. properties: absolute: nullable: true x-sortable: true type: number format: real description: Distance in absolute terms. relative: nullable: true x-sortable: true type: number format: relativeValue description: Distance relative to the current underlying level. breach: nullable: false type: object x-property-sort: - breached - datetime description: Information whether or not, and if yes - when a barrier breach has occurred. properties: breached: nullable: true x-sortable: true type: boolean description: If `true`, the barrier has been breached. datetime: nullable: true x-sortable: true type: string format: datetime description: Date and time of the breach. knockIn: nullable: false type: object x-property-sort: - observation - value - distance - breach - cashFlow description: Knock-in of the securitized derivative. properties: observation: nullable: false type: object x-property-sort: - type description: Barrier observation modality. properties: type: nullable: true x-sortable: true type: string description: Type of the barrier observation. x-enum-description: - The barrier is observed on a continuous basis (intraday prices are relevant). - The barrier is observed only at the end of the final auction for the underlying on the relevant exchange (intraday prices are of no relevance). enum: - continuous - eod value: nullable: true x-sortable: true type: number format: real description: Value of the knock-in. distance: nullable: false type: object x-property-sort: - absolute - relative description: Distance of the current underlying level to the knock-in. properties: absolute: nullable: true x-sortable: true type: number format: real description: Distance in absolute terms. relative: nullable: true x-sortable: true type: number format: relativeValue description: Distance relative to the current underlying level. breach: nullable: false type: object x-property-sort: - breached - datetime description: Information whether or not, and if yes - when a barrier breach has occurred. properties: breached: nullable: true x-sortable: true type: boolean description: If `true`, the barrier has been breached. datetime: nullable: true x-sortable: true type: string format: datetime description: Date and time of the breach. cashFlow: nullable: true type: number format: real description: Cash flow amount. lockOut: nullable: false type: object x-property-sort: - observation - value - distance - cashFlow description: Lock-out of the securitized derivative. properties: observation: nullable: false type: object x-property-sort: - type description: Barrier observation modality. properties: type: nullable: true x-sortable: true type: string description: Type of the barrier observation. x-enum-description: - The barrier is observed on a continuous basis (intraday prices are relevant). - The barrier is observed only at the end of the final auction for the underlying on the relevant exchange (intraday prices are of no relevance). enum: - continuous - eod value: nullable: true x-sortable: true type: number format: real description: Value of the lock-out. distance: nullable: false type: object x-property-sort: - absolute - relative description: Distance of the current underlying level to the lock-out. properties: absolute: nullable: true x-sortable: true type: number format: real description: Distance in absolute terms. relative: nullable: true x-sortable: true type: number format: relativeValue description: Distance relative to the current underlying level. cashFlow: nullable: true x-sortable: true type: number format: real description: Cash flow amount. lockIn: nullable: false type: object x-property-sort: - observation - value - distance - cashFlow description: Lock-in of the securitized derivative. properties: observation: nullable: false type: object x-property-sort: - type description: Barrier observation modality. properties: type: nullable: true x-sortable: true type: string description: Type of the barrier observation. x-enum-description: - The barrier is observed on a continuous basis (intraday prices are relevant). - The barrier is observed only at the end of the final auction for the underlying on the relevant exchange (intraday prices are of no relevance). enum: - continuous - eod value: nullable: true x-sortable: true type: number format: real description: Value of the lock-in. distance: nullable: false type: object x-property-sort: - absolute - relative description: Distance of the current underlying level to the lock-in. properties: absolute: nullable: true x-sortable: true type: number format: real description: Distance in absolute terms. relative: nullable: true x-sortable: true type: number format: relativeValue description: Distance relative to the current underlying level. cashFlow: nullable: true x-sortable: true type: number format: real description: Cash flow amount. capitalGuarantee: nullable: false type: object x-property-sort: - value - distance - cashFlow description: Capital guarantee of the securitized derivative. properties: value: nullable: true x-sortable: true type: number format: real description: Value of the capital guarantee. distance: nullable: false type: object x-property-sort: - absolute - relative description: Distance of the current underlying level to the capital guarantee. properties: absolute: nullable: true x-sortable: true type: number format: real description: Distance in absolute terms. relative: nullable: true x-sortable: true type: number format: relativeValue description: Distance relative to the current underlying level. cashFlow: nullable: true x-sortable: true type: number format: real description: Cash flow amount. couponTriggerLevel: nullable: false type: object x-property-sort: - value - distance - cashFlow description: Coupon trigger level of the securitized derivative. properties: value: nullable: true x-sortable: true type: number format: real description: Value of the coupon trigger level. distance: nullable: false type: object x-property-sort: - absolute - relative description: Distance of the current underlying level to the coupon trigger level. properties: absolute: nullable: true x-sortable: true type: number format: real description: Distance in absolute terms. relative: nullable: true x-sortable: true type: number format: relativeValue description: Distance relative to the current underlying level. cashFlow: nullable: true x-sortable: true type: number format: real description: Cash flow amount. rangeKnockOut: nullable: false type: object x-property-sort: - observation - upper - lower - breach - cashFlow description: Range knock-out of the securitized derivative. properties: observation: nullable: false type: object x-property-sort: - type description: Barrier observation modality. properties: type: nullable: true x-sortable: true type: string description: Type of the barrier observation. x-enum-description: - The barrier is observed on a continuous basis (intraday prices are relevant). - The barrier is observed only at the end of the final auction for the underlying on the relevant exchange (intraday prices are of no relevance). enum: - continuous - eod upper: nullable: false type: object x-property-sort: - value description: Upper bound of the range knock-out. properties: value: nullable: true x-sortable: true type: number format: real description: Value of the upper bound. lower: nullable: false type: object x-property-sort: - value description: Lower bound of the range knock-out. properties: value: nullable: true x-sortable: true type: number format: real description: Value of the lower bound. breach: nullable: false type: object x-property-sort: - breached - datetime description: Information whether or not, and if yes - when a barrier breach has occurred. properties: breached: nullable: true x-sortable: true type: boolean description: If `true`, the barrier has been breached. datetime: nullable: true x-sortable: true type: string format: datetime description: Date and time of the breach. cashFlow: nullable: true x-sortable: true type: number format: real description: Cash flow amount. participation: nullable: true x-sortable: true type: string description: Participation direction of a factor certificate at the level movement of its effective underlying. x-enum-description: - The factor certificate participates positively with rising levels of its effective underlying. - The factor certificate participates negatively with rising levels of its effective underlying. enum: - long - short constantLeverage: nullable: true x-sortable: true type: number format: real description: Constant leverage of a factor certificate. nominalCurrency: nullable: false type: object x-property-sort: - id - isoCode description: Main currency of the nominal and of the coupon payments. properties: id: nullable: true type: number format: id32 x-positive: true description: Identifier of the currency. See endpoint `/basic/valueUnit/currency/main/list` for possible values. isoCode: nullable: true x-sortable: true type: string description: ISO 4217 code of the currency. currentInterestRate: nullable: false type: object x-property-sort: - type - value description: Interest rate of the current coupon period. properties: type: nullable: true x-sortable: true type: string description: Type of the interest rate. x-enum-description: - The interest rate is fixed for all periods and remains unchanged throughout the lifetime of the securitized derivative. - The interest rate is variable and might change from period to period throughout the lifetime of the securitized derivative. enum: - fixed - variable value: nullable: true x-sortable: true type: number format: relativeValue description: Interest rate of the current coupon period. For coupon periods different than one year, the value is annualized. Not available for securitized derivatives with a current interest rate type other than `fixed`. keyFigures: nullable: false type: object x-property-sort: - currency - bonusYield - sidewaysYield - maximumYield - agio - discount - breakEven - spread - delta - thetaOneWeek - vega - leverage - omega - impliedVolatility - intrinsicValue - timeValue - outperformancePoint - parity description: Key figures specific to securitized derivatives; based on ask prices. properties: currency: nullable: false type: object x-property-sort: - id - isoCode description: Main currency of key figures, if not stated otherwise. properties: id: nullable: true type: number format: id32 x-positive: true description: Identifier of the currency. See endpoint `/basic/valueUnit/currency/main/list` for possible values. isoCode: nullable: true type: string description: ISO 4217 code of the currency. bonusYield: nullable: false type: object x-property-sort: - absolute - relative - annualized description: Bonus yield. It represents the bonus level adjusted for the cover ratio and currency cross rate minus the ask price of the securitized derivative. The value can become negative (e.g. for uncapped products), which does not mean that the investor will necessarily suffer a loss buying it. This key figure is calculated for bonus certificates with an intact knock-in barrier only, i.e. the attribute `knockIn.breach.breached` is false. properties: absolute: nullable: true x-sortable: true type: number format: real description: Bonus yield in absolute terms. relative: nullable: true x-sortable: true type: number format: relativeValue description: Bonus yield relative to the ask price. annualized: nullable: true x-sortable: true type: number format: relativeValue description: Annualized bonus yield relative to the ask price. sidewaysYield: nullable: false type: object x-property-sort: - absolute - relative - annualized description: Sideways yield. It represents a hypothetical payout at maturity minus the ask price of the securitized derivative, under the assumption that all payout-influencing factors remain unchanged until maturity. properties: absolute: nullable: true x-sortable: true type: number format: real description: Sideways yield in absolute terms. relative: nullable: true x-sortable: true type: number format: relativeValue description: Sideways yield relative to the ask price. annualized: nullable: true x-sortable: true type: number format: relativeValue description: Annualized sideways yield relative to the ask price. maximumYield: nullable: false type: object x-property-sort: - absolute - relative - annualized description: Maximum yield. It represents a hypothetical maximum payout at maturity minus the ask price of the derivative. This key figure represents a theoretically possible best-case scenario, disregarding the probability of occurrence. It is calculated only for securitized derivatives with a limited payout (e.g. capped products). properties: absolute: nullable: true x-sortable: true type: number format: real description: Maximum yield in absolute terms. relative: nullable: true x-sortable: true type: number format: relativeValue description: Maximum yield relative to the ask price. annualized: nullable: true x-sortable: true type: number format: relativeValue description: Annualized maximum yield relative to the ask price. agio: nullable: false type: object x-property-sort: - absolute - relative - annualized description: Agio. For plain vanilla warrants, it represents the difference between the ask price of the derivative and its parity (see attribute `parity`). Thus, for those with exercise right `call`, the agio indicates how much more expensive would it be to obtain the underlying through purchasing and exercising the warrant compared to directly purchasing the underlying. For those with exercise right `put`, the above consideration is applied inversely. For other types of securitized derivatives, the calculation and interpretation of the agio depends on their category. Negative values are possible. properties: absolute: nullable: true x-sortable: true type: number format: real description: Agio in absolute terms. relative: nullable: true x-sortable: true type: number format: relativeValue description: Agio relative to the underlying level. annualized: nullable: true x-sortable: true type: number format: relativeValue description: Annualized agio relative to the underlying level. discount: nullable: false type: object x-property-sort: - absolute - relative description: Discount. It represents the difference between the ask price of the securitized derivative and the underlying level, adjusted for the cover ratio and the currency cross rate. This key figure is calculated only for discount certificates. For the value unit, see attribute `instrument.underlying.valueUnit.` properties: absolute: nullable: true x-sortable: true type: number format: real description: Discount in absolute terms. relative: nullable: true x-sortable: true type: number format: relativeValue description: Discount relative to the underlying level. breakEven: nullable: false type: object x-property-sort: - breakEvenPoint - distance description: Break even point. It represents the underlying level that has to be reached at maturity, such that no loss or profit occurs for the holder of the securitized derivative. properties: breakEvenPoint: nullable: true x-sortable: true type: number format: real description: Break even point. For the value unit, see attribute `instrument.underlying.valueUnit`. distance: nullable: false type: object x-property-sort: - absolute - relative description: Distance from the underlying level to the break even point. properties: absolute: nullable: true type: number format: real description: Distance in absolute terms. For the value unit, see attribute `instrument.underlying.valueUnit`. relative: nullable: true type: number format: relativeValue description: Distance relative to the underlying level. spread: nullable: false type: object x-property-sort: - harmonized - relative description: Spread of the securitized derivative. It represents the difference between the ask and bid price. properties: harmonized: nullable: true x-sortable: true type: number format: real description: Spread in absolute terms, adjusted for the cover ratio. relative: nullable: true x-sortable: true type: number format: relativeValue description: Spread relative to the ask price. delta: nullable: false type: object x-property-sort: - effective - unadjusted description: Delta. It represents the first partial derivative of the function determining the derivative notation's theoretical price with respect to the underlying level, evaluated at the underlying level. Delta indicates the ratio of the absolute change of the price of a derivative for an indefinitely small absolute change in the underlying level, thus it represents the price sensitivity of the derivative relative to changes in the underlying level. This key figure is calculated for plain vanilla warrants only. properties: effective: nullable: true x-sortable: true type: number format: real description: Delta calculated using the actual cover ration of the securitized derivative. unadjusted: nullable: true x-sortable: true type: number format: real description: Delta calculated using a (hypothetical) cover ratio of 1:1. thetaOneWeek: nullable: false type: object x-property-sort: - effective - unadjusted description: Weekly theta. It represents the first partial derivative of the function determining the derivative notation's theoretical price with respect to the residual term, evaluated at the current residual term and multiplied by 7 / 365. Weekly theta indicates the absolute change (decrease) of the price of a derivative for a reduction of the residual term by one week (seven calendar days), thus it represents the price sensitivity of the derivative relative to changes in the residual term. This key figure is calculated for plain vanilla warrants only. properties: effective: nullable: true x-sortable: true type: number format: real description: Weekly theta calculated using the actual cover ratio of the securitized derivative. unadjusted: nullable: true x-sortable: true type: number format: real description: Weekly theta calculated using a (hypothetical) cover ratio of 1:1. vega: nullable: false type: object x-property-sort: - effective - unadjusted description: Vega. It represents the first partial derivative of the function determining the derivative notation's theoretical price with respect to the implied volatility, evaluated at the current implied volatility. Vega indicates the ratio of the absolute change of the price of a derivative for an absolute change of the implied volatility, thus it represents the price sensitivity of the derivative relative to changes in the implied volatility. This key figure is calculated for plain vanilla warrants only. properties: effective: nullable: true x-sortable: true type: number format: real description: Vega calculated using the actual cover ratio of the securitized derivative. unadjusted: nullable: true x-sortable: true type: number format: real description: Vega calculated using a (hypothetical) cover ratio of 1:1. leverage: nullable: true x-sortable: true type: number format: real description: Leverage. It represents the ratio of the underlying level to the ask price of the securitized derivative, adjusted for the cover ratio and the currency cross rate. This key figure is calculated only for leveraged securitized derivatives (e.g. warrants, knock-out certificates). omega: nullable: true x-sortable: true type: number format: real description: Omega. It represents unadjusted delta (see attribute `delta.unadjusted`) multiplied with the leverage (see attribute `leverage`), both calculated based on the ask price of the derivative. Omega indicates the elasticity of the securitized derivative's price regarding the underlying level. This key figure is calculated for plain vanilla warrants only. impliedVolatility: nullable: true x-sortable: true type: number format: relativeValue description: Implied volatility. It represents the volatility of the underlying that justifies the ask price of the derivative, when used as a parameter in the derivative's pricing model (such as Black-Scholes). Its value is a result of the pricing process, thus it represents the annual volatility of the underlying expected by the market participants until maturity of the derivative. This key figure is calculated for plain vanilla warrants only. intrinsicValue: nullable: true x-sortable: true type: number format: real description: Intrinsic value. It represents the difference between the underlying level and the strike of the securitized derivative, adjusted for the cover ratio and the currency cross rate. If the difference is negative, the intrinsic value is given as 0. The intrinsic value represents the theoretical profit from an immediate exercise of the derivative. This key figure is calculated for plain vanilla warrants only. timeValue: nullable: true x-sortable: true type: number format: real description: Time value. It represents the difference between the ask price of the securitized derivative and its intrinsic value (see attribute `intrinsicValue`). This key figure is calculated for plain vanilla warrants only. outperformancePoint: nullable: true x-sortable: true type: number format: real description: Outperformance point. It represents the underlying level from which the underlying starts to outperform the securitized derivative, thus the investor would be better off investing directly in the underlying. It is calculated only for securitized derivatives with a limited payout (e.g. capped products). For the value unit, see attribute `instrument.underlying.valueUnit`. parity: nullable: true x-sortable: true type: number format: real description: Parity. It represents the difference between the underlying level and the strike of the derivative, adjusted for the cover ratio and the currency cross rate. Negative values are possible. It is the gain or loss that would result from the immediate exercise of an already present warrant and a simultaneously executed compensation transaction on the spot markets. This key figure is calculated for plain vanilla warrants only. performance: nullable: false type: object x-property-sort: - intraday - sinceIssue - endOfDay description: Relative performance for different time ranges. properties: intraday: nullable: true x-sortable: true type: number format: relativeValue description: Intraday relative performance. That is the difference of a notation's most recent price from the current trading day against the most recent EOD closing price. sinceIssue: nullable: false type: object x-property-sort: - ask - bid description: Relative performance since issue. That is the difference of a notation's most recent price against the price on the issue date, relative to the price on the issue date. properties: ask: nullable: true x-sortable: true type: number format: relativeValue description: Ask-based relative performance since issue. bid: nullable: true x-sortable: true type: number format: relativeValue description: Bid-based relative performance since issue. endOfDay: nullable: false type: object x-property-sort: - day1 - week1 - month1 - months3 - months6 - year1 - years3 - years5 - yearToDate description: End-of-day (EOD) relative performance for different time ranges. The relative performance is the difference of a notation's most recent EOD closing price against the EOD closing price on the reference date, relative to the EOD closing price on the reference date. properties: day1: nullable: true x-sortable: true type: number format: relativeValue description: One day. week1: nullable: true x-sortable: true type: number format: relativeValue description: One week. month1: nullable: true x-sortable: true type: number format: relativeValue description: One month. months3: nullable: true x-sortable: true type: number format: relativeValue description: Three months. months6: nullable: true x-sortable: true type: number format: relativeValue description: Six months. year1: nullable: true x-sortable: true type: number format: relativeValue description: One year. years3: nullable: true x-sortable: true type: number format: relativeValue description: Three years. years5: nullable: true x-sortable: true type: number format: relativeValue description: Five years. yearToDate: nullable: true x-sortable: true type: number format: relativeValue description: Year-to-date. volatility: nullable: false type: object x-property-sort: - week1 - month1 - months3 - months6 - year1 - years3 - years5 - yearToDate description: Volatility of the daily logarithmic returns, annualized assuming 256 trading days per year for different time ranges. properties: week1: nullable: true x-sortable: true type: number format: relativeValue description: One week. month1: nullable: true x-sortable: true type: number format: relativeValue description: One month. months3: nullable: true x-sortable: true type: number format: relativeValue description: Three months. months6: nullable: true x-sortable: true type: number format: relativeValue description: Six months. year1: nullable: true x-sortable: true type: number format: relativeValue description: One year. years3: nullable: true x-sortable: true type: number format: relativeValue description: Three years. years5: nullable: true x-sortable: true type: number format: relativeValue description: Five years. yearToDate: nullable: true x-sortable: true type: number format: relativeValue description: Year-to-date. x-partial: true meta: type: object description: The meta member contains the meta information of the response. properties: status: $ref: '#/components/schemas/StatusObject' pagination: $ref: '#/components/schemas/OffsetBasedPaginationOutputObject' partial: $ref: '#/components/schemas/PartialOutputObject' x-property-sort: - status - pagination - partial PostNewsPublisherSearchByName200Response: description: Successful Response content: application/json: schema: type: object properties: data: type: array description: List of publishers. nullable: false items: type: object nullable: false x-property-sort: - id - name properties: id: nullable: true x-sortable: true type: number format: id32 x-positive: true description: Identifier of the publisher. name: nullable: true x-sortable: true x-default-sort-attribute: true x-default-sort-direction: 1 type: string description: Name of the publisher. meta: type: object description: The meta member contains the meta information of the response. properties: status: $ref: '#/components/schemas/StatusObject' x-property-sort: - status x-property-sort: - data - meta PostDebtInstrumentIssuerSearch200Response: description: Successful Response content: application/json: schema: type: object properties: data: nullable: false type: array items: type: object nullable: false x-property-sort: - id - name - count properties: id: nullable: true type: number format: id32 x-positive: true description: Identifier of an issuer. name: nullable: true type: string description: Name of the issuer. count: nullable: true type: number format: int32 description: Number of debt instruments issued. description: List of issuers, sorted descending by the number of debt instruments issued. meta: type: object description: The meta member contains the meta information of the response. properties: status: $ref: '#/components/schemas/StatusObject' x-property-sort: - status GetNotationSearchBasic200Response: description: Successful Response content: application/json: schema: type: object properties: data: type: array description: List of notations. nullable: false items: type: object nullable: false x-property-sort: - id - symbol - nsin - price - instrument description: The data member contains a list of the matching notations. properties: id: nullable: true type: string format: id64 x-positive: true description: Identifier of the notation. symbol: nullable: true type: string description: The symbol of the notation. It is a market-specific code to identify the notation. Which characters can be part of a symbol depends on the market. If a market does not define a proprietary symbol, but uses a different identifier (for example, the ISIN or the WKN) to identify instruments, no symbol will be set for the notations of that market. nsin: nullable: false type: object x-property-sort: - sedol description: NSIN data of the notation. properties: sedol: nullable: true type: string description: The SEDOL or IDII for the notation. price: nullable: false type: object x-property-sort: - value - time description: Most recent trade or price of the trading day. See attribute `valueUnit` for its unit. properties: value: nullable: true type: number format: real description: Value of the latest price. time: nullable: true type: string format: datetime description: Date and time of the most recent bid price of the trading day. instrument: nullable: false type: object x-property-sort: - id - name - isin - nsin - assetClass - type description: Instrument data of the notation. properties: id: nullable: true type: string format: id64 x-positive: true description: Identifier of the instrument of the notation. name: nullable: true type: string description: Asset class-unspecific name in English. isin: nullable: true type: string description: The International Securities Identification Number (ISIN) of the instrument. The ISIN is a 12-character code of digits and upper-case letters that uniquely identifies an instrument. nsin: nullable: false type: object x-property-sort: - wkn - valor - cusip description: NSIN data of the instrument. properties: wkn: nullable: true type: string description: The WKN (Wertpapierkennnummer, German for Securities Identification Number) of the instrument. The WKN is a 6-character code of digits and upper-case letters that uniquely identifies an instrument. valor: nullable: true type: string description: 'The Valor number (German: Valorennummer) of the instrument. The Valor number is an integer number that uniquely identifies an instrument.' cusip: nullable: true type: string description: The CUSIP (Committee on Uniform Security Identification Procedures) or CINS (CUSIP International Numbering System) identifier of the instrument. These numbers are 9-character codes of digits and upper-case letters that uniquely identify an instrument. assetClass: nullable: true type: string description: Name of the asset class of the instrument. Possible values are listed in the enumeration in the parameter description. type: nullable: false description: Instrument type as defined by FactSet Digital Solutions. Instrument categories are arranged in a hierarchy, with level 1 representing the most coarse granularity and further levels successively refining the granularity (see MDG category system 18). type: array items: type: object nullable: false x-property-sort: - id - name properties: id: nullable: true type: number format: id32 x-positive: true description: Identifier of the category. name: nullable: true type: string format: localizedString description: Name of the category. x-partial: true meta: type: object description: The meta member contains the meta information of the response. properties: status: $ref: '#/components/schemas/StatusObject' pagination: $ref: '#/components/schemas/OffsetBasedPaginationOutputObject' partial: $ref: '#/components/schemas/PartialOutputObject' x-property-sort: - status - pagination - partial x-property-sort: - data - meta PostStockNotationScreenerSearch200Response: description: Successful Response content: application/json: schema: type: object properties: data: description: List of notations. nullable: false type: array items: type: object nullable: false x-property-sort: - id - valueUnit - market - symbol - nsin - fsym - instrument - esg - compliance - currentKeyFigures - reportedKeyFigures - benchmark - performance - volatility - tradingValue - simpleMovingAverage - rsiWilder - recommendation - estimates properties: id: nullable: true description: Identifier of the notation. type: string format: id64 x-positive: true valueUnit: nullable: false description: Value unit of the notation such as a main or fractional currency for equities, a percentage for debt instruments, or points for indices. See endpoint `/basic/valueUnit/list` for possible values. type: object x-property-sort: - id - code properties: id: nullable: true description: Identifier of the value unit. type: number format: id32 x-positive: true code: nullable: true description: 'Code of the value unit: If assigned, a code according to ISO 4217, otherwise a local code, for a main currency; a code such as GBp (for British pence) for a fractional currency; or a code such as PT (points) for non-currency value units.' x-sortable: true type: string market: nullable: false description: Market of the notation. See endpoint `/basic/market/list` for possible values. type: object x-property-sort: - id - name properties: id: nullable: true description: Identifier of the market. type: number format: id32 x-positive: true name: nullable: true description: Name of the market. x-sortable: true type: string format: localizedString symbol: nullable: true description: The symbol of the notation. It is a market-specific code to identify the notation. Which characters can be part of a symbol depends on the market. If a market does not define a proprietary symbol, but uses a different identifier (for example, the ISIN or the WKN) to identify instruments, no symbol will be set for the notations of that market. x-sortable: true type: string nsin: nullable: false description: NSIN data of the notation. type: object x-property-sort: - sedol properties: sedol: nullable: true description: The SEDOL or IDII for the notation. type: string fsym: nullable: false type: object x-property-sort: - listing - regional description: Notation-level FactSet identifiers of the financial instrument used primarily in FactSet products other than the MDG. properties: listing: nullable: false type: object x-property-sort: - permanentIdentifier - tickerExchange - isPrimary description: Listing-level identifiers. properties: permanentIdentifier: nullable: true type: string description: FactSet Permanent Identifier for a notation. The format is six alpha numeric characters, excluding vowels, with an L suffix (XXXXXX-L). tickerExchange: nullable: true type: string description: 'FactSet market symbol of the notation, usually consisting of the ticker (e.g. "DAI" for Daimler AG) and the three-character code of the exchange on which the listing is traded (example: DAI-ETR).' isPrimary: nullable: true type: boolean description: Indicates whether the notation is the primary notation among all notations within the same region (`true`) or not (`false`). regional: nullable: false type: object x-property-sort: - permanentIdentifier - tickerRegion - isPrimary description: Regional-level identifiers. properties: permanentIdentifier: nullable: true type: string description: FactSet Permanent Identifier for a set of one or more notations of the same region with the same value unit. The format is six alpha numeric characters, excluding vowels, with an R suffix (XXXXXX-R). tickerRegion: nullable: true type: string description: 'FactSet regional symbol of the notation, consisting of the ticker and the two-character code of the country or region where the listing is traded (example: DAI-DE).' isPrimary: nullable: true type: boolean description: Indicates whether the notation is in the primary region of the security (`true`) or not (`false`). instrument: nullable: false description: Instrument data of the notation. type: object x-property-sort: - id - name - shortName - isin - nsin - fsym - stockType - industryClassification - company properties: id: nullable: true description: Identifier of the instrument. type: string format: id64 x-positive: true name: nullable: true description: Name of the instrument. x-sortable: true x-default-sort-attribute: true x-default-sort-direction: 1 type: string format: localizedString shortName: nullable: true description: Short name of the instrument. x-sortable: true type: string format: localizedString isin: nullable: true description: The International Securities Identification Number (ISIN) of the instrument. The ISIN is a 12-character code of digits and upper-case letters that uniquely identifies an instrument. type: string format: isin nsin: nullable: false description: NSIN data of the instrument. type: object x-property-sort: - wkn - valor - cusip properties: wkn: nullable: true description: The WKN (Wertpapierkennnummer, German for Securities Identification Number) of the instrument. The WKN is a 6-character code of digits and upper-case letters that uniquely identifies an instrument. type: string valor: nullable: true description: 'The Valor number (German: Valorennummer) of the instrument. The Valor number is an integer number that uniquely identifies an instrument.' type: string cusip: nullable: true description: The CUSIP (Committee on Uniform Security Identification Procedures) or CINS (CUSIP International Numbering System) identifier of the instrument. These numbers are 9-character codes of digits and upper-case letters that uniquely identify an instrument. type: string fsym: nullable: false type: object x-property-sort: - security description: Instrument-level FactSet identifier of the financial instrument used primarily in FactSet products other than the MDG. properties: security: nullable: false type: object x-property-sort: - permanentIdentifier description: Security-level identifier. properties: permanentIdentifier: nullable: true type: string description: FactSet Permanent Identifier for an instrument. The format is six alpha numeric characters, excluding vowels, with an S suffix (XXXXXX-S). stockType: nullable: true description: Type of stock. x-sortable: true type: string x-enum-description: - Common stock - Preferred stock - Depository receipt - Other stock enum: - common - preferred - depositoryReceipt - other industryClassification: nullable: false description: Industry classification. See endpoint `/category/listBySystem` with `id=48` for possible values. type: object x-property-sort: - rbics properties: rbics: nullable: false description: Classification based on FactSet Revere Business Industry Classification System (RBICS). type: object x-property-sort: - level1 - level2 - level3 - level4 - level5 - level6 properties: level1: nullable: false description: Economy level of classification. type: object x-property-sort: - id - name properties: id: nullable: true description: Identifier of the category. type: number format: id32 x-positive: true name: nullable: true description: Name of the category. x-sortable: true type: string format: localizedString level2: nullable: false description: Sector level of classification. type: object x-property-sort: - id - name properties: id: nullable: true description: Identifier of the category. type: number format: id32 x-positive: true name: nullable: true description: Name of the category. x-sortable: true type: string format: localizedString level3: nullable: false description: Sub-sector level of classification. type: object x-property-sort: - id - name properties: id: nullable: true description: Identifier of the category. type: number format: id32 x-positive: true name: nullable: true description: Name of the category. x-sortable: true type: string format: localizedString level4: nullable: false description: Industry group level of classification. type: object x-property-sort: - id - name properties: id: nullable: true description: Identifier of the category. type: number format: id32 x-positive: true name: nullable: true description: Name of the category. x-sortable: true type: string format: localizedString level5: nullable: false description: Industry level of classification. type: object x-property-sort: - id - name properties: id: nullable: true description: Identifier of the category. type: number format: id32 x-positive: true name: nullable: true description: Name of the category. x-sortable: true type: string format: localizedString level6: nullable: false description: Sub-industry level of classification. type: object x-property-sort: - id - name properties: id: nullable: true description: Identifier of the category. type: number format: id32 x-positive: true name: nullable: true description: Name of the category. x-sortable: true type: string format: localizedString company: nullable: false description: Details of the company. type: object x-property-sort: - id - name - country properties: id: nullable: true description: Identifier of the company. type: number format: id32 x-positive: true name: nullable: true description: Name of the company. x-sortable: true type: string country: nullable: false description: Country where the head office of the company is located. See endpoint `/basic/region/country/list` for possible values. type: object x-property-sort: - id - name properties: id: nullable: true description: Identifier of the country. type: number format: id32 x-positive: true name: nullable: true description: Name of the country. x-sortable: true type: string format: localizedString esg: nullable: false description: Parameters related to Environmental, Social, and Governance (ESG) data. type: object x-property-sort: - truvalueLabs properties: truvalueLabs: nullable: false description: ESG data provided by FactSet's Truvalue Labs. type: object x-property-sort: - sasb - sdg properties: sasb: nullable: false description: ESG data for categories as defined by the Sustainability Accounting Standards Board (SASB). type: object x-property-sort: - allCategories - materiality properties: allCategories: nullable: false description: ESG data for all 26 SASB categories. type: object x-property-sort: - insight - momentum - ranking properties: insight: nullable: true description: Insight score. x-sortable: true type: number format: real momentum: nullable: true description: Momentum score. x-sortable: true type: number format: real ranking: nullable: true description: Ranking. x-sortable: true type: string x-enum-description: - Indicates that the company's ESG rating is within the percentile range of 90% to 100% of all companies. - Indicates that the company's ESG rating is within the percentile range of 70% to 90% (exclusive) of all companies. - Indicates that the company's ESG rating is within the percentile range of 30% to 70% (exclusive) of all companies. - Indicates that the company's ESG rating is within the percentile range of 10% to 30% (exclusive) of all companies. - Indicates that the company's ESG rating is within the percentile range of 0% to 10% (exclusive) of all companies. enum: - leader - aboveAverage - average - belowAverage - laggard materiality: nullable: false description: ESG data for all materiality categories. type: object x-property-sort: - insight - momentum - ranking properties: insight: nullable: true description: Insight score. x-sortable: true type: number format: real momentum: nullable: true description: Momentum score. x-sortable: true type: number format: real ranking: nullable: true description: Ranking. x-sortable: true type: string x-enum-description: - Indicates that the company's ESG rating is within the percentile range of 90% to 100% of all companies. - Indicates that the company's ESG rating is within the percentile range of 70% to 90% (exclusive) of all companies. - Indicates that the company's ESG rating is within the percentile range of 30% to 70% (exclusive) of all companies. - Indicates that the company's ESG rating is within the percentile range of 10% to 30% (exclusive) of all companies. - Indicates that the company's ESG rating is within the percentile range of 0% to 10% (exclusive) of all companies. enum: - leader - aboveAverage - average - belowAverage - laggard sdg: nullable: false description: ESG data for categories based on the Sustainable Development Goals (SDG) as defined by the United Nations. type: object x-property-sort: - impact properties: impact: nullable: false description: ESG data for the category impact. type: object x-property-sort: - insight - momentum properties: insight: nullable: true description: Insight score. x-sortable: true type: number format: real momentum: nullable: true description: Momentum score. x-sortable: true type: number format: real compliance: nullable: false description: 'Compliance properties. See endpoint `/instrument/complianceProperty/list` for the full list of compliance properties associated with instruments (across all asset classes). ' type: object x-property-sort: - france properties: france: nullable: false description: List of compliance properties in accordance with the French law to which the stock is compliant. type: array items: type: object nullable: false x-property-sort: - id - name properties: id: nullable: true description: Identifier of a compliance property. type: number format: id32 x-positive: true x-enum-description: - PEA - PEAPME - SRD - SRD long only enum: - 2 - 3 - 4 - 10 name: nullable: true description: Name of the compliance property. type: string format: localizedString currentKeyFigures: nullable: false description: Stock-specific current key figures. type: object x-property-sort: - company - shareInstrument properties: company: nullable: false description: Company key figures. type: object x-property-sort: - sharesOutstanding - freeFloat - currencyDependent properties: sharesOutstanding: nullable: true description: Number of outstanding shares. x-sortable: true type: string format: int64 freeFloat: nullable: true description: Number of free float shares. x-sortable: true type: string format: int64 currencyDependent: nullable: false description: Currency-dependent key figures. type: object x-property-sort: - marketCapitalizationSharesOutstanding - perShare properties: marketCapitalizationSharesOutstanding: nullable: true description: Market capitalization based on the number of outstanding shares. x-sortable: true type: number format: real perShare: nullable: false description: Per-share key figures. type: object x-property-sort: - earnings - bookValue - cashFlow - sales properties: earnings: nullable: true description: Earnings per share. x-sortable: true type: number format: real bookValue: nullable: true description: Book value per share. x-sortable: true type: number format: real cashFlow: nullable: true description: Cash flow per share. x-sortable: true type: number format: real sales: nullable: true description: Sales per share. x-sortable: true type: number format: real shareInstrument: nullable: false description: Share instrument key figures. type: object x-property-sort: - sharesOutstanding - freeFloat - ratios - currencyDependent properties: sharesOutstanding: nullable: true description: Number of outstanding shares. x-sortable: true type: string format: int64 freeFloat: nullable: true description: Number of free float shares. x-sortable: true type: string format: int64 ratios: nullable: false description: Ratios. type: object x-property-sort: - priceEarnings - priceBookValue - priceCashFlow - priceSales - dividendYield - earningsYield properties: priceEarnings: nullable: true description: Price earnings ratio. x-sortable: true type: number format: real priceBookValue: nullable: true description: Price book value ratio. x-sortable: true type: number format: real priceCashFlow: nullable: true description: Price cash flow ratio. x-sortable: true type: number format: real priceSales: nullable: true description: Price sales ratio. x-sortable: true type: number format: real dividendYield: nullable: true description: Dividend yield. x-sortable: true type: number format: relativeValue earningsYield: nullable: true description: Earnings yield. x-sortable: true type: number format: relativeValue currencyDependent: nullable: false description: Currency-dependent key figures. type: object x-property-sort: - marketCapitalizationSharesOutstanding - perShare properties: marketCapitalizationSharesOutstanding: nullable: true description: Market capitalization based on the number of outstanding shares. x-sortable: true type: number format: real perShare: nullable: false description: Per-share key figures. type: object x-property-sort: - dividend properties: dividend: nullable: true description: Dividend per share. x-sortable: true type: number format: real reportedKeyFigures: nullable: false description: Stock-specific key figures as reported for a fiscal year. type: object x-property-sort: - firstFiscalYear - secondFiscalYear - thirdFiscalYear properties: firstFiscalYear: nullable: false description: Data of the most recent fiscal year that has been requested. If the parameters used in the request refer to data from only one fiscal year, the respective data is found here. type: object x-property-sort: - fiscalYear - currencyDependentKeyFigures - ebitMargin - ebitdaMargin - netIncomeMargin - grossIncomeMargin - operatingMargin - returnOnAssets - returnOnEquity - ratios properties: fiscalYear: nullable: false description: Fiscal year to which the fiscal year data belongs. type: object x-property-sort: - yearEnd - year properties: yearEnd: nullable: true description: Calendar year of the ending date of the fiscal year. type: number format: int32 year: nullable: true description: Derived fiscal year. type: number format: int32 currencyDependentKeyFigures: nullable: false description: Currency-dependent key figures. If no currency has been selected (see parameter `reportedKeyFigures.currencyDependentKeyFigures.currency.isoCode`), the returned values are in the reporting currency of the company. type: object x-property-sort: - currency - marketCapitalization - ebit - ebitda - perShare properties: currency: nullable: false description: Currency of the attributes representing a monetary value. See endpoint `/basic/valueUnit/currency/main/list` for possible values. type: object x-property-sort: - id - isoCode properties: id: nullable: true description: Identifier of the currency. type: number format: id32 x-positive: true isoCode: nullable: true description: ISO 4217 code of the currency. x-sortable: true type: string marketCapitalization: nullable: true description: Market capitalization, which is the market value of the shares outstanding over all types of shares of the company. x-sortable: true type: number format: real ebit: nullable: true description: EBIT (earnings before interest and taxes). x-sortable: true type: number format: real ebitda: nullable: true description: EBITDA (earnings before interest, taxes, depreciation, and amortization). x-sortable: true type: number format: real perShare: nullable: false description: Per-share figures. type: object x-property-sort: - sales - recurringDilutedEarnings - dividends - bookValue - cashFlow properties: sales: nullable: true description: Total sales revenue per share. x-sortable: true type: number format: real recurringDilutedEarnings: nullable: true description: Recurring (excluding extraordinary items) diluted earnings per share, which is the ratio of the net income excluding extraordinary items, divided by the diluted shares outstanding. An extraordinary item is an atypical and infrequent gain or loss due to an unforeseeable event. x-sortable: true type: number format: real dividends: nullable: true description: Dividends per share, which is the ratio of the total dividends paid out, divided by the shares outstanding. In general, the figure is based on the gross dividend, i.e. before taxes, except for countries with special tax regimes. x-sortable: true type: number format: real bookValue: nullable: true description: Book value per share, which is the ratio of the book value (common equity), divided by the shares outstanding. x-sortable: true type: number format: real cashFlow: nullable: true description: Cash flow per share, which is the ratio of the net operating cash flow, divided by the diluted shares outstanding. x-sortable: true type: number format: real ebitMargin: nullable: true description: EBIT margin, which is the ratio of the EBIT, divided by the total sales revenue. x-sortable: true type: number format: relativeValue ebitdaMargin: nullable: true description: EBITDA margin, which is the ratio of the EBITDA, divided by the total sales revenue. x-sortable: true type: number format: relativeValue netIncomeMargin: nullable: true description: Net income margin, which is the ratio of the net income, divided by the total sales revenue. x-sortable: true type: number format: relativeValue grossIncomeMargin: nullable: true description: Gross income margin, which is the ratio of the gross income, divided by the total sales revenue. x-sortable: true type: number format: relativeValue operatingMargin: nullable: true description: Operating margin, which is the ratio of the operating income, divided by the sales revenue. x-sortable: true type: number format: relativeValue returnOnAssets: nullable: true description: Return on assets (ROA), which is the ratio of the net income, divided by the two-fiscal-year average of the total assets. x-sortable: true type: number format: relativeValue returnOnEquity: nullable: true description: Return on equity (ROE), which is the ratio of the net income, divided by the two-fiscal-year average of the total shareholders' equity. x-sortable: true type: number format: relativeValue ratios: nullable: false description: Ratios. type: object x-property-sort: - priceSales - priceEarnings - priceBookValue - priceCashFlow - priceFreeCashFlow - dividendYield - enterpriseValueEbit - enterpriseValueEbitda - enterpriseValueSales - debtEquity properties: priceSales: nullable: true description: Ratio of the price, divided by the total sales revenue per share. x-sortable: true type: number format: real priceEarnings: nullable: true description: Ratio of the price, divided by the reported earnings per share (basic or diluted) by the company. x-sortable: true type: number format: real priceBookValue: nullable: true description: Ratio of the price, divided by the book value per share. x-sortable: true type: number format: real priceCashFlow: nullable: true description: Ratio of the price, divided by the cash flow per share. x-sortable: true type: number format: real priceFreeCashFlow: nullable: true description: Ratio of the price, divided by the free (i.e. without subtraction of dividends) cash flow per share. x-sortable: true type: number format: real dividendYield: nullable: true description: Ratio of the dividend per share, divided by the price. x-sortable: true type: number format: relativeValue enterpriseValueEbit: nullable: true description: Ratio of the enterprise value, divided by the EBIT. x-sortable: true type: number format: real enterpriseValueEbitda: nullable: true description: Ratio of the enterprise value, divided by the EBITDA. x-sortable: true type: number format: real enterpriseValueSales: nullable: true description: Ratio of the enterprise value, divided by the total amount of sales revenue. x-sortable: true type: number format: real debtEquity: nullable: true description: Total-debt-to-total-equity ratio, which is the ratio of the total debt, divided by the total shareholders' equity. x-sortable: true type: number format: real secondFiscalYear: nullable: false description: Data of the second most recent fiscal year that has been requested. If the parameters used in the request refer to data from two fiscals year, the respective data of the more distant one is found here. type: object x-property-sort: - fiscalYear - currencyDependentKeyFigures - ebitMargin - ebitdaMargin - netIncomeMargin - grossIncomeMargin - operatingMargin - returnOnAssets - returnOnEquity - ratios properties: fiscalYear: nullable: false description: Fiscal year to which the fiscal year data belongs. type: object x-property-sort: - yearEnd - year properties: yearEnd: nullable: true description: Calendar year of the ending date of the fiscal year. type: number format: int32 year: nullable: true description: Derived fiscal year. type: number format: int32 currencyDependentKeyFigures: nullable: false description: Currency-dependent key figures. If no currency has been selected (see parameter `reportedKeyFigures.currencyDependentKeyFigures.currency.isoCode`), the returned values are in the reporting currency of the company. type: object x-property-sort: - currency - marketCapitalization - ebit - ebitda - perShare properties: currency: nullable: false description: Currency of the attributes representing a monetary value. See endpoint `/basic/valueUnit/currency/main/list` for possible values. type: object x-property-sort: - id - isoCode properties: id: nullable: true description: Identifier of the currency. type: number format: id32 x-positive: true isoCode: nullable: true description: ISO 4217 code of the currency. x-sortable: true type: string marketCapitalization: nullable: true description: Market capitalization, which is the market value of the shares outstanding over all types of shares of the company. x-sortable: true type: number format: real ebit: nullable: true description: EBIT (earnings before interest and taxes). x-sortable: true type: number format: real ebitda: nullable: true description: EBITDA (earnings before interest, taxes, depreciation, and amortization). x-sortable: true type: number format: real perShare: nullable: false description: Per-share figures. type: object x-property-sort: - sales - recurringDilutedEarnings - dividends - bookValue - cashFlow properties: sales: nullable: true description: Total sales revenue per share. x-sortable: true type: number format: real recurringDilutedEarnings: nullable: true description: Recurring (excluding extraordinary items) diluted earnings per share, which is the ratio of the net income excluding extraordinary items, divided by the diluted shares outstanding. An extraordinary item is an atypical and infrequent gain or loss due to an unforeseeable event. x-sortable: true type: number format: real dividends: nullable: true description: Dividends per share, which is the ratio of the total dividends paid out, divided by the shares outstanding. In general, the figure is based on the gross dividend, i.e. before taxes, except for countries with special tax regimes. x-sortable: true type: number format: real bookValue: nullable: true description: Book value per share, which is the ratio of the book value (common equity), divided by the shares outstanding. x-sortable: true type: number format: real cashFlow: nullable: true description: Cash flow per share, which is the ratio of the net operating cash flow, divided by the diluted shares outstanding. x-sortable: true type: number format: real ebitMargin: nullable: true description: EBIT margin, which is the ratio of the EBIT, divided by the total sales revenue. x-sortable: true type: number format: relativeValue ebitdaMargin: nullable: true description: EBITDA margin, which is the ratio of the EBITDA, divided by the total sales revenue. x-sortable: true type: number format: relativeValue netIncomeMargin: nullable: true description: Net income margin, which is the ratio of the net income, divided by the total sales revenue. x-sortable: true type: number format: relativeValue grossIncomeMargin: nullable: true description: Gross income margin, which is the ratio of the gross income, divided by the total sales revenue. x-sortable: true type: number format: relativeValue operatingMargin: nullable: true description: Operating margin, which is the ratio of the operating income, divided by the sales revenue. x-sortable: true type: number format: relativeValue returnOnAssets: nullable: true description: Return on assets (ROA), which is the ratio of the net income, divided by the two-fiscal-year average of the total assets. x-sortable: true type: number format: relativeValue returnOnEquity: nullable: true description: Return on equity (ROE), which is the ratio of the net income, divided by the two-fiscal-year average of the total shareholders' equity. x-sortable: true type: number format: relativeValue ratios: nullable: false description: Ratios. type: object x-property-sort: - priceSales - priceEarnings - priceBookValue - priceCashFlow - priceFreeCashFlow - dividendYield - enterpriseValueEbit - enterpriseValueEbitda - enterpriseValueSales - debtEquity properties: priceSales: nullable: true description: Ratio of the price, divided by the total sales revenue per share. x-sortable: true type: number format: real priceEarnings: nullable: true description: Ratio of the price, divided by the reported earnings per share (basic or diluted) by the company. x-sortable: true type: number format: real priceBookValue: nullable: true description: Ratio of the price, divided by the book value per share. x-sortable: true type: number format: real priceCashFlow: nullable: true description: Ratio of the price, divided by the cash flow per share. x-sortable: true type: number format: real priceFreeCashFlow: nullable: true description: Ratio of the price, divided by the free (i.e. without subtraction of dividends) cash flow per share. x-sortable: true type: number format: real dividendYield: nullable: true description: Ratio of the dividend per share, divided by the price. x-sortable: true type: number format: relativeValue enterpriseValueEbit: nullable: true description: Ratio of the enterprise value, divided by the EBIT. x-sortable: true type: number format: real enterpriseValueEbitda: nullable: true description: Ratio of the enterprise value, divided by the EBITDA. x-sortable: true type: number format: real enterpriseValueSales: nullable: true description: Ratio of the enterprise value, divided by the total amount of sales revenue. x-sortable: true type: number format: real debtEquity: nullable: true description: Total-debt-to-total-equity ratio, which is the ratio of the total debt, divided by the total shareholders' equity. x-sortable: true type: number format: real thirdFiscalYear: nullable: false description: Data of the most distant fiscal year that has been requested. Available only if the parameters used in the request refer to data from three fiscals year. type: object x-property-sort: - fiscalYear - currencyDependentKeyFigures - ebitMargin - ebitdaMargin - netIncomeMargin - grossIncomeMargin - operatingMargin - returnOnAssets - returnOnEquity - ratios properties: fiscalYear: nullable: false description: Fiscal year to which the fiscal year data belongs. type: object x-property-sort: - yearEnd - year properties: yearEnd: nullable: true description: Calendar year of the ending date of the fiscal year. type: number format: int32 year: nullable: true description: Derived fiscal year. type: number format: int32 currencyDependentKeyFigures: nullable: false description: Currency-dependent key figures. If no currency has been selected (see parameter `reportedKeyFigures.currencyDependentKeyFigures.currency.isoCode`), the returned values are in the reporting currency of the company. type: object x-property-sort: - currency - marketCapitalization - ebit - ebitda - perShare properties: currency: nullable: false description: Currency of the attributes representing a monetary value. See endpoint `/basic/valueUnit/currency/main/list` for possible values. type: object x-property-sort: - id - isoCode properties: id: nullable: true description: Identifier of the currency. type: number format: id32 x-positive: true isoCode: nullable: true description: ISO 4217 code of the currency. x-sortable: true type: string marketCapitalization: nullable: true description: Market capitalization, which is the market value of the shares outstanding over all types of shares of the company. x-sortable: true type: number format: real ebit: nullable: true description: EBIT (earnings before interest and taxes). x-sortable: true type: number format: real ebitda: nullable: true description: EBITDA (earnings before interest, taxes, depreciation, and amortization). x-sortable: true type: number format: real perShare: nullable: false description: Per-share figures. type: object x-property-sort: - sales - recurringDilutedEarnings - dividends - bookValue - cashFlow properties: sales: nullable: true description: Total sales revenue per share. x-sortable: true type: number format: real recurringDilutedEarnings: nullable: true description: Recurring (excluding extraordinary items) diluted earnings per share, which is the ratio of the net income excluding extraordinary items, divided by the diluted shares outstanding. An extraordinary item is an atypical and infrequent gain or loss due to an unforeseeable event. x-sortable: true type: number format: real dividends: nullable: true description: Dividends per share, which is the ratio of the total dividends paid out, divided by the shares outstanding. In general, the figure is based on the gross dividend, i.e. before taxes, except for countries with special tax regimes. x-sortable: true type: number format: real bookValue: nullable: true description: Book value per share, which is the ratio of the book value (common equity), divided by the shares outstanding. x-sortable: true type: number format: real cashFlow: nullable: true description: Cash flow per share, which is the ratio of the net operating cash flow, divided by the diluted shares outstanding. x-sortable: true type: number format: real ebitMargin: nullable: true description: EBIT margin, which is the ratio of the EBIT, divided by the total sales revenue. x-sortable: true type: number format: relativeValue ebitdaMargin: nullable: true description: EBITDA margin, which is the ratio of the EBITDA, divided by the total sales revenue. x-sortable: true type: number format: relativeValue netIncomeMargin: nullable: true description: Net income margin, which is the ratio of the net income, divided by the total sales revenue. x-sortable: true type: number format: relativeValue grossIncomeMargin: nullable: true description: Gross income margin, which is the ratio of the gross income, divided by the total sales revenue. x-sortable: true type: number format: relativeValue operatingMargin: nullable: true description: Operating margin, which is the ratio of the operating income, divided by the sales revenue. x-sortable: true type: number format: relativeValue returnOnAssets: nullable: true description: Return on assets (ROA), which is the ratio of the net income, divided by the two-fiscal-year average of the total assets. x-sortable: true type: number format: relativeValue returnOnEquity: nullable: true description: Return on equity (ROE), which is the ratio of the net income, divided by the two-fiscal-year average of the total shareholders' equity. x-sortable: true type: number format: relativeValue ratios: nullable: false description: Ratios. type: object x-property-sort: - priceSales - priceEarnings - priceBookValue - priceCashFlow - priceFreeCashFlow - dividendYield - enterpriseValueEbit - enterpriseValueEbitda - enterpriseValueSales - debtEquity properties: priceSales: nullable: true description: Ratio of the price, divided by the total sales revenue per share. x-sortable: true type: number format: real priceEarnings: nullable: true description: Ratio of the price, divided by the reported earnings per share (basic or diluted) by the company. x-sortable: true type: number format: real priceBookValue: nullable: true description: Ratio of the price, divided by the book value per share. x-sortable: true type: number format: real priceCashFlow: nullable: true description: Ratio of the price, divided by the cash flow per share. x-sortable: true type: number format: real priceFreeCashFlow: nullable: true description: Ratio of the price, divided by the free (i.e. without subtraction of dividends) cash flow per share. x-sortable: true type: number format: real dividendYield: nullable: true description: Ratio of the dividend per share, divided by the price. x-sortable: true type: number format: relativeValue enterpriseValueEbit: nullable: true description: Ratio of the enterprise value, divided by the EBIT. x-sortable: true type: number format: real enterpriseValueEbitda: nullable: true description: Ratio of the enterprise value, divided by the EBITDA. x-sortable: true type: number format: real enterpriseValueSales: nullable: true description: Ratio of the enterprise value, divided by the total amount of sales revenue. x-sortable: true type: number format: real debtEquity: nullable: true description: Total-debt-to-total-equity ratio, which is the ratio of the total debt, divided by the total shareholders' equity. x-sortable: true type: number format: real benchmark: nullable: false description: Benchmark-related data. type: object x-property-sort: - index - beta - correlation - outperformance properties: index: nullable: false description: Benchmark index-related data. type: object x-property-sort: - id - instrument properties: id: nullable: true description: Identifier of the notation. type: string format: id64 x-positive: true instrument: nullable: false description: Instrument of the benchmark. type: object x-property-sort: - id - name properties: id: nullable: true description: Identifier of the instrument. type: string format: id64 x-positive: true name: nullable: true description: Name of the instrument. type: string format: localizedString beta: nullable: false description: Beta of the stock notation with respect to the benchmark notation. type: object x-property-sort: - week1 - month1 - months3 - months6 - year1 - years3 - years5 properties: week1: nullable: true description: Beta for the time range one week. x-sortable: true type: number format: real month1: nullable: true description: Beta for the time range one month. x-sortable: true type: number format: real months3: nullable: true description: Beta for the time range three months. x-sortable: true type: number format: real months6: nullable: true description: Beta for the time range six months. x-sortable: true type: number format: real year1: nullable: true description: Beta for the time range one year. x-sortable: true type: number format: real years3: nullable: true description: Beta for the time range three years. x-sortable: true type: number format: real years5: nullable: true description: Beta for the time range five years. x-sortable: true type: number format: real correlation: nullable: false description: Correlation of the stock notation with respect to the benchmark notation. type: object x-property-sort: - week1 - month1 - months3 - months6 - year1 - years3 - years5 properties: week1: nullable: true description: Correlation for the time range one week. x-sortable: true type: number format: real month1: nullable: true description: Correlation for the time range one month. x-sortable: true type: number format: real months3: nullable: true description: Correlation for the time range three months. x-sortable: true type: number format: real months6: nullable: true description: Correlation for the time range six months. x-sortable: true type: number format: real year1: nullable: true description: Correlation for the time range one year. x-sortable: true type: number format: real years3: nullable: true description: Correlation for the time range three years. x-sortable: true type: number format: real years5: nullable: true description: Correlation for the time range five years. x-sortable: true type: number format: real outperformance: nullable: false description: Outperformance of the stock notation with respect to the benchmark notation. type: object x-property-sort: - week1 - month1 - months3 - months6 - year1 - years3 - years5 properties: week1: nullable: true description: Outperformance for the time range one week. x-sortable: true type: number format: relativeValue month1: nullable: true description: Outperformance for the time range one month. x-sortable: true type: number format: relativeValue months3: nullable: true description: Outperformance for the time range three months. x-sortable: true type: number format: relativeValue months6: nullable: true description: Outperformance for the time range six months. x-sortable: true type: number format: relativeValue year1: nullable: true description: Outperformance for the time range one year. x-sortable: true type: number format: relativeValue years3: nullable: true description: Outperformance for the time range three years. x-sortable: true type: number format: relativeValue years5: nullable: true description: Outperformance for the time range five years. x-sortable: true type: number format: relativeValue performance: nullable: false description: Relative performance for different time ranges. type: object x-property-sort: - intraday - endOfDay properties: intraday: nullable: true description: Intraday relative performance. That is the difference of a notation's most recent price from the current trading day against the most recent EOD closing price. x-sortable: true type: number format: relativeValue endOfDay: nullable: false description: End-of-day (EOD) relative performance for different time ranges. The relative performance is the difference of a notation's most recent EOD closing price against the EOD closing price on the reference date, relative to the EOD closing price on the reference date. type: object x-property-sort: - day1 - week1 - month1 - months3 - months6 - year1 - years3 - years5 - yearToDate properties: day1: nullable: true description: One day. x-sortable: true type: number format: relativeValue week1: nullable: true description: One week. x-sortable: true type: number format: relativeValue month1: nullable: true description: One month. x-sortable: true type: number format: relativeValue months3: nullable: true description: Three months. x-sortable: true type: number format: relativeValue months6: nullable: true description: Six months. x-sortable: true type: number format: relativeValue year1: nullable: true description: One year. x-sortable: true type: number format: relativeValue years3: nullable: true description: Three years. x-sortable: true type: number format: relativeValue years5: nullable: true description: Five years. x-sortable: true type: number format: relativeValue yearToDate: nullable: true description: Year-to-date. x-sortable: true type: number format: relativeValue volatility: nullable: false description: Volatility of the daily logarithmic returns, annualized assuming 256 trading days per year for different time ranges. type: object x-property-sort: - week1 - month1 - months3 - months6 - year1 - years3 - years5 - yearToDate properties: week1: nullable: true description: One week. x-sortable: true type: number format: relativeValue month1: nullable: true description: One month. x-sortable: true type: number format: relativeValue months3: nullable: true description: Three months. x-sortable: true type: number format: relativeValue months6: nullable: true description: Six months. x-sortable: true type: number format: relativeValue year1: nullable: true description: One year. x-sortable: true type: number format: relativeValue years3: nullable: true description: Three years. x-sortable: true type: number format: relativeValue years5: nullable: true description: Five years. x-sortable: true type: number format: relativeValue yearToDate: nullable: true description: Year-to-date. x-sortable: true type: number format: relativeValue tradingValue: nullable: false description: Sum of the cash flow for all transactions of a notation over a certain time range. The cash flow of a transaction is its volume multiplied by its trade price. type: object x-property-sort: - average properties: average: nullable: false description: Arithmetic mean of the trading value for different time ranges. type: object x-property-sort: - days5 - days30 properties: days5: nullable: true description: Five trading days. x-sortable: true type: number format: real days30: nullable: true description: 30 trading days. x-sortable: true type: number format: real simpleMovingAverage: nullable: false description: Simple moving average (SMA), that is the arithmetic mean of a notation�"s EOD closing price, for different time ranges. type: object x-property-sort: - days20 - days50 - days200 - tradingDaysSinceCrossover properties: days20: nullable: true description: 20 trading days. type: number format: real days50: nullable: true description: 50 trading days. type: number format: real days200: nullable: true description: 200 trading days. type: number format: real tradingDaysSinceCrossover: nullable: false description: Number of trading days since a simple moving average crossed another one. All SMAs are calculated with EOD prices, thus the value 0 for the number of days means the crossover occurred on the most recent trading day for which such prices are available. type: object x-property-sort: - sma20vs50 - sma50vs200 properties: sma20vs50: nullable: false description: Number of trading days since the crossover and direction thereof of the SMA 20 (see parameter `simpleMovingAverage.days20`) and the SMA 50 (see parameter `simpleMovingAverage.days50`). Only crossovers which occurred in the most recent 100 trading days are considered, hence the attribute `sma20vs50.numberDays` cannot exceed the value 100. type: object x-property-sort: - numberDays - direction properties: numberDays: nullable: true description: Number of trading days. x-sortable: true type: number format: int32 direction: nullable: true description: Direction of the crossing. x-sortable: true type: string x-enum-description: - The SMA 20 crossed the SMA 50 from below, hence the SMA 20 has currently a higher value. - The SMA 20 crossed the SMA 50 from above, hence the SMA 20 has currently a lower value. enum: - up - down sma50vs200: nullable: false description: Number of trading days since the crossover and direction thereof of the SMA 50 (see parameter `simpleMovingAverage.days50`) and the SMA 200 (see parameter `simpleMovingAverage.days200`). Only crossovers which occurred in the most recent 300 trading days are considered, hence the attribute `sma50vs200.numberDays` cannot exceed the value 300. type: object x-property-sort: - numberDays - direction properties: numberDays: nullable: true description: Number of trading days. x-sortable: true type: number format: int32 direction: nullable: true description: Direction of the crossing. x-sortable: true type: string x-enum-description: - The SMA 50 crossed the SMA 200 from below, hence the SMA 50 has currently a higher value. - The SMA 50 crossed the SMA 200 from above, hence the SMA 50 has currently a lower value. enum: - up - down rsiWilder: nullable: false description: Relative strength index (RSI) by Wilder for different time ranges. This is the ratio of the smoothed moving averages of the upwards and downwards daily returns over the given period, normalized to the range between 0 and 100. The RSI by Wilder measures the magnitude of the price changes in a given time period evaluating whether an asset is overbought or oversold and deriving a respective sell or buy signal. type: object x-property-sort: - days14 properties: days14: nullable: true x-sortable: true description: 14 trading days. type: number format: real recommendation: nullable: false description: Aggregated recommendation. type: object x-property-sort: - counts - consensus properties: counts: nullable: false description: Number of recommendations. type: object x-property-sort: - total properties: total: nullable: true x-sortable: true description: Total number of recommendations included in the current recommendation consensus (see attribute `recommendation.consensus`). type: number format: int32 consensus: nullable: false description: Recommendation consensus, which is the average value of all provided recommendations. type: object x-property-sort: - value - change properties: value: nullable: true description: Recommendation consensus value. Values are in the range from 1.0 to 5.0, whereby 1 represents the strongest buy recommendation, 3 a hold (neutral) recommendation and 5 the strongest sell recommendation. type: number format: real change: nullable: false description: Recommendation change as the difference of the current recommendation value minus the historic recommendation value. Values are in the range from -4.0 to 4.0, whereby -4 represents a recommendation change from 5.0 to 1.0 and 4 represents a recommendation change from 1 to 5. type: object x-property-sort: - week1 - month1 - months3 - months6 - year1 properties: week1: nullable: true description: Recommendation change for the time range one week. x-sortable: true type: number format: real month1: nullable: true description: Recommendation change for the time range one month. x-sortable: true type: number format: real months3: nullable: true description: Recommendation change for the time range three months. x-sortable: true type: number format: real months6: nullable: true description: Recommendation change for the time range six months. x-sortable: true type: number format: real year1: nullable: true description: Recommendation change for the time range one year. x-sortable: true type: number format: real estimates: nullable: false description: Stock-specific consolidated estimates for a fiscal year. type: object x-property-sort: - firstFiscalYear - secondFiscalYear - thirdFiscalYear properties: firstFiscalYear: nullable: false description: Estimates for the closest fiscal year that has been requested. If the parameters used in the request refer to data from only one fiscal year, the respective data is found here. type: object x-property-sort: - fiscalYear - currencyDependentEstimates - returnOnAssets - returnOnEquity - ratios properties: fiscalYear: nullable: false description: Fiscal year to which the estimates belong. type: object x-property-sort: - yearEnd - year properties: yearEnd: nullable: true description: Calendar year of the ending date of the fiscal year. type: number format: int32 year: nullable: true description: Derived fiscal year. type: number format: int32 currencyDependentEstimates: nullable: false description: Currency-dependent estimates. If no currency has been selected (see parameter `estimates.currencyDependentEstimates.currency.isoCode`) the currency in which the analysts report is used. type: object x-property-sort: - currency - ebit - ebitda - perShare properties: currency: nullable: false description: Currency of the currency-dependent estimates. See endpoint `/basic/valueUnit/currency/main/list` for possible values. type: object x-property-sort: - id - isoCode properties: id: nullable: true description: Identifier of a currency. type: number format: int32 isoCode: nullable: true description: ISO 4217 code of the currency. x-sortable: true type: string ebit: nullable: false description: EBIT (earnings before interest and taxes). type: object x-property-sort: - mean properties: mean: nullable: true description: Mean value. x-sortable: true type: number format: real ebitda: nullable: false description: EBITDA (earnings before interest, taxes, depreciation, and amortization). type: object x-property-sort: - mean properties: mean: nullable: true description: Mean value. x-sortable: true type: number format: real perShare: nullable: false description: Per-share figures. type: object x-property-sort: - sales - earnings - dividends - cashFlow properties: sales: nullable: false description: Total sales revenue per share. type: object x-property-sort: - mean properties: mean: nullable: true description: Mean value. x-sortable: true type: number format: real earnings: nullable: false description: Earnings per share (EPS), which is ratio of the net income, divided by the shares outstanding. For European equities, EPS is adjusted for exceptional and any non-recurring items. For Asian equities, EPS is as reported (as per local accounting standards). For US, Canada & South Africa, EPS reflects the analysts�" and company�"s standards. type: object x-property-sort: - mean properties: mean: nullable: true description: Mean value. x-sortable: true type: number format: real dividends: nullable: false description: Dividends per share, which is the ratio of the total dividends paid out, divided by the shares outstanding. type: object x-property-sort: - mean properties: mean: nullable: true description: Mean value. x-sortable: true type: number format: real cashFlow: nullable: false description: Cash flow per share, which is the ratio of the net operating cash flow, divided by the shares outstanding. type: object x-property-sort: - mean properties: mean: nullable: true description: Mean value. x-sortable: true type: number format: real returnOnAssets: nullable: false description: Return on assets (ROA), which is the ratio of the net income, divided by the total assets. type: object x-property-sort: - mean properties: mean: nullable: true description: Mean value. x-sortable: true type: number format: real returnOnEquity: nullable: false description: Return on equity (ROE), which is the ratio of the net income, divided by the total shareholders' equity. type: object x-property-sort: - mean properties: mean: nullable: true description: Mean value. x-sortable: true type: number format: real ratios: nullable: false description: Ratios. type: object x-property-sort: - priceSales - priceEarnings - priceEarningsGrowth - priceBookValue - priceCashFlow - priceFreeCashFlow - dividendYield - enterpriseValueEbit - enterpriseValueEbitda - enterpriseValueSales properties: priceSales: nullable: false description: Ratio of the price, divided by the total sales revenue per share. type: object x-property-sort: - mean properties: mean: nullable: true description: Mean value. x-sortable: true type: number format: real priceEarnings: nullable: false description: Ratio of the price, divided by the earnings per share. type: object x-property-sort: - mean properties: mean: nullable: true description: Mean value. x-sortable: true type: number format: real priceEarningsGrowth: nullable: false description: Price-earnings ratio divided by the growth rate of the earnings. type: object x-property-sort: - mean properties: mean: nullable: true description: Mean value. x-sortable: true type: number format: real priceBookValue: nullable: false description: Ratio of the price, divided by the book value per share. type: object x-property-sort: - mean properties: mean: nullable: true description: Mean value. x-sortable: true type: number format: real priceCashFlow: nullable: false description: Ratio of the price, divided by the cash flow per share. type: object x-property-sort: - mean properties: mean: nullable: true description: Mean value. x-sortable: true type: number format: real priceFreeCashFlow: nullable: false description: Ratio of the price, divided by the free (i.e. without subtraction of dividends) cash flow per share. type: object x-property-sort: - mean properties: mean: nullable: true description: Mean value. x-sortable: true type: number format: real dividendYield: nullable: false description: Ratio of the dividend per share, divided by the price. type: object x-property-sort: - mean properties: mean: nullable: true description: Mean value. x-sortable: true type: number format: relativeValue enterpriseValueEbit: nullable: false description: Ratio of the enterprise value, divided by the EBIT. type: object x-property-sort: - mean properties: mean: nullable: true description: Mean value. x-sortable: true type: number format: real enterpriseValueEbitda: nullable: false description: Ratio of the enterprise value, divided by the EBITDA. type: object x-property-sort: - mean properties: mean: nullable: true description: Mean value. x-sortable: true type: number format: real enterpriseValueSales: nullable: false description: Ratio of the enterprise value, divided by the total amount of sales revenue. type: object x-property-sort: - mean properties: mean: nullable: true description: Mean value. x-sortable: true type: number format: real secondFiscalYear: nullable: false description: Estimates for the second most distant fiscal year that has been requested. If the parameters used in the request refer to data from two fiscals year, the respective data of the more distant one is found here. type: object x-property-sort: - fiscalYear - currencyDependentEstimates - returnOnAssets - returnOnEquity - ratios properties: fiscalYear: nullable: false description: Fiscal year to which the estimates belong. type: object x-property-sort: - yearEnd - year properties: yearEnd: nullable: true description: Calendar year of the ending date of the fiscal year. type: number format: int32 year: nullable: true description: Derived fiscal year. type: number format: int32 currencyDependentEstimates: nullable: false description: Currency-dependent estimates. If no currency has been selected (see parameter `estimates.currencyDependentEstimates.currency.isoCode`) the currency in which the analysts report is used. type: object x-property-sort: - currency - ebit - ebitda - perShare properties: currency: nullable: false description: Currency of the currency-dependent estimates. See endpoint `/basic/valueUnit/currency/main/list` for possible values. type: object x-property-sort: - id - isoCode properties: id: nullable: true description: Identifier of a currency. type: number format: int32 isoCode: nullable: true description: ISO 4217 code of the currency. x-sortable: true type: string ebit: nullable: false description: EBIT (earnings before interest and taxes). type: object x-property-sort: - mean properties: mean: nullable: true description: Mean value. x-sortable: true type: number format: real ebitda: nullable: false description: EBITDA (earnings before interest, taxes, depreciation, and amortization). type: object x-property-sort: - mean properties: mean: nullable: true description: Mean value. x-sortable: true type: number format: real perShare: nullable: false description: Per-share figures. type: object x-property-sort: - sales - earnings - dividends - cashFlow properties: sales: nullable: false description: Total sales revenue per share. type: object x-property-sort: - mean properties: mean: nullable: true description: Mean value. x-sortable: true type: number format: real earnings: nullable: false description: Earnings per share (EPS), which is ratio of the net income, divided by the shares outstanding. For European equities, EPS is adjusted for exceptional and any non-recurring items. For Asian equities, EPS is as reported (as per local accounting standards). For US, Canada & South Africa, EPS reflects the analysts�" and company�"s standards. type: object x-property-sort: - mean properties: mean: nullable: true description: Mean value. x-sortable: true type: number format: real dividends: nullable: false description: Dividends per share, which is the ratio of the total dividends paid out, divided by the shares outstanding. type: object x-property-sort: - mean properties: mean: nullable: true description: Mean value. x-sortable: true type: number format: real cashFlow: nullable: false description: Cash flow per share, which is the ratio of the net operating cash flow, divided by the shares outstanding. type: object x-property-sort: - mean properties: mean: nullable: true description: Mean value. x-sortable: true type: number format: real returnOnAssets: nullable: false description: Return on assets (ROA), which is the ratio of the net income, divided by the total assets. type: object x-property-sort: - mean properties: mean: nullable: true description: Mean value. x-sortable: true type: number format: real returnOnEquity: nullable: false description: Return on equity (ROE), which is the ratio of the net income, divided by the total shareholders' equity. type: object x-property-sort: - mean properties: mean: nullable: true description: Mean value. x-sortable: true type: number format: real ratios: nullable: false description: Ratios. type: object x-property-sort: - priceSales - priceEarnings - priceEarningsGrowth - priceBookValue - priceCashFlow - priceFreeCashFlow - dividendYield - enterpriseValueEbit - enterpriseValueEbitda - enterpriseValueSales properties: priceSales: nullable: false description: Ratio of the price, divided by the total sales revenue per share. type: object x-property-sort: - mean properties: mean: nullable: true description: Mean value. x-sortable: true type: number format: real priceEarnings: nullable: false description: Ratio of the price, divided by the earnings per share. type: object x-property-sort: - mean properties: mean: nullable: true description: Mean value. x-sortable: true type: number format: real priceEarningsGrowth: nullable: false description: Price-earnings ratio divided by the growth rate of the earnings. type: object x-property-sort: - mean properties: mean: nullable: true description: Mean value. x-sortable: true type: number format: real priceBookValue: nullable: false description: Ratio of the price, divided by the book value per share. type: object x-property-sort: - mean properties: mean: nullable: true description: Mean value. x-sortable: true type: number format: real priceCashFlow: nullable: false description: Ratio of the price, divided by the cash flow per share. type: object x-property-sort: - mean properties: mean: nullable: true description: Mean value. x-sortable: true type: number format: real priceFreeCashFlow: nullable: false description: Ratio of the price, divided by the free (i.e. without subtraction of dividends) cash flow per share. type: object x-property-sort: - mean properties: mean: nullable: true description: Mean value. x-sortable: true type: number format: real dividendYield: nullable: false description: Ratio of the dividend per share, divided by the price. type: object x-property-sort: - mean properties: mean: nullable: true description: Mean value. x-sortable: true type: number format: relativeValue enterpriseValueEbit: nullable: false description: Ratio of the enterprise value, divided by the EBIT. type: object x-property-sort: - mean properties: mean: nullable: true description: Mean value. x-sortable: true type: number format: real enterpriseValueEbitda: nullable: false description: Ratio of the enterprise value, divided by the EBITDA. type: object x-property-sort: - mean properties: mean: nullable: true description: Mean value. x-sortable: true type: number format: real enterpriseValueSales: nullable: false description: Ratio of the enterprise value, divided by the total amount of sales revenue. type: object x-property-sort: - mean properties: mean: nullable: true description: Mean value. x-sortable: true type: number format: real thirdFiscalYear: nullable: false description: Estimates for the most distant fiscal year that has been requested. Available only if the parameters used in the request refer to data from three fiscals year. type: object x-property-sort: - fiscalYear - currencyDependentEstimates - returnOnAssets - returnOnEquity - ratios properties: fiscalYear: nullable: false description: Fiscal year to which the estimates belong. type: object x-property-sort: - yearEnd - year properties: yearEnd: nullable: true description: Calendar year of the ending date of the fiscal year. type: number format: int32 year: nullable: true description: Derived fiscal year. type: number format: int32 currencyDependentEstimates: nullable: false description: Currency-dependent estimates. If no currency has been selected (see parameter `estimates.currencyDependentEstimates.currency.isoCode`) the currency in which the analysts report is used. type: object x-property-sort: - currency - ebit - ebitda - perShare properties: currency: nullable: false description: Currency of the currency-dependent estimates. See endpoint `/basic/valueUnit/currency/main/list` for possible values. type: object x-property-sort: - id - isoCode properties: id: nullable: true description: Identifier of a currency. type: number format: int32 isoCode: nullable: true description: ISO 4217 code of the currency. x-sortable: true type: string ebit: nullable: false description: EBIT (earnings before interest and taxes). type: object x-property-sort: - mean properties: mean: nullable: true description: Mean value. x-sortable: true type: number format: real ebitda: nullable: false description: EBITDA (earnings before interest, taxes, depreciation, and amortization). type: object x-property-sort: - mean properties: mean: nullable: true description: Mean value. x-sortable: true type: number format: real perShare: nullable: false description: Per-share figures. type: object x-property-sort: - sales - earnings - dividends - cashFlow properties: sales: nullable: false description: Total sales revenue per share. type: object x-property-sort: - mean properties: mean: nullable: true description: Mean value. x-sortable: true type: number format: real earnings: nullable: false description: Earnings per share (EPS), which is ratio of the net income, divided by the shares outstanding. For European equities, EPS is adjusted for exceptional and any non-recurring items. For Asian equities, EPS is as reported (as per local accounting standards). For US, Canada & South Africa, EPS reflects the analysts�" and company�"s standards. type: object x-property-sort: - mean properties: mean: nullable: true description: Mean value. x-sortable: true type: number format: real dividends: nullable: false description: Dividends per share, which is the ratio of the total dividends paid out, divided by the shares outstanding. type: object x-property-sort: - mean properties: mean: nullable: true description: Mean value. x-sortable: true type: number format: real cashFlow: nullable: false description: Cash flow per share, which is the ratio of the net operating cash flow, divided by the shares outstanding. type: object x-property-sort: - mean properties: mean: nullable: true description: Mean value. x-sortable: true type: number format: real returnOnAssets: nullable: false description: Return on assets (ROA), which is the ratio of the net income, divided by the total assets. type: object x-property-sort: - mean properties: mean: nullable: true description: Mean value. x-sortable: true type: number format: real returnOnEquity: nullable: false description: Return on equity (ROE), which is the ratio of the net income, divided by the total shareholders' equity. type: object x-property-sort: - mean properties: mean: nullable: true description: Mean value. x-sortable: true type: number format: real ratios: nullable: false description: Ratios. type: object x-property-sort: - priceSales - priceEarnings - priceEarningsGrowth - priceBookValue - priceCashFlow - priceFreeCashFlow - dividendYield - enterpriseValueEbit - enterpriseValueEbitda - enterpriseValueSales properties: priceSales: nullable: false description: Ratio of the price, divided by the total sales revenue per share. type: object x-property-sort: - mean properties: mean: nullable: true description: Mean value. x-sortable: true type: number format: real priceEarnings: nullable: false description: Ratio of the price, divided by the earnings per share. type: object x-property-sort: - mean properties: mean: nullable: true description: Mean value. x-sortable: true type: number format: real priceEarningsGrowth: nullable: false description: Price-earnings ratio divided by the growth rate of the earnings. type: object x-property-sort: - mean properties: mean: nullable: true description: Mean value. x-sortable: true type: number format: real priceBookValue: nullable: false description: Ratio of the price, divided by the book value per share. type: object x-property-sort: - mean properties: mean: nullable: true description: Mean value. x-sortable: true type: number format: real priceCashFlow: nullable: false description: Ratio of the price, divided by the cash flow per share. type: object x-property-sort: - mean properties: mean: nullable: true description: Mean value. x-sortable: true type: number format: real priceFreeCashFlow: nullable: false description: Ratio of the price, divided by the free (i.e. without subtraction of dividends) cash flow per share. type: object x-property-sort: - mean properties: mean: nullable: true description: Mean value. x-sortable: true type: number format: real dividendYield: nullable: false description: Ratio of the dividend per share, divided by the price. type: object x-property-sort: - mean properties: mean: nullable: true description: Mean value. x-sortable: true type: number format: relativeValue enterpriseValueEbit: nullable: false description: Ratio of the enterprise value, divided by the EBIT. type: object x-property-sort: - mean properties: mean: nullable: true description: Mean value. x-sortable: true type: number format: real enterpriseValueEbitda: nullable: false description: Ratio of the enterprise value, divided by the EBITDA. type: object x-property-sort: - mean properties: mean: nullable: true description: Mean value. x-sortable: true type: number format: real enterpriseValueSales: nullable: false description: Ratio of the enterprise value, divided by the total amount of sales revenue. type: object x-property-sort: - mean properties: mean: nullable: true description: Mean value. x-sortable: true type: number format: real x-partial: true meta: type: object description: The meta member contains the meta information of the response. properties: status: $ref: '#/components/schemas/StatusObject_2' pagination: $ref: '#/components/schemas/OffsetBasedPaginationOutputObject_2' partial: $ref: '#/components/schemas/PartialOutputObject_2' x-property-sort: - status - pagination - partial PostSecuritizedDerivativeIssuerSearch200Response: description: Successful Response content: application/json: schema: type: object properties: data: nullable: false type: array items: type: object nullable: false x-property-sort: - id - name - count properties: id: nullable: true type: number format: id32 x-positive: true description: Identifier of the issuer. name: nullable: true type: string description: Name of the issuer. count: nullable: true type: number format: int32 description: Number of securitized derivatives issued. description: List of issuers, including issuer groups, sorted descending by the number of securitized derivatives issued. meta: type: object description: The meta member contains the meta information of the response. properties: status: $ref: '#/components/schemas/StatusObject' x-property-sort: - status examples: AuthErrorDetails: summary: Sample Error Response value: errors: - code: Not Authenticated title: Unauthenticated USERNAME-SERIAL. id: fd5a51ff-02cf-48ec-b9b1-913d64863b0 ServerErrorDetails: summary: Sample Error Response value: errors: - code: Internal Server Error title: An unexpected error happened. id: 7af3d86ca5954503b9244f2620fcf5eb AuthorizationErrorDetails: summary: Sample Error Response value: errors: - code: Forbidden title: USERNAME-SERIAL does not have permission. id: 7af3d86ca5954503b9244f2620fcf5eb ErrorDetails: summary: Sample Error Response value: errors: - code: Bad Request title: parameterError:['_paginationLimit'] is not a valid parameter(s). id: 7af3d86ca5954503b9244f2620fcf5eb parameters: categories: schema: type: array items: type: string in: query name: categories example: - CN:US - LN:EN description: 'Code for categories to include. This is a comma-separated list. Use the ```/helper``` endpoint to get the list of available categories. Default = All categories.' explode: false DisableNoAnswerResponses: name: disableNoAnswerResponses in: query description: Disables no-result answer responses (no-results and answer without data) required: false schema: type: boolean default: true IncludeThumbnail: name: includeThumbnail in: query description: Includes thumbnail of Adaptive Card in response required: false schema: type: boolean default: false ids: schema: type: array items: type: string in: query name: ids examples: oneId: summary: One identifier value: - MODN-US multipleIds: summary: Multiple Identifiers value: - MODN-US - OSIS-US description: Requested symbols or securities. This is a comma-separated list with a maximum limit of 1000. Each symbol can be a FactSet exchange symbol, CUSIP, or SEDOL. explode: false Query: name: query in: query description: Query for desired answer (e.g., "fds price") required: true schema: type: string ConsumingApplication: name: consumingApplication in: query description: Name of application consuming the API (used for analytics purposes) required: false schema: type: string default: Developer Portal searchText: schema: type: string in: query name: searchText example: Updates description: Restricts the search to include only document stories which include the text searched. primaryId: schema: type: string enum: - Y - N default: N in: query name: primaryId description: 'Type of identifier search * Y - Returns headlines of stories that have the search ID(s) as the Primary ID. * N - Returns headlines of stories that mention/refer to the ID(s).' Theme: name: theme in: query description: Theme for desired answer (e.g., "Light", "Dark") required: false schema: type: string default: Light startDate: schema: type: string default: '0' in: query name: startDate example: '20231222' description: Start Date. Format is YYYYMMDD or relative +/- days (0,-1,etc). timezone: schema: type: string default: America/New_York in: query name: timezone description: Time zone to return story dates and times. Time zones are in POSIX format and automatically adjusted for daylight savings. sourcesOne: schema: type: array items: type: string in: query name: sources required: true examples: oneSource: summary: One Source value: - EDG multipleSources: summary: Multiple Sources value: - EDG - FFR description: Code for document source to include. This is a comma-separated list. Use the ```/helper``` endpoint to get the list of available sources. explode: false sort: schema: type: string enum: - asc - desc default: desc in: query name: sort description: "Sorting the results in chronological (oldest to newest) or reverse chronological (newest to oldest) order. \n\n * desc - sorting results in reverse chronological (descending) order. This is the default value if\n the sort parameter isnt used in the query\n \n * asc - sorting results in chronological (ascending) order. If a start date is not specified, the\n API has a 10-year searching limitation. " paginationLimit: schema: type: integer format: int32 default: 25 in: query name: paginationLimit example: 20 description: Number of results to return per page. formType: schema: type: string in: query description: Restricts the search to include any form types of EDGAR. name: formType required: false paginationOffset: schema: type: integer format: int32 in: query name: paginationOffset description: Page number of the results to return. endDate: schema: type: string default: '0' in: query name: endDate example: '20231223' description: End Date. Format is YYYYMMDD or relative +/- days (0,-1,etc). accession: schema: type: string in: query description: A unique identifier given to each EDGAR filings document. e.g. accession=0001013237-21-000069&sources=EDG name: accession required: false securitySchemes: basicAuth: type: http scheme: basic definitions: PostAttributesGroupSearchDto: properties: limit: description: Limit the amount of records per page. example: 10 type: integer default: 10 maximum: 300 page: description: Select which page to show. example: 1 type: integer default: 1 minimum: 1 sort: description: Sort according to specific field value. example: name:asc type: string default: name:asc fields: description: Fetch only specific fields. The fields' names separated by a comma. example: name,prodType type: string search: description: Search for terms in certain fields. example: name:Country,prodType:Data Feed type: string filter: description: Filter against specific field values. example: name:Region/Country type: string type: object PostAttributeSearchDto: properties: limit: description: Limit the amount of records per page. example: 10 type: integer default: 10 maximum: 300 page: description: Select which page to show. example: 1 type: integer default: 1 minimum: 1 sort: description: Sort according to specific field value. example: name:asc type: string default: name:asc fields: description: Fetch only specific fields. The fields' names separated by a comma. example: name,groupId type: string search: description: Search for terms in certain fields. example: name:Global,name:Europe type: string filter: description: Filter against specific field values. example: name:Europe:Global type: string type: object GetProductDto: description: A Json representation of a Product record. properties: id: example: 89bba0ab-b123-4766-8a7b-9a174a453571 type: string marking: $ref: '#/definitions/Marking' name: example: FactSet Corporate Governance type: string detail: example: 'FactSets corporate activism database, SharkRepellent, allows you to monitor and analyze corporate activism with data items related to poison pills, significant activism reported in SEC filings and news sources, and key takeover defenses compiled from articles of incorporation, bylaws, and other publicly available sources. Data Frequency: Event; Update Frequency: Intraday. ' type: string dateAdded: example: 1441029240 type: integer highlight: example: point1: Access activism campaign details, including participants, events, defenses, filing dates, and related entities point2: Leverage takeover defense and corporate governance data, including bullet proof ratings, charter provisions and amendment details, and appeal/repeal percentage requirements point3: Obtain data for all U.S. in-force poison pills, Canadian in-force and ratification pending poison pills, and any other non-U.S. EDGAR filers that adopts a U.S. style poison pill properties: point1: type: string point2: type: string point3: type: string type: object coverageTable: example: columns: - field: field1 title: region align: left required: true - field: field2 title: Count align: left required: true - field: field3 title: Type align: left required: false - field: field4 title: Start Date align: left required: false rows: - field1: Africa field3: Entities field2: '{40}' field4: '2014' - field1: Asia field3: Entities field2: '{350}' field4: '2000' - field1: Europe field3: Entities field2: '{640}' field4: '1995' - field1: Latin America field3: Entities field2: '{30}' field4: '2006' - field1: Middle East field3: Entities field2: '{70}' field4: '1996' - field1: North America field3: Entities field2: '{11740}' field4: '1984' - field1: Pacific field3: Entities field2: '{370}' field4: '1998' items: properties: columns: items: properties: title: type: string field: type: string align: type: string required: type: boolean type: object type: array rows: items: type: object type: array type: object type: array videoUrl: example: https://vimeo.com/320509757 type: string previewLink: example: linkUrl: https://insight.factset.com/resources/at-a-glance-factset-corp-datafeed linkName: FactSet Corporate Governance DataFeed properties: linkUrl: type: string linkName: type: string type: object thirdPartyUrls: example: - link: https://insight.factset.com/activists-knocking-on-doors-of-big-firms name: Activists Knocking on Doors of Big Firms - link: https://advantage.factset.com/analyzing-trends-in-shareholder-activism-webcast name: 'Webcast: 2016 Trends in Shareholder Activism' - link: https://insight.factset.com/in-2017-middle-east-ma-activity-dips-value-soars name: In 2017 Middle East M&A Activity Dips, Value Soars items: properties: link: type: string name: type: string type: object type: array seoMeta: example: productTitle: FactSet Corporate Governance - Shark Repellent productSummary: With FactSet's corporate activism database, monitor and analyze corporate activism campaign details, including participants, events, defenses, and filings. properties: productTitle: type: string productSummary: type: string videoAltText: type: string type: object slug: example: factset-corporate-governance type: string productStatusAttr: example: Available type: string enum: - Coming Soon - Recently Added - Candidate - In queue - Recently Updated - Available - Available for Testing partner: example: name: FactSet logoUrl: /media/download/partners/logo/774c3a5c-cc77-4e4c-b4a8-224a35cb00ba slug: factset firmInfo: FactSet creates data and technology solutions for investment professionals around the world, providing instant access to financial data and analytics that investors use to make crucial decisions. We combine our unique proprietary datasets, your in-house data, and third-party unstructured data to help you see and seize opportunity sooner.\n videoUrl: https://vimeo.com/320509757 companyUrl: https://www.factset.com/ socialMedia: linkedin: https://www.linkedin.com/company/factset twitter: https://twitter.com/FactSet facebook: https://www.facebook.com/FactSet/ seoMeta: partnerTitle: FactSet partnerSummary: FactSet creates data and technology solutions for investment professionals around the world. videoAltText: '' forumTags: - id: factset tag: factset id: caa0ee0f-c0fe-427e-9596-491e6c527b3f properties: id: type: string name: type: string slug: type: string logoUrl: type: string firmInfo: type: string companyUrl: type: string socialMedia: properties: linkedin: type: string facebook: type: string twitter: type: string type: object type: object relatedProducts: example: - name: FactSet Ownership id: b7650ba1-519e-4af6-a5d1-8b6cb6ec744c slug: factset-ownership - name: FactSet Mergers id: 8a579d81-ba0e-45c2-9cb9-144c9e7d895c slug: factset-mergers - name: FactSet People id: 168e9bf8-108c-4912-beca-b658083c7c86 slug: factset-people items: properties: name: type: string id: type: string slug: type: string type: object type: array documents: example: - ref: ofsProductsDataDictionaryFile fileName: factset standard datafeed sharkrepellent v1 userguide.pdf isFile: true name: Data Dictionary description: '' isPublic: false section: name: Documentation id: 2 type: dataDictionary url: /media/download/products/documents/4653f3d6-6de1-4e23-b6da-327301c4c860 order: 0 - fileName: Corporate Governance V1.zip isFile: true name: Starter Kit - Jupyter Notebooks and SQL Queries description: Use case examples and sample code\t isPublic: false section: name: Sample Data id: 1 url: /media/download/products/documents/5de6b025-d8a3-423b-a8c6-157730abe334 order: 1 - fileName: OFM Sample FactSet Corporate Activism Announced 2019.xlsx isFile: true name: Corporate Activism Sample - 2019 description: '' isPublic: false section: name: Sample Data id: 1 url: /media/download/products/documents/b7a73952-c6ed-45fe-bf0d-0ab4b7ceb1e9 order: 2 - fileName: OFM Sample FactSet Corporate Governance 2019.xlsx isFile: true name: Corporate Governance Sample - 2019 description: '' isPublic: false section: name: Sample Data id: 1 url: /media/download/products/documents/372ef839-591c-44c4-a668-838bc144cdb1 order: 3 items: $ref: '#/definitions/Document' type: array default: 'null' type: example: - Data Feed items: type: string enum: - Data Feed - API - Solution type: array attributesGroups: example: - attributes: - color: tag-color-9 created: 1531815428 groupId: 5378b993-1057-4197-9a88-92de71d8f55e name: 20+ yrs id: df4b1f7c-58d3-463e-ad9f-55c24cba6f86 updated: 1531815428 id: 5378b993-1057-4197-9a88-92de71d8f55e - attributes: - color: tag-color-1 created: 1531815416 groupId: 3bb76ffb-a83c-4b40-ba6b-c4003702f4fe name: Corporate Governance id: ec224c5d-9b20-4af8-9e7c-725ee3cb4aa3 updated: 1531815416 - color: tag-color-1 created: 1531815419 groupId: 3bb76ffb-a83c-4b40-ba6b-c4003702f4fe name: Events id: ac310994-b350-48d2-abd4-a779af80f421 updated: 1531815419 - color: tag-color-1 created: 1531815415 groupId: 3bb76ffb-a83c-4b40-ba6b-c4003702f4fe name: Corporate Activism id: e2f036fa-c407-4db5-b6b1-0128c739698e updated: 1531815415 id: 3bb76ffb-a83c-4b40-ba6b-c4003702f4fe items: properties: id: type: string attributes: items: properties: id: type: string groupId: type: string name: type: string color: type: string created: type: integer updated: type: integer type: object type: array type: object type: array previewTags: example: - color: tag-color-1 created: 1531815415 groupId: 3bb76ffb-a83c-4b40-ba6b-c4003702f4fe name: Corporate Activism id: e2f036fa-c407-4db5-b6b1-0128c739698e updated: 1531815415 - color: tag-color-1 created: 1531815416 groupId: 3bb76ffb-a83c-4b40-ba6b-c4003702f4fe name: Corporate Governance id: ec224c5d-9b20-4af8-9e7c-725ee3cb4aa3 updated: 1531815416 - color: tag-color-9 created: 1531815428 groupId: 5378b993-1057-4197-9a88-92de71d8f55e name: 20+ yrs id: df4b1f7c-58d3-463e-ad9f-55c24cba6f86 updated: 1531815428 items: properties: id: type: string groupId: type: string name: type: string color: type: string created: type: integer updated: type: integer type: object type: array updateFrequency: example: '' type: string deliveryFrequency: example: '' type: string productLabelOverride: example: '' type: string created: example: 1565883044 type: integer updated: example: 1576275398 type: integer meta: example: documentsTotal: 4 documentsPrivate: 4 items: properties: documentsTotal: type: integer documentsPrivate: type: integer type: object type: array versionSchema: example: major: 1 minor: 0 patch: 0 versionedId: 89bba0ab-b123-4766-8a7b-9a174a453571-1.0.0 originalId: 89bba0ab-b123-4766-8a7b-9a174a453571 properties: major: type: integer minor: type: integer patch: type: integer versionedId: type: string originalId: type: string type: object type: object GetPartnerDto: description: A Json representation of a Partner record. properties: id: example: caa0ee0f-c0fe-427e-9596-491e6c527b3f type: string logoUrl: example: /media/download/partners/logo/774c3a5c-cc77-4e4c-b4a8-224a35cb00ba type: string forumTags: example: - id: factset tag: factset items: properties: tag: type: string id: type: string type: object type: array videoUrl: example: https://vimeo.com/320509757 type: string firmInfo: example: FactSet creates data and technology solutions for investment professionals around the world, providing instant access to financial data and analytics that investors use to make crucial decisions. We combine our unique proprietary datasets, your in-house data, and third-party unstructured data to help you see and seize opportunity sooner.\n type: string socialMedia: example: linkedin: https://www.linkedin.com/company/factset twitter: https://twitter.com/FactSet facebook: https://www.facebook.com/FactSet/ properties: linkedin: type: string facebook: type: string twitter: type: string type: object name: example: FactSet type: string firmId: example: 6992 type: integer companyUrl: example: https://www.factset.com/ type: string seoMeta: example: partnerTitle: FactSet partnerSummary: FactSet creates data and technology solutions for investment professionals around the world. videoAltText: '' properties: productTitle: type: string productSummary: type: string type: object publishedDate: example: 1568801114 type: integer slug: example: factset type: string marking: $ref: '#/definitions/Marking' created: example: 1518816584 type: integer updated: example: 1568801114 type: integer versionSchema: example: major: 1 minor: 0 patch: 0 versionedId: caa0ee0f-c0fe-427e-9596-491e6c527b3f-1.0.0 originalId: caa0ee0f-c0fe-427e-9596-491e6c527b3f properties: major: type: integer minor: type: integer patch: type: integer versionedId: type: string originalId: type: string type: object type: object GetAttributesGroupDto: description: A Json representation of an Attributes Group record. properties: id: example: fd8f12e9-aa8b-4c2a-9e2e-a212f3ec29e1 type: string name: example: Region/Country type: string prodType: example: Data Feed type: string color: example: tag-color-2 type: string type: example: checkbox type: string selection: example: multi type: string created: example: 1531815425 type: integer updated: example: 1531815425 type: integer attributes: example: - id: 904eb623-2b58-4dba-8e81-61e2ef889bb5 name: Europe groupId: fd8f12e9-aa8b-4c2a-9e2e-a212f3ec29e1 prodType: Data Feed created: 1531815425 updated: 1531815425 isUsed: true - id: 8edfdf11-ce9a-45e2-831a-e6d7717736c9 name: Global groupId: fd8f12e9-aa8b-4c2a-9e2e-a212f3ec29e1 prodType: Data Feed created: 1531815424 updated: 1531815424 isUsed: true items: properties: name: example: Europe type: string groupId: example: fd8f12e9-aa8b-4c2a-9e2e-a212f3ec29e1 type: string prodType: example: Data Feed type: string id: example: 904eb623-2b58-4dba-8e81-61e2ef889bb5 type: string created: example: 1531815425 type: integer updated: example: 1531815425 type: integer isUsed: example: true type: boolean type: object type: array type: object PostResourceSearchDto: properties: limit: description: Limit the amount of records per page. example: 10 type: integer default: 10 maximum: 300 page: description: Select which page to show. example: 1 type: integer default: 1 minimum: 1 sort: description: Sort according to specific field value. example: name:desc type: string default: name:asc fields: description: Fetch only specific fields. The fields' names separated by a comma. example: name,fileName,isPublic,url type: string search: description: Search for terms in certain fields. example: description:Template,name:Template,fileName:Template type: string filter: description: Filter against specific field values. example: isFile:true type: string type: object Document: properties: name: type: string description: type: string fileName: type: string url: type: string isFile: type: boolean isPublic: type: boolean order: type: integer section: items: properties: id: type: integer name: type: string type: object type: array type: object PostPartnerSearchDto: properties: limit: description: Limit the amount of records per page. example: 10 type: integer default: 10 maximum: 300 page: description: Select which page to show. example: 1 type: integer default: 1 minimum: 1 sort: description: Sort according to specific field value. example: name:asc type: string default: name:asc fields: description: Fetch only specific fields. The fields' names separated by a comma. example: name,marking.state,slug type: string search: description: Search for terms in certain fields. example: name:FactSet type: string filter: description: Filter against specific field values. example: name:FactSet type: string type: object PostResourcesSectionSearchDto: properties: limit: description: Limit the amount of records per page. example: 10 type: integer default: 10 maximum: 300 page: description: Select which page to show. example: 1 type: integer default: 1 minimum: 1 sort: description: Sort according to specific field value. example: name:asc type: string default: name:asc fields: description: Fetch only specific fields. The fields' names separated by a comma. example: name,order type: string search: description: Search for terms in certain fields. example: name:Data type: string filter: description: Filter against specific field values. example: order:1 type: string type: object GetAttributeDto: properties: id: example: 904eb623-2b58-4dba-8e81-61e2ef889bb5 type: string name: example: Europe type: string groupId: example: fd8f12e9-aa8b-4c2a-9e2e-a212f3ec29e1 type: string groupName: example: Region/Country type: string prodType: example: Data Feed type: string created: example: 1531815425 type: integer updated: example: 1531815425 type: integer type: object Marking: properties: state: example: published type: string type: object GetResourcesSectionDto: description: A Json representation of a Document Category record. properties: id: example: 4c77e650-372b-4ab4-9acd-bbd237d52b74 type: string name: example: New Provider Resources type: string order: example: 3 type: integer created: example: 1559578671 type: integer updated: example: 1559578671 type: integer documents: example: id: 3d8410df-2b04-45fa-bc33-d2cc5418f293 name: Candidate Agreement--Exhibit A fileName: Exhibit A.docx description: Template for Exhibit A to the new Candidate Agreement. Fill out this document with a description of the product(s) for the Open=>FactSet marketplace url: /media/download/resources/documents/c2e2394c-747e-422f-bc5d-b775b14833bd order: 5 isFile: true isPublic: true categoryId: 4c77e650-372b-4ab4-9acd-bbd237d52b74 created: 1564487399 updated: 1568288463 items: $ref: '#/definitions/GetResourceDto' type: array meta: example: documentsTotal: 1 documentsPrivate: 0 items: properties: documentsTotal: type: integer documentsPrivate: type: integer type: object type: array type: object PostProductSearchDto: properties: limit: description: Limit the amount of records per page. example: 10 type: integer default: 10 maximum: 300 page: description: Select which page to show. example: 1 type: integer default: 1 minimum: 1 sort: description: Sort according to specific field value. example: name:asc type: string default: name:asc fields: description: Fetch only specific fields. The fields' names separated by a comma. example: name,marking.state,slug,partner type: string search: description: Search for terms in certain fields. example: name:FactSet,detail:FactSet type: string filter: description: Filter against specific field values. example: type:Data Feed:API type: string type: object GetResourceDto: description: A Json representation of a Document record. properties: id: example: 3d8410df-2b04-45fa-bc33-d2cc5418f293 type: string name: example: Candidate Agreement--Exhibit A type: string fileName: example: Exhibit A.docx type: string description: example: Template for Exhibit A to the new Candidate Agreement. Fill out this document with a description of the product(s) for the Open:FactSet marketplace type: string url: example: /media/download/resources/documents/c2e2394c-747e-422f-bc5d-b775b14833bd type: string order: example: 5 type: integer isFile: example: true type: boolean isPublic: example: true type: boolean categoryId: example: 4c77e650-372b-4ab4-9acd-bbd237d52b74 type: string created: example: 1564487399 type: integer updated: example: 1568288463 type: integer type: object externalDocs: url: https://developer.factset.com/api-catalog/analytics-datastore-api description: API Documentation