input-output-hk / cardano-rest

Cardano REST

Overview

Cardano REST provides a set of APIs for interacting with on-chain data through JSON over HTTP.

⚠️ These APIs are the currently supported APIs. In future they may be augmented or replaced by a GraphQL API of cardano-graphql, when GraphQL component will be released. These APIs will be supported for some time, even once alternatives become available.

Getting Started

1. Clone the repository.

$ git clone git@github.com:input-output-hk/cardano-rest.git
$ cd cardano-rest

2. Start cardano-node, cardano-db-sync, postgresql and cardano-rest components using Docker:

$ NETWORK=testnet docker-compose up

3. Query the API 🎉

$ curl http://localhost:8100/api/txs/last 

For more information, have a look at the Wiki 📖.

How to install (Linux / Mac OS / Docker)

Docker (recommended)

See Using Docker.

From Binaries

See assets available for each release.

Documentation

• API Documentation (cardano-explorer-api)
• API Documentation (cardano-submit-api)