Get Available Filters - Rulebook Company

Get available filters

curl --request GET \
  --url https://api.rulebookcompany.com/api/v1/fee-schedule-results/filters \
  --header 'x-rulebook-api-access-key: <api-key>'

import requests

url = "https://api.rulebookcompany.com/api/v1/fee-schedule-results/filters"

headers = {"x-rulebook-api-access-key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'x-rulebook-api-access-key': '<api-key>'}};

fetch('https://api.rulebookcompany.com/api/v1/fee-schedule-results/filters', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.rulebookcompany.com/api/v1/fee-schedule-results/filters",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-rulebook-api-access-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.rulebookcompany.com/api/v1/fee-schedule-results/filters"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-rulebook-api-access-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.rulebookcompany.com/api/v1/fee-schedule-results/filters")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-rulebook-api-access-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Missing or invalid API key."
  },
  "meta": { "query_time_ms": 1 }
}

GET

fee-schedule-results

filters

Get available filters

curl --request GET \
  --url https://api.rulebookcompany.com/api/v1/fee-schedule-results/filters \
  --header 'x-rulebook-api-access-key: <api-key>'

import requests

url = "https://api.rulebookcompany.com/api/v1/fee-schedule-results/filters"

headers = {"x-rulebook-api-access-key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'x-rulebook-api-access-key': '<api-key>'}};

fetch('https://api.rulebookcompany.com/api/v1/fee-schedule-results/filters', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.rulebookcompany.com/api/v1/fee-schedule-results/filters",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-rulebook-api-access-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.rulebookcompany.com/api/v1/fee-schedule-results/filters"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-rulebook-api-access-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.rulebookcompany.com/api/v1/fee-schedule-results/filters")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-rulebook-api-access-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Missing or invalid API key."
  },
  "meta": { "query_time_ms": 1 }
}

Overview

Returns all distinct filter values for fee schedule results, scoped to exchanges associated with your API key. The values returned are the exact values to pass as query parameters when calling List Fee Schedule Results.

Authorization Required - Include your API key in the x-rulebook-api-access-key header. Contact aaron@rulebookcompany.com to obtain access.

Call this endpoint first, then use the returned values as filter parameters in List Fee Schedule Results.

Query Parameters

string[]

Optionally narrow filter values to specific exchanges. When provided, only returns filter values relevant to the specified exchange(s).Example: ?exchange_name=nasdaq&exchange_name=nasdaq_phlx

Request

curl -X GET "https://api.rulebookcompany.com/api/v1/fee-schedule-results/filters" \
  -H "x-rulebook-api-access-key: YOUR_API_KEY"

Filtered by Exchange

curl -X GET "https://api.rulebookcompany.com/api/v1/fee-schedule-results/filters?exchange_name=nasdaq" \
  -H "x-rulebook-api-access-key: YOUR_API_KEY"

Response

object

Available filter values

Show Filter Values

string[]

Available exchange identifiers (use as exchange_name filter values)

string[]

Available fee types (e.g., option, equity)

string[]

Available fee categories (e.g., fees_and_rebates, legal_regulatory_fee)

string[]

Available trading action types (e.g., make, take, open)

string[]

Available market participant types (e.g., market_maker, away_market_maker)

string[]

Available symbol classifications (e.g., etf, equity_class, not_applicable)

string[]

Available symbol types (e.g., penny, non_penny, both)

string[]

Available trade types (e.g., simple_order, complex_order). May be empty if no trade type data is available.

object

Response metadata

Show Meta

integer

Total fee schedule records across all accessible exchanges

integer | null

Query execution time in milliseconds

Example Response

{
  "data": {
    "exchange_names": ["nasdaq", "nasdaq_gemx", "nasdaq_ise", "nasdaq_mrx", "nasdaq_phlx", "nasdaq_texas"],
    "fee_types": ["option"],
    "fee_categories": [
      "fees_and_rebates",
      "legal_regulatory_fee",
      "market_data_fees",
      "participant_fee",
      "port_fees_and_other_services"
    ],
    "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", "equity_class", "etf", "index", "not_applicable"],
    "fee_symbol_types": ["both", "non_penny", "not_applicable", "penny"],
    "fee_trade_types": []
  },
  "meta": {
    "record_count": 6773,
    "query_time_ms": 127
  }
}

Usage

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

# Step 2: Query with the returned values
curl -X GET "https://api.rulebookcompany.com/api/v1/fee-schedule-results?exchange_name=nasdaq&fee_type=option&fee_action=make&fee_participant=market_maker&latest_only=true" \
  -H "x-rulebook-api-access-key: YOUR_API_KEY"

Error Responses

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Missing or invalid API key."
  },
  "meta": { "query_time_ms": 1 }
}

Authorizations

x-rulebook-api-access-key

string

header

required

API access key provided by Rulebook Company. Contact aaron@rulebookcompany.com to obtain one.

Query Parameters

exchange_name

string[]

Narrow filter values to specific exchange(s). Repeat for multiple: ?exchange_name=fee_cboe_us_bzx_options&exchange_name=fee_memx

Response

Available filter values

data

object

Available filter values scoped to your associated exchanges. Use the returned values directly as query parameter values when calling the fee schedule results endpoint.

Show child attributes

​Overview

​Query Parameters

​Request

​Filtered by Exchange

​Response

​Example Response

​Usage

​Error Responses

Authorizations

Query Parameters

Response

Overview

Query Parameters

Request

Filtered by Exchange

Response

Example Response

Usage

Error Responses