DateParser API
REST API which extracts financial and statistical dates referred to within a text
DateParser API [dateparser.exerica.com/api] is a REST API which extracts financial and statistical dates referred to within a text. While Natural Language solutions abound in this domain, we believe none of them can read financial and statistical documents, and particularly periodic fiscal dates and specialized financial terminology.
Input
| Property | Type | Description |
|---|---|---|
| Text Required | String |
Text containing dates to parse. |
| Year | Integer |
Year as a number. |
| Quarter | Integer |
The quarter as number from 1 to 4. |
| FiscalYearEndQuarter | Integer |
The quarter as number from 1 to 4. Default value is 4 (i.e. the fourth quarter). This affects how fiscal dates get converted into astronomical. For example “3Q2019” with FiscalYearEndQuarter = 1, would return the date token “31 December 2019”. |
Default date - default astronomical date normally which would be normally equal to the date of the publication of a document. It is used to parse phrases like “current period” or “previous quarter”.
Output
API response is delivered as an array of date tokens found in the text. Each token has the same format:
| Property | Type | Description |
|---|---|---|
| Year | Integer |
Year as a number. Null if not found. |
| Month | Integer |
Number of the month (from 1 to 12). Null if not found. |
| Day | Integer |
Day of the month. Null if not found. |
| Duration | Integer |
A number of months in periodic dates like “three months ending 31 December”. Can be positive or negative. A negative number represents the period ended in this date and which started N months ago, and a positive number - the period started at this date and ended N months later. |
| SuggestedQuarter | Integer |
The quarter as number from 1 to 4. If the found date is not an eligible fiscal quarter-end (i.e. it is different from 31 December, 31 March, 30 June or 30 September), then this field would contain a quarter-end nearest to the found date. |
| Match | String |
The expression from which the date comes from. It is a subexpression of the text passed as a parameter to the service. |
| Index | Integer |
The index is the position of the match expression inside the text passed as a parameter to the service. Position 0 means that the subexpression begins at the start of the sentence |
API Keys
All our routes are protected and to access them, you must provide a valid API key. To get one, you must provide an email, so that we can manage your API key.
To authorize a request, add your API key to your request headers as an 'APIKEY'.
Get your API Key
Please enter your Email in the field below. We will send you the API Key which could be used to send requests to Dateparser API.
Try Dateparser API
In the form below you can try Dateparser API. Use your API Key and some text to test Date extraction.
Here is a list of a few supported text formats from which dates can be extracted:
- 1Q’17
- 9M 2019
- Current period
- FY2020
- 6 months ended 30 September
There are many other expressions that Date Parser will recognize. If a specific expression is not yet supported, please contact us.
