diff --git a/docs/.gitbook/assets/image (1).png b/docs/.gitbook/assets/image (1).png new file mode 100644 index 0000000..700c1ca Binary files /dev/null and b/docs/.gitbook/assets/image (1).png differ diff --git a/docs/README.md b/docs/README.md index ff9c972..4afef0a 100644 --- a/docs/README.md +++ b/docs/README.md @@ -2,11 +2,11 @@ description: An aggregated Ethereum gas price feed. --- -# ETH Gas.watch overview +# Introduction ETH Gas.watch is an aggregated gas price feed that checks multiple data sources for the latest gas prices. By aggregating these data sources, it provides a more reliable, median gas price. Visit [ethgas.watch](https://ethgas.watch/) -![](.gitbook/assets/image.png) +![](.gitbook/assets/image%20%281%29.png) diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md index 219f43c..252932d 100644 --- a/docs/SUMMARY.md +++ b/docs/SUMMARY.md @@ -1,9 +1,9 @@ # Table of contents -## API -* [Overview](README.md) +* [Introduction](README.md) * [API](api.md) ## ETH Gas.watch -* [Visit website](https://ethgas.watch/) \ No newline at end of file +* [Visit website](https://ethgas.watch/) + diff --git a/docs/api.md b/docs/api.md index 8225525..f57c1d0 100644 --- a/docs/api.md +++ b/docs/api.md @@ -111,13 +111,17 @@ Trend {% endapi-method-summary %} {% api-method-description %} -This endpoint allows you to get historical gas price data. +This endpoint allows you to get historical gas price data. Chose one of the query params below to retrieve either the daily or the hourly trend data. {% endapi-method-description %} {% api-method-spec %} {% api-method-request %} {% api-method-query-parameters %} -{% api-method-parameter name="" type="string" required=true %} +{% api-method-parameter name="hours" type="number" required=false %} +Amount of hours to return \(e.g. 24 for 1 day\) +{% endapi-method-parameter %} + +{% api-method-parameter name="days" type="number" required=false %} Amount of days to return \(e.g. 7 for 1 week\) {% endapi-method-parameter %} {% endapi-method-query-parameters %} @@ -154,6 +158,12 @@ This endpoint allows you to get statistics on the amount of alerts and registrat {% api-method-spec %} {% api-method-request %} +{% api-method-query-parameters %} +{% api-method-parameter name="days" type="number" required=true %} +Amount of days to return \(e.g. 7 for 1 week\) +{% endapi-method-parameter %} +{% endapi-method-query-parameters %} +{% endapi-method-request %} {% api-method-response %} {% api-method-response-example httpCode=200 %}