Sign in
bids

Get bids with filtering

Retrieve bids with optional filtering by slot, status, entity, with pagination

get/api/v1/bids

Query parameters

slotnumber
Example:1234567

Filter by slot number

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

Filter by bid status

entityIdstring
Example:entity-123

Filter by entity ID

limitnumber
Example:20

Number of results to return

offsetnumber

Number of results to skip

Response

List of bids

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