API Documentation

Welcome to the Celeraq Developer API. Our beta endpoints allow algorithmic traders and developers to programmatically access real-time quotes, volatility surfaces, and specialized Jamaican market data.

Beta Access: These endpoints are currently in public beta. While no API key is strictly enforced for the beta routes, rate limits apply.

Authentication

Authenticate your requests by including your API key in the header. You can generate and manage your keys implementation the Developer Dashboard.

Authorization: Bearer YOUR_API_KEY

Base URL

All API requests should be made to:

https://api.celeraq.com/beta

GET

Index Quote

Get the latest snapshot value for a supported index (e.g., CQX).

Parameters

Name	Type	Description
api_key	string	Required. Your Developer API Key.
ticker	string	The index symbol (e.g., 'CQX')

Example Request

params = {
    "api_key": "YOUR_KEY",
    "ticker": "CQX"
}
response = requests.get(
    "https://api.celeraq.com/beta/index_quote", 
    params=params
)

print(response.json())

Example Response

{
  "ticker": "CQX",
  "value": 1245.32,
  "currency": "JMD",
  "change": 12.4,
  "change_pct": 1.01,
  "timestamp": "2023-10-27T10:35:01.123"
}

GET

Specific Option Data

Retrieve specific pricing or risk metrics (Greeks) for a single option contract.

Rate Limit: 30 requests per day per user. API Key is required.

Parameters

Name	Type	Description
api_key	string	Required. Your Developer API Key.
underlying	string	Symbol (e.g., 'USDJMD')
expiry	string	Expiration Date (YYYY-MM-DD)
strike	float	Strike Price
request_type	string	'price' or 'greeks' (Default: price)

Example Request (Pricing)

params = {
    "api_key": "YOUR_KEY",
    "underlying": "USDJMD",
    "expiry": "2025-01-17",
    "strike": 155.0,
    "request_type": "price"
}
response = requests.get(
    "https://api.celeraq.com/beta/options", 
    params=params
)

Example Response (Pricing)

{
  "underlying": "USDJMD",
  "expiry": "2025-01-17",
  "strike": 155.0,
  "call_midpoint": 2.80,
  "put_midpoint": 1.50,
  "implied_volatility": 0.154
}

Example Response (Greeks)

{
  "underlying": "USDJMD",
  "expiry": "2025-01-17",
  "strike": 155.0,
  "delta": {
    "call": 0.54,
    "put": -0.46
  },
  "gamma": 0.05,
  "theta": {
    "call": -0.02,
    "put": -0.01
  },
  "vega": 0.12
}