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

​
Overview

This endpoint returns all available trading action types for a specific exchange/supplier. Use this to discover which action types (Make, Take, Open, etc.) 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/actions \
  -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/actions?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)
​
actions
array
Array of available action objects

​
Example Response

{
  "success": true,
  "data": {
    "supplier": "NYSE",
    "date_range": null,
    "actions": [
      {
        "action": "Make",
        "display_name": "Make",
        "description": "Orders that add liquidity to the order book",
        "available": true,
        "record_count": 5240,
        "liquidity_type": "adding"
      },
      {
        "action": "Take",
        "display_name": "Take",
        "description": "Orders that remove liquidity from the order book",
        "available": true,
        "record_count": 4890,
        "liquidity_type": "removing"
      },
      {
        "action": "Open",
        "display_name": "Open",
        "description": "Opening auction transactions",
        "available": true,
        "record_count": 1250,
        "liquidity_type": "neutral"
      },
      {
        "action": "Routed & Other",
        "display_name": "Routed & Other",
        "description": "Orders routed to other venues and miscellaneous actions",
        "available": true,
        "record_count": 2180,
        "liquidity_type": "neutral"
      }
    ],
    "total_actions": 4
  }
}

​
Action Type Details

Make orders add liquidity to the order book by resting on the book until matched.
  • Typically receive rebates
  • Limit orders that don’t immediately execute
  • Help provide market depth
  • Often incentivized by exchanges
Take orders remove liquidity from the order book by immediately executing against resting orders.
  • Typically charged fees
  • Market orders and aggressive limit orders
  • Execute immediately
  • Higher fee structure than make orders
Open refers to transactions during opening auction periods.
  • Opening cross transactions
  • Pre-market auction executions
  • Special fee structures
  • Different pricing than continuous trading
Routed & Other includes orders routed away and miscellaneous action types.
  • Orders routed to other trading venues
  • Special order types
  • Non-standard executions
  • Variable fee structures

​
Error Responses

{
  "error": "Bad Request",
  "message": "Invalid date format",
  "details": {
    "field": "start_date",
    "expected_format": "YYYY-MM-DD"
  }
}
Use the date range parameters to see which actions had data available during specific time periods.