Luxor PlatformAPI DocumentationDerivatives

Get derivatives orders

Returns a paginated list of the workspace's orders, filterable by status, side, book and contract. This is where a batch submitted through POST /v2/derivatives/orders shows up once its action completes.

GET
/v2/derivatives/orders

Authorization

LuxorAPIKey
authorization<token>

Use your API key here.

In: header

Query Parameters

status?string

Filter by order status

Default"ALL"

Value in

  • "ALL"
  • "OPEN"
  • "CANCELLED"
  • "EXPIRED"
side?string

Filter by order side

Default"ALL"

Value in

  • "ALL"
  • "BUY"
  • "SELL"
type?string

Filter by payment book

Default"ALL"

Value in

  • "ALL"
  • "STANDARD"
  • "UPFRONT"
duration?string

Filter by duration book

Default"ALL"

Value in

  • "ALL"
  • "MONTHLY"
  • "DAYS"
contract?string

Contract identifier: MMYY for a monthly book, one of D030, D060, D090, D120, D150, D180 for a days book

page_number?integer
Range1 <= value
Default1
page_size?integer
Range1 <= value
Default10

Response Body

application/json

application/json

curl -X GET "https://example.com/v2/derivatives/orders"
{  "orders": [    {      "order_number": 4821,      "contract": "1226",      "duration_days": 0,      "denomination": "BTC",      "side": "BUY",      "type": "STANDARD",      "duration": "MONTHLY",      "status": "OPEN",      "unit_hashprice": 0.0005,      "daily_hashrate_ph": 10,      "good_till_cancelled": true,      "created_at": "2026-09-10T15:20:11Z",      "updated_at": "2026-09-10T15:20:11Z"    }  ],  "pagination": {    "page_number": 1,    "page_size": 1,    "item_count": 0,    "previous_page_url": null,    "next_page_url": null  }}
{  "statusCode": 400,  "code": "FST_ERR_VALIDATION",  "error": "Bad Request",  "message": "body/end_date Required"}

Get order book

Returns the live order book for one of the four books: a payment type (`type`) crossed with a duration (`duration`), in the denomination given by `currency_type`. Each contract carries its price ladder, with the daily hashrate bid and offered at each level, plus the mid-market price and the current spot hashprice. `contracts` is optional and defaults to every contract the book is quoting today — the monthly set rolls with the calendar and the last day of a month has already dropped that month, so a client should let the API decide it rather than hardcoding MMYY codes. A contract must belong to the book it is requested under: MMYY for `MONTHLY`, a D-prefixed tenor (D030–D180) for `DAYS`.

Get derivatives payments

Returns a list of derivatives payments for a specific currency type with optional filtering by payment type.