TypeScript SDK

npm install rulebook-typescript

import { Rulebook } from "rulebook-typescript";

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

export RULEBOOK_API_KEY="your-api-key"

import { Rulebook } from "rulebook-typescript";

const client = new Rulebook(); // reads from RULEBOOK_API_KEY

export RULEBOOK_BASE_URL="https://your-custom-endpoint/api/v1"

const response = await client.exchanges.list();

for (const ex of response.data) {
  console.log(`${ex.name} (${ex.display_name})`);
  console.log(`  Fee types: ${ex.fee_types}`);
  console.log(`  Records: ${ex.record_count}`);
}

console.log(`Total exchanges: ${response.meta.record_count}`);

const response = await client.exchanges.retrieve("nasdaq");

const detail = response.data;
console.log(`Date range: ${detail.date_range.earliest} to ${detail.date_range.latest}`);
console.log(`Actions: ${detail.actions}`);
console.log(`Participants: ${detail.participants}`);
console.log(`Fee categories: ${detail.fee_categories}`);
console.log(`Query time: ${response.meta.query_time_ms}ms`);

const page = await client.feeScheduleResults.list({
  exchange_name: ["nasdaq"],
  fee_type: ["option"],
  fee_participant: ["market_maker"],
  latest_only: true,
  page_size: 10,
});

console.log(`Total results: ${page.meta.record_count}`);
for (const result of page.data) {
  console.log(`  ${result.fee_action}: ${result.fee_amount} (${result.fee_symbol_type})`);
}

const response = await client.feeScheduleResults.retrieve(
  "a3d76e96-0cad-4ece-9db1-7ad3c743bdf8",
  { include_footnotes: true, include_definitions: true, include_source: true }
);

const result = response.data;
console.log(`${result.exchange_name} — ${result.fee_type} — ${result.fee_category}`);
console.log(`  Action: ${result.fee_action}`);
console.log(`  Amount: ${result.fee_amount}`);
console.log(`  Participant: ${result.fee_participant}`);
console.log(`Query time: ${response.meta.query_time_ms}ms`);

const response = await client.feeScheduleResults.getFilters();

const filters = response.data;
console.log(`Exchanges: ${filters.exchange_names}`);
console.log(`Fee types: ${filters.fee_types}`);
console.log(`Categories: ${filters.fee_categories}`);
console.log(`Actions: ${filters.fee_actions}`);
console.log(`Participants: ${filters.fee_participants}`);
console.log(`Total records: ${response.meta.record_count}`);

// Narrow filters to specific exchanges
const nasdaqFilters = await client.feeScheduleResults.getFilters({
  exchange_name: ["nasdaq", "nasdaq_phlx"],
});

const page = await client.feeScheduleResults.getResultsByVersion(
  "b962c0b1-5d99-4ef6-b3f6-36cb18c08933",
  { include_source: true, include_footnotes: true, page_size: 50 },
);

console.log(`Version has ${page.meta.record_count} results (${page.meta.total_pages} pages)`);
for (const result of page.data) {
  console.log(`  ${result.fee_action}: ${result.fee_amount}`);
  if (result.source_document) {
    console.log(`    Source: ${result.source_document} (p.${result.page_number})`);
  }
}

let page_number = 0;
let totalFetched = 0;

while (true) {
  const page = await client.feeScheduleResults.list({
    latest_only: true,
    page_size: 50,
    page_number,
  });
  totalFetched += page.data.length;
  console.log(`Page ${page_number + 1}/${page.meta.total_pages}: ${page.data.length} results`);

  if (page_number >= page.meta.total_pages - 1) break;
  page_number++;
}

console.log(`Fetched ${totalFetched} of ${page.meta.record_count} total results`);

import { Rulebook } from "rulebook-typescript";

async function main() {
  const client = new Rulebook({ apiKey: "your-api-key" });
  const exchanges = await client.exchanges.list();
  const detail = await client.exchanges.retrieve("nasdaq");
}

main();