The Upvest Blockchain API

A multi-protocol blockchain API for building blockchain-interacting applications.

Get Started     Tutorial     API Reference


This page is an overview of the Upvest Blockchain API documentation and related resources.

The Upvest Blockchain API is a multi-protocol blockchain API for building blockchain-interacting applications. Learn what the Upvest Blockchain API is on our homepage or in our tutorial.

Try the Upvest Blockchain API

The Upvest Blockchain API is designed from the start for gradual adaptation, and you can use as little or as much of the Upvest Blockchain API as you need. Whether you want to get a taste of the Upvest Blockchain API or start a blockchain-powered app, the links in this section will help you get started.


If you are interested in playing around with the Upvest Blockchain API, you can obtain access to our playground, where you have access to protocol test nets.

Learn the Upvest Blockchain API

People come to the Upvest Blockchain API from different backgrounds and with varying styles of learning. Whether you prefer a more theoretical or practical approach, we hope you'll find this section helpful.

Like any unfamiliar technology, the Upvest Blockchain API has a learning curve. With practice and some patience, you will get the hang of it.

JavaScript Resources

Though the Upvest Blockchain API is programming language agnostic, the documentation assumes some familiarity with programming in the JavaScript language. You don't have to be an expert, but the examples provided are written in JavaScript.

We recommend going through this JavaScript overview to check your knowledge level. It will take you between 30 minutes and an hour, but you will feel more confident learning the Upvest Blockchain API.


Whenever you get confused about something in JavaScript, MDN and javascript.info are great websites to check.

Practical Tutorial

If you prefer to learn by doing, check out our practical tutorial. In this tutorial, we will build a wallet command-line interface using the Upvest Blockchain API. The techniques you'll learn in the tutorial are fundamental to making any app using the Upvest Blockchain API, and mastering it will give you a much deeper understanding.

Step-by-Step Guide

If you prefer to learn concepts step by step, our guide to main concepts is the best place to start. Every next chapter in it builds on the knowledge introduced in the previous chapter, so you won't miss anything as you go along.

Advanced Concepts

Once you're comfortable with the main concepts and gained a little practical experience with the Upvest Blockchain API, you might be interested in more advanced topics. This section will introduce you to the powerful features like forwarding contracts, and account recovery.

API Reference

This documentation section is useful when you want to learn more details about a particular Upvest Blockchain API.

Glossary and FAQ

The glossary contains an overview of the most common terms you'll see in the Upvest Blockchain API documentation. There is also an FAQ section dedicated to short questions and answers about common topics.

Staying Informed

The Upvest blog is the official source for the updates from the Upvest team. Anything important, including release notes and deprecation notices, will be posted there first.

You can also follow the @upvestco account on Twitter, but you won't miss anything essential if you only read the blog.

Versioned Documentation

This documentation always reflects the latest stable version of the Upvest Blockchain API. You can find older versions of the documentation by changing the version in the breadcrumbs. Note that documentation for past versions is snapshotted by the time of the release and won't be continuously updated.

Something Missing?

If something is missing in the documentation or if you found some part confusing, please [link: file an issue for the documentation repository] with your suggestions for improvement, or tweet at the @upvestco account. We love hearing from you!