Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
Fixes #4
  • Loading branch information
odrail committed Dec 7, 2024
1 parent ebccc84 commit 881ae2d
Showing 1 changed file with 26 additions and 13 deletions.
39 changes: 26 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,17 +13,30 @@ Unofficial APIs for Investing.com website.
### getHistoricalData
Not all parameters are mandatory.

- **input** String: input string, provide a valid investing.com pairId. (Required)
- **resolution** String: resolution of the response.
- Valid values:
- `5` (5 minutes)
- `60` (1 hour)
- `300` (5 hours)
- `D` (1 day, **Default**)
- `W` (week)
- `M` (month)
- **from** Date: a Date object to indicate the start of the period (Required)
- **to** Date: a Date object to indicate the end of the period (Required)
#### Input params
- **params** Object (required)
- **input** String: input string, provide a valid investing.com pairId. (Required)
- **resolution** String: resolution of the response.
- Valid values:
- `5` (5 minutes)
- `60` (1 hour)
- `300` (5 hours)
- `D` (1 day, **Default**)
- `W` (week)
- `M` (month)
- **from** Date: a Date object to indicate the start of the period (Required)
- **to** Date: a Date object to indicate the end of the period (Required)

#### Output
```js
{
date: number; // Timestamp of the data point
price_open: number; // Opening price
price_high: number; // Highest price during the period
price_low: number; // Lowest price during the period
price_close: number; // Closing price
}[]
```

#### Example
```js
Expand Down Expand Up @@ -68,14 +81,14 @@ Response

### searchQuotes

Input params:
#### Input params
- **search** String (required)
- **options** Object (optional)
- **filters** Object (optional)
- **type** String (optional)
- **exchange** Array of Strings (optional)

Output:
#### Output
```js
{
pairId: number;
Expand Down

0 comments on commit 881ae2d

Please sign in to comment.