Luxor Documentation Hub Logo
Energy/API Documentation/Contracts

List contracts

Retrieves a list of contracts for one or more sites with pagination support.

GET
/api/v1/energy/contracts

Authorization

AuthorizationRequiredBearer <token>

In: header

Query Parameters

site_idRequiredSite Id

Site IDs to filter contracts for

page_numberPage Number

Page number for pagination

Default: 1
page_sizePage Size

Number of items per page

Default: 100
curl -X GET "https://app.luxor.tech/api/v1/energy/contracts?site_id=497f6eca-6276-4993-bfeb-53cbbbba6f08&page_number=1&page_size=100" \
  -H "Authorization: Bearer <token>"

Successful Response

{
  "contracts": [
    {
      "site_id": "72771e6a-6f5e-4de4-a5b9-1266c4197811",
      "origin_iso_name": "string",
      "origin_settlement_point_name": "string",
      "type": "PPA",
      "subtype": "FIXED",
      "quantity_kw": "string",
      "price": "string",
      "strike_quantity_kw": "string",
      "strike_price": "string",
      "start_time": "2019-08-24T14:15:22Z",
      "end_time": "2019-08-24T14:15:22Z",
      "eligible_hours": [
        0
      ],
      "counterparty": "string",
      "comments": "string",
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z"
    }
  ],
  "pagination": {
    "page_number": 0,
    "page_size": 0,
    "item_count": 0,
    "previous_page_url": "string",
    "next_page_url": "string"
  }
}

Previous

Delete contract

Next

Update contract