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
The name or code of the supplier (e.g., NYSE, NASDAQ, CBOE)
Query Parameters
Optional: Filter by start date (ISO 8601 format: YYYY-MM-DD)
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
Date range filter applied (if any)
Array of available fee type objects Fee type identifier (option, equity)
Human-readable name for the fee type
Description of what this fee type covers
Whether this fee type currently has data available
Number of records available for this fee type
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
401 Unauthorized
404 Not Found
{
"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
}