Skip to content

Create Order

Request

Creates new GOPACS order.

Security
api-key
Bodyapplication/jsonrequired
orderTypestringrequired

The Order type is required field.

Enum:"BUY""SELL"
Example:"BUY / SELL"
participantIdstringrequired
Example:"292c3db8-3ee1-4999-bbed-d579225d1596"
quantitynumberrequired

The quantity can not be negative and 0. Also the decimal limit of the quantity is 1. The capacity is required field.

Example:2
startinteger, (int64)required

The start time is an epoch time. It is the time in milliseconds since the start of the unix time. The start time is required field.

Example:1465596000000
endinteger, (int64)required

The end time is an epoch time. It is the time in milliseconds since the start of the unix time. The end time time is required field

Example:1465682400000
pricenumberrequired

The price is required field.

Example:35
eanstringrequired

The ean is required field.

Example:871685920001768800
metaDataobject
Example:
{
  "key1": "value1",
  "key2": "value2"
}
customExpirationTimeinteger, (int64)

Custom expiration time of an order. If no value is provided then the order will expire 15 minutes before the start time. The time must be a time in the future and must not be later than 15 minutes before the start time. The time provided must be a multiple of 15 minutes. For example 03:00, 03:15, 03:30 and 03:45.

Example:1465682400000
marketBasedbooleanrequired

The markedBased field is mandatory

facilityTypestring

The facilityType field is required when marketBased is set to false.

Example:"B01"
contractIdstring

The contractId field is not mandatory

usageFractionnumber, [ 0 .. 1 ]

The usageFraction field is not mandatory

Example:0.28
POST
/public-api/2.0/electricity/orders/gopacs
curl -i -X POST \
  https://acc-trading.etpa.nl/public-api/2.0/electricity/orders/gopacs \
  -H 'Content-Type: application/json' \
  -H 'api_key: YOUR_API_KEY_HERE' \
  -d '{
    "orderType": "BUY / SELL",
    "participantId": "292c3db8-3ee1-4999-bbed-d579225d1596",
    "quantity": 2,
    "start": 1465596000000,
    "end": 1465682400000,
    "price": 35,
    "ean": 871685920001768800,
    "metaData": {
      "key1": "value1",
      "key2": "value2"
    },
    "customExpirationTime": 1465682400000,
    "marketBased": true,
    "facilityType": "B01",
    "contractId": "string",
    "usageFraction": 0.28
  }'

Responses

OK

Bodyapplication/json
hrefstring
hreflangstring
titlestring
typestring
deprecationstring
profilestring
namestring
templatedboolean
Response
{
  "href": "string",
  "hreflang": "string",
  "title": "string",
  "type": "string",
  "deprecation": "string",
  "profile": "string",
  "name": "string",
  "templated": true
}