From b9ce2ef6064c168fe898e6ea06b55ffa21763e27 Mon Sep 17 00:00:00 2001 From: Alexander Graebe Date: Wed, 13 May 2020 12:54:36 -0700 Subject: [PATCH] Update stacks node api docs (#583) * Update stacks node api docs * Improvements based on feedback * Update _common/core_ref.md Co-authored-by: kyranjamie * Update _common/core_ref.md Co-authored-by: kyranjamie * Update based on most recent feedback * Update _common/core_ref.md Co-authored-by: kyranjamie * Update naming Co-authored-by: kyranjamie --- _common/core_ref.md | 19 ++++++++++++++++--- 1 file changed, 16 insertions(+), 3 deletions(-) diff --git a/_common/core_ref.md b/_common/core_ref.md index 79249daf..9c11a12e 100644 --- a/_common/core_ref.md +++ b/_common/core_ref.md @@ -1,5 +1,18 @@ --- -layout: externalurl -redirect_url: https://core.blockstack.org/ -title: "Stacks Node API" +layout: core +title: "Stacks Blockchain APIs" +description: Interacting with the Stacks 2.0 Blockchain +permalink: /:collection/:path.html --- + +With the launch of Stacks 2.0, a new version of the Blockstack blockchain was released. There are two ways of interacting with the blockchain, either using the Stacks Blockchain API or by making RPC calls to a Stacks Core directly. + +## Stacks Core API +The Stacks 2.0 blockchain's Rust implementation exposes RPC endpoints (in JSON format), which can be used to interface with the Stacks blockchain. [You can find the RPC API references here](https://docs.blockstack.org/core/smart/rpc-api.html). + +## Stacks Blockchain API +The Stacks Blockchain API was built to maintain pageable materialized views of the Stacks 2.0 Blockchain. It is a server that exposes a RESTful JSON API, hosted by PBC. It introduces aidditonal functionality (e.g. get all transactions), as well as proxies calls directly to Stacks Node. [You can find the OpenAPI specification and documentation here](https://blockstack.github.io/stacks-blockchain-sidecar/). + +*Note: Using this API requires you to trust the server, but provides a faster onboarding experience. It also addresses performance issues for which querying a node itself would be too slow or difficult.* + +{% include note.html content="If you are looking for the Stacks 1.0 RPC endpoint references, please follow this link." %}