Core/grin
0
0
Fork 0
mirror of https://github.com/mimblewimble/grin.git synced 2025-01-21 03:21:08 +03:00
Code Issues Projects Releases Packages Wiki Activity Actions
grin/doc/api/api.md

1.5 KiB
Raw Blame History

Grin API Documentation

This document contains the documentation for the 3 Grin REST APIs. These endpoints can be grouped in two categories.

Node API

This endpoint is used to query a node about various information on the blockchain, networks and peers. By default, this REST API will listen on localhost:3413. This API is started as the same time as the Grin node. This endpoint requires, by default, Basic Authentication. The username is grin and the password can be found in the .api_secret file. To learn about what specific calls can be made read the node API doc.

Wallet APIs

Foreign Wallet API

The foreign API is an endpoint mainly designed to receiving grins through a network. This REST API can be started with the grin wallet listen command and by default will listen on localhost:3415. To learn about what specific calls can be made read the wallet foreign API doc.

Wallet Owner API

The wallet owner API is an endpoint to manage the user wallet: broadcast transaction, sign transaction, see the current balance... This REST API can be started with the grin wallet owner_api command and will listen on localhost:3420. This endpoint must never be exposed to the outside world. This endpoint requires, by default, Basic Authentication. The username is grin and the password can be found in the .api_secret file. To learn about what specific calls can be made read the wallet owner API doc.