Indication of Interest

List of statuses

Here is a list of possible statuses.

Status	Description
new	Indication of Interest was created
accepted	Offer was accepted by client
rejected	Offer was rejected by client
expired	Indication of Interest is expired and not available for being accepted or rejected anymore

Object structure

Property	Type	Description	Nullable
id	String	UUID	No
volume	Integer	Volume of the specified commodity	No
status	String	See list of statuses.	No
type	String	”buy” or “sell”	No
createdAt	String	Date and time. Atom format (Y-m-d\TH:i:sP )	No
expiresAt	String	Date and time, 3 minutes since Indication of Interest was created. Atom format (Y-m-d\TH:i:sP )	No
currencyCode	Integer	Currency code, for example, EUR or GBP	No
offers	Array	See Offer structure.	Yes

POST Create an Indication of Interest

POST /api/iois

This endpoint allows you to create an Indication of Interest resource.

Parameters

No parameters

Request header should contain Content-Type: application/json and Accept: application/json.

Request body

Property	Type	Description	Nullable
commodity	String	”EU_ETS” or “UK_ETS”	No
volume	Integer	Volume of the specified commodity	No
type	String	”buy” or “sell”	No

Example:

{
   "commodity": "EU_ETS",
   "volume": 100,
   "type": "buy"
}

Responses

See Indication of Interest structure. Status is “new”, offers are empty for this request.

Example:

{
   "id": "string",
   "volume": 100,
   "status": "new",
   "type": "buy",
   "createdAt": "2024-03-28T12:36:17+00:00",
   "expiresAt": null,
   "currencyCode": "EUR",
   "offers": []
}

GET Retrieve all Indications of Interest

GET /api/iois?page=<page>

This endpoint allows you to retrieve the list of all Indication of Interest resources.

Parameters

Property	Type	Description	Nullable
page	Integer	Number of page	No

Request header should contain Accept: application/json.

Responses

See Indication of Interest structure.

Example:

[
   {
       "id": "string",
       "volume": 100,
       "status": "accepted",
       "type": "buy",
       "createdAt": "2024-03-28T12:36:17+00:00",
       "expiresAt": "2024-03-28T12:51:17+00:00",
       "currencyCode": "EUR",
       "offers": [
           {
               "id": "string",
               "price": 100,
               "totalPrice": 10000,
               "currencyCode": "EUR",
               "createdAt": "2024-03-28T12:38:17+00:00",
               "answeredAt": "2024-03-28T12:39:17+00:00",
               "isAccepted": true,
               "iri": "/api/offers/1eef674e-3698-6450-82fb-5922191c8aa1"
           }
       ]
   }
]

GET Retrieve the Indication of Interest

GET /api/iois/<id>

This endpoint allows you to retrieve the Indication of Interest by id.

Parameters

Property	Type	Description	Nullable
id	String	UUID	No

Request header should contain Content-Type: application/json.

Responses

See Indication of Interest structure.

Example:

{
   "id": "string",
   "volume": 100,
   "status": "accepted",
   "type": "buy",
   "createdAt": "2024-03-28T12:36:17+00:00",
   "expiresAt": "2024-03-28T12:51:17+00:00",
   "currencyCode": "EUR",
   "offers": [
       {
           "id": "string",
           "price": 100,
           "totalPrice": 10000,
           "currencyCode": "EUR",
           "createdAt": "2024-03-28T12:38:17+00:00",
           "answeredAt": "2024-03-28T12:39:17+00:00",
           "isAccepted": true,
           "iri": "/api/offers/1eef674e-3698-6450-82fb-5922191c8aa1"
       }
   ]
}