Submit Block order

Changed on

Submit Block order(s) to a specific auction, portfolio and area.

post/blockorders

Request

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

Request body

auctionIdstring required

Id of auction subjected to order submission

portfoliostring required

Portfolio name

areaCodeobject required

Area id, code or EIC code.

commentstring

Free text to label an order, max 255 characters.

Response

201

orderIdstring
areaCodestring
portfoliostring
companyNamestring
auctionIdstring
modifierstring
modifiedstring
currencyCodestring
commentstring

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": "EUR",
  "comment": "My block order 😎",
  "blocks": [
    {
      "modifier": "username",
      "state": "Accepted",
      "name": "EG Block 1",
      "price": 11,
      "minimumAcceptanceRatio": 1,
      "exclusiveGroup": "Group 1",
      "periods": [
        {
          "contractId": "AAA-20190419-07",
          "volume": 9
        }
      ]
    }
  ]
}

Changes