Merge pull request #9 from neilgarb/orderbook

Update API

Author: neilgarb

src/Luno/Client.php

@@ -187,19 +187,38 @@ public function GetOrder(Request\GetOrder $req): Response\GetOrder
   }
 
   /**
-   * GetOrderBook makes a call to GET /api/1/orderbook.
+   * GetOrderBook makes a call to GET /api/1/orderbook_top.
    *
-   * Returns a list of bids and asks in the order book. Ask orders are sorted by
-   * price ascending. Bid orders are sorted by price descending. Note that
-   * multiple orders at the same price are not necessarily conflated.
+   * Returns a list of the top 100 bids and asks in the order book.
+   * Ask orders are sorted by price ascending.
+   * Bid orders are sorted by price descending.
+   * Orders of the same price are aggregated.
    */ 
   public function GetOrderBook(Request\GetOrderBook $req): Response\GetOrderBook
   {
-    $res = $this->do("GET", "/api/1/orderbook", $req, false);
+    $res = $this->do("GET", "/api/1/orderbook_top", $req, false);
     $mapper = new \JsonMapper();
     return $mapper->map($res, new Response\GetOrderBook);
   }
 
+  /**
+   * GetOrderBookFull makes a call to GET /api/1/orderbook.
+   *
+   * Returns a list of all bids and asks in the order book.
+   * Ask orders are sorted by price ascending.
+   * Bid orders are sorted by price descending.
+   * Multiple orders at the same price are not aggregated.
+   * 
+   * Warning: This may return a large amount of data. Generally you should rather
+   * use GetOrderBook or the Streaming API.
+   */ 
+  public function GetOrderBookFull(Request\GetOrderBookFull $req): Response\GetOrderBookFull
+  {
+    $res = $this->do("GET", "/api/1/orderbook", $req, false);
+    $mapper = new \JsonMapper();
+    return $mapper->map($res, new Response\GetOrderBookFull);
+  }
+
   /**
    * GetQuote makes a call to GET /api/1/quotes/{id}.
    *

src/Luno/Request/GetOrderBookFull.php

@@ -0,0 +1,32 @@
+<?php declare(strict_types=1);
+
+namespace Luno\Request;
+
+class GetOrderBookFull extends AbstractRequest
+{
+  /**
+   * Currency pair
+   */
+  protected $pair;
+  
+  /**
+   * @return string
+   */
+  public function getPair(): string
+  {
+    if (!isset($this->pair)) {
+      return "";
+    }
+    return $this->pair;
+  }
+
+  /**
+   * @param string $pair
+   */
+  public function setPair(string $pair)
+  {
+    $this->pair = $pair;
+  }
+}
+
+// vi: ft=php

src/Luno/Response/GetOrderBookFull.php

@@ -0,0 +1,69 @@
+<?php declare(strict_types=1);
+
+namespace Luno\Response;
+
+class GetOrderBookFull extends AbstractResponse
+{
+  protected $asks;
+  protected $bids;
+  protected $timestamp;
+  
+  /**
+   * @return \Luno\Types\OrderBookEntry[]
+   */
+  public function getAsks(): array
+  {
+    if (!isset($this->asks)) {
+      return [];
+    }
+    return $this->asks;
+  }
+
+  /**
+   * @param \Luno\Types\OrderBookEntry[] $asks
+   */
+  public function setAsks(array $asks)
+  {
+    $this->asks = $asks;
+  }
+
+  /**
+   * @return \Luno\Types\OrderBookEntry[]
+   */
+  public function getBids(): array
+  {
+    if (!isset($this->bids)) {
+      return [];
+    }
+    return $this->bids;
+  }
+
+  /**
+   * @param \Luno\Types\OrderBookEntry[] $bids
+   */
+  public function setBids(array $bids)
+  {
+    $this->bids = $bids;
+  }
+
+  /**
+   * @return int
+   */
+  public function getTimestamp(): int
+  {
+    if (!isset($this->timestamp)) {
+      return 0;
+    }
+    return $this->timestamp;
+  }
+
+  /**
+   * @param int $timestamp
+   */
+  public function setTimestamp(int $timestamp)
+  {
+    $this->timestamp = $timestamp;
+  }
+}
+
+// vi: ft=php