FinancialContracts.Definition
Summary
FinancialContracts allows to retrieve data regarding financial instruments within a specific session.
FinancialContractsDefinitions is an array of Definition objects from the FinancialContracts group
The FinancialContracts group includes:
- Bond.Definition
- BondFuture.Definition
- CapFloor.Definition
- CDS.Definition
- FxCross.Definition
- IRSwap.Definition
- Option.Definition
- Repo.Definition
- Swaption.Definition
- TermDeposit.Definition
Methods
Definition(params: FinancialContractsDefinitions | FinancialContracts.Params)
Allows you to create a FinancialContracts data Definition object
Parameters:
| Name | Is Optional | Default Value | Type | Description |
|---|---|---|---|---|
| definitions | No | - | FinancialContractsDefinitions[] | An array of single definitions from FinancialContracts group. |
| fields | Yes | - | string[] | |
| outputs | Yes | - | enum | See Outputs |
| extendedParams | Yes | - | {[key: string]: any} | Specifies the parameters that will be merged with the request |
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 | Description |
|---|---|---|---|
| session | No | - | Session instance |
Returned value: ContentResponse