GET
/
api
/
v1
/
suppliers
/
{supplier_name}
/
participants
Get Available Participants
curl --request GET \
  --url https://api.example.com/api/v1/suppliers/{supplier_name}/participants
{
  "error": "Bad Request",
  "message": "Invalid date format",
  "details": {
    "field": "start_date",
    "expected_format": "YYYY-MM-DD"
  }
}

Overview

This endpoint returns all available participant types for a specific exchange/supplier. Use this to discover which participant types 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/participants \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

With Date Range Filter

curl -X GET "https://api.rulebook.company/v1/suppliers/NYSE/participants?start_date=2024-01-01&end_date=2024-12-31" \
  -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)
participants
array
Array of available participant objects

Example Response

{
  "success": true,
  "data": {
    "supplier": "NYSE",
    "date_range": null,
    "participants": [
      {
        "participant": "All",
        "display_name": "All Participants",
        "description": "Aggregated data across all participant types",
        "available": true,
        "record_count": 18500,
        "typical_fee_structure": "Aggregated"
      },
      {
        "participant": "Market Maker",
        "display_name": "Market Maker",
        "description": "Exchange-designated market makers with obligations",
        "available": true,
        "record_count": 4250,
        "typical_fee_structure": "Enhanced rebates"
      },
      {
        "participant": "Away Market Maker",
        "display_name": "Away Market Maker",
        "description": "Market makers from other exchanges",
        "available": true,
        "record_count": 3100,
        "typical_fee_structure": "Standard rebates"
      },
      {
        "participant": "Broker Dealer",
        "display_name": "Broker Dealer",
        "description": "Registered broker-dealer firms",
        "available": true,
        "record_count": 5680,
        "typical_fee_structure": "Standard fees"
      },
      {
        "participant": "Customer",
        "display_name": "Customer",
        "description": "Retail and institutional customers",
        "available": true,
        "record_count": 2840,
        "typical_fee_structure": "Reduced fees"
      },
      {
        "participant": "Firm",
        "display_name": "Firm",
        "description": "Proprietary trading firms",
        "available": true,
        "record_count": 1950,
        "typical_fee_structure": "Standard fees"
      },
      {
        "participant": "Professional & Other",
        "display_name": "Professional & Other",
        "description": "Professional traders and other categories",
        "available": true,
        "record_count": 1420,
        "typical_fee_structure": "Variable"
      }
    ],
    "total_participants": 7
  }
}

Participant Type Details

All represents aggregated data across all participant types.
  • Combined statistics
  • Overall market activity
  • Useful for macro analysis
  • Includes all participant categories
Market Maker are exchange-designated firms with quoting obligations.
  • Required to maintain two-sided quotes
  • Enhanced rebate structures
  • Liquidity provision incentives
  • Specialized fee tiers
  • Performance obligations
Away Market Maker are market makers registered at other exchanges.
  • From competing venues
  • Standard rebate structures
  • Cross-exchange liquidity
  • Different obligation levels
Broker Dealer are registered firms executing for clients and proprietary accounts.
  • SEC registered firms
  • Client order flow
  • Proprietary trading
  • Standard fee structures
  • Compliance requirements
Customer includes retail and institutional investors.
  • End customer orders
  • Retail investors
  • Institutional clients
  • Often receive reduced fees
  • Protected under customer priority rules
Firm represents proprietary trading operations.
  • Principal trading
  • High-frequency trading firms
  • Algorithmic trading
  • Standard fee schedules
Professional & Other includes professional traders and miscellaneous categories.
  • Professional individual traders
  • Specialized trading strategies
  • Non-standard categorizations
  • Variable fee structures

Error Responses

{
  "error": "Bad Request",
  "message": "Invalid date format",
  "details": {
    "field": "start_date",
    "expected_format": "YYYY-MM-DD"
  }
}

Discovery Workflow

Recommended API Call SequenceAll discovery endpoints are independent - call them in any order to explore available data:
  1. Call List Exchanges to get all suppliers
  2. Call Check Date Ranges to see available time periods
  3. Call Get Fee Types to see available fee types
  4. Call Get Fee Categories to explore fee categories
  5. Call Get Actions to see available actions
  6. Call Get Participants to see all participant types
  7. Finally, query Supplier Data with your chosen parameters