GET
/
fee-schedule-results
/
filters
Get available filters
curl --request GET \
  --url https://api.rulebook.company/api/v1/fee-schedule-results/filters \
  --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 all distinct filter values for fee schedule results, scoped to exchanges associated with your API key. Use this to populate filter dropdowns in your UI, validate query parameters, and discover what data is available.
Authorization Required - Include your API key in the x-rulebook-api-access-key header. Contact sales@rulebook.company to obtain access.
Call this endpoint first, then use the returned values as filter parameters in List Fee Schedule Results.

​
Request

curl -X GET "https://api.rulebook.company/api/v1/fee-schedule-results/filters" \
  -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
Available filter values

​
Example Response

{
  "message": "Operation completed successfully.",
  "data": {
    "exchange_names": ["fee_cboe_us_options", "Nasdaq"],
    "fee_types": ["OPTION"],
    "fee_categories": [
      "Fees And Rebates",
      "Legal Regulatory Fee",
      "Market Data Fees",
      "Participant Fee",
      "Port Fees And Other Services",
      "Regulatory Fee"
    ],
    "fee_actions": ["Make", "Open", "Other", "Routed", "Take"],
    "fee_participants": [
      "All",
      "Away Market Maker",
      "Broker Dealer",
      "Customer",
      "Firm",
      "Market Maker",
      "Other",
      "Professional"
    ],
    "fee_symbol_classifications": ["All", "ETF", "Equity", "Index"],
    "fee_symbol_types": ["Both", "Non Penny", "Penny"],
    "fee_trade_types": ["Complex Order", "Index Options"]
  },
  "query_time": null,
  "success": true,
  "disable_jsonable_encoder": false
}

​
Usage

# Step 1: Discover what's available
curl -X GET "https://api.rulebook.company/api/v1/fee-schedule-results/filters" \
  -H "x-rulebook-api-access-key: YOUR_API_KEY"

# Step 2: Query with discovered values
curl -X GET "https://api.rulebook.company/api/v1/fee-schedule-results?exchange_name=fee_cboe_us_options&fee_type=Option&fee_action=Make&fee_participant=Market%20Maker&latest_only=true" \
  -H "x-rulebook-api-access-key: YOUR_API_KEY"

​
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.

Response

Available filter values

​
success
boolean
Example:

true

​
message
string
Example:

"Operation completed successfully."

​
data
object

Available filter values scoped to your associated exchanges. Use these to build queries for the fee schedule results endpoint.