Welcome to the documentation for the Bjarkan Smart Order Router (SOR) API. This API provides a powerful and flexible solution for getting aggregated or non-aggregated market data, streaming real-time trades, and executing orders across multiple cryptocurrency exchanges, optimizing for the best possible execution price.

​
What is Bjarkan SOR?

Bjarkan SOR is a comprehensive Market Data provider and Smart Order Router designed to:

  1. Provide both aggregated and non-aggregated orderbook data views with fees and VWAP calculations available.
  2. Stream real-time trade data from multiple exchanges.
  3. Intelligently split and route orders to achieve the best overall execution price.

​
API Endpoints

https://api.bjarkan.io

wss://api.bjarkan.io

​
Dashboard

https://dashboard.bjarkan.io

​
Key Features

  • Multi-Exchange Support: Connect to and trade on multiple exchanges simultaneously.
  • Configurable: Set up your own configurations to define which exchanges and symbols you want to work with.
  • Real-time Order Book Data: Get a comprehensive view of the market across all connected exchanges, with options for aggregated or non-aggregated data.
  • Live Trade Streaming: Receive real-time trade data from multiple exchanges.
  • Smart Order Execution: Automatically split and route orders for optimal execution.
  • Customizable Strategies: Leverage our open market data, execution and SOR to create your own advanced trading strategies and execution models.
  • Flexible Configuration: Easily set up and modify your orderbook and trades configurations, as well as API keys.
  • Sandbox Mode: Test your strategies in a safe environment using exchange sandbox modes.
  • Fee-Aware Orderbooks: Incorporate exchange fees directly into price levels to view the real orderbook of crypto.
  • VWAP Calculations: Utilize Volume Weighted Average Price calculations for more accurate pricing and better execution strategies.

​
Getting Started

  1. Authenticate with the API using the username and password obtained to get your access token.
  2. Set your orderbook and trades configurations.
  3. Start the required data streams (orderbook and/or trades).
  4. Connect to WebSocket endpoints to receive real-time data.
  5. Execute orders or implement your custom trading strategies.

Remember to keep your session active by making regular API calls or maintaining active WebSocket connections. If your session expires (after 1 hour of inactivity), you’ll need to log in again and restart your streams.

​
API Reference

For detailed information about each API endpoint, refer to our API Reference section. This includes request/response formats, parameters, and example usage for each endpoint.

​
Examples

To see the Bjarkan SOR API in action, take a look at our Examples section. Here you’ll find practical code samples and use cases to help you integrate the API into your trading systems and develop custom execution algorithms.

We’re excited to see what you’ll build with the Bjarkan SOR API. Happy trading!