NOnordpoolgroup

Get Exclusive Group order

Changed on

Get exclusive group order details by its Id. Blocks within an exclusive group are always mutually exclusive alternatives, but they can additionally be linked to each other (a parent block plus one or more linked/child blocks, via the linkedTo field). This combination — exclusivity plus linkage — is referred to as a Linked Exclusive Group. Use this endpoint to retrieve such orders, including their linked block structure.

get/exclusivegrouporders/{orderId}

Request

  • Base URL
    https://auctions-api.test.nordpoolgroup.com/api/v1
  • URL
    https://auctions-api.test.nordpoolgroup.com/api/v1/exclusivegrouporders/{orderId}
  • Auth
    API key in header Authorization

Path parameters

orderIdstring required

Id of requested Block order.

Response

200

orderIdstring
areaCodestring
portfoliostring
companyNamestring
auctionIdstring
modifierstring
modifiedstring
currencyCodestring
commentunknown

Example response

{
  "orderId": "9593dac8-da00-4f2e-8f1a-f9ec10094870",
  "areaCode": "AT",
  "portfolio": "Portfolio AT",
  "companyName": "Test Company",
  "auctionId": "AAA-20190418",
  "modifier": "username",
  "modified": "2019-04-16T10:48:06.403Z",
  "currencyCode": "GBP",
  "blocks": [
    {
      "modifier": "username",
      "state": "Accepted",
      "name": "EG Block 1",
      "price": 11,
      "minimumAcceptanceRatio": 1,
      "exclusiveGroup": "Group 1",
      "periods": [
        {
          "contractId": "AAA-20190419-07",
          "volume": 9
        }
      ]
    }
  ]
}

Changes