GET
/
api
/
v1
/
suppliers
/
{supplier_name}
/
fee-types
Get Available Fee Types
curl --request GET \
  --url https://api.example.com/api/v1/suppliers/{supplier_name}/fee-types
{
  "error": "Unauthorized",
  "message": "Invalid or missing API key"
}

Overview

This endpoint returns all available fee types for a specific exchange/supplier. Use this to discover which fee types (option or equity) have data available before making detailed data requests.
Authorization Required - You must include a valid Bearer token in the Authorization header. Contact sales@rulebook.company to obtain API access.

Path Parameters

supplier_name
string
required
The name or code of the supplier (e.g., NYSE, NASDAQ, CBOE)

Query Parameters

start_date
string
Optional: Filter by start date (ISO 8601 format: YYYY-MM-DD)
end_date
string
Optional: Filter by end date (ISO 8601 format: YYYY-MM-DD)

Request

curl -X GET https://api.rulebook.company/v1/suppliers/NYSE/fee-types \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

Response

supplier
string
Name of the supplier
date_range
object
Date range filter applied (if any)
fee_types
array
Array of available fee type objects

Example Response

{
  "success": true,
  "data": {
    "supplier": "NYSE",
    "date_range": null,
    "fee_types": [
      {
        "type": "equity",
        "display_name": "Equity",
        "description": "Fees and rebates for equity securities trading",
        "available": true,
        "record_count": 15420
      },
      {
        "type": "option",
        "display_name": "Options",
        "description": "Fees and rebates for options trading",
        "available": true,
        "record_count": 8750
      }
    ],
    "total_types": 2
  }
}

Error Responses

{
  "error": "Unauthorized",
  "message": "Invalid or missing API key"
}

Usage Example

Use this endpoint before querying detailed data to ensure the fee type you need is available for the supplier.
// Example: Check available fee types before querying data
const response = await fetch('https://api.rulebook.company/v1/suppliers/NYSE/fee-types', {
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json'
  }
});

const { data } = await response.json();
const hasEquity = data.fee_types.some(ft => ft.type === 'equity' && ft.available);

if (hasEquity) {
  // Proceed to query equity data
}