> ## Documentation Index
> Fetch the complete documentation index at: https://docs.trlyr.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get an auction by ID

> Returns a single auction your organisation participates in, including the auctioned virtual-asset parameters, your latest bid, and a status (`NOT_STARTED`, `RUNNING`, `WON`, `LOST`, `PENDING`, or `NO_BIDS_SUBMITTED`). If you won, the item includes the allocated virtual asset ID.



## OpenAPI

````yaml https://api.trlyr.com/auctions/docs/doc.json get /auctions/{auctionID}
openapi: 3.1.0
info:
  description: >
    This API lets participating organisations browse energy auctions, submit
    bids, and track outcomes on the terralayr platform. 
     
    Each auction offers a virtual-asset delivery window (power, energy, and
    efficiency parameters) for a specific period. During the auction open
    interval, invited organisations can place bids priced in EUR. After the
    auction closes, the highest valid bid wins; if prices tie, the earliest bid
    wins. 
     
    Auction responses include a status for your organisation, such as
    `NOT_STARTED`, `RUNNING`, `WON`, `LOST`, `PENDING`, or `NO_BIDS_SUBMITTED`.
    When you win, the response includes the allocated virtual asset ID. 
     
    ### Authorization 
     
    All requests require a Bearer-type `Authorization` header in the form:
    `Authorization: Bearer <YOUR_TOKEN>`. 
     
    To retrieve a valid token, authenticate with username and password: 
     
    ``` 

    POST https://api.trlyr.com/auth/public/authenticate 

    ``` 
     
    with the following JSON body: 
     
    ``` 

    { 
        "username": "YOUR_USERNAME", 
        "password": "YOUR_PASSWORD" 
    } 

    ``` 
     
    Your username and password are the ones you created after receiving an
    invitation to join your organisation. 
     
    You should receive a JSON response body from which you can extract your
    token under `access_token`. 
     
    If you have any questions, don't hesitate to contact our account manager at
    the following address: support@trlyr.com. 
  title: terralayr Auctioneer API
  version: 1.0.0
servers:
  - description: Production API
    url: https://api.trlyr.com
  - description: Sandbox API
    url: https://api.sandbox.trlyr.com
security: []
tags:
  - description: >-
      Browse auctions your organisation participates in and inspect auction
      status.
    name: auctions
  - description: Submit and review bids on open auctions.
    name: bids
externalDocs:
  description: ''
  url: ''
paths:
  /auctions/{auctionID}:
    get:
      tags:
        - auctions
      summary: Get an auction by ID
      description: >-
        Returns a single auction your organisation participates in, including
        the auctioned virtual-asset parameters, your latest bid, and a status
        (`NOT_STARTED`, `RUNNING`, `WON`, `LOST`, `PENDING`, or
        `NO_BIDS_SUBMITTED`). If you won, the item includes the allocated
        virtual asset ID.
      parameters:
        - description: Access token
          in: header
          name: Authorization
          required: true
          schema:
            default: Bearer <access token value>
            type: string
        - description: Auction ID
          in: path
          name: auctionID
          required: true
          schema:
            format: uuid
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/pkg_models_http_public_v0_responses.AuctionResponseBody
          description: OK
        '404':
          description: Not Found
        '500':
          description: Internal Server Error
components:
  schemas:
    pkg_models_http_public_v0_responses.AuctionResponseBody:
      properties:
        currentBid:
          $ref: >-
            #/components/schemas/pkg_models_http_public_v0_responses.CurrentBidResponseBody
        end:
          type: string
        id:
          format: uuid
          type: string
        item:
          $ref: >-
            #/components/schemas/pkg_models_http_public_v0_responses.ItemResponseBody
        start:
          type: string
        status:
          type: string
      type: object
    pkg_models_http_public_v0_responses.CurrentBidResponseBody:
      properties:
        price:
          type: string
        timestamp:
          type: string
      type: object
    pkg_models_http_public_v0_responses.ItemResponseBody:
      properties:
        chargeEfficiency:
          $ref: '#/components/schemas/style.Precision3Float'
        dailyCycleLimit:
          $ref: '#/components/schemas/style.Precision3Float'
        deliveryZone:
          example: 50Hertz
          type: string
        dischargeEfficiency:
          $ref: '#/components/schemas/style.Precision3Float'
        end:
          example: '2023-11-12T00:00:00Z'
          format: dateTime
          type: string
        energyCapacity:
          $ref: '#/components/schemas/style.Precision1Float'
        finalSoCTolerance:
          $ref: '#/components/schemas/style.Precision3Float'
        id:
          format: uuid
          type: string
        initialSoC:
          $ref: '#/components/schemas/style.Precision3Float'
        lastSoCTarget:
          $ref: '#/components/schemas/style.Precision3Float'
        ratedChargePower:
          $ref: '#/components/schemas/style.Precision1Float'
        ratedDischargePower:
          $ref: '#/components/schemas/style.Precision1Float'
        start:
          example: '2023-11-11T00:00:00Z'
          format: dateTime
          type: string
        unitsEnergy:
          example: kWh
          type: string
        unitsPower:
          example: kW
          type: string
      type: object
    style.Precision3Float:
      format: float
      type: object
    style.Precision1Float:
      format: float
      type: object

````