Auctions

List public Auctions

Changed on
get/api/v1/auctions

Request

  • Base URL: https://api.stage.aura-historia.com
  • URL: https://api.stage.aura-historia.com/api/v1/auctions
  • Auth: none declared

Query parameters

listingSourceIdstring
format'LIVE' | 'TIMED'
reportedStatus'SCHEDULED' | 'IN_PROGRESS' | 'ENDED' | 'POSTPONED' | 'CANCELLED'
timeRole'BIDDING_OPENS' | 'LIVE_STARTS' | 'LOTS_BEGIN_CLOSING' | 'SCHEDULED_END'
fromstring date-time
tostring date-time
sort'created' | 'scheduled'

created sorts by creation time; scheduled requires timeRole and sorts on that role's instant, with missing instants last when no window is specified.

order'asc' | 'desc'

Defaults to desc for created and asc for scheduled.

pageSizeinteger
searchAfterstring

Complete returned JSON cursor. Its scope must match the source, format, reported-status, exact-time filters, sort and order of this request.

Response

Bounded Auction directory, newest-created-first by default. Scheduled order uses the chosen role instant, with Auction ID as the final tie-breaker. Anonymous successful 200 responses without Authorization use public, max-age=0, s-maxage=60, stale-if-error=0; requests with any Authorization header and all non-200 responses use private, no-store.

pageSizeinteger required

Example response

{
  "items": [
    {
      "name": {
        "language": "de"
      }
    }
  ]
}

Changes

    • info

      added the new optional query request parameter order

    • info

      added the new optional query request parameter sort

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      endpoint added