GET
/
exchanges
/
{exchange_name}
Get exchange details
curl --request GET \
  --url https://api.rulebook.company/api/v1/exchanges/{exchange_name} \
  --header 'x-rulebook-api-access-key: <api-key>'
{
  "message": "You are not authorized to perform this action. Invalid API key.",
  "data": [],
  "query_time": null,
  "success": false,
  "disable_jsonable_encoder": false,
  "status_code": 401
}

Overview

Returns full metadata for a single exchange, including all available filter values: fee types, fee categories, actions, participants, symbol classifications, symbol types, trade types, and the date range of available data. Use this to discover what query parameters you can use when fetching fee schedule results.
Authorization Required - Include your API key in the x-rulebook-api-access-key header. Contact sales@rulebook.company to obtain access.
This endpoint consolidates all discovery information into a single call. Instead of making separate requests for fee types, categories, actions, and participants, get everything at once.

Path Parameters

exchange_name
string
required
Exchange identifier (e.g., NYSE, NASDAQ, CBOE). Get the list of available exchanges from List Exchanges.

Request

curl -X GET https://api.rulebook.company/api/v1/exchanges/NYSE \
  -H "x-rulebook-api-access-key: YOUR_API_KEY"

Response

success
boolean
Whether the request was successful
message
string
Human-readable status message
data
object
Exchange detail object

Example Response

{
  "message": "Operation completed successfully.",
  "data": {
    "name": "fee_cboe_us_options",
    "display_name": "Fee - CBOE US Options",
    "date_range": {
      "earliest": "2025-08-28",
      "latest": "2025-12-15"
    },
    "fee_types": ["OPTION"],
    "fee_categories": [
      "Fees And Rebates",
      "Legal Regulatory Fee",
      "Market Data Fees",
      "Participant Fee"
    ],
    "actions": ["Make", "Open", "Other", "Routed", "Take"],
    "participants": [
      "All",
      "Away_Market_Maker",
      "Broker_Dealer",
      "Customer",
      "Firm",
      "Market_Maker",
      "Other",
      "Professional"
    ],
    "symbol_classifications": ["All", "ETF", "Equity", "Index"],
    "symbol_types": ["Both", "Non_Penny", "Penny"],
    "trade_types": ["Complex_Order", "Index_Options"],
    "record_count": 1787
  },
  "query_time": null,
  "success": true,
  "disable_jsonable_encoder": false
}

Using Exchange Details to Build Queries

Use the returned filter values as parameters when querying fee schedule results:
# Step 1: Get exchange details to see available filters
curl -X GET https://api.rulebook.company/api/v1/exchanges/NYSE \
  -H "x-rulebook-api-access-key: YOUR_API_KEY"

# Step 2: Use discovered values in your fee schedule query
curl -X GET "https://api.rulebook.company/api/v1/fee-schedule-results?supplier_name=NYSE&fee_type=Equity&fee_action=Make&fee_participant=Market%20Maker&latest_only=true" \
  -H "x-rulebook-api-access-key: YOUR_API_KEY"

Reference: Filter Value Descriptions

  • Fee And Rebates — Standard trading fees and liquidity rebates
  • Legal Regulatory Fees — SEC fees, FINRA TAF, and other regulatory charges
  • Market Data Fees — Real-time and delayed market data subscription fees
  • Participant Fee — Membership and participation fees
  • Port Fees And Other Services — Network connectivity, co-location, and port fees
  • Make — Orders that add liquidity to the order book (typically receive rebates)
  • Take — Orders that remove liquidity (typically charged fees)
  • Open — Opening auction transactions
  • Routed — Orders routed to other venues
  • Other — Miscellaneous action types
  • All — Aggregated across all participant types
  • Market Maker — Exchange-designated market makers with quoting obligations
  • Away Market Maker — Market makers registered at other exchanges
  • Broker Dealer — Registered broker-dealer firms
  • Customer — Retail and institutional customers
  • Firm — Proprietary trading firms
  • Professional — Professional individual traders
  • Other — Other participant categories
  • ETF — Exchange Traded Funds
  • ETN — Exchange Traded Notes
  • Equity — Equity securities
  • Index — Index options
  • All — All classifications
  • N/A — Not applicable
  • Penny — Penny increment symbols
  • Non Penny — Non-penny increment symbols
  • Both — Applies to both
  • N/A — Not applicable
  • Simple Order — Simple (single-leg) orders
  • Complex Order — Complex/multi-leg orders
  • Index Options — Index option trades
  • Multiply Traded Options — Multiply-listed options

Error Responses

{
  "message": "You are not authorized to perform this action. Invalid API key.",
  "data": [],
  "query_time": null,
  "success": false,
  "disable_jsonable_encoder": false,
  "status_code": 401
}

Authorizations

x-rulebook-api-access-key
string
header
required

API access key provided by Rulebook Company. Contact sales@rulebook.company to obtain one.

Path Parameters

exchange_name
string
required

Exchange identifier (e.g., NYSE, NASDAQ, CBOE)

Response

Exchange detail

success
boolean
Example:

true

message
string
Example:

"Operation completed successfully."

data
object

Full metadata for a single exchange including all discoverable filter values