Skip to content

List trades

Request

Returns a Spring Page JSON with trade records under the 'content' field.

How to use: at least one filter must be supplied. Provide a date window (dateFrom/dateTo in epoch-millis) and/or an orderId. Choose which timestamp the window applies to with dateFilter: TRANSACTION_DATE (the default, when the trade was executed) or DELIVERY_DATE (the start of the delivery period). dateFilter also selects the field the results are ordered by, so changing it changes the paging order. When orderId is supplied, the trades belonging to that order are returned; if a date window is also supplied the result is additionally constrained to that window. Filter additionally with productFilter and optional participantId. Paginate with page/size. Requests exceeding the configured maximum date range are rejected.

Path
productstringrequired

Product scope. "XBID" covers XBID and Intraday; "EXPOST", "GOPACS" and "INTRADAY" each cover only themselves; ALL covers every product.

Enum:"XBID""REGULAR""EXPOST""GOPACS""INTRADAY""ALL"
Query
participantIdstring

Restricts the result to a single participant.

dateFilterstring

Selects which timestamp the dateFrom/dateTo window applies to, and which field the results are ordered by. TRANSACTION_DATE is when the trade was executed and DELIVERY_DATE the start of its delivery period. Note: this is only available in ACC at the moment; it is not yet in production.

Default:"TRANSACTION_DATE"
Enum:"TRANSACTION_DATE""DELIVERY_DATE"
dateFrominteger, (int64)

Start of the window, inclusive, as epoch milliseconds. Applies to the field named by dateFilter. May not be more than two years before the start of the current day.

dateTointeger, (int64)

End of the window, inclusive, as epoch milliseconds. Applies to the field named by dateFilter. The window may not exceed the maximum range configured for the service. Certain values (I.e. ORDER_CREATION_DATE/TRANSACTION_DATE) may not be in the future

orderIdstring

The identifier of an order. Returns all the trades which resulted from the supplied order. Supply either this or the dateFrom/dateTo window; supplying both additionally constrains the order's trades to that window.

sortDirectionstring

Direction the results are ordered in. The field ordered on is the one named by dateFilter.

Default:"DESC"
Enum:"ASC""DESC"
pageinteger, >= 0

Zero-based page index (0..N)

Default:0
sizeinteger, >= 1

The size of the page to be returned

Default:20
sortArray of strings

Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

GET
/public-api/4.0/electricity/reporting/{product}/trades
curl -i -X GET \
  'https://acc-trading.etpa.nl/public-api/4.0/electricity/reporting/{product}/trades?participantId=string&dateFilter=TRANSACTION_DATE&dateFrom=0&dateTo=0&orderId=string&sortDirection=ASC&page=0&size=20&sort=string'

Responses

Success. Paginated list of trades. Each element of 'content' is either an Intraday/Ex-post trade (RegularTradeDto), a Gopacs trade (GopacsTradeDto) or an XBID trade (XbidTradeDto).

Bodyapplication/json
contentArray of any
pageableobject(PageableInfo)

Pagination request metadata that produced this page.

sortobject(SortInfo)

Sorting information for the page.

totalElementsinteger, (int64)

Total number of trades across all pages.

totalPagesinteger, (int32)

Total number of pages available.

sizeinteger, (int32)

Page size.

numberinteger, (int32)

Zero-based index of this page.

numberOfElementsinteger, (int32)

Number of elements on this page.

firstboolean

Whether this is the first page.

lastboolean

Whether this is the last page.

emptyboolean

Whether this page has no elements.

Response
{
  "content": [
    { … }
  ],
  "pageable": {
    "pageNumber": 0,
    "pageSize": 0,
    "offset": 0,
    "sort": { … },
    "paged": true,
    "unpaged": true
  },
  "sort": {
    "empty": true,
    "sorted": true,
    "unsorted": true
  },
  "totalElements": 0,
  "totalPages": 0,
  "size": 0,
  "number": 0,
  "numberOfElements": 0,
  "first": true,
  "last": true,
  "empty": true
}