Skip to content

Commit

Permalink
fix: further readme changes
Browse files Browse the repository at this point in the history
  • Loading branch information
deimantas Jakovlevas committed Jan 25, 2022
1 parent e243cf6 commit 6986834
Showing 1 changed file with 2 additions and 9 deletions.
11 changes: 2 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -165,7 +165,7 @@ console.log(mapping["4151"]);

### Prices

Gives 5 or 60 (`interval: "5m"` or `interval: "1h"` respectively ) minute average of item high and low prices as well as the number traded for the items that we have data on. Comes with a Unix timestamp indicating the 5 or 60 minute block the data is from.
Gives 5 or 60 minute average of item high and low prices as well as the number traded for the items that we have data on. Comes with a Unix timestamp indicating the 5 or 60 minute block the data is from.

```ts
const data = await runeliteAPI.prices({ useragent, interval: "5m" });
Expand Down Expand Up @@ -203,17 +203,10 @@ console.log(data["25849"]);
*/

```

You may optionally provide a timestamp to return prices for.

```ts
const data = await runeliteAPI.prices({ useragent, timestamp: 1634688300, interval: "1h" });
```

You may optionally provide a timestamp to return prices for. If provided, will display 5-minute averages for all items we have data on for this time. The timestamp field represents the beginning of the 5-minute period being averaged

```ts
const data = await runeliteAPI.prices({ useragent, timestamp: 1634688300, interval: "1h" });
const data = await runeliteAPI.prices({ useragent, timestamp: 1634688300, interval: "5m" });
```

### Time-series
Expand Down

0 comments on commit 6986834

Please sign in to comment.