Index

  1. Submit Preconf Request
  2. Cancel Preconf Request
  3. Submit Preconf Transaction
  4. Get Preconf Request
  5. Get Available Slots

Submit Preconf Request

/commitments/v1/preconf_request

Endpoint for submitting a preconfirmation request.

PropertyValueDescription
MethodPOSTThe HTTP method used for this endpoint
ResponsePreconfResponseThe type of response returned by the endpoint
HeadersContent-Type: application/jsonThe required headers for the request
BodyPreconfRequestThe type of data expected in the request body

Cancel Preconf Request

/commitments/v1/preconf_request

Endpoint for cancelling a preconfirmation request.

PropertyValueDescription
MethodDELETEThe HTTP method used for this endpoint
ResponseCancelPreconfResponseThe type of response returned by the endpoint
HeadersContent-Type: application/jsonThe required headers for the request
BodyCancelPreconfRequestThe type of data expected in the request body

Submit Preconf Transaction

/commitments/v1/preconf_request/tx

Endpoint for submitting a preconfirmation transaction.

PropertyValueDescription
MethodPOSTThe HTTP method used for this endpoint
Response--
HeadersContent-Type: application/jsonThe required headers for the request
BodyPreconfTxRequestThe type of data expected in the request body

Get Preconf Request Status

/commitments/v1/preconf_request/:preconf_hash

Endpoint for checking the status of a preconfirmation request.

PropertyValueDescription
MethodGETThe HTTP method used for this endpoint
ResponsePreconfStatusResponseThe type of response returned by the endpoint
HeadersContent-Type: application/jsonThe required headers for the request
Path Parameterspreconf_hash: PreconfHashThe hash of the preconfirmation request

Get Available Slots

/commitments/v1/slots

Endpoint for retrieving available slots for preconfirmation.

PropertyValueDescription
MethodGETThe HTTP method used for this endpoint
ResponseAvailableSlotResponseThe type of response returned by the endpoint
HeadersContent-Type: application/jsonThe required headers for the request