curl --request GET \
--url https://api.example.com/v1/bidder/get_bid_info{
"blockBidInfo": [
{
"blockNumber": "<string>",
"bids": [
{
"txnHashes": [
"<string>"
],
"revertableTxnHashes": [
"<string>"
],
"blockNumber": "<string>",
"bidAmount": "<string>",
"decayStartTimestamp": "<string>",
"decayEndTimestamp": "<string>",
"bidDigest": "<string>",
"slashAmount": "<string>",
"commitments": [
{
"providerAddress": "<string>",
"dispatchTimestamp": "<string>",
"status": "<string>",
"details": "<string>",
"payment": "<string>",
"refund": "<string>"
}
],
"bidOptions": {
"options": [
{
"positionConstraint": {
"anchor": "ANCHOR_TOP",
"basis": "BASIS_PERCENTILE",
"value": 123
}
}
]
}
}
]
}
]
}GetBidInfo
GetBidInfo is called by the bidder to get the bid information. If block number is not specified, all known block numbers are returned in the ascending order.
curl --request GET \
--url https://api.example.com/v1/bidder/get_bid_info{
"blockBidInfo": [
{
"blockNumber": "<string>",
"bids": [
{
"txnHashes": [
"<string>"
],
"revertableTxnHashes": [
"<string>"
],
"blockNumber": "<string>",
"bidAmount": "<string>",
"decayStartTimestamp": "<string>",
"decayEndTimestamp": "<string>",
"bidDigest": "<string>",
"slashAmount": "<string>",
"commitments": [
{
"providerAddress": "<string>",
"dispatchTimestamp": "<string>",
"status": "<string>",
"details": "<string>",
"payment": "<string>",
"refund": "<string>"
}
],
"bidOptions": {
"options": [
{
"positionConstraint": {
"anchor": "ANCHOR_TOP",
"basis": "BASIS_PERCENTILE",
"value": 123
}
}
]
}
}
]
}
]
}Query Parameters
Optional block number for querying bid info. If not specified, all known block numbers are returned in ascending order.
Page number for pagination.
Number of items per page for pagination. Default is 50
Response
A successful response.
List of block bid info containing bids and their commitments.
Show child attributes
Show child attributes
Block number for which the bid info is requested.
List of bids for the specified block number.
Show child attributes
Show child attributes
Hex string encoding of the hashes of the transactions that the bidder wants to include in the block.
Optional array of tx hashes that are allowed to revert or be discarded.
Block number that the bidder wants to include the transaction in.
Amount of ETH that the bidder is willing to pay to the provider for including the transaction in the block.
Timestamp at which the bid starts decaying.
Timestamp at which the bid ends decaying.
Hex string encoding of digest of the bid message signed by the bidder.
Amount of ETH that will be slashed from the provider if they fail to include the transaction. If zero, the decayed bid amount is used for slashing.
Show child attributes
Show child attributes
Hex string encoding of the address of the provider that signed the commitment.
Timestamp at which the commitment is published.
Status of the commitment. Possible values: 'pending', 'stored', 'opened', 'settled', 'slashed', 'failed'.
Additional details about the commitment status.
Payment amount in wei for the commitment.
Refund amount in wei for the commitment, if applicable.
Show child attributes
Show child attributes
List of bid options for the transaction.
Show child attributes
Show child attributes
Constraint on the position of the transaction in the block.
Show child attributes
Show child attributes
ANCHOR_TOP, ANCHOR_BOTTOM BASIS_PERCENTILE, BASIS_ABSOLUTE, BASIS_GAS_PERCENTILE Value of the position constraint. If anchor is TOP, this is the position from the top of the block. If anchor is BOTTOM, this is the position from the bottom of the block.