Place, modify or cancel a bid

Time	Status	User Agent
Make a request to see history.

URL Expired

The URL for this request expired after 30 days.

🚧

CAISO Only & Generally Leap Managed

Submitting bids is only applicable for the CAISO wholesale marketplace. Most partners leverage Leap to manage bids on their behalf based on their dispatch preferences (frequency & timing). However, these bid endpoints are available for partners that would like to manage their own bids.

accountId

uuid
- required
  - The UUID of your account
The bid to be submitted for this account
The request object for submitting bids.

currency

string
- enum
- required
  - The currency to use for the trade
Allowed:
- USD

bids

array of objects
- required
- length ≥ 1
- The list of bids to submit into the market.

bids*

object
- The object describing a bid

meter_id

uuid
- required
- The unique identifier of a meter

market_type

string
- enum
- This can have the value "day-head" or "hour-ahead". It is used to decide the appropriate market to bid in.
- Allowed:
- day-ahead
- hour-ahead

timeslots

array of objects
- required
- length ≥ 1
- A collection of all timeslots of a bid.

timeslots*

object
- The timeslot of a bid. The timeslot describes the bid for a specific hour of the day. The start and end time must be given in periods of a full hour.

start_time

date-time
- required
- The start time of the bid

end_time

date-time
- required
- The end time of the bid

curve

array of objects
- required
- A list of quantity/price pairs

curve*

object
ADD object
ADD object
ADD object

`` 202 The bid was submitted successfully

validations

array of objects
- required
- The validation messages returned by the API. The following API validation rules are currently specified:
- 404 - A bid contains timeslot(s) for a closed market.
- 406 - A bid contains timeslot(s) which do not start at a full hour.
- 407 - A bid contains timeslot(s) which do not have a range of one hour.
- 408 - A bid contains meter(s) which are not assigned to this account.
- 409 - A bid contains meter(s) which are not assigned to a resource.
- 410 - A bid curve does not meet the minimum quantity.
- 411 - A bid curve price that is not within the range of $ 0.01/kWh to $ 1.00/kWh.
- 412 - A bid curve is not increasing in power or price.
- 414 - The maximum number of meters in a single bid request has been exceeded. The limit is set to 100 per request.

validations*

object
- A rule for validating an API request.

code

integer
- A unique code to identify the validation rule. Please send this when reporting issues with the API.

type

string
- enum
- The type of validation message. At the moment only "REJECTION" is supported.
- Allowed:
  - REJECTION

message

string
- A message describing the validation rule

currency

string
- enum
- required
- The currency to use for the trade
- Allowed:
- USD

results

array of objects
- required
- The list of bids that were submitted. Check the status of the bids and the validations to see if the bid submission was successful.

results*

object
A bid containing information about the status of the bid.

meter_id

uuid
- required
- The unique identifier of a meter

timeslots

array of objects
- required
- A list of all timeslots for this bid

timeslots*

object
- A timeslot of bid containing information about the status.

start_time

date-time
- required
- The start time of the bid

end_time

date-time
- required
- The end time of the bid

curve

array of objects
- required
- A list of quantity/price pairs

curve*

object
- A quantity/price pair on the bid curve

quantity_in_kw

double
- required
- 0 to 1000000

price

double
- required
- 0 to 1000

version

integer
- required
- The version of the bid. Bid versioning is deprecated. The version will always be "1".

bid_status

string
- enum
- required
- The status of the bid submission
- Allowed:
  - Received - Bid has been received by Leap, but still has to be validated
  - Accepted - Bid has been accepted for processing by the market
  - Rejected - Bid has not been accepted by the market
  - Error - An unforeseen case occurred, theoretically bids will never enter this state

market_status

string
- enum
- The status of the internal market
- Allowed:
  - Open - Market is open and accepting new bids, Accepted and Rejected bids can still be updated
  - Processing - Market is closed and processing bids
  - Cleared - Market is closed and finished processing, potential dispatches are available
  - Unknown - The market state is currently unknown

`` 400 The request could not be parsed or is invalid

`` 401 Unauthorized

`` 403 No access to this resource

`` 5XX Unexpected error

Shell Node Ruby PHP Python

Base URL
https://api.staging.leap.energy/v1.1/account/{accountId}/bidding/bid

xxxxxxxxxx

curl --request POST \

--url https://api.staging.leap.energy/v1.1/account//bidding/bid \

--header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '

{
  "currency": "USD",
  "bids": [
    {
      "timeslots": []
    }
  ]
}
'

xxxxxxxxxx

{
  "currency": "USD",
  "results": [
    {
      "meter_id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "timeslots": [
        {
          "start_time": "2023-01-28T16:00:00Z",
          "end_time": "2023-01-28T17:00:00Z",
          "bid_status": "Accepted",
          "market_type": "day-ahead",
          "market_status": "Open",
          "version": 1,
          "curve": [
            {
              "quantity_in_kw": 60,
              "price": 0.25
            },
            {
              "quantity_in_kw": 80,
              "price": 0.28
            }
          ]
        },
        {
          "start_time": "2023-01-28T17:00:00Z",
          "end_time": "2023-01-28T18:00:00Z",
          "bid_status": "Accepted",
          "market_status": "Open",
          "version": 1,
          "market_type": "day-ahead",
          "curve": [
            {
              "quantity_in_kw": 60,
              "price": 0.25
            },
            {
              "quantity_in_kw": 80,
              "price": 0.28
            }
          ]
        }
      ]
    }
  ]
}