> For the complete documentation index, see [llms.txt](https://rumvessel.gitbook.io/sir-bofi/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://rumvessel.gitbook.io/sir-bofi/documentation.md).

# Documentation

## Logic

Platform scrapes 9000+ cryptos, 600+ exchanges and hundreds of trading pairs per crypto, goes over every possible price difference combination, calculates price differences and provides those as arbitrage opportunities with corresponding market links attached.

### Basic Filters

1. **Start analyzing from** - Pulled cryptos are ordered by their market cap. As BTC has the biggest market cap in the market it is the first to be checked. Based on that you can choose from what rank (ordered by market cap) to start checking from.
2. **Number of cryptos to check** - Taking into account the previous filter - how many cryptos to scan from that point on.
3. **Market pairs check offset** - In case there is a crypto with a a lot of trading pairs and exchanges related you might need to execute multiple scans going through different ranges of the market pairs.
4. **Minimum/maximum profit margin** - this is an option to filter out illogical arbitrage opportunities. For example if you do not filter the results to be from trustworthy exchanges and with specifications that make the arbitrage possible it can return results with unrealistically high profit margins.

### Advanced Filters

1. **Trading categories** - You can choose to filter out either spot trading or perpetual trading categories. Not sure why you’d need both but I left it open as an option :D.
2. **Quote symbols** - This filters out what kind of price quote currencies to accept into the arbitrage trading pairs. For example if the algorithm is analysing BTC and only USD quote symbol is selected then it will only compare BTC/USD trading pair prices.
3. **Exchanges** - This is one of the most important filters. If this filter is disabled the all 600+ exchanges are analysed - many of them are not trustworthy. The ones listed in the filters should be trustworthy though as they have minimum 4/5 ratings on their apps and an appropriate amount of downloads.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://rumvessel.gitbook.io/sir-bofi/documentation.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.