Added documentation for ticker method

butschster · Mar 3, 2018 · beefc18 · beefc18
1 parent 3d57db8
commit beefc18
Showing 1 changed file with 16 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -102,6 +102,22 @@ foreach($pairs as $pair) {
 }
 ```
 
+#### Get ticker information
+https://www.kraken.com/help/api#get-ticker-info
+
+```php
+$pairs = $client->getTicker(string|array $pair) : Butschster\Kraken\Objects\TickerCollection;
+
+foreach($pairs as $pair) {
+    $pair->name();
+    $pair->askPrice();
+    $pair->askWholeLotVolume();
+    $pair->askLotVolume();
+    $pair->askLotVolume();
+    ...
+}
+```
+
 #### Get account balance
 https://www.kraken.com/help/api#get-account-balance