Skip to content
This repository was archived by the owner on Dec 1, 2025. It is now read-only.

Commit 04080e8

Browse files
committed
Updated README
1 parent 658aa9b commit 04080e8

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed

README.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,11 @@
77

88
A simple REST API client, written with PHP for [messari.io](https://messari.io).
99

10-
Messari.io [HTTP REST API documentation](https://messari.io/api/docs#tag/HTTP-REST-API).
10+
Messari provides free API endpoints for thousands of crypto assets. These endpoints include trades, market data (VWAP), quantitative metrics, qualitative information. This is the same API that drives the [messari.io](https://messari.io) web app.
11+
12+
Most endpoints are accessible without an API key, but rate limited. This is free tier. This free tier does not include redistribution rights and requires attribution and a link back to [messari.io](https://messari.io).
13+
14+
Messari.io [API documentation](https://messari.io/api/docs).
1115

1216
## Requirements
1317

@@ -87,7 +91,7 @@ $data = $client->assets()->getMarketData('btc');
8791
Retrieve historical timeseries data for an asset.
8892

8993
```php
90-
$data = $client->assets()->getTimeseries('btc', 'price', '2020-01-01', '2020-01-07', '1d');
94+
$data = $client->assets()->getTimeseries('btc', 'price', ['start' => '2020-01-01', 'end' => '2020-01-07', 'interval' => '1d']);
9195
```
9296

9397
### Markets
@@ -105,7 +109,7 @@ $data = $client->markets()->getAll();
105109
Retrieve historical timeseries data for a market.
106110

107111
```php
108-
$data = $client->markets()->getTimeseries('binance-btc-usdt', 'price', '2020-01-01', '2020-01-07', '1d');
112+
$data = $client->markets()->getTimeseries('binance-btc-usdt', 'price', ['start' => '2020-01-01', 'end' => '2020-01-07', 'interval' => '1d']);
109113
```
110114

111115
### News

0 commit comments

Comments
 (0)