Skip to main content

Getting Started

Getting started using the Rosetta API will depend on your goals. Are you looking to create a Rosetta implementation for your blockchain or are you looking to integrate with an existing Rosetta implementation? The path you take is based on your answer.

The basic idea is that once you implement Rosetta API with a blockchain, you can integrate applications that use Rosetta API to interact with that blockchain (or any blockchain that has a Rosetta implementation).

Implementing Rosetta for your Blockchain​

If you are working on a blockchain that you would like to make more accessible with Rosetta API, this is the best way to get started:

  1. Learn the specs. We have Rosetta specifications to help you check what the APIs request response should be.

  2. Implement the endpoints. The rosetta-specifications repository contains all the API endpoints that you need to implement and test your code. If you are coding in Golang, we have a Go SDK that can help you get started.

  3. Deploy the Rosetta implementation along with the blockchain node. Write a functional Docker file to do this. Follow this guide on Docker deployment for more information. We also have references in the rosetta-ecosystem repo that you can use to see how developers implement the Rosetta API for their assets.

  4. Test your implementation with the rosetta-cli tool. Once you run the blockchain node, you can use the rosetta-cli tool to test your implementation. The tool will run a basic check against the Rosetta API specs and will make sure your implementation functions correctly.

Integrating Applications with Rosetta API​

Once you have a Rosetta implementation, you can use the Rosetta client to integrate applications with your blockchain. You can also integrate using existing Rosetta implementations. Here’s the best way to get started with this task:

  1. Learn the specs. We have Rosetta specifications to help you check what the APIs request response should be.

  2. Choose a Rosetta blockchain implementation to work with. You can find a collection of community-driven implementations on the Rosetta API Community site and the rosetta-ecosystem repository in GitHub.

  3. Deploy the Rosetta implementation along with the blockchain node. Write a functional Docker file to do this. Follow this guide on Docker deployment for more information. The references in the rosetta-ecosystem repo can also guide you.

  4. Test requests and responses using the Rosetta API endpoints. You can find the entire specification in our Full Reference documentation. For a quick overview, read the next section.

Rosetta Quick Reference Guide​

This guide provides an overview of the Rosetta API endpoints. For more information on these endpoints, read the Full Reference documentation.

Rosettta API Quickstart with list of endpoints

Next Steps​

Follow the navigation menu’s order to learn more about Rosetta API. You can start writing a configuration file to test with rosetta-cli. Or follow the implementations we’ve referenced. The Testing section provides great details on how to test your Rosetta implementation. If you have any questions, you can check out our Community website to find the answer or submit your own questions. Happy coding!

Last updated on

Was this helpful?