Welcome to rubi’s documentation!

rubi is a Python library for interacting with the Rubicon protocol, a limit order book market currently on Optimism.

RISKS AND DISCLAIMERS

SDK Disclaimer: This codebase is in Alpha and could contain bugs or change significantly between versions. Contributing through Issues or Pull Requests is welcome!

Protocol Disclaimer: Please refer to this for information on the risks associated to the Rubicon Protocol.

Check out the Quickstart section for information on how to get going, including how to install the sdk.

Table of contents

Intro

• Quickstart
  • Installation
  • Using rubi
    • rubi client
    • READ ONLY rubi client
    • rubi client pairs and tokens
  • rubi data methods
    • The get_offers Method
    • The get_trades Method
    • Retrieving Offer Data
    • Retrieving Trade Data
• Overview
  • The client
  • Rubicon contracts
    • RubiconMarket contract
    • RubiconRouter contract

API

• rubi client
• rubi package

Indices and tables

• Index

• Module Index

• Search Page