API Reference

Let's wall through the steps involved for creating a collection bid via the API on Satflow.

There are several steps involved in creating a collection bid:

  1. Generate a bidding address for your payment and ordinals address using /walletBidding/address
    1. This bidding address is unique to the payment and ordinals address.
  2. Fund the bidding address by simply sending Bitcoin to the generated address from Step 1.
  3. Create a collection bid by publishing the bid parameters with /bid
    1. You may create a collection bid up to your maximum bidding balance available. You can place your maximum bidding balance as a bid on multiple collections, however if any of these bids are accepted, your remaining bid that fall under your balance will automatically be cancelled.
  4. You can then check your existing bids with /walletBids
    1. This will return a list of bids for the requested address. Collection bids will be identified with type = 'collection'.

Cancelling a collection bid

Similar to cancelling a normal listing or bid you can use the /cancel endpoint, however the bid_id (obtained from /walletBids) must be provided instead of the inscription id or outpoint.