The OrderBookApi class provides methods to interact with the CoW Protocol Order Book API, enabling operations like posting orders, obtaining quotes, retrieving trades, and managing order states.
Constructor
Initialization Examples
Methods
get_version
Retrieves the current API version string.
post_order
Submits a new order to the order book.
post_quote
Requests a quote for a potential order.
get_order_by_uid
Retrieves complete order details by UID.
get_orders_by_owner
Fetches all orders for a specified owner with pagination.
get_trades_by_owner
Retrieves all trades executed by a specific owner.
get_trades_by_order_uid
Returns all trades associated with a particular order.
delete_order
Cancels one or more orders.
get_native_price
Obtains the native token price for a specified token.
get_total_surplus
Retrieves total surplus accumulated for a user.
get_tx_orders
Fetches all orders included in a specific transaction.
get_solver_competition
Obtains solver competition details.
get_solver_competition_by_tx_hash
Retrieves solver competition details using a transaction hash.
get_order_link
Generates an API endpoint URL for a specific order.
put_app_data
Uploads application data to the API.
get_app_data
Retrieves application data using its hash.
get_order_multi_env
Searches for an order across production and staging environments.
Method Summary
Last modified on March 11, 2026