Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
Retrieve a specific auction by ID
curl -X GET "https://api.trusset.org/orderbooks/stocks/api/order-books/ob_abc123/auctions/auc_001" \
-H "x-api-key: trusset_{instanceRef}_{secret}"
{
"success": true,
"data": {
"auctionId": "auc_001",
"orderBookId": "ob_abc123",
"status": "SETTLED",
"startTime": "2025-01-15T10:30:00.000Z",
"endTime": "2025-01-15T10:35:00.000Z",
"clearingPrice": "100000000000000000000",
"matchedVolume": "12000000000000000000",
"tradeCount": 7,
"settledAt": "2025-01-15T10:35:02.000Z"
},
"metadata": {
"requestId": "550e8400-e29b-41d4-a716-446655440000",
"timestamp": "2025-01-15T10:36:00.000Z",
"instanceId": "inst_abc"
}
}
trading service enabled.
curl -X GET "https://api.trusset.org/orderbooks/stocks/api/order-books/ob_abc123/auctions/auc_001" \
-H "x-api-key: trusset_{instanceRef}_{secret}"
{
"success": true,
"data": {
"auctionId": "auc_001",
"orderBookId": "ob_abc123",
"status": "SETTLED",
"startTime": "2025-01-15T10:30:00.000Z",
"endTime": "2025-01-15T10:35:00.000Z",
"clearingPrice": "100000000000000000000",
"matchedVolume": "12000000000000000000",
"tradeCount": 7,
"settledAt": "2025-01-15T10:35:02.000Z"
},
"metadata": {
"requestId": "550e8400-e29b-41d4-a716-446655440000",
"timestamp": "2025-01-15T10:36:00.000Z",
"instanceId": "inst_abc"
}
}
| Code | Status | Description |
|---|---|---|
ORDER_BOOK_NOT_FOUND | 404 | No order book found with this ID in your instance |
NOT_FOUND | 404 | No auction found with this ID for this order book |
curl -X GET "https://api.trusset.org/orderbooks/stocks/api/order-books/ob_abc123/auctions/auc_001" \
-H "x-api-key: trusset_{instanceRef}_{secret}"
{
"success": true,
"data": {
"auctionId": "auc_001",
"orderBookId": "ob_abc123",
"status": "SETTLED",
"startTime": "2025-01-15T10:30:00.000Z",
"endTime": "2025-01-15T10:35:00.000Z",
"clearingPrice": "100000000000000000000",
"matchedVolume": "12000000000000000000",
"tradeCount": 7,
"settledAt": "2025-01-15T10:35:02.000Z"
},
"metadata": {
"requestId": "550e8400-e29b-41d4-a716-446655440000",
"timestamp": "2025-01-15T10:36:00.000Z",
"instanceId": "inst_abc"
}
}