@alpha-arcade/sdk 0.4.1 → 0.4.2

package/README.md

@@ -2,7 +2,7 @@
 
 TypeScript SDK for trading on **Alpha Market** — Algorand prediction markets.
 
-Place orders, manage positions, read orderbooks, and build automated trading bots — all directly on-chain.
+Place orders, manage positions, read orderbooks from the API or chain, and build automated trading bots.
 
 ## Installation
 
@@ -246,7 +246,7 @@ for (const pos of positions) {
 
 #### `getOrderbook(marketAppId)`
 
-Fetches the full on-chain orderbook.
+Fetches the full on-chain orderbook for a single market app.
 
 ```typescript
 const book = await client.getOrderbook(123456789);
@@ -263,6 +263,24 @@ if (book.yes.bids.length > 0) {
 }
 ```
 
+#### `getFullOrderbookFromApi(marketId)`
+
+Fetches the full processed orderbook snapshot for a market from the Alpha REST API. Requires `apiKey`.
+
+This returns the same shape as websocket `orderbook_changed.orderbook`: a record keyed by `marketAppId`, where each value includes:
+- top-level aggregated `bids`, `asks`, and `spread`
+- detailed `yes` and `no` bid/ask orders with `escrowAppId` and `owner`
+
+```typescript
+const snapshot = await client.getFullOrderbookFromApi('market-uuid-here');
+
+for (const [appId, book] of Object.entries(snapshot)) {
+  console.log(`App ${appId}: spread=${book.spread}`);
+  console.log('Top-level bids:', book.bids);
+  console.log('Detailed YES bids:', book.yes.bids);
+}
+```
+
 #### `getOpenOrders(marketAppId, walletAddress?)`
 
 Gets open orders for a wallet on a specific market (from on-chain data).
@@ -407,7 +425,7 @@ ws.subscribeMarket('will-btc-hit-100k', (event) => {
 
 #### `subscribeOrderbook(slug, callback)`
 
-Receive full orderbook snapshots on every change (~5s interval). Replaces on-chain polling.
+Receive full orderbook snapshots on every change (~5s interval). The payload matches `getFullOrderbookFromApi(marketId)`.
 
 **Note:** The WebSocket API uses market **slugs** (URL-friendly names like `"will-btc-hit-100k"`), not `marketAppId` numbers. You can get a market's slug from the `slug` field on `Market` objects returned by `getLiveMarkets()` or `getMarket()`.
 

package/dist/index.cjs

@@ -2266,6 +2266,18 @@ var getWalletOrdersFromApi = async (config, walletAddress) => {
   }
   return allOrders;
 };
+var getFullOrderbookFromApi = async (config, marketId) => {
+  if (!config.apiKey) {
+    throw new Error("apiKey is required for API-based orderbook fetching. Retrieve an API key from the Alpha Arcade platform via the Account page and pass it to the client.");
+  }
+  const baseUrl = config.apiBaseUrl ?? DEFAULT_API_BASE_URL;
+  const url = `${baseUrl}/get-full-orderbook?marketId=${encodeURIComponent(marketId)}`;
+  const response = await fetch(url, { headers: { "x-api-key": config.apiKey } });
+  if (!response.ok) {
+    throw new Error(`Alpha API error: ${response.status} ${response.statusText}`);
+  }
+  return response.json();
+};
 
 // src/modules/trading.ts
 var extractEscrowAppId = async (algodClient, indexerClient, targetTxId) => {
@@ -3272,6 +3284,19 @@ var AlphaClient = class {
   async getOrderbook(marketAppId) {
     return getOrderbook(this.config, marketAppId);
   }
+  /**
+   * Fetches the full processed orderbook snapshot for a market from the Alpha REST API.
+   *
+   * Returns the same shape as websocket `orderbook_changed.orderbook`: a record keyed by
+   * `marketAppId`, where each value includes aggregated bids/asks plus detailed yes/no orders.
+   * Requires `apiKey`.
+   *
+   * @param marketId - The Alpha market UUID
+   * @returns Full processed market orderbook keyed by marketAppId
+   */
+  async getFullOrderbookFromApi(marketId) {
+    return getFullOrderbookFromApi(this.config, marketId);
+  }
   /**
    * Gets open orders for a specific wallet on a market.
    *