@cowprotocol/sdk-order-book 1.0.0 → 1.1.0

package/README.md

@@ -121,6 +121,39 @@ const orderBookApi = new OrderBookApi({
 })
 ```
 
+### Partner API (Authenticated Access)
+
+Partners can use the Partner API for authenticated, rate-limited access with higher request quotas. Provide your API key and the SDK will automatically route requests through the partner gateway and attach the `X-API-Key` header.
+
+| Environment | Partner API Base URL |
+|-------------|---------------------|
+| Production  | `https://partners.cow.fi` |
+| Staging     | `https://partners.barn.cow.fi` |
+
+```typescript
+const orderBookApi = new OrderBookApi({
+  chainId: SupportedChainId.MAINNET,
+  apiKey: 'your-partner-api-key',
+})
+```
+
+To use the Partner API with the Trading SDK, pass a configured `OrderBookApi` instance:
+
+```typescript
+import { TradingSdk } from '@cowprotocol/sdk-trading'
+
+const orderBookApi = new OrderBookApi({
+  chainId: SupportedChainId.MAINNET,
+  apiKey: 'your-partner-api-key',
+})
+
+const sdk = new TradingSdk(
+  { chainId: SupportedChainId.MAINNET, appCode: 'YOUR_APP_CODE' },
+  { orderBookApi },
+  adapter,
+)
+```
+
 ### Rate Limiting Configuration
 
 ```typescript

package/dist/index.d.mts

@@ -1129,6 +1129,18 @@ declare const ORDER_BOOK_PROD_CONFIG: ApiBaseUrls;
  * An object containing *staging* environment base URLs for each supported `chainId`.
  */
 declare const ORDER_BOOK_STAGING_CONFIG: ApiBaseUrls;
+/**
+ * An object containing *partner production* environment base URLs for each supported `chainId`.
+ * Used when apiKey is set; requests include X-API-Key header.
+ * @see {@link https://partners.cow.fi}
+ */
+declare const ORDER_BOOK_PARTNER_PROD_CONFIG: ApiBaseUrls;
+/**
+ * An object containing *partner staging* environment base URLs for each supported `chainId`.
+ * Used when apiKey is set and env is staging; requests include X-API-Key header.
+ * @see {@link https://partners.barn.cow.fi}
+ */
+declare const ORDER_BOOK_PARTNER_STAGING_CONFIG: ApiBaseUrls;
 /**
  * The parameters for the `getOrders` request.
  */
@@ -1344,8 +1356,9 @@ declare class OrderBookApi {
      */
     private getContextWithOverride;
     /**
-     * Get the base URLs for the API endpoints given the environment.
-     * @param env The environment to get the base URLs for.
+     * Get the base URLs for the API endpoints given the context.
+     * Uses partner URLs when apiKey is set (and no custom baseUrls override).
+     * @param context The merged API context for the request.
      * @returns The base URLs for the API endpoints.
      */
     private getApiBaseUrls;
@@ -1401,10 +1414,11 @@ interface FetchParams {
  * @param body The body of the request.
  * @param rateLimiter The rate limiter to use.
  * @param backoffOpts The backoff options to use.
+ * @param additionalHeaders Optional additional headers (e.g. X-API-Key for Partner API).
  * @returns The response of the request.
  * @throws If the API returns an error or if the request fails.
  */
-declare function request<T>(baseUrl: string, { path, query, method, body }: FetchParams, rateLimiter: RateLimiter, backoffOpts: BackoffOptions): Promise<T>;
+declare function request<T>(baseUrl: string, { path, query, method, body }: FetchParams, rateLimiter: RateLimiter, backoffOpts: BackoffOptions, additionalHeaders?: Record<string, string>): Promise<T>;
 
 type OrderAmountsBig = {
     sellAmount: bigint;
@@ -1532,4 +1546,4 @@ interface ProtocolFeeAmountParams {
  */
 declare function getProtocolFeeAmount(params: ProtocolFeeAmountParams): bigint;
 
-export { type Address, type Amounts, type AppData, type AppDataHash, type AppDataObject, type Auction, type AuctionOrder, type AuctionPrices, type BigUint, BuyTokenDestination, type CallData, type CompetitionAuction, CompetitionOrderStatus, type Costs, DEFAULT_BACKOFF_OPTIONS, DEFAULT_LIMITER_OPTIONS, type EcdsaSignature, EcdsaSigningScheme, type EnrichedOrder, type EthflowData, type ExecutedAmounts, type ExecutedProtocolFee, type FeePolicy, type FetchParams, type GetOrdersRequest, type GetTradesRequest, type InteractionData, type NativePriceResponse, ORDER_BOOK_PROD_CONFIG, ORDER_BOOK_STAGING_CONFIG, OnchainOrderData, type Order, type OrderAmountsBig, OrderBookApi, OrderBookApiError, type OrderCancellation, OrderCancellationError, type OrderCancellations, OrderClass, type OrderCreation, OrderKind, type OrderMetaData, type OrderParameters, OrderPostError, type OrderQuoteRequest, type OrderQuoteResponse, type OrderQuoteSide, OrderQuoteSideKindBuy, OrderQuoteSideKindSell, type OrderQuoteValidity, OrderStatus, type PreSignature, PriceEstimationError, type PriceImprovement, PriceQuality, type ProtocolFeeAmountParams, type Quote, type QuoteAmountsAfterSlippage, type QuoteAmountsAfterSlippageParams, type QuoteAmountsAndCosts, type QuoteAmountsAndCostsParams, type QuoteAmountsWithNetworkCosts, type QuoteParameters, type QuotePriceParams, SellTokenSource, type Signature, SigningScheme, type SolverCompetitionResponse, type SolverSettlement, type Surplus, type TokenAmount, type TotalSurplus, type Trade, type TransactionHash, type UID, type Volume, getProtocolFeeAmount, getQuoteAmountsAfterPartnerFee, getQuoteAmountsAfterSlippage, getQuoteAmountsAndCosts, request };
+export { type Address, type Amounts, type AppData, type AppDataHash, type AppDataObject, type Auction, type AuctionOrder, type AuctionPrices, type BigUint, BuyTokenDestination, type CallData, type CompetitionAuction, CompetitionOrderStatus, type Costs, DEFAULT_BACKOFF_OPTIONS, DEFAULT_LIMITER_OPTIONS, type EcdsaSignature, EcdsaSigningScheme, type EnrichedOrder, type EthflowData, type ExecutedAmounts, type ExecutedProtocolFee, type FeePolicy, type FetchParams, type GetOrdersRequest, type GetTradesRequest, type InteractionData, type NativePriceResponse, ORDER_BOOK_PARTNER_PROD_CONFIG, ORDER_BOOK_PARTNER_STAGING_CONFIG, ORDER_BOOK_PROD_CONFIG, ORDER_BOOK_STAGING_CONFIG, OnchainOrderData, type Order, type OrderAmountsBig, OrderBookApi, OrderBookApiError, type OrderCancellation, OrderCancellationError, type OrderCancellations, OrderClass, type OrderCreation, OrderKind, type OrderMetaData, type OrderParameters, OrderPostError, type OrderQuoteRequest, type OrderQuoteResponse, type OrderQuoteSide, OrderQuoteSideKindBuy, OrderQuoteSideKindSell, type OrderQuoteValidity, OrderStatus, type PreSignature, PriceEstimationError, type PriceImprovement, PriceQuality, type ProtocolFeeAmountParams, type Quote, type QuoteAmountsAfterSlippage, type QuoteAmountsAfterSlippageParams, type QuoteAmountsAndCosts, type QuoteAmountsAndCostsParams, type QuoteAmountsWithNetworkCosts, type QuoteParameters, type QuotePriceParams, SellTokenSource, type Signature, SigningScheme, type SolverCompetitionResponse, type SolverSettlement, type Surplus, type TokenAmount, type TotalSurplus, type Trade, type TransactionHash, type UID, type Volume, getProtocolFeeAmount, getQuoteAmountsAfterPartnerFee, getQuoteAmountsAfterSlippage, getQuoteAmountsAndCosts, request };

package/dist/index.d.ts

@@ -1129,6 +1129,18 @@ declare const ORDER_BOOK_PROD_CONFIG: ApiBaseUrls;
  * An object containing *staging* environment base URLs for each supported `chainId`.
  */
 declare const ORDER_BOOK_STAGING_CONFIG: ApiBaseUrls;
+/**
+ * An object containing *partner production* environment base URLs for each supported `chainId`.
+ * Used when apiKey is set; requests include X-API-Key header.
+ * @see {@link https://partners.cow.fi}
+ */
+declare const ORDER_BOOK_PARTNER_PROD_CONFIG: ApiBaseUrls;
+/**
+ * An object containing *partner staging* environment base URLs for each supported `chainId`.
+ * Used when apiKey is set and env is staging; requests include X-API-Key header.
+ * @see {@link https://partners.barn.cow.fi}
+ */
+declare const ORDER_BOOK_PARTNER_STAGING_CONFIG: ApiBaseUrls;
 /**
  * The parameters for the `getOrders` request.
  */
@@ -1344,8 +1356,9 @@ declare class OrderBookApi {
      */
     private getContextWithOverride;
     /**
-     * Get the base URLs for the API endpoints given the environment.
-     * @param env The environment to get the base URLs for.
+     * Get the base URLs for the API endpoints given the context.
+     * Uses partner URLs when apiKey is set (and no custom baseUrls override).
+     * @param context The merged API context for the request.
      * @returns The base URLs for the API endpoints.
      */
     private getApiBaseUrls;
@@ -1401,10 +1414,11 @@ interface FetchParams {
  * @param body The body of the request.
  * @param rateLimiter The rate limiter to use.
  * @param backoffOpts The backoff options to use.
+ * @param additionalHeaders Optional additional headers (e.g. X-API-Key for Partner API).
  * @returns The response of the request.
  * @throws If the API returns an error or if the request fails.
  */
-declare function request<T>(baseUrl: string, { path, query, method, body }: FetchParams, rateLimiter: RateLimiter, backoffOpts: BackoffOptions): Promise<T>;
+declare function request<T>(baseUrl: string, { path, query, method, body }: FetchParams, rateLimiter: RateLimiter, backoffOpts: BackoffOptions, additionalHeaders?: Record<string, string>): Promise<T>;
 
 type OrderAmountsBig = {
     sellAmount: bigint;
@@ -1532,4 +1546,4 @@ interface ProtocolFeeAmountParams {
  */
 declare function getProtocolFeeAmount(params: ProtocolFeeAmountParams): bigint;
 
-export { type Address, type Amounts, type AppData, type AppDataHash, type AppDataObject, type Auction, type AuctionOrder, type AuctionPrices, type BigUint, BuyTokenDestination, type CallData, type CompetitionAuction, CompetitionOrderStatus, type Costs, DEFAULT_BACKOFF_OPTIONS, DEFAULT_LIMITER_OPTIONS, type EcdsaSignature, EcdsaSigningScheme, type EnrichedOrder, type EthflowData, type ExecutedAmounts, type ExecutedProtocolFee, type FeePolicy, type FetchParams, type GetOrdersRequest, type GetTradesRequest, type InteractionData, type NativePriceResponse, ORDER_BOOK_PROD_CONFIG, ORDER_BOOK_STAGING_CONFIG, OnchainOrderData, type Order, type OrderAmountsBig, OrderBookApi, OrderBookApiError, type OrderCancellation, OrderCancellationError, type OrderCancellations, OrderClass, type OrderCreation, OrderKind, type OrderMetaData, type OrderParameters, OrderPostError, type OrderQuoteRequest, type OrderQuoteResponse, type OrderQuoteSide, OrderQuoteSideKindBuy, OrderQuoteSideKindSell, type OrderQuoteValidity, OrderStatus, type PreSignature, PriceEstimationError, type PriceImprovement, PriceQuality, type ProtocolFeeAmountParams, type Quote, type QuoteAmountsAfterSlippage, type QuoteAmountsAfterSlippageParams, type QuoteAmountsAndCosts, type QuoteAmountsAndCostsParams, type QuoteAmountsWithNetworkCosts, type QuoteParameters, type QuotePriceParams, SellTokenSource, type Signature, SigningScheme, type SolverCompetitionResponse, type SolverSettlement, type Surplus, type TokenAmount, type TotalSurplus, type Trade, type TransactionHash, type UID, type Volume, getProtocolFeeAmount, getQuoteAmountsAfterPartnerFee, getQuoteAmountsAfterSlippage, getQuoteAmountsAndCosts, request };
+export { type Address, type Amounts, type AppData, type AppDataHash, type AppDataObject, type Auction, type AuctionOrder, type AuctionPrices, type BigUint, BuyTokenDestination, type CallData, type CompetitionAuction, CompetitionOrderStatus, type Costs, DEFAULT_BACKOFF_OPTIONS, DEFAULT_LIMITER_OPTIONS, type EcdsaSignature, EcdsaSigningScheme, type EnrichedOrder, type EthflowData, type ExecutedAmounts, type ExecutedProtocolFee, type FeePolicy, type FetchParams, type GetOrdersRequest, type GetTradesRequest, type InteractionData, type NativePriceResponse, ORDER_BOOK_PARTNER_PROD_CONFIG, ORDER_BOOK_PARTNER_STAGING_CONFIG, ORDER_BOOK_PROD_CONFIG, ORDER_BOOK_STAGING_CONFIG, OnchainOrderData, type Order, type OrderAmountsBig, OrderBookApi, OrderBookApiError, type OrderCancellation, OrderCancellationError, type OrderCancellations, OrderClass, type OrderCreation, OrderKind, type OrderMetaData, type OrderParameters, OrderPostError, type OrderQuoteRequest, type OrderQuoteResponse, type OrderQuoteSide, OrderQuoteSideKindBuy, OrderQuoteSideKindSell, type OrderQuoteValidity, OrderStatus, type PreSignature, PriceEstimationError, type PriceImprovement, PriceQuality, type ProtocolFeeAmountParams, type Quote, type QuoteAmountsAfterSlippage, type QuoteAmountsAfterSlippageParams, type QuoteAmountsAndCosts, type QuoteAmountsAndCostsParams, type QuoteAmountsWithNetworkCosts, type QuoteParameters, type QuotePriceParams, SellTokenSource, type Signature, SigningScheme, type SolverCompetitionResponse, type SolverSettlement, type Surplus, type TokenAmount, type TotalSurplus, type Trade, type TransactionHash, type UID, type Volume, getProtocolFeeAmount, getQuoteAmountsAfterPartnerFee, getQuoteAmountsAfterSlippage, getQuoteAmountsAndCosts, request };

package/dist/index.js

@@ -25,6 +25,8 @@ __export(src_exports, {
   DEFAULT_BACKOFF_OPTIONS: () => DEFAULT_BACKOFF_OPTIONS,
   DEFAULT_LIMITER_OPTIONS: () => DEFAULT_LIMITER_OPTIONS,
   EcdsaSigningScheme: () => EcdsaSigningScheme,
+  ORDER_BOOK_PARTNER_PROD_CONFIG: () => ORDER_BOOK_PARTNER_PROD_CONFIG,
+  ORDER_BOOK_PARTNER_STAGING_CONFIG: () => ORDER_BOOK_PARTNER_STAGING_CONFIG,
   ORDER_BOOK_PROD_CONFIG: () => ORDER_BOOK_PROD_CONFIG,
   ORDER_BOOK_STAGING_CONFIG: () => ORDER_BOOK_STAGING_CONFIG,
   OnchainOrderData: () => OnchainOrderData,
@@ -118,11 +120,12 @@ var getResponseBody = async (response) => {
   }
   return void 0;
 };
-async function request(baseUrl, { path, query, method, body }, rateLimiter, backoffOpts) {
+async function request(baseUrl, { path, query, method, body }, rateLimiter, backoffOpts, additionalHeaders) {
   const queryString = query ? "?" + query : "";
   const headers = {
     Accept: "application/json",
-    "Content-Type": "application/json"
+    "Content-Type": "application/json",
+    ...additionalHeaders
   };
   const url = `${baseUrl}${path}${queryString}`;
   const bodyContent = (() => {
@@ -175,6 +178,8 @@ function transformEthFlowOrder(order) {
 // src/api.ts
 var PROD_BASE_URL = "https://api.cow.fi";
 var STAGING_BASE_URL = "https://barn.api.cow.fi";
+var PARTNER_PROD_BASE_URL = "https://partners.cow.fi";
+var PARTNER_STAGING_BASE_URL = "https://partners.barn.cow.fi";
 var ORDER_BOOK_PROD_CONFIG = {
   [import_sdk_config2.SupportedChainId.MAINNET]: `${PROD_BASE_URL}/mainnet`,
   [import_sdk_config2.SupportedChainId.GNOSIS_CHAIN]: `${PROD_BASE_URL}/xdai`,
@@ -203,6 +208,34 @@ var ORDER_BOOK_STAGING_CONFIG = {
   [import_sdk_config2.SupportedChainId.PLASMA]: `${STAGING_BASE_URL}/plasma`,
   [import_sdk_config2.SupportedChainId.INK]: `${STAGING_BASE_URL}/ink`
 };
+var ORDER_BOOK_PARTNER_PROD_CONFIG = {
+  [import_sdk_config2.SupportedChainId.MAINNET]: `${PARTNER_PROD_BASE_URL}/mainnet`,
+  [import_sdk_config2.SupportedChainId.GNOSIS_CHAIN]: `${PARTNER_PROD_BASE_URL}/xdai`,
+  [import_sdk_config2.SupportedChainId.ARBITRUM_ONE]: `${PARTNER_PROD_BASE_URL}/arbitrum_one`,
+  [import_sdk_config2.SupportedChainId.BASE]: `${PARTNER_PROD_BASE_URL}/base`,
+  [import_sdk_config2.SupportedChainId.SEPOLIA]: `${PARTNER_PROD_BASE_URL}/sepolia`,
+  [import_sdk_config2.SupportedChainId.POLYGON]: `${PARTNER_PROD_BASE_URL}/polygon`,
+  [import_sdk_config2.SupportedChainId.AVALANCHE]: `${PARTNER_PROD_BASE_URL}/avalanche`,
+  [import_sdk_config2.SupportedChainId.LENS]: `${PARTNER_PROD_BASE_URL}/lens`,
+  [import_sdk_config2.SupportedChainId.BNB]: `${PARTNER_PROD_BASE_URL}/bnb`,
+  [import_sdk_config2.SupportedChainId.LINEA]: `${PARTNER_PROD_BASE_URL}/linea`,
+  [import_sdk_config2.SupportedChainId.PLASMA]: `${PARTNER_PROD_BASE_URL}/plasma`,
+  [import_sdk_config2.SupportedChainId.INK]: `${PARTNER_PROD_BASE_URL}/ink`
+};
+var ORDER_BOOK_PARTNER_STAGING_CONFIG = {
+  [import_sdk_config2.SupportedChainId.MAINNET]: `${PARTNER_STAGING_BASE_URL}/mainnet`,
+  [import_sdk_config2.SupportedChainId.GNOSIS_CHAIN]: `${PARTNER_STAGING_BASE_URL}/xdai`,
+  [import_sdk_config2.SupportedChainId.ARBITRUM_ONE]: `${PARTNER_STAGING_BASE_URL}/arbitrum_one`,
+  [import_sdk_config2.SupportedChainId.BASE]: `${PARTNER_STAGING_BASE_URL}/base`,
+  [import_sdk_config2.SupportedChainId.SEPOLIA]: `${PARTNER_STAGING_BASE_URL}/sepolia`,
+  [import_sdk_config2.SupportedChainId.POLYGON]: `${PARTNER_STAGING_BASE_URL}/polygon`,
+  [import_sdk_config2.SupportedChainId.AVALANCHE]: `${PARTNER_STAGING_BASE_URL}/avalanche`,
+  [import_sdk_config2.SupportedChainId.LENS]: `${PARTNER_STAGING_BASE_URL}/lens`,
+  [import_sdk_config2.SupportedChainId.BNB]: `${PARTNER_STAGING_BASE_URL}/bnb`,
+  [import_sdk_config2.SupportedChainId.LINEA]: `${PARTNER_STAGING_BASE_URL}/linea`,
+  [import_sdk_config2.SupportedChainId.PLASMA]: `${PARTNER_STAGING_BASE_URL}/plasma`,
+  [import_sdk_config2.SupportedChainId.INK]: `${PARTNER_STAGING_BASE_URL}/ink`
+};
 function cleanObjectFromUndefinedValues(obj) {
   return Object.keys(obj).reduce(
     (acc, key) => {
@@ -428,8 +461,8 @@ var OrderBookApi = class {
    * @returns The API endpoint to get the order.
    */
   getOrderLink(orderUid, contextOverride) {
-    const { chainId, env } = this.getContextWithOverride(contextOverride);
-    return this.getApiBaseUrls(env)[chainId] + `/api/v1/orders/${orderUid}`;
+    const context = this.getContextWithOverride(contextOverride ?? {});
+    return this.getApiBaseUrls(context)[context.chainId] + `/api/v1/orders/${orderUid}`;
   }
   /**
    * Apply an override to the context for a request.
@@ -440,14 +473,18 @@ var OrderBookApi = class {
     return { ...this.context, ...contextOverride };
   }
   /**
-   * Get the base URLs for the API endpoints given the environment.
-   * @param env The environment to get the base URLs for.
+   * Get the base URLs for the API endpoints given the context.
+   * Uses partner URLs when apiKey is set (and no custom baseUrls override).
+   * @param context The merged API context for the request.
    * @returns The base URLs for the API endpoints.
    */
-  getApiBaseUrls(env) {
-    if (this.context.baseUrls)
-      return this.context.baseUrls;
-    return env === "prod" ? ORDER_BOOK_PROD_CONFIG : ORDER_BOOK_STAGING_CONFIG;
+  getApiBaseUrls(context) {
+    if (context.baseUrls)
+      return context.baseUrls;
+    if (context.apiKey) {
+      return context.env === "prod" ? ORDER_BOOK_PARTNER_PROD_CONFIG : ORDER_BOOK_PARTNER_STAGING_CONFIG;
+    }
+    return context.env === "prod" ? ORDER_BOOK_PROD_CONFIG : ORDER_BOOK_STAGING_CONFIG;
   }
   /**
    * Make a request to the API.
@@ -456,12 +493,14 @@ var OrderBookApi = class {
    * @returns The response from the API.
    */
   fetch(params, contextOverride = {}) {
-    const { chainId, env, backoffOpts: _backoffOpts } = this.getContextWithOverride(contextOverride);
-    const baseUrl = this.getApiBaseUrls(env)[chainId];
+    const context = this.getContextWithOverride(contextOverride);
+    const { chainId, backoffOpts: _backoffOpts, apiKey } = context;
+    const baseUrl = this.getApiBaseUrls(context)[chainId];
     const backoffOpts = _backoffOpts || DEFAULT_BACKOFF_OPTIONS;
     const rateLimiter = contextOverride.limiterOpts ? new import_limiter.RateLimiter(contextOverride.limiterOpts) : this.rateLimiter;
+    const additionalHeaders = apiKey ? { "X-API-Key": apiKey } : void 0;
     (0, import_sdk_common.log)(`Fetching OrderBook API: ${baseUrl}${params.path}. Params: ${JSON.stringify(params, import_sdk_common.jsonWithBigintReplacer)}`);
-    return request(baseUrl, params, rateLimiter, backoffOpts);
+    return request(baseUrl, params, rateLimiter, backoffOpts, additionalHeaders);
   }
 };
 
@@ -785,6 +824,8 @@ function getQuoteAmountsAndCosts(params) {
   DEFAULT_BACKOFF_OPTIONS,
   DEFAULT_LIMITER_OPTIONS,
   EcdsaSigningScheme,
+  ORDER_BOOK_PARTNER_PROD_CONFIG,
+  ORDER_BOOK_PARTNER_STAGING_CONFIG,
   ORDER_BOOK_PROD_CONFIG,
   ORDER_BOOK_STAGING_CONFIG,
   OnchainOrderData,

package/dist/index.mjs

@@ -71,11 +71,12 @@ var getResponseBody = async (response) => {
   }
   return void 0;
 };
-async function request(baseUrl, { path, query, method, body }, rateLimiter, backoffOpts) {
+async function request(baseUrl, { path, query, method, body }, rateLimiter, backoffOpts, additionalHeaders) {
   const queryString = query ? "?" + query : "";
   const headers = {
     Accept: "application/json",
-    "Content-Type": "application/json"
+    "Content-Type": "application/json",
+    ...additionalHeaders
   };
   const url = `${baseUrl}${path}${queryString}`;
   const bodyContent = (() => {
@@ -128,6 +129,8 @@ function transformEthFlowOrder(order) {
 // src/api.ts
 var PROD_BASE_URL = "https://api.cow.fi";
 var STAGING_BASE_URL = "https://barn.api.cow.fi";
+var PARTNER_PROD_BASE_URL = "https://partners.cow.fi";
+var PARTNER_STAGING_BASE_URL = "https://partners.barn.cow.fi";
 var ORDER_BOOK_PROD_CONFIG = {
   [SupportedChainId.MAINNET]: `${PROD_BASE_URL}/mainnet`,
   [SupportedChainId.GNOSIS_CHAIN]: `${PROD_BASE_URL}/xdai`,
@@ -156,6 +159,34 @@ var ORDER_BOOK_STAGING_CONFIG = {
   [SupportedChainId.PLASMA]: `${STAGING_BASE_URL}/plasma`,
   [SupportedChainId.INK]: `${STAGING_BASE_URL}/ink`
 };
+var ORDER_BOOK_PARTNER_PROD_CONFIG = {
+  [SupportedChainId.MAINNET]: `${PARTNER_PROD_BASE_URL}/mainnet`,
+  [SupportedChainId.GNOSIS_CHAIN]: `${PARTNER_PROD_BASE_URL}/xdai`,
+  [SupportedChainId.ARBITRUM_ONE]: `${PARTNER_PROD_BASE_URL}/arbitrum_one`,
+  [SupportedChainId.BASE]: `${PARTNER_PROD_BASE_URL}/base`,
+  [SupportedChainId.SEPOLIA]: `${PARTNER_PROD_BASE_URL}/sepolia`,
+  [SupportedChainId.POLYGON]: `${PARTNER_PROD_BASE_URL}/polygon`,
+  [SupportedChainId.AVALANCHE]: `${PARTNER_PROD_BASE_URL}/avalanche`,
+  [SupportedChainId.LENS]: `${PARTNER_PROD_BASE_URL}/lens`,
+  [SupportedChainId.BNB]: `${PARTNER_PROD_BASE_URL}/bnb`,
+  [SupportedChainId.LINEA]: `${PARTNER_PROD_BASE_URL}/linea`,
+  [SupportedChainId.PLASMA]: `${PARTNER_PROD_BASE_URL}/plasma`,
+  [SupportedChainId.INK]: `${PARTNER_PROD_BASE_URL}/ink`
+};
+var ORDER_BOOK_PARTNER_STAGING_CONFIG = {
+  [SupportedChainId.MAINNET]: `${PARTNER_STAGING_BASE_URL}/mainnet`,
+  [SupportedChainId.GNOSIS_CHAIN]: `${PARTNER_STAGING_BASE_URL}/xdai`,
+  [SupportedChainId.ARBITRUM_ONE]: `${PARTNER_STAGING_BASE_URL}/arbitrum_one`,
+  [SupportedChainId.BASE]: `${PARTNER_STAGING_BASE_URL}/base`,
+  [SupportedChainId.SEPOLIA]: `${PARTNER_STAGING_BASE_URL}/sepolia`,
+  [SupportedChainId.POLYGON]: `${PARTNER_STAGING_BASE_URL}/polygon`,
+  [SupportedChainId.AVALANCHE]: `${PARTNER_STAGING_BASE_URL}/avalanche`,
+  [SupportedChainId.LENS]: `${PARTNER_STAGING_BASE_URL}/lens`,
+  [SupportedChainId.BNB]: `${PARTNER_STAGING_BASE_URL}/bnb`,
+  [SupportedChainId.LINEA]: `${PARTNER_STAGING_BASE_URL}/linea`,
+  [SupportedChainId.PLASMA]: `${PARTNER_STAGING_BASE_URL}/plasma`,
+  [SupportedChainId.INK]: `${PARTNER_STAGING_BASE_URL}/ink`
+};
 function cleanObjectFromUndefinedValues(obj) {
   return Object.keys(obj).reduce(
     (acc, key) => {
@@ -381,8 +412,8 @@ var OrderBookApi = class {
    * @returns The API endpoint to get the order.
    */
   getOrderLink(orderUid, contextOverride) {
-    const { chainId, env } = this.getContextWithOverride(contextOverride);
-    return this.getApiBaseUrls(env)[chainId] + `/api/v1/orders/${orderUid}`;
+    const context = this.getContextWithOverride(contextOverride ?? {});
+    return this.getApiBaseUrls(context)[context.chainId] + `/api/v1/orders/${orderUid}`;
   }
   /**
    * Apply an override to the context for a request.
@@ -393,14 +424,18 @@ var OrderBookApi = class {
     return { ...this.context, ...contextOverride };
   }
   /**
-   * Get the base URLs for the API endpoints given the environment.
-   * @param env The environment to get the base URLs for.
+   * Get the base URLs for the API endpoints given the context.
+   * Uses partner URLs when apiKey is set (and no custom baseUrls override).
+   * @param context The merged API context for the request.
    * @returns The base URLs for the API endpoints.
    */
-  getApiBaseUrls(env) {
-    if (this.context.baseUrls)
-      return this.context.baseUrls;
-    return env === "prod" ? ORDER_BOOK_PROD_CONFIG : ORDER_BOOK_STAGING_CONFIG;
+  getApiBaseUrls(context) {
+    if (context.baseUrls)
+      return context.baseUrls;
+    if (context.apiKey) {
+      return context.env === "prod" ? ORDER_BOOK_PARTNER_PROD_CONFIG : ORDER_BOOK_PARTNER_STAGING_CONFIG;
+    }
+    return context.env === "prod" ? ORDER_BOOK_PROD_CONFIG : ORDER_BOOK_STAGING_CONFIG;
   }
   /**
    * Make a request to the API.
@@ -409,12 +444,14 @@ var OrderBookApi = class {
    * @returns The response from the API.
    */
   fetch(params, contextOverride = {}) {
-    const { chainId, env, backoffOpts: _backoffOpts } = this.getContextWithOverride(contextOverride);
-    const baseUrl = this.getApiBaseUrls(env)[chainId];
+    const context = this.getContextWithOverride(contextOverride);
+    const { chainId, backoffOpts: _backoffOpts, apiKey } = context;
+    const baseUrl = this.getApiBaseUrls(context)[chainId];
     const backoffOpts = _backoffOpts || DEFAULT_BACKOFF_OPTIONS;
     const rateLimiter = contextOverride.limiterOpts ? new RateLimiter(contextOverride.limiterOpts) : this.rateLimiter;
+    const additionalHeaders = apiKey ? { "X-API-Key": apiKey } : void 0;
     log(`Fetching OrderBook API: ${baseUrl}${params.path}. Params: ${JSON.stringify(params, jsonWithBigintReplacer)}`);
-    return request(baseUrl, params, rateLimiter, backoffOpts);
+    return request(baseUrl, params, rateLimiter, backoffOpts, additionalHeaders);
   }
 };
 
@@ -737,6 +774,8 @@ export {
   DEFAULT_BACKOFF_OPTIONS,
   DEFAULT_LIMITER_OPTIONS,
   EcdsaSigningScheme,
+  ORDER_BOOK_PARTNER_PROD_CONFIG,
+  ORDER_BOOK_PARTNER_STAGING_CONFIG,
   ORDER_BOOK_PROD_CONFIG,
   ORDER_BOOK_STAGING_CONFIG,
   OnchainOrderData,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cowprotocol/sdk-order-book",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "description": "CowProtocol Order Book package",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",
@@ -31,8 +31,8 @@
     "cross-fetch": "^3.2.0",
     "exponential-backoff": "^3.1.2",
     "limiter": "^3.0.0",
-    "@cowprotocol/sdk-config": "0.8.1",
-    "@cowprotocol/sdk-common": "0.6.2"
+    "@cowprotocol/sdk-config": "0.9.0",
+    "@cowprotocol/sdk-common": "0.6.3"
   },
   "scripts": {
     "build": "tsup src/index.ts --format esm,cjs --dts",