FundamentalAndReference.Definition
Summary
FundamentalAndReference.Definition objects are used to define the FundamentalAndReference data your application needs to retrieve.
Definition objects describe the universe (list of instruments), the fields (a.k.a. data items) and parameters that will be requested to the data platform. Once the data described, your application just needs to call the getData() method of the Definition to actually retrieve the data.
Methods
Definition(universe: string, fields?: string | string[])
Allows you to create a FundamentalAndReference data Definition object
Parameters:
| Name | Is Optional | Default Value | Type | Description |
|---|---|---|---|---|
| universe | No | - | string | Single instrument to request or full object definition (FundamentalAndReference.Params) |
| fields | No | - | string[] | fields parameter is required if the first parameter is a single instrument or list of instruments |
Returned value: a Definition object
Definition(universe: string[ ], fields?: string | string[])
Allows you to create a FundamentalAndReference data Definition object
Parameters:
| Name | Is Optional | Default Value | Type | Description |
|---|---|---|---|---|
| universe | No | - | string[] | List of instruments to request or full object definition (FundamentalAndReference.Params) |
Returned value: a Definition object
Definition(params: FundamentalAndReference.Params)
Allows you to create a FundamentalAndReference data Definition object
FundamentalAndReference.Params properties:
| Property | Is Optional | Default Value | Type | Description |
|---|---|---|---|---|
| universe | No | - | string[] | Single instrument or list of instruments to request |
| fields | Yes | - | string[] | The list of market events. It is optional if the first parameter is a full object definition (FundamentalAndReference.Params). |
| parameters | Yes | - | FieldGlobalParameters[] | Global parameters for fields. See FundamentalAndReference.FieldGlobalParametersbellow |
| extendedParams | Yes | - | {[key: string]: any} | Specifies the parameters that will be merged with the request |
FundamentalAndReference.FieldGlobalParameters
| Property | Is Optional | Default Value | Type | Description |
|---|---|---|---|---|
| SDate | Yes | - | string | - |
| EDate | Yes | - | string | - |
| Frq | Yes | - | string | - |
| Period | Yes | - | string | - |
| Scale | Yes | - | number | - |
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