Surfaces.Definition
Summary
A Surfaces allows to retrieve Volatility Surface data within a specific session.
SurfacesDefinitions is an array of Definition objects from the Surfaces group
The Surfaces group includes:
Methods
Definition(params: SurfacesDefinitions | Surfaces.Params)
Allows you to create a Surfaces data Definition object
Parameters:
Property | Is Optional | Default Value | Description |
---|---|---|---|
definitions | No | - | SurfacesDefinitions[] |
outputs | Yes | - | An array of outputs |
extendedParams | Yes | - | {[key: string]: any} |
Returned value: a Definition object
getData(session: Session)
Sends a request to the data platform to retrieve the data described by the Definition object.
Parameters:
Name | Is Optional | Default Value | Type | Description |
---|---|---|---|---|
session | No | - | Session | Session instance |
Returned value: a ContentResponse
Learn more
For more information, please follow the link: https://developers.refinitiv.com/en/api-catalog/