Skip to content

Commit

Permalink
chore(docs/quote): note earningsTimestamps innacuracies (closes #386)
Browse files Browse the repository at this point in the history
[skip ci]
  • Loading branch information
gadicc committed Feb 16, 2022
1 parent ad7e29b commit 54553d2
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions docs/modules/quote.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ Note: in the original `node-yahoo-finance`, we had a module called "`quote`"
that actually called the [quoteSummary](./quoteSummary.md) API. See that
module for further details.

**Make sure to read the [quirks](#quirks) section at the bottom of this file.**

## Usage:

```js
Expand Down Expand Up @@ -179,3 +181,17 @@ For a list of all fields, see the `Quote` interface in
### Module Options

See [Common Options](../README.md#common-options).

<a name="quirks"></a>
## Quirks

### Inaccurate Earnings Dates

As reported by @glintik in
[issue #386](https://github.com/gadicc/node-yahoo-finance2/issues/386),
the values of
`earningsTimestamp`, `earningsTimestampStart`, `earningsTimestampEnd`
can be very misleading, and you are advised to find a better source for
accurate timing. However, to get a *rough indication* of when the earnings
call might be (+/- 2 days), this might be sufficient. Please review the
issue for further details and comments.

0 comments on commit 54553d2

Please sign in to comment.