Period and Reference Date
The Period parameter expects either a period or a reference date, in one of the formats described in the Period settings table and the Reference Date settings table below.
The reference date specifies a specific date. It is used generally for items which vary over time such as Close Price, Market Capitalization, Earning per share. This parameter is used only on historicized item. Some data points are available only on a monthly or weekly format, the data item returned corresponds to the next following points.
There are three classes of items depending on entry format as described on the following table:
| Item class | Reference Date | Period |
| Class 1 (example: Company Name) | Not allowed | Not allowed |
| Class 2 (example: Close Price) | Required | Not allowed |
| Class 3 (example: Sales) | Optional | Required |
Note: items in grey are not yet supported
Period settings table
|
Keyword |
Description |
|
YYYY |
The expected year as an integer between 1900 and 2999. Example: 2018 |
|
LASTY |
Last available company year (historical). Can be used to refer to a relative date. |
|
LTM |
Last Twelve Months (historical) |
|
NTM |
Next Twelve Months (forecast) |
|
CY |
Current Year (Current Calendar Year if the current date is after 3rd of July, and the previous calendar Year otherwise). Can be used to refer to a relative date. |
|
LASTINT |
Last available company interim (historical + interim) |
|
FY-1 |
Previous Forecast year (eq CY-1 and DatasetType is forecast) |
|
FY0 |
Forecast year 0 (eq CY and DatasetType is forecast) |
|
FY1 |
Forecast year 1 (eq CY+1 and DatasetType is forecast) |
|
FY2 |
Forecast year 2 (eq CY+2 and DatasetType is forecast) |
|
FY3 |
Forecast year 3 (eq CY+3 and DatasetType is forecast) |
Reference Date settings table
|
Keyword |
Description |
|
yyyyMMdd |
A date between 1/1/1900 and 31/12/2999 in a valid ISO date format. Examples: 31/12/2017, 20180115 |
|
CWS |
Current Week Start (Monday). Can be used to refer to a relative date. |
|
CMS |
Current Month Start. Can be used to refer to a relative date. |
|
CYS |
Current Year Start. Can be used to refer to a relative date. |
|
TODAY |
Refers to today's date. Can be used to refer to a relative date. |
|
YESTERDAY |
Refers to yesterday's date. Can be used to refer to a relative date. |
Keywords that can be used to refer to a relative date
You can refer to a relative date by adding or subtracting a number of weeks, months or years to the keywords below:
LASTY
CY
CWS
CMS
CYS
TODAY
YESTERDAY
Note: with CWS, CMS and CYS you can only subtract (and not add) a number of weeks, months or years as these keywords refer to historical estimates.
|
Examples |
LASTY-2 CY+1 CWS-2 TODAY-1W |
