<aside> 💡

You’ll need an API key. Sign in and generate one here: https://bankr.bot/api

A typescript example for submitting an order can be found at the end of the documentation. And an example repo can be found here: https://github.com/BankrBot/trading-engine-api-example/tree/main/examples/widget

</aside>

Overview

The External Orders API allows third party users to interact with Bankr’s trading engine and order book, which supports a variety of simple and complex order types

Specifically, using the External Orders API, you can:

• Get quotes for supported order types
• Submit signed orders to the Bankr order book
• Get order(s) for a given user
• Cancel an order

The supported order types are as follows:

• Limit buy
• Limit sell
• Stop buy
• Stop sell
• Time-weighted average price (TWAP)
• Dollar-cost averaging (DCA)

Core API Interactions

Let’s walk through how core interactions with the API work. For concrete details on each of these, visit the API Reference section below

To place an order:

1. Generate a quote by querying the API quote endpoint
   1. If you would like to include app fees, you include the arguments when posting to the API quote endpoint
2. Submit any approval transactions and sign the order in the quote response