Price Reference
Get Price Reference History
Read the audit log of reference prices applied to a book
GET
/
orderbooks
/
external-securities
/
api
/
order-books
/
{orderBookId}
/
price-reference
/
history
curl "https://api.trusset.org/orderbooks/external-securities/api/order-books/clx_ob_extsec_001/price-reference/history?limit=20" \
-H "X-API-Key: trusset_your_key_here"
const res = await fetch(
`https://api.trusset.org/orderbooks/external-securities/api/order-books/${orderBookId}/price-reference/history?limit=20`,
{ headers: { 'X-API-Key': 'trusset_your_key_here' } }
);
const { data } = await res.json();
{
"success": true,
"data": {
"logs": [
{
"id": "clx_prlog_1204",
"orderBookId": "clx_ob_extsec_001",
"instanceId": "inst_abc123",
"price": "104.2",
"source": "MANUAL",
"enforcementUsed": "1HOUR",
"createdAt": "2025-06-15T11:00:00.000Z"
}
],
"total": 1,
"limit": 20,
"offset": 0
}
}
Returns every reference price recorded against a book, newest first. One entry is written each time the reference changes, whether it was pushed manually or fetched from a feed, which makes this the audit trail behind any
PRICE_OUTSIDE_BAND refusal or band sweep.
Circuit breaker events appear here too, as an entry whose source is CIRCUIT_BREAKER_TRIGGERED and whose enforcementUsed names the size of the move that tripped it.
Only logs written under your own instance are visible, so an imported book returns its record but no history.
Path Parameters
string
required
Order book ID.
Query Parameters
integer
default:"50"
Page size, capped at 100.
integer
default:"0"
Rows to skip.
Response Fields
object
Show child attributes
Show child attributes
array
Show child attributes
Show child attributes
string
Log entry ID.
string
Book the entry belongs to.
string
Instance that recorded it.
string
Reference price as a plain decimal.
string
MANUAL, EXTERNAL_FEED, EXTERNAL_FEED_CACHED, STOCK_FEED:<symbol>, STOCK_FEED_CACHED, or CIRCUIT_BREAKER_TRIGGERED.string
The enforcement interval in force. On a circuit breaker entry this carries the move instead, as
<n>bps_move.string
ISO 8601 timestamp.
integer
Total entries for this book.
integer
Page size applied.
integer
Offset applied.
curl "https://api.trusset.org/orderbooks/external-securities/api/order-books/clx_ob_extsec_001/price-reference/history?limit=20" \
-H "X-API-Key: trusset_your_key_here"
const res = await fetch(
`https://api.trusset.org/orderbooks/external-securities/api/order-books/${orderBookId}/price-reference/history?limit=20`,
{ headers: { 'X-API-Key': 'trusset_your_key_here' } }
);
const { data } = await res.json();
{
"success": true,
"data": {
"logs": [
{
"id": "clx_prlog_1204",
"orderBookId": "clx_ob_extsec_001",
"instanceId": "inst_abc123",
"price": "104.2",
"source": "MANUAL",
"enforcementUsed": "1HOUR",
"createdAt": "2025-06-15T11:00:00.000Z"
}
],
"total": 1,
"limit": 20,
"offset": 0
}
}
Error Codes
| Code | HTTP | Cause |
|---|---|---|
INVALID_PARAM | 400 | orderBookId is missing or longer than 100 characters |
ORDER_BOOK_NOT_FOUND | 404 | No such external securities book on this instance, and not imported |
SERVICE_NOT_ENABLED | 403 | The Trading service is not enabled on this instance |
⌘I
curl "https://api.trusset.org/orderbooks/external-securities/api/order-books/clx_ob_extsec_001/price-reference/history?limit=20" \
-H "X-API-Key: trusset_your_key_here"
const res = await fetch(
`https://api.trusset.org/orderbooks/external-securities/api/order-books/${orderBookId}/price-reference/history?limit=20`,
{ headers: { 'X-API-Key': 'trusset_your_key_here' } }
);
const { data } = await res.json();
{
"success": true,
"data": {
"logs": [
{
"id": "clx_prlog_1204",
"orderBookId": "clx_ob_extsec_001",
"instanceId": "inst_abc123",
"price": "104.2",
"source": "MANUAL",
"enforcementUsed": "1HOUR",
"createdAt": "2025-06-15T11:00:00.000Z"
}
],
"total": 1,
"limit": 20,
"offset": 0
}
}