Skip to content

Commit

Permalink
Add APIs overview
Browse files Browse the repository at this point in the history
  • Loading branch information
cakevm committed Jan 24, 2025
1 parent 2868020 commit a5d5764
Showing 1 changed file with 31 additions and 0 deletions.
31 changes: 31 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,37 @@ Current concept for types:
Future concept for types:
- Alloy for all types

### APIs
```
- Solver API (driver)
- /quote (GET)
- /solve (POST)
- /reveal (POST)
- /settle (POST)
- Solver Engine API (solvers)
- /solve (POST)
- /notify (POST)
- Order Book API (orderbook)
- /orders (POST, DELETE)
- /orders/{UID} (GET, DELETE)
- /orders/{UID}/status (GET)
- /transactions/{txHash}/orders (GET)
- /trades (GET)
- /auction (GET)
- /account/{owner}/orders (GET)
- /token/{token}/native_price (GET)
- /quote (POST)
- /solver_competition/{auction_id} (GET)
- /solver_competition/by_tx_hash/{tx_hash} (GET)
- /solver_competition/latest (GET)
- /version (GET)
- /app_data/{app_data_hash} (GET, PUT)
- /app_data (PUT)
- /users/{address}/total_surplus (GET)
```

## Usage
See the [examples](./examples) directory for usage examples.

Expand Down

0 comments on commit a5d5764

Please sign in to comment.