Advanced Usage

import { Rulebook } from "rulebook-typescript";

const client = new Rulebook({
  apiKey: "your-key",                                      // required (or RULEBOOK_API_KEY env var)
  baseUrl: "https://api.rulebookcompany.com/api/v1",       // default (or RULEBOOK_BASE_URL env var)
  timeout: 30000,                                          // milliseconds, default 30000
  maxRetries: 2,                                           // default 2
  defaultHeaders: { "X-Custom": "value" },                 // merged into every request
  defaultQuery: { customParam: "value" },                  // merged into every request
});

// All requests use a 60-second timeout
const client = new Rulebook({ apiKey: "your-key", timeout: 60000 });

// Override timeout for a single request
const detail = await client.exchanges.retrieve("NYSE", { timeout: 120000 });

const detail = await client.exchanges.retrieve("NYSE", { timeout: 0 });

// Set max retries
const client = new Rulebook({ apiKey: "your-key", maxRetries: 5 });

// Disable retries for a single request
const noRetryClient = client.withOptions({ maxRetries: 0 });
await noRetryClient.exchanges.retrieve("nasdaq");

const client = new Rulebook({ apiKey: "your-key" });

// Create a variant with different timeout
const slowClient = client.withOptions({ timeout: 120000 });

// Create a variant with extra headers
const debugClient = client.withOptions({ defaultHeaders: { "X-Debug": "true" } });

// Original client is unmodified

// Extra headers
const exchanges = await client.exchanges.list({
  extra_headers: { "X-Request-Id": "abc-123" },
});

// Extra query parameters
const exchanges = await client.exchanges.list({
  extra_query: { customParam: "value" },
});

// Custom timeout
const detail = await client.exchanges.retrieve("NYSE", { timeout: 60000 });

// Combine them
const detail = await client.exchanges.retrieve("NYSE", {
  extra_headers: { "X-Trace-Id": "xyz" },
  timeout: 90000,
});

const raw = await client.exchanges.withRawResponse.retrieve("NYSE");

console.log(raw.statusCode);                  // 200
console.log(raw.headers.get("content-type")); // application/json

// Parse the body on demand
const detail = raw.parse();                   // ExchangeDetail
console.log(detail.name);                     // "NYSE"

const raw = await client.feeScheduleResults.withRawResponse.list({
  exchange_name: ["nasdaq"],
  latest_only: true,
});

console.log(raw.statusCode);                  // 200
const page = raw.parse();                     // PaginatedResponse<FeeScheduleResult>
console.log(page.total_records);

import { Rulebook } from "rulebook-typescript";
import type {
  Exchange,
  ExchangeDetail,
  DateRange,
  FeeScheduleResult,
  FeeScheduleResultFilters,
  PaginatedResponse,
} from "rulebook-typescript/types";

function summarizeResult(result: FeeScheduleResult): string {
  return `${result.exchange_name} — ${result.fee_action}: ${result.fee_amount}`;
}

const client = new Rulebook({ apiKey: "your-key" });
const page = await client.feeScheduleResults.list({ latest_only: true });
const summaries = page.data.map(summarizeResult);