Sign in
bids

Update bid

  Update a bid's value, quantity, or gas parameters. 
  Only the bid owner can update their bids.
  Bids can only be updated in PENDING or VALIDATED status.
put/api/v1/bids/{id}

Path parameters

idstring required

Bid CUID

Request body

valuestring

Updated bid value in wei

quantitynumber

Updated quantity

gasFeeCapstring

Updated gas fee cap in wei

gasTipCapstring

Updated gas tip cap in wei

Example request

{
  "value": "1500000000000000000",
  "quantity": 150,
  "gasFeeCap": "25000000000",
  "gasTipCap": "2500000000"
}

Response

Bid updated successfully

idstring required

Unique bid identifier

slotnumber required

Slot number

entityIdstring required

Entity identifier

valuestring required

Bid value in wei

quantitynumber required

Quantity of units

gasFeeCapstring required

Gas fee cap in wei

gasTipCapstring required

Gas tip cap in wei

builderPublicKeystring required

Builder public key

status'pending' | 'submitted' | 'validated' | 'updated' | 'winning' | 'partial' | 'lost' | 'cancelled' | 'expired' required

Current bid status

submittedAtstring date-time required

Bid submission timestamp

updatedAtstring date-time required

Last update timestamp

validatedAtstring date-time

Validation timestamp

validFromstring date-time required

Bid valid from timestamp

validUntilstring date-time required

Bid valid until timestamp

versionnumber required

Bid version number

noncestring required

Unique nonce for replay protection

metadataobject

Additional bid metadata

isActiveboolean required

Whether bid is currently active

isModifiableboolean required

Whether bid can be modified

hasExpiredboolean required

Whether bid has expired

Example response

{
  "id": "tz4a98xxat96iws9zmbrgj3a",
  "slot": 1234567,
  "entityId": "entity-123",
  "value": "1000000000000000000",
  "quantity": 100,
  "gasFeeCap": "20000000000",
  "gasTipCap": "2000000000",
  "builderPublicKey": "0x1234567890abcdef...",
  "status": "pending",
  "submittedAt": "2024-01-01T00:00:00.000Z",
  "updatedAt": "2024-01-01T00:00:00.000Z",
  "validatedAt": "2024-01-01T00:00:05.000Z",
  "validFrom": "2024-01-01T00:00:00.000Z",
  "validUntil": "2024-01-01T00:00:12.000Z",
  "version": 1,
  "nonce": "1234567890",
  "metadata": {
    "priority": "high",
    "source": "api"
  },
  "isActive": true,
  "isModifiable": true
}

Changes