Skip to content

XBID Orders v1

The XBID Orders v1 will be used for managing orders for XBID. This API will also function in case of a disconnection of XBID.

Be aware: In case the XBID connection gets lost. The new orders which are created with the XBID order API will be automatically forwarded to the local intraday orderbook. You can use the XBID Status API for the current connection of XBID.

Operations

Get Order

Request

This API will get you a specific order from the Orderbook. You must use the ETPA order id and not the XBID order id.

Security
api-key
Path
idstringrequired
GET
/public-api/1.0/xbid/electricity/orders/{id}
curl -i -X GET \
  'https://acc-trading.etpa.nl/public-api/1.0/xbid/electricity/orders/{id}' \
  -H 'api_key: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json
xbidOrderIdinteger, (int64)
idstring
orderTypestringrequired
Enum:"BUY""SELL"
xbidOrderTypestring
Enum:"REGULAR""ICEBERG"
participantIdstring
individualIdstring
individualFullNamestring
capacitynumberrequired
originalCapacitynumberrequired
createdinteger, (int64)
Example:1517406300000
priorityinteger, (int64)
Example:1517406300000
deliveryStartTimeinteger, (int64)required
Example:1517406300000
deliveryEndTimeinteger, (int64)required
Example:1517406300000
unitPricenumberrequired
customExpirationTimeinteger, (int64)
Example:1517406300000
metadataobject
totalPricenumberrequired
orderDeliveryAreaobject(DeliveryAreaDto)
originatingDeliveryAreastring
Enum:"AT""BG""BE""CZ""DE1""DE2""DE3""DE4""DK1""DK2"
orderExecutionstring
Enum:"NON""FOK""IOC"
orderStatusstring
Enum:"ACTIVE""HIBERNATE""WITHDRAWN"
localMarketbooleanrequired
revisionNointeger, (int64)
allowedForLocalMarketbooleanrequired
icebergDetailsobject(IcebergDetails)
Response
{
  "xbidOrderId": 0,
  "id": "string",
  "orderType": "BUY",
  "xbidOrderType": "REGULAR",
  "participantId": "string",
  "individualId": "string",
  "individualFullName": "string",
  "capacity": 0,
  "originalCapacity": 0,
  "created": 1517406300000,
  "priority": 1517406300000,
  "deliveryStartTime": 1517406300000,
  "deliveryEndTime": 1517406300000,
  "unitPrice": 0,
  "customExpirationTime": 1517406300000,
  "metadata": {
    "property1": "string",
    "property2": "string"
  },
  "totalPrice": 0,
  "orderDeliveryArea": {
    "country": "DE",
    "eic": "10YDE-VE-------2",
    "name": "DE - 50HzT"
  },
  "originatingDeliveryArea": "AT",
  "orderExecution": "NON",
  "orderStatus": "ACTIVE",
  "localMarket": true,
  "revisionNo": 0,
  "allowedForLocalMarket": true,
  "icebergDetails": {
    "showCapacity": 0,
    "pricePerDelta": 0,
    "hiddenCapacity": 0,
    "originalUnitPrice": 0
  }
}