@import url('https://fonts.googleapis.com/css2?family=Inconsolata:wght@200..900&display=swap');

h1, h2, h3, #navbar {
  font-family: "Inconsolata", monospace;
}

.dark #navbar {
  background-color: #121213;
}


September 28, 2024

August 21, 2024

Support

Skip

API Reference

Release Notes

Skip:Connect

Research

Jobs

Selected updates and improvements to the Skip Go REST API.

REST API

This pages explains what the Skip Go API is, gives examples of applications built with it, and provides guidance on standard ways to use it.

Introduction

This guide walks you through the process of setting up and using the Skip Go Client to perform a cross-chain from USDC on Noble to TIA on Celestia.

Quickstart Guide

Overview & Common Usage Patterns

Supported Ecosystems

This document covers the tooling provided in Skip Go for tracking transaction status across multiple chains and bridge hops.

Transaction Tracking

Requesting & Using API Keys

This page covers Smart Relay -- Skip Go API's universal cross-chain data & token delivery service

Smart Relay

How to specify actions to perform after a route of transfers/swaps is completed

Post-Route Actions

This page covers how integrators can earn affiliate fees on swaps.

Setting Affiliate Fees

Understand how Skip Go handles user-facing fees

Getting Fee Info

This page highlights a few of the features we're cooking up 🧑‍🍳. Please get in touch with us if you'd like us to prioritize any of these or add something else to our roadmap

Upcoming Features

Getting Started

This page details your widget configuration options. Tweak it to fit your exact user experience needs!

Configuration

Web Component

@skip-go/client is a TypeScript library that streamlines interaction with the Skip Go API, enabling cross-chain swaps and transfers across multiple ecosystems.

This page details the utility functions for token balances, gas calculations, and transaction fees in Skip Go.

Balances, Gas and Transaction Fee Utilities

Migration Guide

This page covers the different ways our cross-chain swaps + transfers might fail to help identify failures and manage user expectations

Cross-chain Failure Cases

This page describes the IBC token routing problem and the algorithm Skip Go API uses to select / recommend token denoms and IBC paths

IBC Token Routing: Problem + Skip Go API Routing Algorithm

This doc covers how to interact with the EvmTx type returned by the Skip Go API

EVM Transactions

This document explains how to use Skip Go API and Client TypeScript Package to construct SVM transactions.

SVM Transactions

CW20 Tokens & Their Limitations

This page provides a living record of the features that can be turned on with the experimental_features flag

Experimental Features

This doc covers the various ways route quote quality is measured -- slippage, USD estimates of the amount in and out, and price impact

Understanding Quote Quality Metrics

`allow_unsafe`: Preventing & Handling Bad Execution

SAFE Swapping: How to Protect Users from Bad Trades

This page introduces the Smart Swap functionality provided by the Skip Go API to improve swap speed, price, and customization.

Smart Swap

This document describes what new chains need to do the support Skip Go API

Chain Support Requirements

This document describes the steps you must complete for the Skip Go API to begin providing new routes for users to transfer a token over to various remote chains using IBC.

Token & Route Support Requirements

This document covers what Skip Go API requires of DEXes to support them as potential swapping venues within the API's cross-chain DEX aggregation functionality. At the end, the document provides instructions for helping the Skip team add your DEX to the API as a swapping venue

Swap Venue Requirements

This guide provides step-by-step instructions to generate go.skip.build shareable links.

How to Generate Shareable Links

This guide provides step-by-step instructions to embed the Skip Go API widget into your project.

How to Embed iframe Widget

Get all supported chains along with additional data useful for building applications + frontends that interface with them (e.g. logo URI, IBC capabilities, fee assets, bech32 prefix, etc...)

Get /v2/info/chains

Get /v2/info/bridges

Get the balances of a given set of assets on a given chain and wallet address.

Post /v2/info/balances

Get /v2/fungible/venues

Get supported assets. Optionally limit to assets on a given chain and/or native assets.

Get /v2/fungible/assets

Get assets that can be reached from a source via transfers under different conditions (e.g. single vs multiple txs)

Post /v2/fungible/assets_from_source

This supports cross-chain actions among EVM chains, Cosmos chains, and between them. Returns the sequence of transfers and/or swaps to reach the given destination asset from the given source asset, along with estimated amount out. Commonly called before /msgs to generate route info and quote.

Post /v2/fungible/route

This supports cross-chain actions among EVM chains, Cosmos chains, and between them. Returns minimal number of messages required to execute a multi-chain swap or transfer. Input consists of the output of route with additional information required for message construction (e.g. destination addresses for each chain)

Post /v2/fungible/msgs

This supports cross-chain actions among EVM chains, Cosmos chains, and between them. Returns minimal number of messages required to execute a multi-chain swap or transfer. This is a convenience endpoint that combines /route and /msgs into a single call.

Post /v2/fungible/msgs_direct

Get origin assets from a given list of denoms and chain IDs.

Post /v2/fungible/ibc_origin_assets

Given 2 chain IDs, returns a list of equivalent assets that can be transferred

Post /v2/fungible/assets_between_chains

Submit a signed base64 encoded transaction to be broadcast to the specified network. On successful submission, the status of the transaction and any subsequent IBC or Axelar transfers can be queried through the /status endpoint.

Post /v2/tx/submit

Requests tracking of a transaction that has already landed on-chain but was not broadcast through the Skip Go API. The status of a tracked transaction and subsequent IBC or Axelar transfers if routing assets cross chain can be queried through the /status endpoint.

Post /v2/tx/track

Get the status of the specified transaction and any subsequent IBC or Axelar transfers if routing assets cross chain. The transaction must have previously been submitted to either the /submit or /track endpoints.

Get /v2/tx/status

Selected updates and improvements to the `@skip-go/client` library.

Client Library

Selected updates and improvements to the `@skip-go/widget` [npm package](https://www.npmjs.com/package/@skip-go/client).

Release Notes

​September 28, 2024

​August 21, 2024

September 28, 2024

August 21, 2024