API v1 Overview

Compass is a cross-chain liquidity aggregation protocol enabling seamless token transfers across 80+ blockchains. This documentation covers the core API endpoints for executing cross-chain transaction

This is an outdated version of our documentation.

Please visit the latest version at https://docs.blockend.com/ for up-to-date and accurate information.

Getting Started

Base URL https://api2.blockend.com/v1/ All type definitions can be found here

Core Transaction Flow

1. Fetching quotes

User flow begins with fetching quotes, which returns a list of quotes for the given input and output assets, along with the steps involved in the transaction. Quotes are by default sorted via best output and contains a scores object and tags to determine fastest/cheapest/best output routes.

Get Quotes Documentation

2. Creating a transaction

After fetching quotes, you can create a transaction using the selected quote by passing in the routeId of the quote.

Create Transaction Documentation

3. Getting transaction data to execute

Call this api with routeId and stepId of individual steps to get the transaction data to execute.

Get Transaction Data Documentation

4. Check status of a transaction

After user signs and submits the transaction on chain, check the status of the transaction by passing in the signature hash of the transaction.

Check Transaction Status Documentation

5. Using WebSockets for realtime updates (in active development)

You can also check the status of a transaction using WebSockets. This can provide faster and almost realtime updates on the status of a transaction.

Note: this feature is in active development and will be generally available soon. Contact us to get access to this feature.

6. Single API for simple flow execution (in active development)

A simple 1 step endpoint is being worked on where a request directly gives you a single quote in response along with array of transaction data to execute to complete the transaction

Note: this feature is in active development and will be generally available soon. Contact us to get access to this feature.

Meta Endpoints

Tokens

Get a list of supported tokens and their details.

curl -X GET "https://api2.blockend.com/v1/tokens"

Chains

Get a list of supported chains and their details.

curl -X GET "https://api2.blockend.com/v1/chains"