Skip to content

Get On Hold Orders

Request

Get a list of on hold orders.

Security
api-key
Query
participantIdstring

Filter on participantId. This is only useful for brokers.

GET
/public-api/1.0/electricity/on-hold-orders
curl -i -X GET \
  'https://acc-trading.etpa.nl/public-api/1.0/electricity/on-hold-orders?participantId=string' \
  -H 'api_key: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json
Array [
idobject(OnHoldOrderId)required
orderTypestringrequired
Enum:"BUY""SELL""DIRECT"
participantIdstringrequired
individualIdstringrequired
productTypestringrequired
Enum:"ELECTRICITY""GAS"
typestringrequired
quantitynumberrequired
originalQuantitynumberrequired
createdinteger, (int64)required
Example:1517406300000
priorityinteger, (int64)required
Example:1517406300000
startinteger, (int64)required
Example:1517406300000
endinteger, (int64)required
Example:1517406300000
timeblockstringrequired
Enum:"BASELOAD""PEAK""OFFPEAK""INTRADAY""EXPOST""GOPACS"
pricenumberrequired
eanstring
customExpirationTimeinteger, (int64)
Example:1517406300000
metadataobject
allowedToBeUsedForIdconsboolean
durationnumber
totalPricenumberrequired
]
Response
[
  {
    "id": { … },
    "orderType": "BUY",
    "participantId": "string",
    "individualId": "string",
    "productType": "ELECTRICITY",
    "type": "string",
    "quantity": 0,
    "originalQuantity": 0,
    "created": 1517406300000,
    "priority": 1517406300000,
    "start": 1517406300000,
    "end": 1517406300000,
    "timeblock": "BASELOAD",
    "price": 0,
    "ean": "string",
    "customExpirationTime": 1517406300000,
    "metadata": { … },
    "allowedToBeUsedForIdcons": true,
    "duration": 0,
    "totalPrice": 0
  }
]